Manage NAS Replication

Initiate Replication for a NAS Share or Individual NAS Share Directory/File

Initiate replication for a specified NAS share, or initiate replication for an individual directory or file on the specified NAS share.

Additional Information

The share must have the file/directory based replication enabled to replicate a directory or a file.
The share must specify a namespace or path specified to avoid a full directory/file based replication by default.
This command cannot be used with application specific shares. Use syscli --sync nas instead. See Initiate Source to Target File/Directory Synchronization

Command

syscli ‑‑replicate nas ‑‑name <NAS_share_name> [‑‑target <host_name_or_ip>] [‑‑path <directory_path_or_filename_to_the_share> | ‑‑namespace] [‑‑disableok]

Command Attributes

Review the following attribute descriptions.

`‑‑replicate nas`	Initiates replication for the specified NAS share.
`‑‑name <NAS_share_name>`	Enter the name of the NAS share for which to initiate replication.
`‑‑target <host_name_or_ip>`	Enter the replication's target host name or IP address. If the system or the share/partition has two targets configured, you must use this option to specify a target IP or hostname. If the system or the share/partition does not have a target configured, invoking this command results in error.
`‑‑path <directory_path_or_filename_to_the_share>`	Enter the directory or filename used for directory/file based replication.
`‑‑namespace`	Enter to indicate namespace replication of the entire NAS share. If you do not use this option, directory/file based replication is performed.
`‑‑disableok`	If you use this option, errors are not returned if directory/file based replication is not enabled.

Lock a NAS Share

Lock the specified NAS share on a replication target so that file/directory based replication recovery requests are queued. Recovery does not occur until the share is unlocked.

Command

syscli ‑‑lock nas ‑‑name <NAS_share_name> [‑‑wait]

Unlock a NAS Share

Unlock the specified NAS share on a replication target. If you specify the ‑‑force option, the lock is forced to unlock.

Command

syscli ‑‑unlock nas ‑‑name <NAS_share_name> [‑‑force]

Get NAS Share Lock Status

Retrieve the status of the lock for the specified NAS share.

Command

syscli ‑‑getstatus naslock ‑‑name <NAS_share_name>

Initiate Source to Target File/Directory Synchronization

Initiate source to target file/directory synchronization for a specified NAS share with file/directory based replication enabled.

Command

syscli ‑‑sync nas ‑‑name <NAS_share_name> [‑‑target <host_name_or_ip>]

Command Attributes

Review the following attribute descriptions.

‑‑sync nas

Initiates source to target synchronization for the specified NAS share.

‑‑name <NAS_share_name>

Enter the name of the NAS share for which to initiate synchronization.

‑‑target <host_name_or_ip>

Enter the replication's target host name or IP address.

If the system or the share/partition has two targets configured, you must use this option to specify a target IP or hostname. If the system or the share/partition does not have a target configured, invoking this command results in error.

Add a NAS Replication Target

Add a target to which a NAS share can replicate data.

Command

syscli ‑‑add nastarget ‑‑name <NAS_share_name> ‑‑target <host_name_or_ip>

Delete a NAS Replication Target

Remove a target to which a NAS share can replicate data.

Command

syscli ‑‑del nastarget ‑‑name <NAS_share_name> ‑‑target <host_name_or_ip>

List NAS Replication Targets

List the replication targets for the specified NAS share.

Command

syscli ‑‑list nastarget ‑‑name <NAS_share_name>

Enable NAS Replication

Enable replication of the specified NAS share.

Additional Information

This command enables replication to all targets configured for the NAS share. You cannot enable replication for a single target using this command. Instead, run the following command to allow or disallow replication to a particular target: syscli ‑‑add/del <nastarget> ‑‑name <nas_name> ‑‑target <host_name_or_ip>.
You must configure the target system's corresponding NAS share with a Sync ID prior to configuring the source system's NAS share.
Application Specific NAS shares are enabled to send replication only.

Command

syscli ‑‑enablerep nas ‑‑name <nas_share> [‑‑filedirbase] [‑‑syncid <sync_id>]

Command Attributes

Review the following attribute descriptions.

`‑‑enablerep nas`	Enable replication of the specified NAS share.
`‑‑name <nas_share>`	Enter the name of the NAS share on which to enable replication.
`‑‑filedirbase`	Enable file/directory based replication. If you do not specify this option, replication is enabled for the entire NAS share. Note: Before editing replication settings, disable file/directory replication using `‑‑disable filedirrep`, and then add and remove targets using `‑‑add nastarget` or `‑‑del nastarget`. Note: File/directory based replication is automatically selected for Application Specific NAS shares.
`‑‑syncid <sync_id>`	Enter the Sync ID of the NAS share for which you are enabling replication. If you do not specify this option when file/directory based replication is enabled, the CLI uses the NAS share name for the Sync ID.

