gridsync

This command is only applicable to IBM® Spectrum Symphony Advanced Edition. It synchronizes collections of files or directories (data sets) from a source (client) to target hosts across a cluster.

Synopsis

gridsync subcommand [options]

gridsync subcommand -h

gridsync -h | -V

Description

Use gridsync to synchronize data sets across a cluster, including the following tasks:

Create, modify, or delete a data set.
Add or delete a file or directory (and its contents) to or from a data set.
Enable and disable synchronization of a data set.
Request a lock on or release a lock from a data set.
Run a consistency check (checksum) on a host and data set, to ensure that the main copy and host copy are the same.
List all data sets.
List all target hosts for a dataset and their status.
View the data sets on a repository server agent or host.
View the details of a data set.
Clean up a deleted data set or deleted files within the data set on the grid.

-h: Prints command usage to stdout and exits.
-V: Prints product version to stdout and exits.

Permissions

To run gridsync commands, you require the appropriate permissions. IBM Spectrum Symphony grid synchronization uses four permissions: GS_DATASET_CREATE, GS_DATASET_VIEW, GS_DATASET_USE, and GS_DATASET_MANAGEMENT. By default, a cluster administrator has all four permissions for all consumers in the cluster; a consumer administrator has all permissions for the consumer that they administer.

To create and work with your own data sets, you require only GS_DATASET_CREATE permission, which allows you to complete these tasks:

Create, modify or delete a data set.
Add or delete a file or directory (and its contents) to or from a data set.
Enable and disable synchronization of a data set.
Request a lock on or release a lock from a data set.
View the data sets on a repository server agent or host.
View the details of a data set.

To work with data sets created by other users, you must have one or more of the other three permissions (that is, GS_DATASET_VIEW, GS_DATASET_USE, GS_DATASET_MANAGEMENT, or a combination).

IBM Spectrum Symphony defines the four grid synchronization permissions as follows:

With GS_DATASET_CREATE permission, you can create a data set under a consumer.
With GS_DATASET_VIEW permission, you can view all data sets under a consumer, including these tasks:
- View the data sets on a repository server agent or host.
- View the details of a data set.
With GS_DATASET_USE permission, you can use all data sets under a consumer, including requesting a lock on or releasing a lock from a data set.
With GS_DATASET_MANAGEMENT permission, you can manage all data sets under a consumer, including these tasks:
- Modify or delete a data set.
- Add or delete a file or directory (and its contents) to or from a data set.
- Enable and disable synchronization of a data set.

Subcommand synopsis

dataset addfile -d data_set_name -c consumer_path -s source_path [-D destination_relative_path]

dataset addfile -i data_set_ID -s source_path [-D destination_relative_path ]

dataset cleanup -r resource_group [,...]

dataset create -d data_set_name -c consumer_path -D destination_path [-o owner] [-g group] [-p permissions] [-r resource_group [,...]] [-e expiry] [-s][-z]

dataset delete -d data_set_name -c consumer_path [-f]

dataset delete -i data_set_ID [-f]

dataset deletefile -d data_set_name -c consumer_path -D relative_path [-f]

dataset deletefile -i data_set_ID -D relative_path [-f]

dataset disablesync -d data_set_name -c consumer_path

dataset disablesync -i data_set_ID

dataset enablesync -d data_set_name -c consumer_path

dataset enablesync -i data_set_ID

dataset list [-c consumer_path | -r resource_group] [-l]

dataset lock -d data_set_name -c consumer_path

dataset lock -i data_set_ID

dataset modify -d data_set_name -c consumer_path [-r resource_group [,...]] [-e expiry]

dataset modify -i data_set_ID [-r resource_group [,...]] [-e expiry]

dataset status -d data_set_name -c consumer_path [-r resource_group] -l

dataset status -i data_set_ID [-r resource_group] -l

dataset unlock -d data_set_name -c consumer_path [-l lock_ID | ALL]

dataset unlock -i data_set_ID [-l lock_ID | ALL]

dataset view -d data_set_name -c consumer_path [-l]

dataset view -i data_set_ID [-l]

host checkdataset -h host_name -d data_set_name -c consumer_path

host checkdataset -h host_name -i data_set_ID

host view -h host_name [-c consumer_path]

dataset addfile -d `data_set_name` -c `consumer_path` -s `source_path` [-D `destination_relative_path`]

Add a new file or directory (and its contents) to an unlocked data set by specifying the data set name and consumer. If the file or directory already exists in the data set, it will be replaced with a new copy. All individual files must be less than 2GB (the entire data set can be larger than 2GB; however each individual file must be less than 2GB).

If synchronization is enabled, the action completes once the repository server fully receives the file or directory from the command or API.

-d data_set_name: Specifies the name of the data set to which the file or directory should be added. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using data_set_name).
-s source_path: Path to the local file or directory that you want to add to the data set. If you specify a directory, both the source directory and the files within the directory will be added to the target directory at the relative destination.
-D destination_relative_path: Relative path to the destination of the file or directory within the data set. If not specified, the new file or directory will be added to the root of the data set.

Add a new directory and contents to the root of a data set

Add a directory, called /tmp, and all of its contents, to the data set mydataset for consumer /ABCconsumer:

gridsync dataset addfile -d mydataset -c /ABCconsumer -s /tmp

Add a new file to a specific directory within a data set

Add a file called file1 under the /tmp directory in the source directory for consumer /ABCconsumer, to the /myfiles directory of the data set mydataset:

gridsync dataset addfile -d mydataset -c /ABCconsumer -s /tmp/file1 -D /myfiles

dataset addfile -i `data_set_ID` -s `source_path` [-D `destination_relative_path`]

Add a new file or directory to an unlocked data set by specifying the data set ID. If the file or directory already exists in the data set, it will be replaced with a new copy. All individual files must be less than 2GB (the entire data set can be larger than 2GB; however each individual file must be less than 2GB).

If synchronization is enabled, the action completes once the repository server fully receives the file or directory from the target repository server agents.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-s source_path: Path to the local file or directory that you want to add to the data set. If you specify a directory, both the source directory and the files within the directory will be added to the target directory at the relative destination.
-D relative_destination: Relative path to the destination of the file or directory within the data set. If not specified, the new file or directory will be added to the root of the data set.

Add a new directory and contents to the root of a data set

Add a directory, called /tmp, and all of its contents, to data set ID 123:

gridsync dataset addfile -i 123 -s /tmp

Add a new file to a specific directory within a data set

Add a file called file1 under the /tmp directory in the source directory to the /myfiles directory for data set ID 123:

gridsync dataset addfile -i 123 -s /tmp/file1 -D /myfiles

dataset cleanup -r `resource_group` [,...]

Clean up deleted data sets or deleted files within data sets on the grid. This action is typically performed on every GS_RS_POLL_INTEVAL period; however, you can also clean up a data set manually by running the dataset cleanup command.

-r resource_group: Name of an individual resource group, or a list of resource groups, to clean up.

Clean up the data sets for a specific resource group

Delete all data sets for resource group UserGroup1:

gridsync dataset cleanup -r UserGroup1

Clean up the data sets for a list of resource groups

Delete all data sets for resource group UserGroup1, UserGroup2, and UserGroup3:

gridsync dataset cleanup -r UserGroup1,UserGroup2,UserGroup3

dataset create -d `data_set_name` -c `consumer_path` -D `destination_path` [-o `owner`] [-g `group`] [-p `permissions`] [-r `resource_group` [,...]] [-e `expiry`] [-s] [-z]

Create a new data set in the repository server. By default, the data set contains no contents, and synchronization is disabled.

-d data_set_name: Specifies the name of the data set to be created. This name must be unique to the consumer.
-c consumer_path: The path to the consumer associated with the data set.
-D destination_path: Path for the data set when it is synchronized to target hosts. Environment variables $EGO_TOP and $SOAM_HOME (for Linux®) and %SOAM_HOME% (for Windows) are supported (on Windows, the EGO top-level directory is Installation_top). You can also define additional environment variables in the repository server agent service definition file ($EGO_TOP/eservice/esc/conf/services/rsa.xml for Linux, and %EGO_TOP%\eservice\esc\conf\services\rsa.xml for Windows).
The destination path must be unique across all data sets.
-o owner: (Applicable to Linux only.) Owner of the data set. The default is the consumer's execution (operating system) user. If the consumer does not have an execution user defined, then this owner is mandatory.
-g group: (Applicable to Linux only.) Group name for the data. The default is the owner's primary group.
-p permissions: Permissions flag for the data set root directory on the target host. The default value is 700. This is not applicable to the permissions for files uploaded using the addfile command; this is only applicable to the root directory.
-r resource_group: Name of an individual resource group, or a list of resource groups, with which to synchronize the data set. By default, the command creates the data set with no resource groups. You can first create the data set, and then return to add resource groups.
-e expiry: The time, in minutes, when the data set will expire and will be automatically deleted from the system. The default is 0, to indicate that the data set never expires.
-s: Enables data set synchronization. Specify the -s option to indicate that files should be synchronized. Otherwise, omit this option.
-z: Indicates whether or not files will be compressed during network transfers. Specify the -z option to indicate that files should be compressed. Otherwise, omit this option. (The main copy of the files on the repository server are not compressed.)

Create a new data set

Create a new, empty, data set in the repository server, called mydataset, for consumer /ABCconsumer, with the destination path set to ${EGO_TOP}/dataset1:

gridsync dataset create -d mydataset -c /ABCconsumer -D ${EGO_TOP}/dataset1

Create a new data set using data compression when transferring, with an expiry time

Create a new, empty, data set in the repository server, called mydataset, for consumer /ABCconsumer, with the destination path set to ${EGO_TOP}/dataset1. This data set expires after 60 minutes, and compresses files before transferring:

gridsync dataset create -d mydataset -c /ABCconsumer -D ${EGO_TOP}/dataset1 -e 60 -z

dataset delete -d `data_set_name` -c `consumer_path` [-f]

Delete an unlocked data set and all of its contents from the repository server and from all repository server agents by specifying the data set name and consumer. This command deletes the data set from all repository server agents and synchronization is disabled.

-d data_set_name: Specifies the name of the data set to be deleted. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-f: To show a confirmation message before deleting, omit this option. To disable confirmation before deleting, specify the -f option.

Delete a data set

Delete a data set, called mydataset for consumer /ABCconsumer, and all of its contents from the repository server and from all repository server agents. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset delete -d mydataset -c /ABCconsumer

Delete a data set without confirmation

Delete a data set, called mydataset for consumer /ABCconsumer, and all of its contents from the repository server and from all repository server agents. The command will not prompt you to confirm the deletion:

gridsync dataset delete -d mydataset -c /ABCconsumer -f

dataset delete -i `data_set_ID` [-f]

Delete an unlocked data set and all of its contents from the repository server and from all repository server agents by specifying the data set ID. This command deletes the data set from all repository and synchronization is disabled.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-f: To show a confirmation message before deleting, omit this option. To disable confirmation before deleting, specify the -f option.

Delete a data set

Delete data set ID 123 and all of its contents from the repository server and from all repository server agents. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset delete -i 123

Delete a data set without confirmation

Delete data set ID 123 and all of its contents from the repository server and from all repository server agents. The command will not prompt you to confirm the deletion:

gridsync dataset delete -i 123 -f

dataset deletefile -d `data_set_name` -c `consumer_path` -D `relative_path` [-f]

Delete a file or directory from an unlocked data set by specifying the data set name and consumer.

If synchronization is enabled, this command immediately removes the deleted file from the target repository server agents. This command is asynchronous; it returns once the repository server has processed the request.

-d data_set_name: Specifies the name of the data set for the file or directory to be deleted. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-D relative_path: Relative path to the destination of the file or directory within the data set. If a directory is specified, the directory and all of its contents, will be deleted.
-f: To show a confirmation message before deleting, omit this option. To disable confirmation before deleting, specify the -f option.

