PowerScaleOneFS CLI Command Reference

isi sync policies create

Creates a replication policy.

Syntax

isi sync policies create <name> <action> (copy | sync)
  <source-root-path> <target-host> <target-path> 
  [--enabled (yes | no)]
  [--description <string>]
  [--check-integrity (yes | no)]
  [--source-include-directories | -i <string>]
  [--source-exclude-directories | -e <string>]
  [--source-subnet <subnet> | --source-pool <pool>]
  [--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 | normal | high)]
  [--cloud-deep-copy (deny | allow | force)]
  [--bandwidth-reservation <integer>]
  [--target-certificate-id <string>]
  [--ocsp-issuer-certificate-id <string>]
  [--ocsp-address <string>]
  [--encryption-cipher-list <string>]
  [--elliptic-curve-list <string>]
  [--linked-service-policies <string>]
  [--delete-quotas (yes | no)]
  [--password (<password>]
  [--set-password)]
  [--verbose | -v]

Options

<name>: Specifies a name for the replication policy.
Specify as any string.
<action>: 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.
<source-root-path>: Specifies the directory on the local cluster that files are replicated from.
Specify as a full directory path.
<target-host>: 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.
<target-path>: Specifies the directory on the target cluster that files are replicated to.
Specify as a full directory path.
--enabled (yes | no): Determines whether the policy is enabled or disabled.
The default value is yes.
--description <string>: Specifies a description of the replication policy.
--check-integrity (yes | no}: Specifies whether to perform a checksum on each file data packet that is affected by the SyncIQ job. If this option is set to yes, and the checksum values do not match, SyncIQ retransmits the file data packet.
The default value is yes.
{--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
{--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
--source-subnet <subnet>: Restricts replication jobs to running only on nodes in the specified subnet on the local cluster. If you specify this option, you must also specify --source-pool.
--source-pool <pool>: Restricts replication jobs to running only on nodes in the specified pool on the local cluster. If you specify this option, you must also specify --source-subnet.
--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 <string>: The naming pattern that a snapshot must match to trigger a replication job, when the schedule is set to when-snapshot-taken. The default value is asterisk (*).
--snapshot-sync-existing (yes | no): If set to Yes, snapshot-triggered replication jobs will include replications taken before the policy creation time. The default is No. If set to yes, set --schedule when-snapshot-taken.
{--schedule | -S} {<schedule> | when-source-modified | when-snapshot-taken}: 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. Specifying when-snapshot-taken causes OneFS to replicate data every time that a snapshot is taken of the source directory.
Specify 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.
--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.
--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.
--log-level (fatal | error | notice | info | copy| debug | trace): 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. This parameter has no effect for copy policies.
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): Determines whether the policy has priority.
The default value is 0, which means that the policy does not have priority. If set to 1, the policy is high-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>: The desired bandwidth reservation for this policy, in kb/s. This feature does not activate unless a SyncIQ bandwidth rule is in effect.
--target-certificate-id <string>: The identifier of the target cluster certificate being used for encryption.
--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.
--delete-quotas (yes | no): If set to Yes, forcibly removes quotas from the target when they are removed from the source.
--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.
--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 message confirming that the snapshot schedule was created.

Welcome

Welcome to Dell

PowerScaleOneFS CLI Command Reference

isi sync policies create

Syntax

Options

Rate this content