Disable NAS Replication

Disable replication for the specified NAS share.

Note: This command disables replication for all targets configured for the NAS share. You cannot disable replication for a single target. Instead, run the following command to allow or disallow replication to a particular target: syscli ‑‑add/del <nastarget> ‑‑name <nas_name> ‑‑target <host_name_or_ip>

Command

syscli ‑‑disablerep nas ‑‑name <nas_share> [‑‑nofiledirbase]

Check Status on a NAS Share

Check and verify the status of a NAS share prior to replicating its data.

DEPRECATED Command

syscli ‑‑checkrepready nas ‑‑name <nas_share>

Abort NAS Share Replication

Abort the current replication of a NAS share.

Command

syscli ‑‑abortrep nas ‑‑name <NAS_share_name> [‑‑target <host_name_or_ip>]

Abort NAS Share Synchronization

Abort the current synchronization of a NAS share.

Command

syscli ‑‑abortsync nas ‑‑name <NAS_share_name> [‑‑target <host_name_or_ip>]

List Deduplicated NAS Shares

List all NAS shares that have data deduplication enabled.

Command

syscli ‑‑list dedupnas [‑‑type all|rep|sync] [‑‑name <sharename> |‑‑namematch <pattern>]

Command Attributes

Review the following attribute descriptions.

`‑‑list dedupnas`	Lists all deduplicated NAS shares on the source system.
`‑‑type all\|rep\|sync`	Enter the type of NAS shares to display: `all` – Lists all deduplication shares . `rep` – Lists only shares with replication tasks. `sync` – Lists only shares with synchronization tasks. The default type is `all`.
`‑‑name <sharename>`	Enter the name of a share for which to list information. Otherwise, information is listed for all shares on the source system.
`‑‑namematch <pattern>`	If you use this option, only shares whose names match the specified pattern are listed. The wild characters `^` and `$` are supported as follows: `^xxx` – Matches pattern xxx at the start of names `xxx$` – Matches pattern xxx at the end of names Because `$` is special to the shell, remember to escape the character with a backslash (\) because it is special to the shell. Example To list all shares ending with test in the names, enter the following command: `syscli ‑‑list dedupnas ‑‑namematch test\$` Note: The `‑‑namematch` option is not supported in Web Service

List All Replicated NAS Shares

List all NAS shares that have been replicated to the target, along with the status of each replication task.

Command

syscli ‑‑list repnas

Example Output

List of all replicated NAS share on the target:

Total count = 1

[replicated nas = 1]

ID = 1

NAS Share Name = nas_cifs1

Source Host = galaxy.quantum-est.com

Replication Started = Wed Jun 3 16:38:20 2009

Replication Finished = Wed Jun 3 16:38:30 2009

Replication Status = Success

Recover a NAS Share

Recover and recreate a NAS share from the target system.

Command

syscli ‑‑recover nas ‑‑repname <replicated_NAS_share_name> ‑‑srchost <source_hostname_or_IP_address> ‑‑id <ID_of_the_replicated_NAS> [‑‑recname <recovered_NAS_share_name>] [‑‑owner <owner_user_id>] [‑‑submit]

Command Attributes

Review the following attribute descriptions.

`‑‑recover nas`	Recovers and recreates the specified NAS share from the target system.
`‑‑repname <replicated NAS_share_name>`	Enter the name of the replicated NAS share. You can retrieve replicated NAs share names using the `syscli ‑‑list repnas` command.
`‑‑srchost <source_hostname_or_IP address>`	Enter the source system's IP address or hostname. You can retrieve the source system's IP address or hostname using the `syscli ‑‑list repnas` command.
`‑‑id <ID_of_the_replicated_NAS>`	Enter the ID of the replicated NAS share. You can retrieve replicated NAS share IDs using the `syscli ‑‑list repnas` command.
`‑‑recname <recovered_NAS_share_name >`	Enter a name for the recovered NAS share. Otherwise the NAS share is assigned its replicated name.
`‑‑owner <owner_user_id>`	You must specify this option if you are recovering a CIFS share.
`‑‑submit`	If specified, the CLI does not wait for the recover operation to complete.

Failback a Replicated NAS Share

Failback a replicated NAS share to a specified system.

Before using this command:

From the system on which the replicated NAS share data exists, run the ‑‑recover NAS command specifying the NAS share to failback.
Configure the target role IP address on the system to which to failback the NAS share.

Command

syscli ‑‑failback repnas ‑‑repname <nas_share_name> ‑‑srchost <source_host> ‑‑id <id> ‑‑tgthost <target_host> [‑‑encrypt {‑‑encrypttype 128|256|tls}]

