EMC Solutions Enabler CLI Command Reference

Chapter 1: SYMCLI Commands

symclone

Performs TimeFinder/Clone control operations on a device group, composite group, devices within the device group, or devices in a device file.

SYNOPSIS symclone -h symclone -g <DgName> [-v] [-noprompt] [-force]

[-i <Interval>] [-c <Count>] [-star]

[-preserveTGTLocks -lockid <lockNum>]

[-tgt [-bcv] | -rdf [-bcv | -tgt] |

-rbcv -tgt | -rrbcv | -hop2 [-tgt]] create [-opt | -exact] [-concurrent] [-skip]

[[-nocopy | -vse] [-nodifferential]] |

[[-copy | -precopy] [-differential | -nodifferential]]

[<LdevName> [[SYM | BCV] pd <PdevName>]...|

<LdevName> [[SYM | BCV] dev <SymDevName>]...|

<LdevName> [[SYM | BCV] ld <LdevName>]...] split [-skip]



<LdevName> [[SYM | BCV] ld <LdevName>]...] activate [-consistent [-both_sides]]

[-preaction <ScriptFile>] [-postaction <ScriptFile>]

[-not_ready] [-skip] [-concurrent]



<LdevName> [[SYM | BCV] ld <LdevName>]...] terminate [-symforce] [-skip] [-restored] [-not_ready]



188 EMC Solutions Enabler CLICommand Reference

<LdevName> [[SYM | BCV] ld <LdevName>]...] recreate [-skip] [-precopy]



<LdevName> [[SYM | BCV] ld <LdevName>]...] establish [-consistent [-both_sides]]


[-not_ready] [-skip]

[-full [-opt|-exact] [-vse]] [-concurrent]



<LdevName> [[SYM | BCV] ld <LdevName>]...] restore [-preaction <ScriptFile>][-postaction

<ScriptFile>] [-full]



<LdevName> [[SYM | BCV] ld <LdevName>]...] symclone -g <DgName> [-offline] [-i <Interval>][-c <Count>]

[-bcv | -rdf [-bcv] | -rbcv | -rrbcv | -hop2] query [<LdevName> [<LdevName>...]] [-multi] [-summary] verify [-created | -copied | -copyinprog |

-copyonaccess | -copyonwrite | -precopy [-cycled] |

-recreated | -restored | -restinprog | -split]

[-force] [-concurrent] [-summary]



<LdevName> [[SYM | BCV] ld <LdevName>]...] symclone -g <DgName> [-force]


-rbcv -tgt | -rrbcv | -hop2 [-tgt]]


symclone 189

Chapter 1: SYMCLI Commands set mode <copy | nocopy | precopy>



<LdevName> [[SYM | BCV] ld <LdevName>]...] symclone -sid <SymmID> <-file <DeviceFileName> [-noprompt] |

-noprompt 'redirect stdin'>

[-force] [-i <Interval>] [-c <Count>] [-star]

[-preserveTGTLocks -lockid <LockNum>] [-v] create [-skip]


[[-copy | -precopy] [-differential | -nodifferential]] split [-skip] activate [-consistent]


[-not_ready] [-skip] terminate [-symforce] [-skip] [-restored] [-not_ready] recreate [-skip] [-precopy] establish [-consistent]



[-full [-opt | -exact] [-vse]] restore [-preaction <ScriptFile>][-postaction

<ScriptFile>] [-full] symclone -sid <SymmID> <-file <DeviceFileName> [-noprompt] |

-noprompt 'redirect stdin'> [-force]

[-i <Interval>] [-c <Count>] set mode <copy | nocopy | precopy>


symclone -sid <SymmID> <-file <DeviceFileName> |

'redirect stdin'>

[-i <Interval>] [-c <Count>] query [-multi] [-summary] verify [-created | -copied | -copyinprog |



[-force] [-concurrent] [-summary] symclone [-sid <SymmID>] [-i <Interval>] [-c <Count>]

[-offline] list [-copy | -nocopy | -precopy | -vse] symclone -cg <CgName> [-v] [-noprompt] [-force]

[-i <Interval>] [-c <Count>] [-star]


-rbcv -tgt | -rrbcv | -hop2 [-tgt]]

[-sid <SymmID> |

-rdfg <SymmID>:<GrpNum>[,<GrpNum>,...]|<all>[,...] | name:<RdfGroupName>[,<RdfGroupName>,...]>] create [-opt | -opt_rag | -exact] [-concurrent] [-skip]


