File System:Get File System Share List

Search (SHIFT+S)

API Reference


Get File System Share List

GET /file/filesystems/{id}/shares

Get list of SMB shares for the specified file system.

idthe URN of a ViPR File system

Required Roles

Requires one of the following roles:

  • SYSTEM_MONITOR
  • TENANT_ADMIN

Response Body

List of file system shares.

Field Description Type Notes
<smb_shares>
<smb_share>     0-* Elements
<mount_point> The SMB mount point of the file system. String
<path> The SMB path of the file system or subdirectory String
<name> User provided name of the file share. String
<description> User provided description of the file share. String
<max_users> Maximum number of users of the file share. Default is unlimited. String
<permission_type> Permission type for the file share. Default is "allow". Valid values: allow = permission type by default deny String
<permission> Permission type for the file share. Default is "change". Valid values: read = read permission only change = read and write permissions full = full control of the file share String
<subDirectory> String
</smb_share>      
</smb_shares>
Notes: