EMC Solutions Enabler CLI Command Reference

Chapter 1: SYMCLI Commands

symrcopy

Performs remote copy control operations between storage arrays on a collection of device pairs.

SYNOPSIS symrcopy [-h] symrcopy <-file <FileName> [-noprompt] |

-noprompt 'redirect stdin'> [-star]

[-i <Interval>] [-c <Count>] create <-push <-hot | -cold>

[-differential | -nodifferential] |

-pull <-hot [-donor_update] | -cold>

[-frontend_zero] [-force]>

[-name <SessionName>] [-copy | -precopy | -nocopy]

[-force_copy] [-pace <Pace>] create -pull -migrate -host_type <OsType>

[-hba_type <HbaType>] [-mp_type <MpType>]

[-name <SessionName>] [-pace <Pace>] [-force] remove symrcopy <-file <FileName> [-noprompt] |

-session_name <SessionName> [-noprompt] |

-noprompt 'redirect stdin'>

[-v] [-force] [-star] [-i <Interval>] [-c <Count>] activate [-consistent | -migrate] failback -migrate recreate [-name <SessionName>] [-pace <Pace>] [-precopy] restore [-name <SessionName>] [-pace <Pace>]

[-donor_update]

540 EMC Solutions Enabler CLICommand Reference

rename -name <SessionName> set mode <copy | nocopy | precopy> set pace <Pace> [-migrate] set donor_update off [-consistent] [-force] set frontend_zero off [-migrate] terminate [-symforce] [-all_sessions | -migrate] terminate -symforce -rp symrcopy [-sid SymmID] [-i <Interval>] [-c <Count>] list [-offline] [-detail | -wwn]

[-type <migrate | standard | recoverpoint>] symrcopy <-file <FileName> | -session_name <SessionName> |

'redirect stdin'>

[-offline] [-i <Interval>] [-c <Count>] query [-detail | -wwn] query -summary verify [-summary]

[-createinprog | -created | -recreateinprog |

-recreated | -copyinprog | -copyonaccess |

-copyonwrite | -copied | -terminateinprog |

-failed | -verifyinprog | -restored | -restinprog |

-precopy [-cycled] | -syncinprog | -synchronized |

-failedback] symrcopy [-sid <SymmID>]


symrcopy 541

Chapter 1: SYMCLI Commands export -file <FileName> -session_name <SessionName>

DESCRIPTION

The symrcopy command controls Symmetrix Remote Copy sessions which can copy data from various types of arrays within the Storage Area Network (SAN). Copy operations are controlled from a host attached to a Symmetrix array (referred to as the control side).

Data can be copied to (push operation) or from (pull operation) the remote side array. Copy operations are either online (hot) or offline (cold). Copying data from a Symmetrix to devices on remote storage arrays allows for data to be copied fully or incrementally.

ARGUMENTS activate Starts the copying process on an existing session.

create Defines a new session.

export Creates the specified file with all of the session information for sessions matching session_name.

failback Stops a federated live migration session and returns the control device(s) to host active mode and the remote device(s) to host passive mode. The control device(s) will retain the WWN and geometry of the remote device(s).

list Lists all the sessions for a given

Symmetrix array, or for all Symmetrix arrays.


query Queries for the status of sessions.

recreate Creates an incremental session on an existing session. Only valid for sessions created with the -differential flag.

remove Removes remote devices from a differential session in the Copied state.

restore Restores copied data from the remote device of an incremental push to the control device. Restore can only be run on an incremental push session in the Copied state.

rename Changes the name of a session. Can only be executed on a differential session in the Copied state.

set donor_update off

Allows the donor_update portion of a session to be cancelled.

set frontend_zero off

Turns off the feature that improves performance of pull sessions to thin devices by detecting incoming zero patterns.

set mode Allows the session mode to be changed to nocopy (while in the CopyInProg state), causing the session state to change to

CopyOnAccess if the session was created with the pull flag, or to CopyOnWrite if the session was created with the push flag.

