Follow

replica.change_role  

ROLE: Admin, Pool Admin 

Description

Change the replica role on the local system only.

Changes the role of the local replica from source to target, or from target to source. When using this command in a failover scenario you have to run this command twice, once on the source and once on the target. 

Syntaxreplica.change_role local_dataset=LOCAL ENTITY [dataset_type=CGORDATASET] 
Argumentsdataset_typeCG, VOLUME or FILESYSTEM 
local_datasetdataset or consistency group with SYNC or ASYNC (not concurrent) replication  
Examplereplica.change_role dataset=vol1 
Replica rep1 role is now TARGET, and its staging area was discarded 



replica.change_type 

ROLE: Admin, Pool Admin

Description

Change replica type

This command changes the type of the replica from synchronous to asynchronous and from asynchronous to synchronous.

  • This operation requires an approval
Changing the type of the replica from asynchronous to synchronous

The source system will initiate a sync job. Until the sync job is finished, the sync state will be SYNC_IN_PROGRESS

Changing the type of the replica from synchronous to asynchronous:

The RPO and Interval parameters are mandatory 

Syntaxreplica.change_type local_dataset=LOCAL ENTITY new_replica_type=REPLICATYPEEXCLUDEACTIVEACTIVE [dataset_type=CGORVOLUME] [rpo=TIMEDELTA] [interval=TIMEDELTA] 
Argumentsdataset_type CG or VOLUME 
new_replica_type ASYNC or SYNC 
local_dataset dataset or consistency group with SYNC or ASYNC (not concurrent) replication 
rpo A time delta, e.g: '02:02', '05:11:06' 
interval A time delta, e.g: '02:02', '05:11:06' 
ExampleChanging the type of the replica from asynchronous to synchronous (this operation requires an approval)  
replica.change_type local_dataset=v1 new_replica_type=sync -y 
Replica for volume "v1" type changed to SYNC 
ExampleChanging the type of the replica from synchronous to asynchronous (this operation requires an approval)  
replica.change_type local_dataset=v1 new_replica_type=ASYNC interval=60 RPO=300 -y 
Replica for volume "v1" type changed to ASYNC 



replica.create  

ROLE: Admin, Pool Admin

Description

Create a new replica.

This command creates a new replica.

  • Set the replica type - either SYNC or ASYNC
  • Set the remote system
  • Set the local entity (volume, consistency group, or filesystem)
  • Set the local entity type
  • Set an existing remote entity
    • Otherwise, set the remote pool
      • Optionally set the name of the remote entity that will be created
      • Optionally set a suffix for the target consistency group members
  • For ASYNC replica - set the interval and RPO in seconds, both values have to be between 4 seconds and 24 hours.

A note on name uniqueness:

  • Two replicated entities (of any entity types) should not have the same name.  
Syntaxreplica.create system=SYSTEM source=NONREPLICATEDORACTIVEACTIVEENTITY remote_pool=REMOTEENTITY replication_type=REPLICATYPE [active_active_preferred=ACTIVEACTIVEPREFERRED] [interval=TIMEDELTA] [rpo=TIMEDELTA] [dataset_type=CGORDATASET] [new_target_name=NAME] [new_datasets_suffix=NAME] 
Argumentsnew_datasets_suffix A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.  
rpo A time delta, e.g: '02:02', '05:11:06'  
interval  A time delta, e.g: '02:02', '05:11:06'  
active_active_preferred LOCAL or REMOTE  
replication_type ASYNC, SYNC or ACTIVE_ACTIVE  
remote_pool  Name of a remote entity (auto-completion unavailable) 
source  Name of an existing dataset or consistency group without replication or dataset with active-active replication  
system Name of an existing replication link
dataset_type CG, VOLUME or FILESYSTEM 
new_target_name A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. 
ExampleCreate an ASYNC replica for a volume. 
replica.create system=localsystem source=vol-1 interval=60 rpo=120 
Replica for volume vol-1 created 
ExampleCreate a replica with no interval. When a replica is created with no Interval, a sync job can be created only manually.  
replica.create system=localsystem source=vol-2 interval=NONE  
Replica for volume vol-2 created  
ExampleCreate a replica with no RPO. When a replica is created with no RPO, the InfiniBox system does not manage the RPO states, nor create events for the transition from RPO OK to RPO lagging and back.  
replica.create system=localsystem source=vol-3 rpo=NONE  
CReplica for volume vol-3 created 
ExampleCreate a replica for a consistency group. The interval and RPO are set to 1 minute each.  
replica.create system=localsystem source=cg-1 interval=60 rpo=60 
Replica for consistency group cg-1 created 
Example Create a synchronous replica
replica.create system=ibox628 remote_pool=p1 source=vol1000 replication_type=sync
Replica for volume vol1000 created



replica.delete  

ROLE: Admin, Pool Admin 

Description

Delete a replica.

