PowerScaleOneFS CLI Command Reference

Syntax

isi dm policies modify <name> 
 [--enabled <boolean>]
 [--priority {LOW | NORMAL | HIGH}]
 [--policy-type {CREATION | EXPIRATION | COPY | REPEAT_COPY}]
 [--run-now <boolean>]
 [--base-policy-id <integer>]
 [--parent-exec-policy-id <integer>]
 [--copy-dataset-id <integer>]
 [--copy-source-base-path <string>]
 [--copy-source-subpaths <string>]
 [--copy-create-dataset-on-target <boolean>]
 [--copy-base-base-account-id <string>]
 [--copy-base-source-account-id <string>]
 [--copy-base-target-account-id <string>]
 [--copy-base-new-tasks-account <string>]
 [--copy-base-target-base-path <string>]
 [--copy-base-target-dataset-type {FILE_ON_OBJECT_COPY | FILE_ON_OBJECT_BACKUP | FILE}]
 [--copy-base-dataset-retention-period <integer>]
 [--copy-base-dataset-reserve <integer>]
 [--copy-base-policy-dataset-expiry-action {DELETE}]
 [--creation-account-id <string>]
 [--creation-base-path <string>]
 [--creation-dataset-retention-period <integer>]
 [--creation-dataset-reserve <integer>]
 [--creation-dataset-expiry-action {DELETE}]
 [--expiration-account-id <string>]
 [--reconnect <boolean>]
 [--repeat-copy-source-base-path <string>]
 [--repeat-copy-base-base-account-id <string>]
 [--repeat-copy-base-source-account-id <string>]
 [--repeat-copy-base-target-account-id <string>]
 [--repeat-copy-base-new-tasks-account <string>]
 [--repeat-copy-base-target-base-path <string>]
 [--repeat-copy-base-target-dataset-type {FILE_ON_OBJECT_COPY | FILE_ON_OBJECT_BACKUP | FILE}]
 [--repeat-copy-base-dataset-retention-period <integer>]
 [--repeat-copy-base-dataset-reserve <integer>]
 [--repeat-copy-base-dataset-expiry-action {DELETE}]
 [--date-times <string>]
 [--recurrence <string>]
 [--start-time <string>]
 [{--help | -h}]
 [{--verbose | -v}]

Options

<name>

Specifies the policy name.

--priority {LOW | NORMAL | HIGH}

The priority of the policy.

--enabled <boolean>

A Boolean value indicating whether or not the policy is enabled. True = policy enabled. False = policy disabled.

--policy-type { CREATION | EXPIRATION | COPY | REPEAT_COPY}

Specifies the policy type.

--run-now <boolean>

Specifies whether to run the policy immediately or according to its schedule. True = run the policy immediately. False = run the policy according to its schedule.

--base-policy-id <integer>

Specifies the unique identifier of the base policy for this Datamover policy.

--parent-exec-policy-id <integer>

Optional. Specifies a unique policy identifier. If the specified policy ID is valid, a job to run the current policy will be scheduled immediately after the specifed policy job completes.

--copy-dataset-id <integer>

Specifies the unique dataset identifier for the dataset to copy.

--copy-source-base-path <string>

Specifies the base path of the dataset on the source data storage system.

--copy-source-subpaths <string>

The set of file system paths relative to the base path.

--copy-create-dataset-on-target <boolean>

Whether or not to create a dataset on the target storage system. True=create the dataset; False=do not create the dataset.

--copy-base-base-account-id <string>

Specifies the Datamover account identifier on the local or the remote Datamover system on which to create the policy.

--copy-base-source-account-id <string>

Specifies the Datamover account ID for the source data storage system.

--copy-base-target-account-id <string>

Specifies the Datamover account ID for the target data storage system.

--copy-base-new-tasks-account <string>

Tells OneFS to create data transfer operations tasks on the specified Datamover account ID.

--copy-base-target-base-path <string>

Base path on the target storage system.

--copy-base-target-dataset-type {FILE_ON_OBJECT_COPY | FILE}

Specifies the dataset as one of the following types:

• FILE_ON_OBJECT_COPY: The target is a cloud system that supports object store.
• FILE: The target is a DM (file-on-file) dataset

--copy-base-dataset-retention-period <integer>

Specifies the dataset expiration time in the number of seconds after dataset creation.

--copy-base-dataset-reserve <integer>

Specifies the number of datasets to preserve in the dataset tree. When the dataset expires, the dataset-expiry-action is triggered by the dataset expiration policy.

--copy-base-policy-dataset-expiry-action {DELETE}

The action to take when the dataset expires.

--creation-account-id <string>

Specifies the Datamover account ID of the source storage system on which to create the dataset.

--creation-base-path <string>

Specifies the file system base path that contains the directories and files from which to create the dataset.

--creation-dataset-retention-period <integer>

Specifies the dataset expiration time in the number of seconds after dataset creation.

--creation-dataset-reserve <integer>

Specifies the number of datasets to preserve in the dataset tree. When the dataset expires, the dataset-expiry-action is triggered by the dataset expiration policy.

--creation-dataset-expiry-action {DELETE}

The action to take when the dataset expires.

--expiration-account-id <string>

The Datamover account on which to run this expiration policy.

--reconnect <boolean>

Specifies whether or not to skip a baseline sync if there are only incremental updates needed for a dataset. To force an incremental sync, set --reconnect to TRUE; otherwise set --reconnect to FALSE.

This boolean allows starting with incremental syncs and skipping the initial baseline sync if the target base path contains a leaf dataset which is an ancestor of a source base path dataset.

--repeat-copy-source-base-path <string>

Specifies the base path of the dataset on the source storage system.

--repeat-copy-base-base-account-id <string>

The account identifier of the local or remote Datamover system account on which to create the policy.

--repeat-copy-base-source-account-id <string>

The account ID of the source data storage system.

--repeat-copy-base-target-account-id <string>

The Datamover account ID of the target data storage system.

--repeat-copy-base-new-tasks-account <string>

The account ID of the Datamover account on which to create data transfer operations tasks.

--repeat-copy-base-target-base-path <string>

Specifies the base path on the target storage system where to copy the data.

--repeat-copy-base-target-dataset-type {FILE_ON_OBJECT_COPY | FILE}

Specifies the dataset as one of the following types:

• FILE_ON_OBJECT_COPY: The target is a cloud system that supports object store.
• FILE: The target is a DM (file-on-file) dataset

--repeat-copy-base-dataset-retention-period <integer>

Specifies the dataset expiration time in the number of seconds after dataset creation.

--repeat-copy-base-dataset-reserve <integer>

Specifies the number of datasets to preserve in the dataset tree. When the dataset expires, the dataset-expiry-action is triggered by the dataset expiration policy.

--repeat-copy-base-dataset-expiry-action {DELETE}

The action to take when the dataset expires.

--date-times <string>

Specifies the cron expression that represents a recurring start time schedule for the policy. Enclose the cron expression in double quotes ("").You can specify multiple cron expressions separated by commas. For example: "5,10,15 * * * *":"30 * 1 * 7".

--recurrence <string>

Specifies the cron expression that represents a recurring start time schedule for the policy. Enclose the cron expression in double quotes ("").You can specify multiple cron expressions separated by colons (':'). For example: "5,10,15 * * * *":"30 * 1 * 7".

--start-time <string>

Specifies the date/time of the first run of the policy. The date/time format is 'yyyy-mm-dd hh:mn:ss', where year range is 2001-2099.

--help | -h

Displays help for this command.

--verbose | -v

Displays more detailed help for this command.