Delete a file from a data set

Delete the file file1 under the /myfiles directory from data set mydataset for consumer /ABCconsumer. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset deletefile -d mydataset -c /ABCconsumer -D /myfiles/file1

Delete a file from a data set without confirmation

Delete the file file1 under the /myfiles directory from data set mydataset for consumer /ABCconsumer. The command will not prompt you to confirm the deletion:

gridsync dataset deletefile -d mydataset -c /ABCconsumer -D /myfiles/file1 -f

Delete a directory and contents from a data set

Delete the /myfiles directory and all of its contents from data set mydataset for consumer /ABCconsumer. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset deletefile -d mydataset -c /ABCconsumer -D /myfiles

Delete a directory and contents from a data set without confirmation

Delete the /myfiles directory and all of its contents from data set mydataset for consumer /ABCconsumer. The command will not prompt you to confirm the deletion:

gridsync dataset deletefile -d mydataset -c /ABCconsumer -D /myfiles -f

dataset deletefile -i `data_set_ID` -D `relative_path` [-f]

Delete a file or directory from an unlocked data set by specifying the data set ID.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-D relative_path: Relative path to the destination of the file or directory within the data set. If a directory is specified, the directory and all of its contents, will be deleted.
-f: To show a confirmation message before deleting, omit this option. To disable confirmation before deleting, specify the -f option.

Delete a file from a data set

Delete the file file1 under the /myfiles directory from data set ID 123. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset deletefile -i 123 -D /myfiles/file1

Delete a file from a data set without confirmation

Delete the file file1 under the /myfiles directory from data set ID 123. Before the deletion, also have the command prompt you to confirm the deletion. The command will not prompt you to confirm the deletion:

gridsync dataset deletefile -i 123 -D /myfiles/file1 -f

Delete a directory and contents from a data set

Delete the /myfiles directory and all of its contents from data set ID 123. Before the deletion, also have the command prompt you to confirm the deletion:

gridsync dataset deletefile -i 123 -D /myfiles

Delete a directory and contents from a data set without confirmation

Delete the /myfiles directory and all of its contents from data set ID 123. Before the deletion, also have the command prompt you to confirm the deletion. The command will not prompt you to confirm the deletion:

gridsync dataset deletefile -i 123 -D /myfiles -f

dataset disablesync -d `data_set_name` -c `consumer_path`

Turn off synchronization for a data set by specifying the data set name and consumer. Any changes made to the data set will be made on the repository side, but not propagated to the repository server agents. Any changes in progress will be cancelled and the partial data will be deleted from all in-progress hosts.

-d data_set_name: Specifies the name of the data set to be disabled for synchronization. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).

Disable synchronization for a data set

Turn off synchronization for data set mydataset for consumer /ABCconsumer:

gridsync dataset disablesync -d mydataset -c /ABCconsumer

dataset disablesync -i `data_set_ID`

Turn off synchronization for a data set by specifying the data set ID. Any changes made to the data set will be made on the repository side, but not propagated to the repository server agents. Any changes in progress will be cancelled and the partial data will be deleted from all in-progress hosts.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.

Disable synchronization for a data set

Turn off synchronization for data set ID 123:

gridsync dataset disablesync -i 123

dataset enablesync -d `data_set_name` -c `consumer_path`

Turn on synchronization for a data set by specifying the data set name and consumer. All content files in the data set will be synchronized to hosts belonging to the data set's target resource groups. Any changes made to the data set while synchronization is enabled will be immediately propagated to target hosts.

-d data_set_name: Specifies the name of the data set to be enabled for synchronization. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).

Enable synchronization for a data set

Turn on synchronization for data set mydataset for consumer /ABCconsumer:

gridsync dataset enablesync -d mydataset -c /ABCconsumer

dataset enablesync -i `data_set_ID`

Turn on synchronization for a data set by specifying the data set ID. All content files in the data set will be synchronized to hosts belonging to the data set's target resource groups. Any changes made to the data set while synchronization is enabled will be immediately propagated to target hosts.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.