Command Attributes

Review the following attribute descriptions.

`‑‑failback repnas`	Failback a replicated NAS share to the specified source system.
`‑‑repname <nas_share_name>`	Enter the name of the replicated NAS share to failback. You can retrieve replicated NAS share names using the `syscli ‑‑list repnas` command.
`‑‑srchost <source_host>`	Enter the hostname or IP address of the system to which to failback the NAS share. You can retrieve the original source system's IP address or hostname using the `syscli ‑‑list repnas` command.
`‑‑id <id>`	Enter the ID of the replicated NAS share to failback. You can retrieve replicated NAS IDs using the `syscli ‑‑list repnas` command.
`‑‑tgthost <target_host>`	Enter the hostname or IP address of the system on which the replicated NAS share data exists. The receiving system must have this system defined as an allowed replication source.
`‑‑encrypt`	Specify to encrypt the failback data. Note: To enable encryption, the Data-In-Flight license must be installed. Encryption is not available in all regions. See Manage Encryption.
`‑‑encrypttype 128\|256`	If you enabled encryption, specify the encryption type, either 128 bit, 256 bit, or TLS 256 bit encryption.

Deleting a Replicated NAS Share from the Target

Delete a replicated NAS share from the target system.

Command

syscli ‑‑del repnas ‑‑repname <NAS_name> ‑‑srchost <source_hostname_or_IP_address> ‑‑id <ID_of_the_replicated_NAS>

Command Attributes

Review the following attribute descriptions.

`‑‑del repnas`	Deletes the specified NAS share from the target system.
`‑‑repname <NAS_name>`	Enter the name of the replicated NAS share to delete from the target system. You can retrieve replicated NAS share names using the `syscli ‑‑list repnas` command.
`‑‑srchost <source_hostname_or_IP_address>`	Enter the source system's IP address or hostname. You can retrieve the source system's IP address or hostname using the `syscli ‑‑list repnas` command.
`‑‑id <ID_of_the_replicated_NAS>`	Enter the ID of the replicated NAS share to delete from the target system. You can retrieve replicated NAS share IDs using the `syscli ‑‑list repnas` command.

List Replicated NAS Share Recovery Jobs

List the replicated NAS share recovery jobs on the target system, along with recovery status.

Command

syscli ‑‑list nasrecjob

Example Output

List of all replicated NAS share recovery jobs:

Total count = 1

[recovery job = 1]

ID = 1

Original NAS Share Name = NAS1

New NAS Share Name = NAS1_REC

Source Host = galaxy.node-1

Recovery Job Started = Mon Jun 1 11:22:17 2009

Recovery Job Finished = Mon Jun 1 11:22:43 2009

Recovery Job Status = Success

Delete Replicated NAS Share Recovery Jobs

Delete a replicated NAS share recovery job from the target system.

Command

syscli ‑‑del nasrecjob ‑‑repname <NAS_share_name> ‑‑srchost <source_hostname> ‑‑id <ID_of_the_recovery_job>

Command Attributes

Review the following attribute descriptions.

`‑‑del nasrecjob`	Deletes the specified replicated NAS share recovery from the target system.
`‑‑repname <NAS_share_name>`	Enter the name of the replicated NAS share to delete from the target system. You can retrieve replicated NAS share names using the `syscli ‑‑list nasrecjob` command.
`‑‑srchost <source_hostname>`	Enter the source system's IP address or hostname. You can retrieve the source system's IP address or hostname using the `syscli ‑‑list nasrecjob` command.
`‑‑id <ID_of_the_recovery_job>`	Enter the ID of the recovery job to delete from the target system. You can retrieve recovery IDs using the `syscli ‑‑list nasrecjob` command.

List Replicated NAS Share Failback Jobs

List replicated NAS share failback jobs on the target system, along with the job's status.

Command

syscli ‑‑list nasfailbackjob

Example Output

List of all replicated NAS share failback jobs:

Total count = 1

[failback job = 1]

ID = 1

NAS Share Name = part4

Target Host = 10.40.164.70

Failback Job Started = Wed Jun 3 16:45:53 2009

Failback Job Finished = Wed Jun 3 16:46:01 2009

Failback Job Status = Success

Delete Replicated NAS Share Failback Jobs

Delete a replicated NAS share failback job from the target system.

Command

syscli ‑‑del nasfailbackjob ‑‑repname <NAS_share_name> ‑‑tgthost <target_hostname> ‑‑id <ID_of_the_failback_job>

Command Attributes

Review the following attribute descriptions.

