Technology Preview
internal-object-storage-create
Usage: internal-object-storage-create [options]
Create a DSX distributed object store
| Options | Descriptions |
|---|---|
| --access-key | Object storage access key. Required if "--secret-key" is specified (keys will be auto-generated if not provided) |
| --help |
Display this help and exit |
| --ip-address | IP address used to access internal object storage |
| * --logical-volume-id | The logical volume(s) that reside on DSX nodes that will be used to create the internal object storage. This parameter is in the form of a UUID and may be repeated. |
| * --name | The name to assign to the object storage |
| --nonexclusive | Allow the internal object storage to exist on the same logical volumes as other object stores and volumes |
| --object-volume-count | The number of volumes to create on the internal object storage |
| --parity | Number of parity volumes (default is the total number of volumes / 2) |
| --secret-key | Object storage secret key. Required if "--access-key" is specified (keys will be auto-generated if not provided) |
internal-object-storage-delete
Usage: internal-object-storage-delete [options]
Delete a DSX distributed object store
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| * --id | The ID of the object storage to delete. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the object storage to delete. Required unless "--id" or "--name" is specified |
| * --name | The name of the object storage to delete. Required unless "--id" or "--internal-id" is specified |
internal-object-storage-list
Usage: internal-object-storage-list [options]
List DSX distributed object stores
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --id | The ID of the object store to list |
| --internal-id | The internal ID of the object store to list |
| --name | The name of the object store to list |
remote-site-list
Usage: remote-site-list [options]
List known remote sites
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --id | The ID of the site to be listed |
| --internal-id | The internal ID of the site to be listed |
| --name | The name of the site to be listed |
remote-site-remove
Usage: remote-site-remove [options]
Remove a remote site
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| * --id | The ID of the site to be removed. Required unless "--name" or "--internal-id" is specified |
| * --internal-id | The internal ID of the site to be removed. Required unless "--id" or "--name" is specified |
| * --name | The name of the site to be removed. Required unless "--id" or "--internal-id" is specified |
share-participant-disable
Usage: share-participant-disable [options]
Stop replication of data and metadata 'to' share participant(s). When one of id, internal-id, or name is specified, the command is applied to that share participant. When site-id, site-internal-id, or site-name is specified and no share identifier is specified, the command is applied to all share participants related to the specified site across all shares. When a site identifier is specified along with a share identifier, the command is applied to the participants related to the specified site for the share(s) specified. Note that the share identifiers may be repeated, and are only applicable when paired with a site identifier.
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| * --id | The ID of the share participant to disable. Required unless "--internal-id" or "--site-id" or "--name" or "--site-name" or "--site-internal-id" is specified |
| * --internal-id | The internal ID of the share participant to disable. Required unless "--site-id" or "--name" or "--id" or "--site-name" or "--site-internal-id" is specified |
| * --name | The name of the share participant to disable. Required unless "--internal-id" or "--site-id" or "--id" or "--site-name" or "--site-internal-id" is specified |
| --share-id | Specifies share participants associated with a share ID. May only be used with a site identifier |
| --share-internal-id | Specifies share participants associated with a share internal ID. May only be used with a site identifier |
| --share-name | Specifies share participants associated with a share name. May only be used with a site identifier |
| * --site-id | Specifies share participants associated with a site ID. Required unless "--internal-id" or "--name" or "--site-name" or "--id" or "--site-internal-id" is specified |
| * --site-internal-id | Specifies share participants associated with a site internal ID. Required unless "--internal-id" or "--site-id" or "--name" or "--site-name" or "--id" is specified |
| * --site-name | Specifies share participants associated with a site name. Required unless "--internal-id" or "--site-id" or "--name" or "--id" or "--site-internal-id" is specified |
share-participant-enable
Usage: share-participant-enable [options]
Allow replication of data and metadata 'to' share participant(s). When one of id, internal-id, or name is specified, the command is applied to that share participant. When site-id, site-internal-id, or site-name is specified and no share identifier is specified, the command is applied to all share participants related to the specified site across all shares. When a site identifier is specified along with a share identifier, the command is applied to the participants related to the specified site for the share(s) specified. Note that the share identifiers may be repeated, and are only applicable when paired with a site identifier
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| * --id | The ID of the share participant to enable. Required unless "--internal-id" or "--site-id" or "--name" or "--site-name" or "--site-internal-id" is specified |
| * --internal-id | The internal ID of the share participant to enable. Required unless "--site-id" or "--name" or "--id" or "--site-name" or "--site-internal-id" is specified |
| * --name | The name of the share participant to enable. Required unless "--internal-id" or "--site-id" or "--id" or "--site-name" or "--site-internal-id" is specified |
| --share-id | Specifies share participants associated with a share ID. May only be used with a site identifier |
| --share-internal-id | Specifies share participants associated with a share internal ID. May only be used with a site identifier |
| --share-name | Specifies share participants associated with a share name. May only be used with a site identifier |
| * --site-id | Specifies share participants associated with a site ID. Required unless "--internal-id" or "--name" or "--site-name" or "--id" or "--site-internal-id" is specified |
| * --site-internal-id | Specifies share participants associated with a site internal ID. Required unless "--internal-id" or "--site-id" or "--name" or "--site-name" or "--id" is specified |
| * --site-name | Specifies share participants associated with a site name. Required unless "--internal-id" or "--site-id" or "--name" or "--id" or "--site-internal-id" is specified |
share-participant-list
Usage: share-participant-list [options]
Display a list of all configured share participants
| Options | Descriptions |
|---|---|
| --full | Print extra information for each element |
| --help |
Display this help and exit |
| --id | The ID of the share participant to list |
| --internal-id | The internal ID of the share participant to list |
| --name | The name of the share participant to list |
share-replication-create
Usage: share-replication-create [options]
Configure another site to replicate a share by creating a share on the remote site and adding all configured sites as participants
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --interval | The interval at which to replicate. May be formatted as 10seconds, 1minute, "1 hour 30 minutes", etc. When no units are specified, seconds are assumed |
| --remote-share-description | A textual description for the new remote share (defaults to the local share's description) |
| --remote-share-export-option | Export options for the new remote share (defaults to the local share's export-option). Each value must contain <subnet,access-permission, {no-}root-squash> |
| --remote-share-name | A name for the new remote share (defaults to the local share's name) |
| --remote-share-path | A path for the new remote share (defaults to the local share's path) |
| --remote-share-preferred-domain | The new remote share's preferred domain in which users have accounts (defaults to the local share's preferred-domain). This field is required for mapping users from another domain into the remote site's domain |
| --remote-share-size | A share size limit (quota) for the new remote share (defaults to the local share's size) |
| --remote-share-unmapped-group | Default group name for new remote share, if there is no mapping discovered into the preferred domain (defaults to the local share's unmapped-group) |
| --remote-share-unmapped-user | Default user name for new remote share, if there is no mapping discovered into the preferred domain (defaults to the local share's unmapped-user) |
| * --share-id | The ID of the local share to be replicated. * required unless share-internal-id or share-name id is specified. Required unless "--share-name" or "--share-internal-id" is specified |
| * --share-internal-id | The Internal ID of the local share to be replicated. Required unless "--share-id" or "--share-name" is specified |
| * --share-name | The Name of the local share to be replicated. Required unless "--share-id" or "--share-internal-id" is specified |
| --site-address | The IP or DNS address of an interface on the remote site which has the MGMT role. Required unless "--site-id" or "--site-name" or "--site-internal-id" is specified |
| --site-id | The ID of the existing remote site. Required unless "--site-address" or "--site-name" or "--site-internal-id" is specified |
| --site-internal-id | The internal ID of the existing remote site. Required unless "--site-id" or "--site-address" or "--site-name" is specified |
| --site-name | The name of the existing remote site. Required unless "--site-id" or "--site-address" or "--site-internal-id" is specified |
| * --site-password | The password for the remote site user. |
| * --site-username | A user which has sufficient rights to create shares on the remote site. Required unless the remote site has been configured to trust this site's client certificate |
| --skip-remote-validations | Skip checks for open replication ports and shared object storage volumes |
share-replication-delete
Usage: share-replication-delete [options]
Remove a site from a share replication by removing the site as a participant of the share.
| Options | Descriptions |
|---|---|
| --help |
Display this help and exit |
| --ignore-remote-failures | Allow delete to proceed even if remote sites are unavailable |
| * --participant-id | The participant id being removed. Required unless "--site-id" or "--site-name" or "--site-internal-id" or "--site-address" is specified |
| * --share-id | The ID of the share from which the participant is being removed. Required unless "--share-name" or "--share-internal-id" is specified |
| * --share-internal-id | The Internal ID of the share from which the participant is being removed. Required unless "--share-id" or "--share-name" is specified |
| * --share-name | The Name of the share from which the participant is being removed. Required unless "--share-id" or "--share-internal-id" is specified |
| * --site-address | The IP or DNS address having a MGMT role of the site being removed as a participant. Required unless "--site-id" or "--site-name" or "--site-internal-id" or "--participant-id" is specified |
| * --site-id | The ID of the site being removed as a participant. Required unless "--site-name" or "--site-internal-id" or "--site-address" or "--participant-id" is specified |
| * --site-internal-id | The internal ID of the site being removed as a participant. Required unless "--site-id" or "--site-name" or "--site-address" or "--participant-id" is specified |
| * --share-name | The Name of the share from which the participant is being removed. Required unless "--share-id" or "--share-internal-id" is specified |
| * --site-address | The IP or DNS address having a MGMT role of the site being removed as a participant. Required unless "--site-id" or "--site-name" or "--site-internal-id" or "--participant-id" is specified |
| * --site-id | The ID of the site being removed as a participant. Required unless "--site-name" or "--site-internal-id" or "--site-address" or "--participant-id" is specified |
| * --site-name | The name of the site being removed as a participant. Required unless "--site-id" or "--site-internal-id" or "--site-address" or "--participant-id" is specified |