[[-copy | -precopy] [-differential | -nodifferential]]



<LdevName> [[SYM | BCV] ld <LdevName>]...] split [-skip]



<LdevName> [[SYM | BCV] ld <LdevName>]...] activate [-consistent]


symclone 191



[-not_ready] [-skip] [-concurrent]



<LdevName> [[SYM | BCV] ld <LdevName>]...] terminate [-symforce] [-skip] [-restored] [-not_ready]



<LdevName> [[SYM | BCV] ld <LdevName>]...] recreate [-skip] [-precopy]



<LdevName> [[SYM | BCV] ld <LdevName>]...] establish [-consistent]



[-full [[-opt | -opt_rag] [-vse | -exact]]

[-concurrent]



<LdevName> [[SYM | BCV] ld <LdevName>]...] restore [-preaction <ScriptFile>][-postaction

<ScriptFile>] [-full]



<LdevName> [[SYM | BCV] ld <LdevName>]...] symclone -cg <CgName> [-offline] [-i <Interval>]

[-bcv | -rdf [-bcv] | -rbcv | -rrbcv | -hop2]

[-c <Count>] [-sid <SymmID> |

-rdfg <SymmID>:<GrpNum>[,<GrpNum>,...]|<all>[,...] | name:<RdfGroupName>[,<RdfGroupName>,...]>]


query [-multi] [-summary]

[LdevName [LdevName...]] verify [-created | -copied | -copyinprog |



[-force] [-concurrent] [-summary]



<LdevName> [[SYM | BCV] ld <LdevName>]...] symclone -cg <DgName> [-force]


-rbcv -tgt | -rrbcv | -hop2 [-tgt]] set mode <copy | nocopy | precopy>



<LdevName> [[SYM | BCV] ld <LdevName>]...]

DESCRIPTION

The symclone command performs TimeFinder/Clone operations on a device or composite group, on a device within a device or composite group, or on pairs listed in a device file.

These operations include creating and activating a source device with a target device in a copy session, terminating the session, and querying the state of the device pair.

You can perform all clone operations on a group or individual device basis.

Before you can copy a source device to a target device, the target device must have been previously associated with


symclone 193

Chapter 1: SYMCLI Commands the device group and the target device must be the same size as the source device.

ARGUMENTS activate Activate an internal copy session with the devices in the device or composite group and one or more target devices associated with the group.

While the operation is in progress, the state of the device pair is either

CopyInProgress or CopyOnAccess. When the operation completes, the state changes to

Copied.

create Creates an internal copy session with the devices in the device or composite group and one or more target devices associated with the group.

While the operation is in progress, the state of the device pair is

CreateInProgress. When the operation completes, the state changes to Created.

establish Creates and activates an internal copy session with the devices in the group and one or more target devices associated with the group. Specifying this argument without the -full option performs a recreate followed by an activate operation.

list Lists all copy sessions created on the

Symmetrix array.

query Returns clone state information about one


or all device pairs in a group or device file. recreate Copies only the tracks that changed since the last activate action to the target device. The session must have been created with the -differential option. You must issue a subsequent activate action to establish a new point-in-time copy.

restore Initiates a copy from the target device to a source device. When you specify this argument with the -full option, a full copy of the data currently on the target device will occur. The device must be in a Copied state for a restore to take place.

set mode Changes a session in the Created state to

Precopy, Copy, or NoCopy. Once a session is in the Precopy state, you cannot change it to one of the other states.

split Splits a clone device pair that is in the

Restored state. Once in the Split state, you can either recreate or restore the pair.

terminate Stops the existing internal copy session between the specified source and target devices in a group.

verify Verifies whether one device pair or all device pairs in a group are in the Copied state.

KEYWORDS

BCV Specifies a BCV target device. dev Indicates a Symmetrix device name.


symclone 195

Chapter 1: SYMCLI Commands ld Indicates a logical device name.

Locks Locks on the target devices. The target devices must already be locked by the same lock holder ID. Requires -lockid.

name Indicates an RDF group's logical name.

pd Indicates a physical device name.

SRCDEVS Specifies to use the path names from the standard devices being controlled.

SYM Specifies a Symmetrix target device

(STD or BCV).

OPTIONS

-bcv When used with the -rdf option, executes the operation on the remote

BCV devices (RBCVs).

-both_sides Activates all locally and remotely associated clone pairs in an SRDF group.