`‑‑del nasfailbackjob`	Deletes the specified replicated NAS share failback from the target system.
`‑‑repname <NAS_share_name>`	Enter the name of the replicated NAS share to delete from the target system. You can retrieve replicated NAS share names using the `syscli ‑‑list nasfailbackjob` command.
`‑‑tgthost <target_hostname>`	Enter the target system's IP address or hostname. You can retrieve the target system's IP address or hostname using the `syscli ‑‑list nasfailbackjob` command.
`‑‑id <ID_of_the_failback_job>`	Enter the ID of the failback job to delete from the target system. You can retrieve recovery IDs using the `syscli ‑‑list nasfailbackjob` command.

Abort Replicated NAS Share Failback Jobs

Abort an active replicated NAS share failback job on the target system.

Command

syscli ‑‑abort nasfailbackjob ‑‑repname <NAS_share_name> ‑‑tgthost <target_hostname> ‑‑id <ID_of_the_failback_job>

Command Attributes

Review the following attribute descriptions.

`‑‑abort nasfailbackjob`	Aborts the specified replicated NAS share failback job on the target system.
`‑‑repname <NAS_share_name>`	Enter the name of the replicated NAS share for which the failback job is running. You can retrieve replicated NAS share names using the `syscli ‑‑list nasfailbackjob` command.
`‑‑tgthost <target_hostname>`	Enter the target system's IP address or hostname. You can retrieve the target system's IP address or hostname using the `syscli ‑‑list nasfailbackjob` command.
`‑‑id <ID_of_the_failback_job>`	Enter the ID of the failback job to abort. You can retrieve recovery IDs using the `syscli ‑‑list nasfailbackjob` command.

Enable NAS Share File/Directory Based Replication

Enable NAS share file/directory based replication for a target system.

Command

syscli ‑‑enable filedirrep ‑‑name <NAS_share_name> [‑‑syncid <sync_id>]

[‑‑locked]

Command Attributes

Review the following attribute descriptions.

`‑‑enable filedirrep`	Enable file/directory based replication for the specified NAS share.
`‑‑name <NAS_share_name>`	The name of the NAS share for which to enable cartridge based replication.
`‑‑syncid <sync_id>`	Enter the Sync ID of the NAS share for which you are enabling replication. If you do not specify this option when file/directory based replication is enabled, the CLI uses the NAS share name for the Sync ID.
`‑‑locked`	If specified, locks the NAS share. Replication requests are queued, but they will not occur until the share is unlocked.

Disable NAS Share File/Directory Based Replication

Disable file/directory based replication for the specified NAS share.

Note: Before editing replication settings using using ‑‑enablerep nas, ‑‑disablerep nas, or ‑‑disable filedirrep, make sure to finish adding and removing targets.

Command

syscli ‑‑disable filedirrep ‑‑name <NAS_share_name>

List Unpack Queue Items

List NAS share file/directory based replications for data received from the source system. This data is referred to as "unpack queue items."

Command

syscli ‑‑list unpackqueueitems

List File/Directory Based Replication Status and Statistics

List the status and statistics of data sent from a NAS share file/directory-based replication.

Command

syscli ‑‑list filedirrepstats ‑‑name <share_name>

List NAS Shares Eligible to Receive File/Directory Based Replication Data

List deduplication-enabled NAS shares that are eligible to receive file/directory based replication data.

Note: When the output of the share's state is Enabled, the share is eligible to receive file/directory based data.

Command

syscli ‑‑list filedirtarget [‑‑name <share_name>]

`‑‑abortrep nas`	Abort the current replication of the specified NAS share.
`‑‑name <NAS_share_name>`	Enter the name of the NAS share for which to abort replication.
`‑‑target <host_name_or_ip>`	If the system or NAS share has more than one target configured, you must specify the target to which replicated data is being sent.

`‑‑abortsync nas`	Abort the current synchronization of the specified NAS share.
`‑‑name <NAS_share_name>`	Enter the name of the NAS share for which to abort synchronization.
`‑‑target <host_name_or_ip>`	If the system or NAS share has more than one target configured, you must specify the target with which the share is being synchronized.

`‑‑list filedirrepstats`	List the replication status and additional statistics of data sent from the specified NAS share.
`‑‑name <share_name>`	Enter the name of the NAS share for which the file/directory based replication is occurring.

`‑‑add nastarget`	Add a target to which a NAS share can replicate data.
`‑‑name <NAS_share_name>`	Enter the name of the NAS share to which to add a replication target.
`‑‑target <host_name_or_ip>`	Enter the target's IP address or hostname.

`‑‑del nastarget`	Remove a target from which a NAS share can replicate data.
`‑‑name <NAS_share_name>`	Enter the name of the NAS share from which to remove a replication target.
`‑‑target <host_name_or_ip>`	Enter the target's IP address or hostname.