Enable synchronization for a data set

Turn on synchronization for data set ID 123:

gridsync dataset enablesync -i 123

dataset list [-c `consumer_path` | -r `resource_group`] [-l]

List all data sets managed by the repository server. You can optionally filter the list by consumer or by resource group.

-c consumer_path: The path to the consumer associated with the data set. To filter the data set list by consumer, specify the consumer using this option. This command will also lists data sets under all sub-consumers.
-r resource_group: To filter the data set list by resource group, specify the resource group using this option. The command displays the data sets using this resource group.
-l: Provides detailed information and expands truncated columns.

List all data sets

List all data sets managed by the repository server:

gridsync dataset list

List all data sets for a specific consumer

List all data sets for consumer /ABCconsumer and any sub-consumers under /ABCconsumer:

gridsync dataset list -c /ABCconsumer

List all data sets for a specific resource group

List all data sets for resource group UserGroup1:

gridsync dataset list -r UserGroup1

dataset lock -d `data_set_name` -c `consumer_path`

Request a lock on a data set to prevent a data set from being changed or removed while it is in use by specifying the data set name and consumer. The data set is therefore, in read-only mode. A data set can have multiple locks.

-d data_set_name: Specifies the name of the data set to be locked. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using data_set_name).

Lock a data set

Lock data set mydataset for consumer /ABCconsumer:

gridsync dataset lock -d mydataset -c /ABCconsumer

dataset lock -i `data_set_ID`

Requests a lock on a data set to prevent a data set from being changed or removed while it is in use by specifying the data set ID. The data set is therefore, in read-only mode. A data set can have multiple locks.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.

Lock a data set

Lock data set ID 123:

gridsync dataset lock -i 123

dataset modify -d `data_set_name` -c `consumer_path` [-r `resource_group` [,...]] [-e `expiry`]

Modify the expiry window, the resource group list for a data set, or both, by specifying the data set name and consumer.

-d data_set_name: Specifies the name of the data set to be modified. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-r resource_group: Name of an individual resource group, or a list of resource groups, with which to synchronize the data set. You can optionally indicate resource groups to associate with the data set that you want to create. If not specified, the list of resource groups for the data set will not change.
-e expiry: The time, in minutes, when the data set will expire and will be automatically deleted from the system. The default is 0, to indicate that the data set never expires. If not specified, the expiry window will not change.

Modify a data set's resource list and expiry time

Change data set mydataset, for consumer /ABCconsumer, to use resource groups UserGroup1 and UserGroup2, and have it expire after 120 minutes:

gridsync dataset modify -d mydataset -c /ABCconsumer -r UserGroup1,UserGroup2 -e 120

Modify a data set's expiry time

Change data set mydataset, for consumer /ABCconsumer to expire after one day (1440 minutes):

gridsync dataset modify -d mydataset -c /ABCconsumer -e 1440

dataset modify -d `data_set_name` -i `data_set_ID` [-r `resource_group` [,...]] [-e `expiry`]

Modify the expiry window, the resource group list for a data set, or both, by specifying the data set name and consumer.

-d data_set_name: Specifies the name of the data set to be modified. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-r resource_group: Name of an individual resource group, or a list of resource groups, with which to synchronize the data set. You can optionally indicate resource groups to associate with the data set that you want to create. If not specified, the list of resource groups for the data set will not change.
-e expiry: The time, in minutes, when the data set will expire and will be automatically deleted from the system. The default is 0, to indicate that the data set never expires. If not specified, the expiry window will not change.

Modify a data set's resource list and expiry time

Change data set ID 123 to use resource groups UserGroup1 and UserGroup2, and have it expire after 120 minutes:

gridsync dataset modify -i 123 -r UserGroup1,UserGroup2 -e 120

Modify a data set's expiry time

Change data set ID 123 to expire after one day (1440 minutes):

gridsync dataset modify -i 123 -e 1440

dataset status -d `data_set_name` -c `consumer_path` [-r `resource_group`] [-l]

List target host, and their status and action, for a data set by specifying the data set name and consumer. You can optionally filter the list by resource group.