Allows the session mode to be changed


symrcopy 543

Chapter 1: SYMCLI Commands to copy (while in the CopyOnAccess or

CopyOnWrite state), causing the session state to change to CopyInProg.

Allows the session mode to be changed to precopy (while in the Created or

Recreated state), causing the session state to change to Precopy.

set pace Allows the session pace to be changed while in the CopyInProg state. Valid values are from 0 to 9, where 0 is the fastest pace, and 9 is the slowest pace.

terminate Terminates a session and removes it from the Symmetrix array.

verify Verifies that a session is in a specified state.

OPTIONS

-all_sessions Terminates all sessions associated with the control device. Remote devices in the control file are ignored.

-c Specifies a count to perform a specific action.

-cold Indicates that any directors that are mapped to the local device and can reach the targets may be used. Therefore, the source devices must be set to User Not

Ready.

With a push operation, there may be up to

16 targets.


-consistent Causes the source and target pairs to be consistently copied.

-copy Causes the device copy to take place in the background. If -nocopy is specified, the copying of tracks is not completed unless all tracks have been accessed during a pull, or all tracks have been written during a push. Only used with create.

After the operation is executed, the state of the device pair is Copy in Progress.

If all the tracks are eventually moved to the Target device, the state changes to

Copied.

-cycled Used with verify command and precopy flag to verify first cycle of precopy is completed.

-detail Specifies a more detailed list or query.

Note that output text may not fit in some displays.

-differential Allows a session to be recreated for incremental copy. A session created with -nodifferential cannot be recreated for incremental copy.

-donor_update Writes data to the control device and the remote device during a hot pull.

-file Specifies a file name to be used for the action, which contains device pairs. A device pair is a control device and a remote


symrcopy 545

Chapter 1: SYMCLI Commands device.

Note that data flows from the control to the remotes on a -push, but on a -pull, data flows from the remote to the control.

Control devices and remote devices may be specified as LUN World Wide Names (WWNs) or Symmetrix device names.

Valid tags are symdev and wwn.

Source devices and remote devices are space delimited.

