PowerScale OneFS 9.3.0.0 CLI Command Reference

isi sync service policies modify

Modify a replication service policy.

Syntax

isi sync service policies modify <policy> 
  [--name <service_policy_name>] 
  [--enabled (yes | no)]
  [--target-host <target-cluster>]
  [--description <service-policy-description>] 
  [--check-integrity (yes | no)]
  [--source-subnet <subnet> --source-pool <pool>] 
  [--target-snapshot-pattern <naming-pattern>]
  [--target-snapshot-expiration <duration>]
  [--target-snapshot-alias <naming-pattern>]
  [--source-snapshot-pattern <naming-pattern>]
  [--source-snapshot-expiration <duration>]
  [--snapshot-sync-pattern <pattern>]
  [--snapshot-sync-existing (yes | no)]
  [--schedule (<schedule> | when-source-modified | when-snapshot-taken)]
  [--rpo-alert <duration>]
  [--clear-rpo-alert]
  [--log-level <level>] 
  [--workers-per-node <integer> | --clear-rpo] 
  [--report-max-age <duration>]
  [--report-max-count <integer>]
  [--restrict-target-network (on | off)] 
  [--accelerated-failback (yes | no)]
  [--priority (0 | 1 | normal | high)]
  [--bandwidth-reservation <integer>]  
  [--clear-bandwidth-reservation]
  [--target-certificate-id <string>]
  [--ocsp-issuer-certificate-id <string>]
  [--ocsp-address <string>]
  [--encryption-cipher-list <string>]
  [--linked-data-policies <string>]
  [--clear-linked-data-policies]
  [--add-linked-data-policies <string>...]
  [--remove-linked-data-policies <string>...]
  [--replicated-services <string>]
  [--clear-replicated-services]
  [--add-replicated-services <string>...]
  [--remove-replicated-services <string>...]
  [--service-history-max-age <duration>]
  [--service-history-max-count <integer>]
  [--password (<password>]
  [--set-password)]
  [--clear-source-network]
  [--verbose] 
  [--force]

Options

<policy>: A replication service policy name.
{--name | -n} <service_policy_name>: Specifies a name for the replication service policy.
Specify as any string.
--enabled (yes | no): Determines whether the service policy is enabled or disabled.
The default value is yes.
{--target-host | -C} <target-cluster>: Specifies the cluster that the service 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 <service-policy-description>: Specifies a description of the replication service policy.
--check-integrity (yes | no}: Specifies whether to perform a checksum on each file data packet that is affected by the replication policy. 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-subnet <subnet>: Restricts replication service policies 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 service policies 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-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
--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 replication policy is executed. 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.
--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 an 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.
{--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.
--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.
--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.
--clear-bandwidth-reservation: Clears a bandwidth reservation for this service policy.
--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.
--linked-data-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-data-policies: Clear the list of SyncIQ policy identifiers.
--add-linked-data-policies <string>...: Add items to the list of SyncIQ policy identifiers. Repeat for multiple policies.
--remove-linked-data-policies <string>...: Remove items from the list of SyncIQ policy identifiers. Repeat for multiple policies.
--replicated-services <string>...: A list of services to replicate. Specify again for each additional service.
--clear-replicated-services: Clear the list of services to replicate.
--add-replicated-services <string>...: Add items to the list of services to replicate. Repeat for multiple replicated services.
--remove-replicated-services <string>...: Remove items from the list of services to replicate. Repeat for multiple replicated services.
--service-history-max-age <duration>: The maximum age of service information to maintain.
--service-history-max-count <integer>: The maximum number of service historical information records to maintain.
--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.
--clear-source-network: Clears the source subnet and pool.
{--verbose | -v}: Displays a message confirming that the snapshot schedule was created.
{--force | -f}: Does not prompt you to confirm modifications.

Welcome

Welcome to Dell

PowerScale OneFS 9.3.0.0 CLI Command Reference

isi sync service policies modify

Syntax

Options

Rate this content