-d data_set_name: Specifies the name of the data set. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-r resource_group: To filter the data set list by resource group, specify the resource group using this option. The command displays the status for data sets using this resource group.
-l: Provides detailed information and expands truncated columns.

Tip: The gridsync dataset status command lists the status and actions for all hosts for a data set. For data sets associated with a large resource group, the list can be lengthy. You can use grep to filter by status or action. The command can return the following statuses:

- (indicating no status)
SYNCED
OUT_OF_SYNC
RSA_UNAVAILABLE

and the following actions:

- (indicating no action)
PUSH
WAIT_PUSH
PULL
WAIT_PULL
DELETE
ERROR

View a list of all target hosts and their host status for a data set

View a list of all target hosts and their status, for data set mydataset, for consumer /ABCconsumer:

gridsync dataset status -d mydataset -c /ABCconsumer

View a list of target hosts and their host status for a specific resource group for a data set

View a list of target hosts and their status for resource group UserGroup1, for data set mydataset, for consumer /ABCconsumer:

gridsync dataset status -d mydataset -c /ABCconsumer -r UserGroup1

dataset status -i `data_set_ID` [-r `resource_group`] [-l]

List target host, and their status, for a data set by specifying the data set ID. You can optionally filter the list by resource group.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-r resource_group: To filter the data set list by resource group, specify the resource group using this option. The command displays the status for data sets using this resource group.
-l: Provides detailed information and expands truncated columns.

View a list of all target hosts and their host status for a data set

View a list of all target hosts and their status, for data set ID 123:

gridsync dataset status -i 123

View a list of target hosts and their host status for a specific resource group for a data set

View a list of target hosts and their status for resource group UserGroup1, for data set ID 123:

gridsync dataset status -i 123 -r UserGroup1

dataset unlock -d `data_set_name` -c `consumer_path` [-l `lock_ID` | ALL]

Release a lock on a data set, by specifying the data set name and consumer, so that it can be changed or removed. The data set is therefore, in write mode. You can release a specific lock, by specifying the lock ID, or release all locks if you hold multiple locks on a data set.

-d data_set_name: Specifies the name of the data set to be unlocked. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-l lock_ID | ALL: The ID that specifies the lock to release. To release a specific lock, specify -l lock_ID. To release all locks, specify -l ALL.

Release a specific lock on a data set

Release lock 555 on data set mydataset for consumer /ABCconsumer:

gridsync dataset unlock -d mydataset -c /ABCconsumer -l 555

Release all locks on a data set

Release all locks on data set mydataset for consumer /ABCconsumer:

gridsync dataset unlock -d mydataset -c /ABCconsumer -l ALL

dataset unlock -i `data_set_ID` [-l `lock_ID` | ALL]

Release a lock on a data set, by specifying the data set ID, so that it can be changed or removed. The data set is therefore, in write mode. You can release a specific lock, by specifying the lock ID, or release all locks if you hold multiple locks on a data set.

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-l lock_ID | ALL: The ID that specifies the lock to release. To release a specific lock, specify -l lock_ID. To release all locks, specify -l ALL.

Release a specific lock on a data set

Release lock 555 on data set ID 123:

gridsync dataset unlock -i 123 -l 555

Release all locks on a data set

Release all locks on data set ID 123:

gridsync dataset unlock -i 123 -l ALL

dataset view -d `data_set_name` -c `consumer_path` [-l]

View details about a data set, by specifying the data set name and consumer. You can view data set configuration information, synchronization status, lock information, and host status information. You can optionally display details of the files in the data set, including a list of file names, file size, and directory path.

-d data_set_name: Specifies the name of the data set. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).
-l: Provides detailed information and expands truncated columns.

View data set details

View details of the data set mydataset, for consumer /ABCconsumer:

gridsync dataset view -d mydataset -c /ABCconsumer

View data set details and a show all full column details

View details of the data set mydataset, for consumer /ABCconsumer. Also expands truncated columns, to display full column details:

gridsync dataset view -d mydataset -c /ABCconsumer -l

dataset view -i `data_set_ID` [-l]

-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.
-l: Provides detailed information and expands truncated columns.

View data set details

View details of the data set ID 123:

gridsync dataset view -i 123

View data set details and full column details

View details of the data set ID 123, and also expands truncated columns, to display full column details:

gridsync dataset view -i 123 -l

host checkdataset -h `host_name` -d `data_set_name` -c `consumer_path`

Perform a consistency check for a specific host and data set, by specifying the data set name and consumer.

A consistency check includes the following information:

Comparing the expected list of files for the data set on the repository server with the actual files on the target host.
Calculating checksum for all files in the data set and comparing the expected value maintained by the repository server. This ensures that the main copy and the copy on the target host are the same using checksum.

-h host_name: Specifies the name of the host to query.
-d data_set_name: Specifies the name of the data set to query. If you specify the data set name, you must also specify the path to the consumer associated with the data set (using -c consumer_path).
-c consumer_path: The path to the consumer associated with the data set. If you specify the consumer, you must also specify the data set name associated with the consumer (using -d data_set_name).

Perform a consistency check for a specific host and data set

Run a consistency check for host myhost and data set mydataset for consumer /ABCconsumer:

gridsync host checkdataset myhost -d mydataset -c /ABCconsumer

host checkdataset -h `host_name` -i `data_set_ID`

Perform a consistency check for a specific host and data set, by specifying the consumer ID.

A consistency check includes the following information:

Comparing the expected list of files for the data set on the repository server wih the actual files on the target host.
Calculating checksum for all files in the data set and comparing the expected value maintained by the repository server.

-h host_name: Specifies the name of the host to query.
-i data_set_ID: The data set ID to uniquely define the data set within the system.
Provide the data set ID as an alternative to the data set name (data_set_name) and consumer path (consumer_path) combination.

Perform a consistency check for a specific host and data set

Run a consistency check for host myhost and data set ID 123:

gridsync host checkdataset myhost -i 123

host view -h `host_name` [-c `consumer_path`]

View the data sets located on a repository server agent or host and their status. You can optionally filter by consumer.

-h host_name: Specifies the name of the host to query.
-c consumer_path: The path to the consumer to query. To filter by consumer, specify the consumer using this option. This command will also list data sets under all sub-consumers.

View all data sets for a host

View all data sets for the host myhost:

gridsync host view -h myhost

View all data sets for a specific consumer on a specific host

View all data sets under the consumer ABCconsumer on host myhost:

gridsync host view -h myhost -c /ABCconsumer

gridsync

Synopsis

Description

Permissions

Subcommand synopsis

dataset addfile -d data_set_name -c consumer_path -s source_path [-D destination_relative_path]

Add a new directory and contents to the root of a data set

Add a new file to a specific directory within a data set

dataset addfile -i data_set_ID -s source_path [-D destination_relative_path]

Add a new directory and contents to the root of a data set

Add a new file to a specific directory within a data set

dataset cleanup -r resource_group [,...]

Clean up the data sets for a specific resource group

Clean up the data sets for a list of resource groups

dataset create -d data_set_name -c consumer_path -D destination_path [-o owner] [-g group] [-p permissions] [-r resource_group [,...]] [-e expiry] [-s] [-z]

Create a new data set

Create a new data set using data compression when transferring, with an expiry time

dataset delete -d data_set_name -c consumer_path [-f]

Delete a data set

Delete a data set without confirmation

dataset delete -i data_set_ID [-f]

Delete a data set

Delete a data set without confirmation

dataset deletefile -d data_set_name -c consumer_path -D relative_path [-f]

Delete a file from a data set

Delete a file from a data set without confirmation

Delete a directory and contents from a data set

Delete a directory and contents from a data set without confirmation

dataset deletefile -i data_set_ID -D relative_path [-f]

Delete a file from a data set

Delete a file from a data set without confirmation

Delete a directory and contents from a data set

Delete a directory and contents from a data set without confirmation

dataset disablesync -d data_set_name -c consumer_path