Delete a replica by indicating the source dataset. The replica is deleted on both source and target.

  • For ASYNC replica: indicate whether to keep the staging area.
  • Use the FORCE flag to delete only the local replica (for example, in a case of link down)  
Syntaxreplica.delete local_dataset=LOCAL ENTITY [dataset_type=CGORDATASET] [remote_system=SYSTEM] [retain_staging_area=YESNO] [force=YESNO] [force_keep_serial=YESNO]  
Argumentsforce Either yes, or no 
retain_staging_area Either yes, or no 
remote_systemName of an existing replication link
dataset_typeCG, VOLUME or FILESYSTEM
local_datasetdataset or consistency group with replication
force_keep_serialEither yes, or no 
Examplereplica.delete dataset=vol1 retain_staging_area=yes  
Replica replica1 deleted 



replica.query 

ROLE: All Roles 

Description

List existing replicas.

Use the local_dataset parameter in order to filter the output by the replicated dataset(s). The query can be filtered by:

  • replication_type
  • state
Syntaxreplica.query [replication_type=REPLICATYPE] [unit=REPLICACAPACITYUNIT] [system=SYSTEM] [local_dataset=LOCAL ENTITY[,LOCAL ENTITY,...]] [role={SOURCE|TARGET}] [state={ACTIVE|UNKNOWN|AUTO_SUSPENDED|SUSPENDED}] [infinisync_protected=YES|NO|Y|N] [type={CG|VOLUME|FILESYSTEM}] [sync_state={SYNCHRONIZED|OUT_OF_SYNC|SYNCH_STALLED}] [concurrent_replica=YES|NO|Y|N] 
Argumentssystem  Name of an existing replication link  
unit  KiB, MiB, GiB, TiB 
replication_type  ASYNC, SYNC or ACTIVE_ACTIVE  
local_dataset dataset or consistency group with replication (multiple values, separated by commas) 
role ASYNC, SYNC or ACTIVE_ACTIVE  
state SOURCE or TARGET 
infinisync_protectedEither yes or no 
type CG, VOLUME or FILESYSTEM  
sync_state  Replication sync state  
concurrent_replica Either yes or no   
ExampleQuerying replicas - synchronous example 
replica.query replication_type=sync 

LOCAL      TYPE   ROLE   REMOTE   REMOTE     STATE  SYNC         LATENCY
DATASET                  SYSTEM   DATASET           STATE 

vol_90b000 VOLUME SOURCE ibox3000 vol_dbad75 ACTIVE SYNCHRONIZED 0.0 MS
vol_c9be33 VOLUME SOURCE ibox3000 vol_45f609 ACTIVE SYNCHRONIZED 0.0 MS

ExampleQuerying replicas - asynchronous example 
replica.query replication_type=async  

LOCAL   TYPE ROLE   REMOTE   REMOTE      STATE  JOB   PROGRESS STATE  RPO   RESTORE
DATASET             SYSTEM   DATASET            STATE                 STATE POINT

CG-1    CG   SOURCE ibox3000 cg-1-remote ACTIVE DONE  100%     ACTIVR OK    2015-08-01 10:00:00
ExampleQuerying for replicated datasets with ongoing sync jobs. 
replica.query --grep=replicating --columns=local_dataset,state,progress,throughput,rpo_state,interval,rpo_value 

LOCAL                     STATE       PROGRESS  THROUGHPUT  RPO  INTERVAL  RPO  
DATASET                                                     STATE          VALUE 
 
io004_replica_to_ibox1106 REPLICATING 90%       249 MB/sec  OK   0:00:05   30 sec
io004_replica_to_ibox1177 REPLICATING 4%        233 MB/sec  OK   0:00:05   30 sec
io004_replica_to_ibox3008 REPLICATING 10%       240 MB/sec  OK   0:00:05   30 sec

ExampleQuerying for replicas, displaying a detailed output 
replica.query --detailed  

local Dataset     cg1
Local Pool Name   p1
Role              SOURCE
Remote System     box-avi
Remote Dataset    cg1-box-avi
Remote Pool Name  p1-box-avi
State             ACTIVE
State Description -
Job State         DONE
Progress          100%
Throughput        -
RPO State         OK
RPO Value         0:05:00
Sync Interval     0:01:00
Created At        2016-09-12 10:00:00
Updated At        2016-09-12 10:00:00
Last Synchronized 2016-09-12 10:00:02
Restore Point     2016-09-12 10:00:02
Staging Area Size 0
Pairs
      Local Dataset Remote Dataset Initializing Restore Point
      v-1           v-1-target     No           2016-09-12 11:20:00
      v-2           v-2-target     No           2016-09-12 11:20:00

Example Querying replicas - asynchronous example 
replica.query 
Malformed JSON
Example Filter the query by the state of the replica
replica.query state=SUSPENDED --columns=local_dataset,state
LOCAL DATASET  STATE
VOL1           SUSPENDED
LOCAL DATASET  STATE
VOL2           SUSPENDED



