Global File System
gfs-participant-add
gfs-participant-add [options]
Configure another site to participate in a global file system share by creating a share on the remote site and adding all configured sites as participants
Options
--async
Causes the command to be executed asynchronously. A reference task identifier will be returned
--force-master-acquisition
Proceed even if a quorum of participants does not acknowledge this site as master for share replication management. This will not allow acquisition of master status while another site is actively operating on the share. Warning: this may leave the share replication configuration in an undefined state
--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
--no-timeout
When running a task-based command synchronously, monitor for task completion indefinitely
--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)
--share-id
The ID of the local share to be replicated. Required unless any of the following is specified: --share-internal-id, --share-name
--share-internal-id
The internal ID of the local share to be replicated. Required unless any of the following is specified: --share-id, --share-name
--share-name
The name of the local share to be replicated. Required unless any of the following is specified: --share-id, --share-internal-id
--site-address
The IP or DNS address of an interface on the remote site which has the MGMT role. Required unless any of the following is specified: --site-id, --site-name, --site-internal-id
--site-id
The ID of the remote site. Required unless any of the following is specified: --site-address, --site-name, --site-internal-id
--site-internal-id
The internal ID of the remote site. Required unless any of the following is specified: --site-id, --site-address, --site-name
--site-name
The name of the remote site. Required unless any of the following is specified: --site-id, --site-address, --site-internal-id
--site-password
The password for the remote site user (Required)
--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 (Required)
--skip-participant-validations
Skip checks for open replication ports and shared object storage volumes at the participant
gfs-participant-disable
gfs-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
--help
Display this help and exit
--id
The ID of the share participant to disable. Required unless any of the following is specified: --internal-id, --site-id, --name, --site-name, --site-internal-id
--internal-id
The internal ID of the share participant to disable. Required unless any of the following is specified: --site-id, --name, --id, --site-name, --site-internal-id
--name
The name of the share participant to disable. Required unless any of the following is specified: --internal-id, --site-id, --id, --site-name, --site-internal-id
--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 any of the following is specified: --internal-id, --name, --site-name, --id, --site-internal-id
--site-internal-id
Specifies share participants associated with a site internal ID. Required unless any of the following is specified: --internal-id, --site-id, --name, --site-name, --id
--site-name
Specifies share participants associated with a site name. Required unless any of the following is specified: --internal-id, --site-id, --name, --id, --site-internal-id
gfs-participant-enable
gfs-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
--help
Display this help and exit
--id
The ID of the share participant to enable. Required unless any of the following is specified: --internal-id, --site-id, --name, --site-name, --site-internal-id
--internal-id
The internal ID of the share participant to enable. Required unless any of the following is specified: --site-id, --name, --id, --site-name, --site-internal-id
--name
The name of the share participant to enable. Required unless any of the following is specified: --internal-id, --site-id, --id, --site-name, --site-internal-id
--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 any of the following is specified: --internal-id, --name, --site-name, --id, --site-internal-id
--site-internal-id
Specifies share participants associated with a site internal ID. Required unless any of the following is specified: --internal-id, --site-id, --name, --site-name, --id
--site-name
Specifies share participants associated with a site name. Required unless any of the following is specified: --internal-id, --site-id, --name, --id, --site-internal-id
gfs-participant-list
gfs-participant-list [options]
Display a list of all configured global file system participants, or a list filtered to a specific share
Options
--full
Print extra information for each element
--help
Display this help and exit
--id
The ID of the participant to list
--internal-id
The internal ID of the participant to list
--name
The name of the participant to list
--share-id
The ID of a share to filter the listing to
--share-internal-id
The internal ID of a share to filter the listing to
--share-name
The name of a share to filter the listing to
gfs-participant-remove
gfs-participant-remove [options]
Remove a site from a share replication by removing the site as a participant of the share.
Options
--async
Causes the command to be executed asynchronously. A reference task identifier will be returned
--force-master-acquisition
Proceed even if a quorum of participants does not acknowledge this site as master for share replication management. This will not allow acquisition of master status while another site is actively operating on the share. Warning: this may leave the share replication configuration in an undefined state
--help
Display this help and exit
--id
The ID (uuid) of the participant to be removed. Required unless any of the following is specified: --internal-id, --share-id, --share-internal-id, --name, --share-name
--ignore-remove-failures
Proceed even if remote sites are unavailable or have already been removed from the replicating share. Warning: this may leave the share replication configuration in an undefined state
--internal-id
The internal ID of the participant to be removed. Required unless any of the following is specified: --share-id, --share-internal-id, --name, --id, --share-name
--name
The name of the participant to be removed. Required unless any of the following is specified: --internal-id, --share-id, --share-internal-id, --id, --share-name
--no-timeout
When running a task-based command synchronously, monitor for task completion indefinitely
--participant-id
The integer participant id being removed
--share-id
The ID of the share from which the participant is being removed. Required unless any of the following is specified: --internal-id, --share-internal-id, --name, --share-name, --id
--share-internal-id
The internal ID of the share from which the participant is being removed. Required unless any of the following is specified: --internal-id, --share-id, --name, --share-name, --id
--share-name
The name of the share from which the participant is being removed. Required unless any of the following is specified: --internal-id, --share-id, --share-internal-id, --name, --id
--site-address
The IP or DNS address having a MGMT role of the site being removed as a participant
--site-id
The ID of the site being removed as a participant
--site-internal-id
The internal ID of the site being removed as a participant
--site-name
The name of the site being removed as a participant