The file system share object model describing this resource contains the following objects.
fileSystemShare
| Attribute
| JSON Type
| Data Type
| Description
|
| objectId
| string
| string
| File system share unique identifier.
|
| shareId
| string
| string
| Either the NFS export ID or the CIFS share ID.
|
| name
| string
| string
| File system share name.
|
| virtualServerId
| number
| ushort
| Virtual server ID.
|
| filesystemId
| string
| string
| File system unique identity.
|
| path
| string
| string
| File system path.
|
| settings
| object
| object
| Depending on the share type, can be either CIFSSettings or NFSSettings.
|
CIFSSettings
| Attribute
| JSON Type
| Data Type
| Description
|
| accessConfig
| string
| string
| CIFS share config options (typically it is the IP addresses of the allowed hosts).
|
| comment
| string
| string
| File system share comment.
|
| userHomeDirectoryPath
| string
| string
| User home directory path.
|
| isScanForVirusesEnabled
| boolean
| boolean
| Enable to scan for virus on this CIFS share.
|
| maxConcurrentUsers
| number
| int
| Maximum concurrent sessions to access the share. The -1 value indicates unlimited concurrent values.
|
| snapshotOption
| string
| string
| Snapshot option. Possible values are:
- HIDE_AND_DISABLE_ACCESS
- HIDE_AND_ALLOW_ACCESS
- SHOW_AND_ALLOW_ACCESS
|
| cacheOption
| string
| string
| Cache option. Possible values are:
- MANUAL_CACHING_DOCS
- AUTO_CACHING_DOCS
- AUTO_CACHING_PROGS
- CACHING_OFF
|
| transferToReplicationTargetSetting
| string
| string
| Transfer to replication target setting. Possible values are:
- DO_NOT_TRANSFER
- TRANSFER
- USE_FS_DEFAULT
- INVALID
|
| userHomeDirectoryMode
| string
| string
| User home directory mode. Possible values are:
- OFF
- ADS
- USER
- HIDDEN_USER
- DOMAIN_AND_USER
- UNIX
|
| isFollowSymbolicLinks
| boolean
| boolean
| Indicates whether or not to follow the symbolic links.
|
| isFollowGlobalSymbolicLinks
| boolean
| boolean
| Indicates whether or not to follow the global symbolic links.
|
| isForceFileNameToLowercase
| boolean
| boolean
| Flag to force file name on the share to lower case.
|
| isABEEnabled
| boolean
| boolean
| Indicates whether access-based enumeration (ABE) is enabled. When enabled, ABE filters the contents of an SMB share. Note that enabling ABE may have a negative impact on SMB performance.
|
NFSSettings
| Attribute
| JSON Type
| Data Type
| Description
|
| accessConfig
| string
| string
| NFS export config options. Typically it is the IP addresses of allowed hosts.
|
| snapshotOption
| string
| string
| NFS snap shot option. Possible values are:
- SHOW_AND_ALLOW_ACCESS
- HIDE_AND_DISABLE_ACCESS
- HIDE_AND_ALLOW_ACCESS
|
| localReadCacheOption
| string
| string
| NFS local read cache option. Possible values are:
- DISABLED
- ENABLED_FOR_ALL_FILES
- ENABLED_FOR_TAGGED_FILES
- ENABLED_FOR_CVLS
|
| transferToReplicationTargetSetting
| string
| string
| NFS transfer to replication target setting. Possible values are:
- DO_NOT_TRANSFER
- TRANSFER
- USE_FS_DEFAULT
- INVALID
|
CIFSAuthentication
| Attribute
| JSON Type
| Data Type
| Description
|
| name
| string
| string
| Name of CIFS access authentication. It is typically a windows user or group name or SID. Example values are:
- current owner
- everyone
- guests
- guest
- users
- administrators
- administrator
- S-1-0
- S-1-3
- S-1-1-0
|
| encodedName
| string
| string
| Encoded string of name that allows the user access through the URI. The user should not be concerned with encoding methods that might be subject to change in the future.
|
| type
| string
| string
| Type of authentication. Possible values are:
- ALIAS
- COMPUTER
- DELETED
- DOMAIN
- GROUP
- INVALID
- UNKNOWN
- USER
- WELLKNOWN
|
| permission
| number
| uint
| Bit representation of permission for access authentication. Use decimal number. See the explanation in the table below.
|
CIFS Authentication Permission Explanation
| Permission
| Binary
| Decimal
|
| No permission
| 0
| 0
|
| Grant read
| 1000
| 8
|
| Grant read+change
| 11000
| 24
|
| Grant read+change+full control
| 111000
| 56
|
| Deny read
| 1
| 1
|
| Deny read+change
| 11
| 3
|
| Deny read+change+full control
| 111
| 7
|
- Parent Topic