Disable synchronization for a data set

dataset disablesync -i data_set_ID

Disable synchronization for a data set

dataset enablesync -d data_set_name -c consumer_path

Enable synchronization for a data set

dataset enablesync -i data_set_ID

Enable synchronization for a data set

dataset list [-c consumer_path | -r resource_group] [-l]

List all data sets

List all data sets for a specific consumer

List all data sets for a specific resource group

dataset lock -d data_set_name -c consumer_path

Lock a data set

dataset lock -i data_set_ID

Lock a data set

dataset modify -d data_set_name -c consumer_path [-r resource_group [,...]] [-e expiry]

Modify a data set's resource list and expiry time

Modify a data set's expiry time

dataset modify -d data_set_name -i data_set_ID [-r resource_group [,...]] [-e expiry]

Modify a data set's resource list and expiry time

Modify a data set's expiry time

dataset status -d data_set_name -c consumer_path [-r resource_group] [-l]

View a list of all target hosts and their host status for a data set

View a list of target hosts and their host status for a specific resource group for a data set

dataset status -i data_set_ID [-r resource_group] [-l]

View a list of all target hosts and their host status for a data set

View a list of target hosts and their host status for a specific resource group for a data set

dataset unlock -d data_set_name -c consumer_path [-l lock_ID | ALL]

Release a specific lock on a data set

Release all locks on a data set

dataset unlock -i data_set_ID [-l lock_ID | ALL]

Release a specific lock on a data set

Release all locks on a data set

dataset view -d data_set_name -c consumer_path [-l]

View data set details

View data set details and a show all full column details

dataset view -i data_set_ID [-l]

View data set details

View data set details and full column details

host checkdataset -h host_name -d data_set_name -c consumer_path

Perform a consistency check for a specific host and data set

host checkdataset -h host_name -i data_set_ID

Perform a consistency check for a specific host and data set

host view -h host_name [-c consumer_path]

View all data sets for a host

View all data sets for a specific consumer on a specific host

dataset addfile -d `data_set_name` -c `consumer_path` -s `source_path` [-D `destination_relative_path`]

dataset addfile -i `data_set_ID` -s `source_path` [-D `destination_relative_path`]

dataset cleanup -r `resource_group` [,...]

dataset create -d `data_set_name` -c `consumer_path` -D `destination_path` [-o `owner`] [-g `group`] [-p `permissions`] [-r `resource_group` [,...]] [-e `expiry`] [-s] [-z]

dataset delete -d `data_set_name` -c `consumer_path` [-f]

dataset delete -i `data_set_ID` [-f]

dataset deletefile -d `data_set_name` -c `consumer_path` -D `relative_path` [-f]

dataset deletefile -i `data_set_ID` -D `relative_path` [-f]

dataset disablesync -d `data_set_name` -c `consumer_path`

dataset disablesync -i `data_set_ID`

dataset enablesync -d `data_set_name` -c `consumer_path`

dataset enablesync -i `data_set_ID`

dataset list [-c `consumer_path` | -r `resource_group`] [-l]

dataset lock -d `data_set_name` -c `consumer_path`

dataset lock -i `data_set_ID`

dataset modify -d `data_set_name` -c `consumer_path` [-r `resource_group` [,...]] [-e `expiry`]

dataset modify -d `data_set_name` -i `data_set_ID` [-r `resource_group` [,...]] [-e `expiry`]

dataset status -d `data_set_name` -c `consumer_path` [-r `resource_group`] [-l]

dataset status -i `data_set_ID` [-r `resource_group`] [-l]

dataset unlock -d `data_set_name` -c `consumer_path` [-l `lock_ID` | ALL]

dataset unlock -i `data_set_ID` [-l `lock_ID` | ALL]

dataset view -d `data_set_name` -c `consumer_path` [-l]

dataset view -i `data_set_ID` [-l]

host checkdataset -h `host_name` -d `data_set_name` -c `consumer_path`

host checkdataset -h `host_name` -i `data_set_ID`

host view -h `host_name` [-c `consumer_path`]