replica.resume 

ROLE: Admin, Pool Admin

Description

Resumes the replica.

This command resumes the replica from a SUSPENDED or AUTO-SUSPENDED state. The command has to be run on the source only.

Syntaxreplica.resume [local_dataset=LOCAL ENTITY] [dataset_type=CGORDATASET] [remote_system=SYSTEM] [resume_all=YESNO]  
Argumentsremote_system Name of an existing replication link
dataset_type CG, VOLUME or FILESYSTEM 
local_dataset dataset or consistency group without mobility replication 
resume_all Either yes or no   
ExampleRun the command, specifying the local dataset. Then, enter the credentials to the remote system.  
replica.resume dataset=vol1 Username for box-avi: admin Password: 

Replica replica1 resumed  



replica.set_interval  

ROLE: Admin, Pool Admin

Description

Set the replica sync interval.

The interval cannot be greater than the RPO.

  • This command is available for ASYNC replica only
  • This command can be run only from the source
Syntaxreplica.set_interval local_dataset=LOCAL ENTITY interval=TIMEDELTA [dataset_type=CGORDATASET] 
Argumentsdataset_type CG, VOLUME or FILESYSTEM
interval A time delta, e.g: '02:02', '05:11:06' 
local_dataset dataset or consistency group with SYNC or ASYNC replication 
Examplereplica.set_interval dataset=vol1 interval=60 

Replica for volume vol1 set to synchronize every 60 seconds  



replica.set_preferred

ROLE: Admin, Pool Admin

Description

Update replica preferred system

Syntaxreplica.set_preferred local_dataset=LOCAL ENTITY active_active_preferred=[LOCAL|REMOTE] [dataset_type={CG}VOLUME|FILESYSTEM] 
Argumentsdataset_type CG, VOLUME or FILESYSTEM
active_active_preferredLOCAL or REMOTE
local_dataset dataset or consistency group with ACTIVE-active replication and without mobility replication



replica.set_rpo 

ROLE: Admin, Pool Admin

Description

Set the replica recovery point objective (RPO).

The RPO has to be greater than the interval.

  • This command is available for ASYNC replica only
  • This command can be run only from the source
  • It is recommended to set the RPO to be at least twice as large as the Interval.
Syntaxreplica.set_rpo local_dataset=LOCAL ENTITY rpo=TIMEDELTA [dataset_type=CGORDATASET] 
Argumentsdataset_type CG, VOLUME or FILESYSTEM
rpo A time delta, e.g: '02:02', '05:11:06' 
local_dataset dataset or consistency group with SYNC or ASYNC replication 
Examplereplica.set_rpo local_dataset=cg-1 rpo=60 

Replica for consistency group cg-1 recovery point objective set to 60 seconds 



replica.suspend 

ROLE: Admin, Pool Admin

Description

Suspend the replica. 

Syntaxreplica.suspend local_dataset=LOCAL ENTITY [dataset_type=CGORDATASET] [remote_system=SYSTEM] 
Argumentsremote_system Name of an existing replication link 
dataset_type CG, VOLUME or FILESYSTEM 
local_dataset dataset or consistency group without mobility replication 
Examplereplica.suspend dataset=vol1 

Replica replica1 suspended 



replica.switch_role  

ROLE: Admin, Pool Admin

Description

Switch the roles of the replica

Switching the roles of replicated datasets changes the source to target and the target to source.

  • When the source switches to target, it becomes write-protected.
  • When the target switches to source, it becomes write-enabled (in order to accept host I/O)

The command is available for SYNC replica only. The command has to be run on the source. The replica has to be Synchronized.

Syntaxreplica.switch_role local_dataset=LOCAL ENTITY [dataset_type=CGORDATASET] 
Argumentsdataset_type  CG, VOLUME or FILESYSTEM  
local_dataset dataset or consistency group with SYNC replication 
Examplereplica.switch_role local_dataset=vol1001 

Roles of replica vol1001 have changed successfully 



replica.sync_now 

ROLE: Admin, Pool Admin

Description

Initiate a sync job.

Initiate a sync job that runs immediately. This command assumes that a replica is defined correctly and has already past its Initialization phase. The command runs only on the source dataset.

Syntaxreplica.sync_now local_dataset=LOCAL ENTITY [dataset_type=CGORDATASET] 
Argumentsdataset_type CG, VOLUME or FILESYSTEM
local_dataset dataset or consistency group with ASYNC replication 
ExampleInitiating a sync for a volume 
replica.sync_now local_dataset=vol-2 
Replica for volume vol-2 sync started 
ExampleInitiating a sync for a consistency group 
replica.sync_now local_dataset=cg-1 
Replica for consistency group cg-1 sync started 
Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:33:05 UTC

Comments