-c Specifies the number (count) of times to display or to acquire an exclusive lock on the Symmetrix host database. If you do not specify this option and specify an interval

(-i), the program will loop continuously to display or start the mirroring operation.

-cg Applies a composite group name to the command.

-concurrent When used with the verify argument, this option verifies the standard device and


multiple target devices. When used with the active commands, this option performs the operation on a pair with an additional target device.

-consistent Consistently activates the source and target pairs.

-copied Verifies that the copy session(s) are in the Copied state.

-copy Performs the device copy in the background.

Normally, tracks are not copied unless the source device is written to, or the target device is read from or written to. When the create -copy operation executes, the state of the device pair is CopyInProgress. If all tracks are eventually moved to the target device, the state changes to Copied. When used with the list command, lists only sessions with background copy active.

-copyinprog Verifies that the copy session(s) are in the CopyInProg state.

-copyonaccess Verifies that the copy session(s) are in the CopyOnAccess state.

-copyonwrite Verifies that the copy session(s) are in the CopyOnWrite state.

-created Verifies that the copy session(s) are in the Created state.

-cycled Verifies that the copy session(s) have completed one precopy cycle. Requires the -precopy option.


symclone 197


-differential Creates a differential session, which you can recreate at a later time.

-exact Selects pairs according to the exact order in which the source and target devices were added to the specified group. This option overrides all other pairing algorithms and only applies to group operations.

-file Applies a device file to the command. The device file contains device pairs

(SymDevnames) listing a pair per each line

(the source device first, a space, and the target device last within each line entry).