Lines that start with a pound sign (#) are ignored. Control devices are always in the left hand column, and remote devices are always in the right.

The usual file format will be: symdev=<SymmID>:<DevName> wwn=<LUN WWN>

...

...

To specify more than one target per source device, add subsequent records, using the same source device and new remote device.

Valid only for -push -cold.

-force Forces the SYMAPI server to allow an action that would ordinarily fail.

-force_copy Forces a create operation even though one or more paired devices in the device file may not be large enough to contain the whole


extents of the control device on a push, or the whole extents of the remote device on a pull.

If the operation is a pull, and the control device is too small, the session will be created so that it will only copy the total number of blocks that will fit into the control device.

If the operation is a push, and the remote device is too small, the session will be created so that it will only copy the total number of blocks that will fit into the remote device, if it is visible to the API host.

-frontend_zero Feature that provides improved performance of pull sessions to thin devices through the detection of incoming zero patterns.

-h Provides brief, online help information.

-hba_type The application host's HBA driver type.

-host_type Specifies the application host operating system in a federated live migration operation.

-hot Indicates that all directors that are mapped to the local device must be able to reach the targets. The source devices may be Read Write.

With a push operation, there may be only one remote device.


symrcopy 547


-i Specifies the interval in seconds to repeat a specific action.

The default interval is 30 seconds if -c is used.

The minimum interval is 5 seconds.

For passive actions the minimum interval is

15 seconds. Passive actions are actions that do not acquire an exclusive lock.

-migrate Indicates a session performing a federated live migration operation.

-mp_type The application host's MP vendor and version.

-name Indicates a session name when creating, recreating, restoring, or renaming a session.

-nocopy Causes the copying of tracks only to happen for tracks accessed during a pull, or written during a push. The copying of tracks is not completed unless all tracks have been accessed or written. Normally, the device copy takes place in the background.

Only used with create.

After the operation is executed, the state of the device pair is Copy on Access or Copy on Write. If all the tracks are eventually moved to the Target device, the state changes to Copied.

-nodifferential

Prevents a session from being recreated for incremental copy. A session must be created with -differential to be recreated for


incremental copy.

-offline Relies on information from the database for updated session information; does not query the Symmetrix array. Used with list or query.

-pace Sets the pace value used for the session

Used for create and recreate.

-precopy Begins copying data immediately in the background at create or recreate time, but without taking a point in time image of the device. Only available for hot push sessions.

-pull Pulls data from the remote to the control device when the session is created with the -pull flag.

-push Pushes data from the control device to the remote device(s) when the session is created with the -push flag.

-rp Indicates a RecoverPoint session.

Used with terminate and -symforce to clean up a RecoverPoint session.

-session_name Specifies the name of the session (or group of sessions) that you want to control.

-star Targets the action for devices that are in

Star mode.

-summary Lists the number of sessions in each state.


symrcopy 549


-symforce Terminates a session that has not yet finished copying. Also used with -rp to terminate a RecoverPoint session.

Used only with terminate.

-type Specifies which type of sessions to include in the list command output. If -type is not specified, all sessions will be included.

Type Description

------------ --------------migrate Indicates federated live migration sessions recoverpoint Indicates sessions used by the RecoverPoint appliance standard Indicates sessions that are neither recoverpoint nor federated live migration

-v Provides more detailed, verbose information.

-wwn Specifies a World Wide Name (WWN). Used for list or query to display remote devices as

WWNs.

PARAMETERS

FileName The name of the file that contains the source and target pairs.

HbaType The Host Bus Adapter type.

Possible values are:

- Emulex

- Qlogic


MpType The multi-path IO type.


- DMP (Dynamic multi-path)

- PPath (PowerPath 4.6+)

- PPath_45 (PowerPath 4.5 only)

- NATIVE (Native multi-path)

OsType The application host operating system.


- AIX

- HPUX

- LINUX

- SunOS_Sparc

- VMWARE

- Windows

Pace The pace value assigned to the session during create, recreate, or set pace commands.

SessionName The optional assigned name used to control a session or group of sessions.

SymmID The 12-digit Symmetrix ID number.

RETURN CODES

Code # Code Symbol

----------------

0 CLI_C_SUCCESS

1 CLI_C_FAIL

2 CLI_C_DB_FILE_IS_LOCKED


symrcopy 551


18 CLI_C_ALREADY_IN_STATE

The device or session is already in the desired state.

19 CLI_C_GK_IS_LOCKED

All GateKeepers to the Symmetrix array are currently locked.

Return codes for symrcopy verify

209 CLI_C_NOT_ALL_VERIFIED

Some but not all of the devices are in the specified state.

210 CLI_C_NONE_VERIFIED

None of the devices are in the specified state.

EXAMPLES

To create a hot push session from an input file, enter: symrcopy create -f input.txt -hot -push

To activate a session from an input file, enter: symrcopy activate -f input.txt

To query a session from an input file, enter: symrcopy query -f input.txt

To terminate a session from an input file, enter: symrcopy terminate -f input.txt

Input file examples:



The following file will control a single session with control device 10 and remote device 34: symdev=000000001234:10 symdev=000000005678:34

The following file will control two separate sessions with different control and remote devices: symdev=000000001234:01 symdev=000000005678:42 symdev=000000001234:02 symdev=000000005678:43

The following file shows a mix of symdev and wwn usage: symdev=000000001234:01 symdev=000000005678:42 symdev=000000001234:02 symdev=000000005678:43 symdev=000000001234:03 wwn=6006048000000000567853594D303434

The following file will control a session with one control device (01) and multiple remotes. (41 and 42) (Note: this can only be used with -cold and -push): symdev=000000001234:01 symdev=000000005678:41 symdev=000000001234:01 symdev=000000005678:42

symrcopy 553

EMC Solutions Enabler CLI Command Reference

symrcopy

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symrcopy

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents