Share Management
share-clone-create
Usage: share-clone-create [options]
Clone share snapshot
| Options | Description |
|---|---|
| --async | Determines that the command will be executed asynchronously. A reference task identifier will be returned |
| * --destination-path | Destination directory path for clone. The path must be relative to the share's root directory |
| --help | Display this help and exit |
| --overwrite-destination | Whether to overwrite the destination directory if it exists |
| * --share-id | Share ID. Required unless "--share-name" is specified |
| * --share-name | Share name. Required unless "--share-id" is specified |
| * --snapshot-name | Name of snapshot to be cloned |
share-create
Usage: share-create [options]
Create a share
Example: share-create --name share2 --path /share2 --export-option *,rw,no-root-squash
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --description | A textual description of the share |
| --export-option | Export options for the share. Each value must contain <subnet,access-permission,{no-}root-squash>. |
| --help | Display this help and exit |
| * --name | The name the system uses to identify the share. This name should be unique across all shares. When creating an SMB share, this name serves as the SMB Share Name used when accessing the share via SMB and can not be changed once the share is created. |
| --override-mem-check | Allow share creation even when it would exceed memory requirements. |
| * --path | The share path (i.e. /share1). The / prefix must be specified. |
| --preferred-domain | Preferred domain in which users have accounts. This field is required for mapping users from another domain into this domain |
| --replication-latency-alert- threshold | Number of seconds of replication latency which will be tolerated before an alert is created |
| --size | Limit the share size (quota) |
| --size-warning-threshold | Threshold (1-99 percent) for share capacity usage, an event will be sent if this threshold is reached. |
| --unmapped-group | Default group name, if there is no mapping discovered into the preferred domain |
| --unmapped-user | Default user name, if there is no mapping discovered into the preferred domain |
Share-delete
Usage: share-delete [options]
Delete a share
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --delay | Postpone share space reclaim for period of time (for example 24h). Mutually exclusive with "--now" |
| --delete-path | Delete the share path directory when the share is purged. Directory must be empty in order to be deleted |
| --help | Display this help and exit |
| * --id | The ID of the share to delete. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share to delete. Required unless "--name" or "--id" is specified |
| * --name | The name of the share to delete. Required unless "--internal-id" or "--id" is specified |
| --now | Share space will be reclaimed immediately. Mutually exclusive with "--delay" |
share-list
Usage: share-list [options]
Display a list of all shares available in the system. Two types of lists can be displayed: a full list and a summary list (default)
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help | Display this help and exit |
| --id | The ID of the share to list |
| --internal-id | The internal ID of the share to list |
| --name | he name of the share to list |
share-mount
Usage: share-mount [options]
Mount a share
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| * --id | The ID of the share to mount. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share to mount. Required unless "--name" or "--id" is specified |
| * --name | The name of the share to mount. Required unless "--internal-id" or "--id" is specified |
share-move
Usage: share-move [options]
Move share to a different path
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| * --id | The ID of the share to move. Required unless "--internal-id" or "--name" is specified |
| * --name | The name of the share to move. Required unless "--internal-id" or "--id" is specified |
|
* --internal-id |
The internal ID of the share to move. Required unless "--name" or "--id" is specified |
| * --path | Path to mount the share on (i.e. /share1). The / prefix must be specified. |
share-objective-add
Usage: share-objective-add [options]
Apply an objective to a share (or at a path within the share)
| Options | Descriptions |
|---|---|
| --clear-existing | Causes all previously added objectives at path to be removed |
| --help | Display this help and exit |
| * --id | The ID of the share. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share. Required unless "--name" or "--id" is specified |
| * --name | The name of the share. Required unless "--internal-id" or "--id" is specified |
| * --objective | The objective name |
| --path | A path within the share to apply the objective to. When omitted, ''/'' is implied |
share-objective-list
Usage: share-objective-list [options]
List the applied and active objectives for a share (or at a path within the share)
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | The ID of the share. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share. Required unless "--name" or "--id" is specified |
| * --name | The name of the share. Required unless "--internal-id" or "--id" is specified |
| --path | A path within the share to list the objectives for. When omitted, ''/'' is implied |
share-objective-remove
Remove an applied objective from a share (or from a path within the share)
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| * --id | The ID of the share. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share. Required unless "--name" or "--id" is specified |
| * --name | The name of the share. Required unless "--internal-id" or "--id" is specified |
| --objective | The objective name to be removed. When omitted, all objectives applied locally are removed |
| --path | A path within the share to remove the objective from. When omitted, ''/'' is implied |
share-offline
Usage: share-offlline [options]
Bring a share to the offline state
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| * --id | The ID of the share to bring online. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the share to bring online. Required unless "--id" or "--name" is specified |
| * --name | The name of the share to bring online. Required unless "--id" or "--internal-id" is specified |
share-online
Usage: share-online [options]
Bring a share to the online state
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| *--id | The ID of the share to bring online. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the share to bring online. Required unless "--id" or "--name" is specified |
| *--name | The name of the share to bring online. Required unless "--id" or "--internal-id" is specified |
share-snapshot-create
Usage: share-snapshot-delete [options]
Create share snapshot
Example: share-snapshot-create --share-name test --now
| Options | Descriptions |
|---|---|
| --helps | Display this help and exit |
| --now | Create immediate snapshot of the share. Required unless "--schedule-name" is specified |
| --retention-name | Name to identify the retention |
| --schedule-name | Name for the schedule of periodic snapshots of the share. Required unless "--now" is specified |
| *--share-id | Share ID. Required unless "--share-name" is specified |
| *--share-name | Share name. Required unless "--share-id" is specified |
share-snapshot-delete
Usage: share-snapshot-delete [options]
Delete share snapshot
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--share-id | Share ID. Required unless "--share-name" is specified |
| *--share-name | Share name. Required unless "--share-id" is specified |
| *--snapshot-name | May include wild-card characters (for example 2001-01-01T12-00*) |
share-snapshot-list
Usage: share-snapshot-list [options]
List snapshots for share
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| *--share-id | Share ID. Required unless "--share-name" is specified |
| *--share-name | Share name. Required unless "--share-id" is specified |
share-snapshot-restore
Usage: share-snapshot-restore [options]
Restore files from a share snapshot (when used with --filename option) or a complete share snapshot.
| Options | Descriptions |
|---|---|
| --async | Determines that the command will be executed asynchronously. A reference task identifier will be returned. This option can be used only when restoring the entire share |
| --filename | Paths for files to be restored from the share snapshot. Multiple paths may be provided. A path must be relative to the share root directory. The filename in the path may include wild-card characters (for example, /dir/file*.txt) |
| --help | Display this help and exit |
| *--share-id | Share ID. Required unless "--share-name" is specified |
| *--share-name | Share name Required unless"--share-id" is specified |
| *--snapshot-name | Share snapshot name |
share-snapshot-schedule-list
Usage: share-snapshot-schedule-list [options]
List scheduled snapshots for share
| Options | Descriptions |
|---|---|
| --help | Display this help and exit |
| --share-id | share ID |
| --share-name | share name |
share-snapshot-update
Usage: share-snapshot-update [options]
Update share snapshot schedule
| Options | Descriptions |
|---|---|
| --clear-snapshots | Delete all snapshots taken for the schedule. Can be provided along with remove-schedule |
| --help | Display this help and exit |
| --new-retention-name | Name to identify the retention. Required unless "--remove-schedule" or "--remove-retention" is specified |
| --remove-retention | Remove retention from share snapshot schedule. Required unless "--remove-schedule" or "--new-retention-name" is specified |
| --remove-schedule | Remove both schedule and retention from share snapshot. Required unless "--new-retention-name" or "--remove-retention" is specified |
| *--schedule-name | Name for the schedule of periodic snapshots of the share |
| *--share-id | Share ID. Required unless "--share-name" is specified |
| *--share-name | Share name. Required unless "--share-id" is specified |
share-undelete
Usage: share-undelete [options]
Abort scheduled deletion a share
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| *--id | The ID of the share to undelete. Required unless "--internal-id" or "--name" is specified |
| * --internal-id | The internal ID of the share to undelete. Required unless "--name" or "--id" is specified |
| *--name | The name of the share to undelete. Required unless "--internal-id" or "--id" is specified |
share-unmount
Usage: share-unmount [options]
Unmount a share
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --help | Display this help and exit |
| *--id | The ID to of the share to unmount. Required unless "--internal-id" or "--name" is specified |
| *--internal-id | The internal ID of the share to unmount. Required unless "--name" or "--id" is specified |
| *--name | The name of the share to unmount. Required unless "--internal-id" or "--id" is specified |
share-update
Usage: share-update [options]
Update a share
| Options | Descriptions |
|---|---|
| --async | Causes the command to be executed asynchronously. A reference task identifier will be returned |
| --description | A textual description of the share. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description-clear " or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --description-clear | Clear description attribute. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --export-option | Export options for the share. Each value must contain <subnet,access-permission, {no-}root-squash>. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" is specified |
| --export-option-clear | Clear export-option attribute. Required unless "--unmapped-group-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --help | Display this help and exit |
| *--id | The ID of the share to update. Required unless "--name" or "--internal-id" is specified |
| *--internal-id | The internal ID of the share to update. Required unless "--id" or "--name" is specified |
| *--name | The name of the share to update. Required unless "--id" or "--internal-id" is specified |
| --preferred-domain | Preferred domain in which users have accounts. This field is required for mapping users from another domain into this domain. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --preferred-domain-clear | Clear preferred domain attribute. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| * --replication-latency-alert-threshold | Number of seconds of replication latency which will be tolerated before an alert is created. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| replication-latency-alert-threshold-clear | Clear replication latency alert threshold. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--size" or "--smb-alias" or "--export-option" is specified |
| --size | Limit the share size (quota). Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--smb-alias" or "--export-option" is specified |
| --size-clear | Set no size limit on the share (no quota). Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --size-warning-threshold | Threshold (1-99 percent) for share capacity usage, an event will be sent if this threshold is reached. ... Required unless "--unmapped-group-clear" or "--export-option-clear" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --smb-alias | Set SMB aliases. Each alias has a name and a path within the share. If not specified, the default path is /. An alias path must be created before creating the alias. Can be specified multiple times. Format: <alias-name> or <alias-name>,<alias-path>. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--export-option" is specified |
| --smb-alias-clear | Clear SMB aliases. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --unmapping-group | Default group name, if there is no mapping discovered into the preferred domain. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --unmapping-group--clear | Clear unmapped group attribute. Required unless "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --unmapped-user | Default user name, if there is no mapping discovered into the preferred domain. . Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--unmapped-user-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |
| --unmapped-user-clear | Clear unmapped user attribute. Required unless "--unmapped-group-clear" or "--export-option-clear" or "--size-warning-threshold" or "--preferred-domain-clear" or "--description" or "--description-clear" or "--smb-alias-clear" or "--replication-latency-alert-threshold" or "--preferred-domain" or "--size-clear" or "--unmapped-group" or "--unmapped-user" or "--replication-latency-alert-threshold-clear" or "--size" or "--smb-alias" or "--export-option" is specified |