PowerScaleOneFS CLI Command Reference

Table 1. Operator valuesAvailable operators.
Operator	Description
eq	Equal. This is the default value.
ne	Not equal
lt	Less than
le	Less than or equal to
gt	Greater than
ge	Greater than or equal to
not	Not

isi sync policies modify

Modifies existing replication policies.

Syntax

isi sync policies modify <policy> 
  [--name | -n <new-policy-name>] 
  [--source-root-path <root-path>]
  [--action | -A <policy-type>] 
  [--enabled <boolean>]
  [--target-host <target-cluster>]
  [--description <string>] 
  [--check-integrity <boolean>] 
  [--source-include-directories | -i <string>]
  [--clear-source-include-directories] 
  [--add-source-include-directories <string>]
  [--remove-source-include-directories <string>]
  [--source-exclude-directories | -e <string>] 
  [--clear-source-exclude-directories] 
  [--add-source-exclude-directories <string>]
  [--remove-source-exclude-directories <string>]
  [--source-subnet <string> --source-pool <string>] 
  [--target-path | -p <target-path>] 
  [--target-snapshot-archive {on | off}]
  [--target-snapshot-pattern <naming-pattern>]
  [--target-snapshot-expiration <duration>]
  [--target-snapshot-alias <naming-pattern>]
  [--sync-existing-target-snapshot-pattern<string>]
  [--sync-existing-snapshot-expiration<boolean>]
  [--target-detect-modifications {on | off}]
  [--source-snapshot-archive {on | off}]
  [--source-snapshot-pattern <naming-pattern>]
  [--source-snapshot-expiration <duration>]
  [--snapshot-sync-pattern <pattern>]
  [--snapshot-sync-existing {yes | no}]
  [--schedule | -S <schedule>]
  [--job-delay <duration>]
  [--skip-when-source-unmodified {true | false}]
  [--rpo-alert <duration>]
  [--log-level (fatal | error | notice | info | copy | debug | trace)] 
  [--log-removed-files {yes | no}] 
  [--workers-per-node | -w <integer>] 
  [--report-max-age <duration>] 
  [--report-max-count <integer>] 
  [--restrict-target-network {on | off}] 
  [--target-compare-initial-sync {on | off}]
  [--accelerated-failback {yes | no}]
  [--priority {0 | 1}]
  [--cloud-deep-copy {deny | allow | force}]
  [--bandwidth-reservation <integer> | --clear-bandwidth-reservation]
  [--target-certificate-id <string>]
  [--ocsp-issuer-certificate-id <string>]
  [--ocsp-address <string>]
  [--encryption-cipher-list <string>]
  [--elliptic-curve-list <string>]
  [--linked-service-policies <string> | --clear-linked-service-policies | --add-linked-service-policies
        <string> | --remove-linked-service-policies <string>]
  [--delete-quotas <boolean>]
  [--password <password>]
  [--clear-source-network]
  [--set-password] 
  [--verbose | -v]
  [--force | -f]

Options

<policy>: Identifies the policy to modify, either by current policy ID or name.
{--name | -n} <new-policy-name>: Specifies a new name for this replication policy.
--source-root-path <root-path>: Specifies the directory on the local cluster that files are replicated from.
Specify as a full directory path.
--action | -A <policy-type>: Specifies the type of replication policy.
The following types of replication policy are valid:

copy

Creates a copy policy that adds copies of all files from the source to the target.

sync

Creates a synchronization policy that synchronizes data on the source cluster to the target cluster and deletes all files on the target cluster that are not present on the source cluster.
--enabled <boolean>: Enables a policy.
{--target-host | -C} <target-cluster>: Specifies the cluster that the policy replicates data to.
Specify as one of the following:

The fully qualified domain name of any node in the target cluster.

The host name of any node in the target cluster.

The name of a SmartConnect zone in the target cluster.

The IPv4 or IPv6 address of any node in the target cluster.

localhost
This will replicate data to another directory on the local cluster.

NOTE: SyncIQ does not support dynamically allocated IP address pools. If a replication job connects to a dynamically allocated IP address, SmartConnect might reassign the address while a replication job is running, which would disconnect the job and cause it to fail.
--description <string>: Specifies a description of this replication policy.
--check-integrity {true | false}: Specifies whether to perform a checksum on each file data packet that is affected by the SyncIQ job. If this option is set to true and the checksum values do not match, SyncIQ retransmits the file data packet.
The default value is true.
{--source-include-directories | -i} <path>: Includes only the specified directories in replication.
Specify as any directory path contained in the root directory. You can specify multiple directories by specifying --source-include-directories multiple times within a command. For example, if the root directory is /ifs/data, you could specify the following:

--source-include-directories /ifs/data/music --source-include-directories /ifs/data/movies
--clear-source-include-directories: Clears the list of included directories.
--add-source-include-directories <path>: Adds the specified directory to the list of included directories.
--remove-source-include-directories <path>: Removes the specified directory from the list of included directories.
{--source-exclude-directories | -e} <path>: Does not include the specified directories in replication.
Specify as any directory path contained in the root directory. If --source-include-directories is specified, --source-exclude-directories directories must be contained in the included directories. You can specify multiple directories by specifying --source-exclude-directories multiple times within a command. For example, you could specify the following:

--source-exclude-directories /ifs/data/music --source-exclude-directories /ifs/data/movies --exclude /ifs/data/music/working
--clear-source-exclude-directories: Clears the list of excluded directories.
--add-source-exclude-directories <path>: Adds the specified directory to the list of excluded directories.
--remove-source-exclude-directories <path>: Removes the specified directory from the list of excluded directories.
--source-subnet <subnet>: Restricts replication jobs to running only on nodes in the specified subnet on the local cluster.
--source-pool <pool>: Restricts replication jobs to running only on nodes in the specified pool on the local cluster.
{--target-path | -p} <target-path>: Specifies the directory on the target cluster that files are replicated to.
Specify as a full directory path.
--target-snapshot-archive {on | off}: Determines whether archival snapshots are generated on the target cluster. If this option is set to off, SyncIQ will still maintain exactly one snapshot at a time on the target cluster to facilitate failback. You must activate a SnapshotIQ license on the target cluster to generate archival snapshots on the target cluster.
--target-snapshot-pattern <naming-pattern>: Specifies the snapshot naming pattern for snapshots that are generated by replication jobs on the target cluster.
The default naming pattern is the following string:

SIQ-%{SrcCluster}-%{PolicyName}-%Y-%m-%d_%H-%M
--target-snapshot-expiration <duration>: Specifies an expiration period for archival snapshots on the target cluster.
If this option is not specified, archival snapshots will remain indefinitely on the target cluster.

Specify in the following format:

<integer><units>

The following <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours
--target-snapshot-alias <naming-pattern>: Specifies a naming pattern for the most recent archival snapshot generated on the target cluster.
The default alias is the following string:

SIQ-%{SrcCluster}-%{PolicyName}-latest
--sync-existing-target-snapshot-pattern <string>: When enabled, this defines the naming pattern for the snapshot on the destination cluster.
--sync-existing-snapshot-expiration <boolean>: When enabled, the target expire duration will use the same time duration of the source expire duration.
--target-detect-modifications {on | off}: Determines whether SyncIQ checks the target directory for modifications before replicating files.
CAUTION:Specifying off could result in data loss. It is recommended that you consult Isilon Technical Support before specifying off.
--source-snapshot-archive {on | off}: Determines whether archival snapshots are retained on the source cluster. If this option is set to off, SyncIQ will still maintain one snapshot at a time for the policy to facilitate replication.
--source-snapshot-pattern <naming-pattern>: Specifies a naming pattern for the most recent archival snapshot generated on the source cluster.
For example, the following pattern is valid:

SIQ-source-%{PolicyName}-%Y-%m-%d_%H-%M
--source-snapshot-expiration <duration>: Specifies an expiration period for archival snapshots retained on the source cluster.
If this option is not specified, archival snapshots will exist indefinitely on the source cluster.

Specify in the following format:

<integer><units>

The following <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours
--snapshot-sync-pattern <pattern>: Specifies the naming pattern for snapshots to be synced. If the --schedule of this replication policy is set to when-snapshot-taken, and a snapshot is taken of the source directory, and the snapshot name matches the specified naming pattern, SyncIQ will replicate the snapshot to the target cluster.
The default value is "*", which causes all snapshots of the source directory to be replicated if the --schedule of the policy is set to when-snapshot-taken.
--snapshot-sync-existing {yes | no}: Determines whether the policy replicates the data conatined snapshots taken before the policy was created.
NOTE:Because this setting cannot be modified after the policy is initially created, this option cannot be specified with isi sync policies modify.
{--schedule | -S} {<schedule> | when-source-modified}: Specifies how often data will be replicated. Specifying when-source-modified causes OneFS to replicate data every time that the source directory of the policy is modified.
Specify <schedule>in the following format:

"<interval> [<frequency>]"

Specify <interval> in one of the following formats:

Every [{other | <integer>}] {weekday | day}

Every [{other | <integer>}] week [on <day>]

Every [{other | <integer>}] month [on the <integer>]

Every [<day>[, ...] [of every [{other | <integer>}] week]]

The last {day | weekday | <day>} of every [{other | <integer>}] month

The <integer> {weekday | <day>} of every [{other | <integer>}] month

Yearly on <month> <integer>

Yearly on the {last | <integer>} [weekday | <day>] of <month>

Specify <frequency> in one of the following formats:

at <hh>[:<mm>] [{AM | PM}]

every [<integer>] {hours | minutes} [between <hh>[:<mm>] [{AM | PM}] and <hh>[:<mm>] [{AM | PM}]]

every [<integer>] {hours | minutes} [from <hh>[:<mm>] [{AM | PM}] to <hh>[:<mm>] [{AM | PM}]]

You can optionally append "st", "th", or "rd" to <integer>. For example, you can specify "Every 1st month"

Specify <day> as any day of the week or a three-letter abbreviation for the day. For example, both "saturday" and "sat" are valid.

To configure a policy to be run only manually, specify the following option:

--schedule ""
--job-delay <duration>: Specifies the amount of time after the source directory is modified that SyncIQ waits before starting a replication job. If the --schedule of this replication policy is set to when-source-modified, and the contents of the source directory are modified, SyncIQ will wait the specified amount of time before starting a replication job.
The default value is 0 seconds.
--clear-job-delay: Clears the amount of time after the source directory is modified that SyncIQ waits before starting a replication job.
--skip-when-source-unmodified {true | false}: Causes the policy not to be run if the contents of the source directory have not been modified since the last time the policy has been run. If --schedule of this replication policy is set to <schedule>, and the policy is scheduled to run before changes have been made to the contents of the source directory, the policy will not be run.
--rpo-alert <duration>: Creates a OneFS event if the specified Recovery Point Objective (RPO) is exceeded. For example, assume you set an RPO of 5 hours; a job starts at 1:00 PM and completes at 3:00 PM; a second job starts at 3:30 PM; if the second job does not complete by 6:00 PM, SyncIQ will create a OneFS event.
The default value is 0, which will not generate events. This option is valid only if --schedule is set to <schedule>.

NOTE:This option is valid only if RPO alerts have been globally enabled through SyncIQ settings. The events have an event ID of 400040020.
--clear-rpo-alert: Clears the RPO alert.
--log-level <level>: Specifies the amount of data recorded in logs.
The following values are valid, organized from least to most information:

fatal

error

notice

info

copy

debug

trace

The default value is info.
--log-removed-files {yes | no}: Determines whether SyncIQ retains a log of all files that are deleted when a synchronization policy is run. If the policy is a copy policy, this parameter has no effect.
The default value is no.
{--workers-per-node | -w} <integer>: Specifies the number of workers per node that are generated by SyncIQ to perform each replication job for the policy.
The default value is 3.

NOTE:This option has been deprecated and will not be recognized if configured.
--report-max-age <duration>: Specifies how long replication reports are retained before they are automatically deleted by SyncIQ.
Specify in the following format:

<integer><units>

The following <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours
--report-max-count <integer>: Specifies the maximum number of reports to retain for the replication policy.
--restrict-target-network {on | off}: If you specify on, and you specify the target cluster as a SmartConnect zone, replication jobs connect only to nodes in the specified zone. If off is specified, does not restrict replication jobs to specific nodes on the target cluster.
--target-compare-initial-sync {on | off}: Determines whether the full or differential replications are performed for this policy. Full or differential replications are performed the first time a policy is run and after a policy has been reset. If set to on, performs a differential replication. If set to off, performs a full replication.
If differential replication is enabled the first time a replication policy is run, the policy will run slower without any benefit.

The default value is off.
--accelerated-failback {enable | disable}: If enabled, SyncIQ will perform failback configuration tasks the next time that a job is run, rather than waiting to perform those tasks during the failback process. Performing these tasks ahead of time will increase the speed of failback operations.
--priority {0 | 1 | normal | high}: Determines whether the policy has priority.
--cloud-deep-copy {deny | allow | force}: Determines how the policy replicates CloudPools smartlinks. If set to deny, SyncIQ replicates all CloudPools smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, the job will fail. If set to force, SyncIQ replicates all smartlinks to the target cluster as regular files. If set to allow, SyncIQ will attempt to replicate smartlinks to the target cluster as smartlinks; if the target cluster does not support the smartlinks, SyncIQ will replicate the smartlinks as regular files.
--bandwidth-reservation <integer>: Specifies the bandwidth reservation for this policy in Kb per second. To enable, create a SyncIQ bandwidth rule.
--clear-bandwidth-reservation: Clears the bandwidth reservation for this policy.
--target-certificate-id <string>: The identification of the encryption certificate on the target cluster.
--ocsp-issuer-certificate-id <string>: The identifier of the certificate authority that issued the certificate whose revocation status is being checked.
--ocsp-address <string>: The address of the OCSP responder to which you want to connect.
--encryption-cipher-list <string>: The cipher list being used with cluster encryption. For SyncIQ targets, this is a list of supported ciphers. For SyncIQ sources, the list of ciphers is used in order.
--elliptic-curve-list <string>: This indicates the elliptic curve list for encryption. For SyncIQ targets, this is a list of supported elliptic curves. For SyncIQ sources, the list of supported elliptic curves will be tried in order.
--linked-service-policies <string>...: A list of SyncIQ policy identifiers whose source root directories will be used to filter service replication. Specify this option again for each additional service policy identifier.
--clear-linked-service-policies: Clears the list of SyncIQ policy names.
--add-linked-service-policies <string>: Adds items to the list of SyncIQ policy names and IDs. Specify this option again for each additional policy name or ID to add.
--remove-linked-service-policies <string>: Removes items from the list of SyncIQ policy names and IDs. Specify this option again for each additional policy name or ID to remove.
--delete-quotas <boolean>: When enabled, this command will remove quotas on the target cluster after they have been removed from the source cluster.
--password <password>: Specifies a password to access the target cluster. If the target cluster requires a password for authentication purposes, you must specify this parameter or --set-password.
--clear-source-network: Runs replication jobs on any nodes in the cluster, instead of restricting the jobs to a specified subnet.
--set-password: Prompts you to specify a password for the target cluster after the command is run. This can be useful if you do not want other users on the cluster to see the password you specify. If the target cluster requires a password for authentication purposes, you must specify this parameter or --password.
{--verbose | -v}: Displays a confirmation message.
{--force | -f}: Does not prompt you to confirm modifications.
--begin-filter <predicate> --operator <value> [<predicate> --operator <operator> <link>]... --end-filter: Specifies the file-matching criteria that determines which files are replicated. Specify <predicate> as one or more of the following options:
The following options are valid for both copy and synchronization policies:

--size<integer>[{B | KB | MB | GB | TB | PB}]

Selects files according to the specified size.

--file-type <value>

Selects only the specified file-system object type.
The following values are valid:

f

Specifies regular files

d

Specifies directories

l

Specifies soft links

--name <value>

Selects only files whose names match the specified string.
You can include the following wildcards:

*

[ ]

?

The following options are valid only for copy policies:

--accessed-after '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that have been accessed since the specified time. This predicate is valid only for copy policies.

--accessed-before '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that have not been accessed since the specified time. This predicate is valid only for copy policies.

--accessed-time '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that were accessed at the specified time. This predicate is valid only for copy policies.

--birth-after '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that were created after the specified time. This predicate is valid only for copy policies.

--birth-before '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that were created before the specified time. This predicate is valid only for copy policies.

--birth-time '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that were created at the specified time. This predicate is valid only for copy policies.

--changed-after '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that have been modified since the specified time. This predicate is valid only for copy policies.

--changed-before '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that have not been modified since the specified time. This predicate is valid only for copy policies.

--changed-time '{<mm>/<dd>/<yyyy> [<HH>:<mm>] | <integer> {days | weeks | months | years} ago}'

Selects files that were modified at the specified time. This predicate is valid only for copy policies.

--no-group

Selects files based on whether they are owned by a group.

--no-user

Selects files based on whether they are owned by a user.

--posix-regex-name <value>

Selects only files whose names match the specified POSIX regular expression. IEEE Std 1003.2 (POSIX.2) regular expressions are supported.

--user-id <id>

Selects files based on whether they are owned by the user of the specified ID.

--user-name <name>

Selects files based on whether they are owned by the user of the specified name.

--group-id <id>

Selects files based on whether they are owned by the group of the specified ID.

--group-name <name>

Selects files based on whether they are owned by the group of the specified name.

The following <operator> values are valid:

Table 1. Operator valuesAvailable operators.

Operator Description

eq Equal. This is the default value.

ne Not equal

lt Less than

le Less than or equal to

gt Greater than

ge Greater than or equal to

not Not

You can use the following <link> values to combine and alter the options available for predicates:

--and

Selects files that meet the criteria of the options that come before and after this value.

--or

Selects files that meet either the criterion of the option that comes before this value or the criterion of the option that follows this value.
--enabled {true | false}: Determines whether the policy is enabled or disabled.

Welcome

Welcome to Dell

PowerScaleOneFS CLI Command Reference

isi sync policies modify

Syntax

Options

Rate this content