CLI Guide

● A value that includes a space must be enclosed in double quotes. If you change this parameter
while a replication is running, the replication set will be immediately renamed but the current
replication will not be affected.
[queue-policy discard|queue-latest]
Optional. Specifies the action to take when a replication is running and a new replication is requested.
● discard: Discard the new replication request.
● queue-latest: Take a snapshot of the primary volume and queue the new replication request.
If the queue contained an older replication request, discard that older request. A maximum of one
replication can be queued. This is the default.
If you change this parameter while a replication is running, the change will affect subsequent
replications but not the current replication.
NOTE: If the queue policy is queue-latest and a replication is running and another is queued, you
cannot change the queue policy to discard. You must manually remove the queued replication
before you can change the policy.
[snapshot-basename basename]
Optional if snapshot-history is set to disabled or off. Required if snapshot-history is
set to secondary or both. Specifies a prefix to help you identify replication snapshots. Input rules:
● The value is case sensitive.
● The value can have 1-26 bytes.
● The value can include spaces and printable UTF-8 characters except: " , . < \
● A value that includes a space must be enclosed in double quotes.
If you change this parameter while a replication is running, for the current replication it will affect the
name of the snapshot on the secondary system. For that replication only, the names of the snapshots
on the primary and secondary systems will differ.
[snapshot-count #]
Optional if snapshot-history is set to disabled or off. Required if snapshot-history is
set to secondary or both.
Specifies the number of snapshots taken of the replication volume to retain, from 1 to 16. When a
new snapshot exceeds this limit, the oldest snapshot in the snapshot history is deleted.
The snapshot-count setting can be changed at any time. Its value must be greater than the
number of existing snapshots in the replication set, regardless of whether snapshot-history is
enabled.
If you change this parameter while a replication is running, for the current replication it will affect
only the secondary system. In this case the value can only be increased, so you might have one less
expected snapshot on the primary system than on the secondary system.
[snapshot-history disabled|off|secondary|both]
Optional. Specifies whether to maintain a replication snapshot history for the replication set, as
described above.
● disabled or off: A snapshot history will not be kept. If this parameter is disabled after a
replication set has been established, any existing snapshots will be kept, but not updated. This
option is the default
● secondary: A snapshot history set will be kept on the secondary system for the secondary
volume, using snapshot-count and snapshot-basename settings.
● both: A snapshot history will be kept for the primary volume on the primary system and for
the secondary volume on the secondary system. Both snapshot histories will use the same
snapshot-count and snapshot-basename settings.
If you change this parameter while a replication is running, for the current replication it will affect only
the snapping of the secondary volume.
[snapshot-retention-priority never-delete|high|medium|low]
Optional. For virtual storage, this specifies the retention priority for history snapshots, which is used
when automatic deletion of snapshots is enabled by using the set snapshot-space command. In a
snapshot tree, only leaf snapshots can be deleted automatically. Deletion based on retention priority
is unrelated to deleting the oldest snapshots to maintain a snapshot count.
Alphabetical list of commands
147