Device files can include comment lines that begin with the pound sign (#). A Symmetrix

ID is required for this option. -f is synonymous with -file.

-force Attempts to force the operation even though one or more paired devices in the device group may not be in the normal, expected state(s) for the specified operation.

-full Copies data from all tracks to the target device. This option is only valid with a

Restore or Establish command.

-g Applies a device group name to the command.

-h Provides brief online help information.

-hop2 Performs the specified action on the

Symmetrix array two hops away.

-i Specifies the repeat interval, in seconds,


to display or to acquire an exclusive lock on the Symmetrix host database.

The default interval is 30 seconds.

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.

When used with the verify action, the number of seconds specified indicates the interval of time (in seconds) to repeat the verify command before the verify action finds and reports the pairs fully synchronized.

-lockid Specifies the lock holder ID for preserving the target locks on the control operation.

The lock number ID must be a hexadecimal number.

-multi Applies to the query operation in a multi-copy session environment to show all targets that are paired with the source devices.

-nocopy Creates a session without a background copy. This option is not allowed with the

-differential option. When used with the list command, lists only sessions with background copy inactive.

-nodifferential

Creates a non-differential session, which cannot be recreated without a full copy of the data.

-noprompt Requests to not return a prompt after you


symclone 199

Chapter 1: SYMCLI Commands enter a command. The default is to prompt for confirmation.

-not_ready Following the clone operation, for activate and establish leaves the target device(s)

Not Ready to the host and for terminate leaves the target(s) in their prior Ready or

Not Ready state.

-offline Specifies that the Symmetrix data connection is offline from the host in-memory database.

-opt Applies the symclone create command to optimize the device pair selection (source and target devices) to achieve the highest copy speed between them. For remote BCV operations, use the -opt_rag option.

-opt_rag Applies to the full create or establish operations for remote device optimization to distribute the I/O load so that the remote adapters are not connected to the same devices of the selected pair.

Requires that you also specify the -rdf or

-rrbcv option.

-postaction Executes the script argument after a copy session has been activated.

-preaction Executes the script argument before a copy session has been activated.

-precopy Performs the device copy in the background before the activate starts. Normally, the copying of tracks does not start until the activate occurs. The precopy process


continuously runs in the background until the activate is called. Precopy implies

-copy. When used with the list command, lists only sessions with precopy active.

-preserveTGT Performs the action without taking out device locks on the target devices. The target devices must already be locked by the same lock holder ID. Requires the -lockid option.

-rdf Performs the action on the remote Symmetrix array.

-rdfg Performs the requested action on a subset of the composite group defined by one or more

Symmetrix/RA Group combinations supplied as the argument to -rdfg.

-restored With the verify command, verifies that the copy session(s) are in the Restored state.

With the terminate command, terminates a restored VP Snap session.

-rrbcv Performs the action on the multi-hop

Symmetrix array.

-sid Applies the command to the specified

Symmetrix ID. Specify this option with the

-file option to select the Symmetrix array on which to perform the operation, or specify this option with -cg option to restrict the operation to a single Symmetrix array.

-skip Skips the source locks action. This option will not lock the source devices if all of


symclone 201

Chapter 1: SYMCLI Commands the specified source devices are either locked or unlocked. Applicable only when the source device is a standard device

(not a BCV).

-vse Sets the copy mode to VP Snap nodifferential. When used with the list command, lists only VP Snap sessions.

-split Verifies that the Copy session(s) are in the

Split state.

-star Targets the action at devices in STAR mode.

-summary Shows device state summary.

-symforce Forces the operation to execute when normally it is rejected. Use extreme caution with this option.

-tgt Uses TGT devices as clone targets. When you use this option with the -rdf option, the operation will use RTGT devices.

-v Provides a more detailed, verbose listing.

PARAMETERS

CgName The composite group name.

DgName The device group name.

DeviceFileName The device file name. The device file contains device pairs (SymDevNames) listing a pair each line (the source device first, a space, followed by the target device name on each line).


GrpNum The RDF (RA) group number.

LockNum The hexadecimal value of the lock holder

ID.

LdevName The device logical name of either the standard or the BCV device.

RdfGroupName The logical name associated with the RDF

(RA) group(s).

PdevName The target or Symmetrix device physical

(host) name.

ScriptFile The full pathname of a script file to execute.

SymDevName The target or Symmetrix device name.

RETURN CODES

Code # Code Symbol

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

0 CLI_C_SUCCESS

1 CLI_C_FAIL

2 CLI_C_DB_FILE_IS_LOCKED

18 CLI_C_ALREADY_IN_STATE

The device or device group is already in the desired Copy state.

19 CLI_C_GK_IS_LOCKED

All gatekeepers to the Symmetrix array are


symclone 203

Chapter 1: SYMCLI Commands currently locked.

22 CLI_C_NEED_FORCE_TO_PROCEED

Requires the force flag to proceed.

23 CLI_C_NEED_SYMFORCE_TO_PROCEED

Requires the symforce flag to proceed.

CAUTION: Extreme caution should be exercised when using this option.

Return codes for symclone verify

53 CLI_C_NOT_ALL_COPYINPROG

Not all source devices are in the CopyInProg state.

54 CLI_C_NONE_COPYINPROG

No source devices are in the

CopyInProg state.

55 CLI_C_NOT_ALL_COPIED

Not all source devices are in the Copied state.

56 CLI_C_NONE_COPIED


Copied state.

57 CLI_C_NOT_ALL_COPYONACCESS

Not all source devices are in the CopyOnAccess state.

58 CLI_C_NONE_COPYONACCESS


CopyOnAccess state.

60 CLI_C_NOT_ALL_CREATED


Not all source devices are in the Created state.

61 CLI_C_NONE_CREATED


Created state.

68 CLI_C_NOT_ALL_RECREATED

Not all source devices are in the Recreated state.

69 CLI_C_NONE_RECREATED


Recreated state.

73 CLI_C_NOT_ALL_PRECOPY

Not all source devices are in the Precopy state.

74 CLI_C_NONE_PRECOPY


Precopy state.

75 CLI_C_NOT_ALL_PRECOPY_CYCLED

Not all source devices have completed one precopy cycle.

76 CLI_C_NONE_PRECOPY_CYCLED

No source devices have completed a precopy cycle.

EXAMPLES

To create the device group ProdDB as a REGULAR device group, enter: symdg create ProdDB


symclone 205


To define device group ProdDB as the default device group, enter: setenv SYMCLI_DG ProdDB

To add the standard device /dev/rdsk/c1t1d1s2 to device group ProdDB and name it act1, enter: symdg add pd c1t1d1s2 act1

To associate the BCV device /dev/rdsk/c2t0d2s2 to device group ProdD and name it mybcv1, enter: symbcv associate pd c2t0d2s2 mybcv1

To create a clone copy of the source device act1 in group

ProdDB with a specified target device (associated with the group), enter: symclone create act1 bcv ld mybcv1 -copy symclone activate act1 bcv ld mybcv1

To wait until the BCV pair is fully copied, polling every

30 seconds, enter: symclone -i 30 verify act1

To terminate the device act1 in group ProdDB, enter: symclone terminate act1 bcv ld mybcv1

To query information about all paired devices in device group ProdDB, enter: symclone query


EMC Solutions Enabler CLI Command Reference

symclone

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symclone

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents