EMC Solutions Enabler CLI Command Reference

Chapter 1: SYMCLI Commands

symsnap

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

SYNOPSIS symsnap -h symsnap -g <DgName> [-v] [-noprompt] [-i <Interval>]

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

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

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

[-svp <PoolName> | -duplicate] [-concurrent]

[<LdevName> [VDEV pd <PdevName>]...|

<LdevName> [VDEV dev <SymDevName>]...|

<LdevName> [VDEV ld <LDevName>]...] activate [-consistent [-both_sides]]

[-concurrent] [-duplicate]

[-preaction <ScriptFile>]

[-postaction <ScriptFile>]

[-not_ready] [-skip]



<LdevName> [VDEV ld <LDevName>]...] duplicate [-consistent] [-exact] [-concurrent]






<LdevName> [VDEV ld <LDevName>]...] recreate [-skip] [-concurrent]

symsnap 723




<LdevName> [VDEV ld <LDevName>]...] terminate [-symforce] [-skip] [-restored]

[-duplicate]



<LdevName> [VDEV ld <LDevName>]...]

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

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

<LdevName> [SYM ld <LDevName>]...]

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

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

<LdevName> [BCV ld <LDevName>]...] establish [-full] [-exact] [-svp <poolname>]

[-consistent [-both_sides]] [-concurrent]






<LdevName> [VDEV ld <LDevName>]...] restore [-full] [-not_ready]



<LdevName> [VDEV ld <LDevName>]...] symsnap -g <DgName> [-offline] [-i <Interval>] [-c <Count>]

[-bcv | -rdf | -rbcv | -hop2] query [<LdevName> [<LdevName>...]] [-multi]

[-restore | -changed] [-attach] [-pools] [-summary] verify [-created | -copied | -copyonwrite |

724 EMC Solutions Enabler CLICommand Reference

-restinprog | -restored | -failed | -recreated]

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









<LdevName> [BCV ld <LDevName>]...] symsnap -g <DgName> [-v] [-noprompt] [-i <Interval>]

[-c <Count>]

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



<LdevName> [VDEV ld <LDevName>]...] detach



<LdevName> [VDEV ld <LDevName>]...] symsnap -cg <CgName> [-v] [-noprompt] [-i <Interval>]

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

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

-rdfg <SymmID>:<GrpNum>[,<GrpNum>,...]|<all>[,...] | name:<RDFName>[,<RDFName>,...]>] create [-exact] [-skip]

[-svp <PoolName> | -duplicate] [-concurrent]





symsnap 725

Chapter 1: SYMCLI Commands activate [-consistent [-both_sides]]



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

[-duplicate]



<LdevName> [VDEV ld <LDevName>]...] duplicate [-consistent] [-exact]






<LdevName> [VDEV ld <LDevName>]...] recreate [-skip] [-concurrent]



<LdevName> [VDEV ld <LDevName>]...] terminate [-symforce] [-skip] [-restored]

[-duplicate]









<LdevName> [BCV ld <LDevName>]...] establish [-full] [-exact] [-svp <poolname>]

[-consistent [-both_sides]]







<LdevName> [VDEV ld <LDevName>]...] restore [-full] [-not_ready]



<LdevName> [VDEV ld <LDevName>]...] symsnap -cg <CgName> [-offline] [-i <Interval>]

[-c <Count>]

[-bcv | -rdf | -rbcv | -hop2] [-sid <SymmID> |

-rdfg <SymmID>:<GrpNum>[,<GrpNum>,...]|<all>[,...] | name:<RDFName>[,<RDFName>,...]>] query [-multi] [-restore] [-attach] [-sid <SymmID>]

[-changed] [-pools] [-summary]

[<LdevName> [<LdevName>...]] verify [-created | -copied | -copyonwrite |


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









<LdevName> [BCV ld <LDevName>]...] symsnap -cg <CgName> [-v] [-noprompt] [-i <Interval>]

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


symsnap 727


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

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



<LdevName> [VDEV ld <LDevName>]...] detach



<LdevName> [VDEV ld <LDevName>]...] symsnap -sid <SymmID> <-file <DeviceFileName> [-noprompt] |

-noprompt 'redirect stdin'> [-v] [-force]

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

[-preserveTGTLocks -lockid <LockNum>] [-star] create [-skip] [-svp <PoolName> | -duplicate] activate [-consistent] [-duplicate]

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

[-not_ready] [-skip] duplicate [-consistent]


[-not_ready] [-skip] recreate [-skip] terminate [-symforce] [-skip] [-restored] [-duplicate] establish [-full] [-svp <PoolName>] [-consistent]




restore [-full] [-not_ready] symsnap -sid <SymmID> <-file <DeviceFileName> |

'redirect stdin'>

[-i <Interval>] [-c <Count>] query [-multi] [-restore] [-attach] [-pools] [-changed]

[-summary] verify [-created | -copied | -copyonwrite |


[-force] [-summary] symsnap -sid <SymmID> <-file <DeviceFileName> [-noprompt] |

-noprompt 'redirect stdin'> [-v]

[-i <Interval>] [-c <Count>] attach detach symsnap [-sid <SymmID>] [-i <Interval>] [-c <Count>]

[-offline] list

DESCRIPTION

The symsnap command performs snap operations on a device group, composite group, devices within the group, or on devices in a device file.

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

You can perform all of these operations on a group or


symsnap 729

Chapter 1: SYMCLI Commands individual device basis.

Before you can create a copy session between a target device and a source device, the target device must be associated with 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 Copy on

Write. If the source device is completely written to, the state changes to Copied.

attach When a device create is issued, attaches a virtual device (VDEV) target to a source device as the preferred target device for pairing.

create Creates an internal snap session with the devices that are in the device group with one or more target devices that are associated with the group.

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

When the operation completes, the state changes to Created.

detach Detaches a VDEV target device from the source device so that it is no longer the preferred target device of the source device.


duplicate Creates and activates a duplicate snap session in a single operation. This is equivalent to performing create -duplicate followed by activate -duplicate.

establish Creates and activates an internal snap 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 snap sessions.

query Returns snap state information about one or all device pairs in a group or device file.

recreate Recreates the snap session on an existing

VDEV. This only applies to sessions that have been activated.

restore Restores a VDEV to another device. After the restore operation, the target of the restore is left in a Ready state unless the

-not_ready option is used.

terminate Terminates (stops) the existing internal copy session between the specified source and target devices in a device group.

verify Verifies, by default, whether one device pair is in the CopyOnWrite state or all device pairs in a group are in the

CopyOnWrite state.


symsnap 731


KEYWORDS

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

ld Indicates a logical device 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).

VDEV Specifies a Symmetrix virtual device.

OPTIONS

-attach Displays target attachment information for the standard device(s) in the device group.

-bcv Uses BCV devices as the source devices and VDEV devices as the target devices. You can only use this option with device or composite groups.

-both_sides Activates all locally and remotely associated VDEV 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 this option is not specified and an interval (-i) is specified, the command will loop continuously to display or to start the mirroring operation.


-cg Applies a composite group name to the command.

-changed When specified with the query argument, this option shows the number of tracks that were written to either the source device or to the virtual device.

-concurrent When specified with the verify argument, this option verifies the standard device and multiple target devices. When specified with active commands, this option performs the operation on a pair with an additional target device.

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

-copied Verifies that the snap device pair(s) are in the Copied state.

-copyonwrite Verifies that the snap device pair(s) are in the CopyOnWrite state.

-created Verifies that the snap device pair(s) are in the Created state.

-duplicate For create, activate, and terminate actions indicates that the action is to be performed on a VDEV to VDEV pair.

-exact Pairs devices in the exact order in which the source and target devices were added to the device group.

-failed Verifies that the snap device pair(s) are in the Failed state.


symsnap 733


-file Applies a device file to the command. The device file contains device pairs (by device number) listing a pair per each line

(the source device first, a space, and the

VDEV target device last within each line entry). 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 Performs a full restore. This option is used with the restore 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.

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

-multi Applies to a query operation in a


multi-target environment to show all targets that are paired with source devices.

Devices are listed in chronological order.

-noprompt Requests to not return a prompt after you enter a command. The default is to prompt for confirmation.

-not_ready Performs the snap control operation but leaves the target device(s) Not Ready. That is, each target device will be set Not

Ready prior to the operation completing.

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

-pools Used with query to display pool names for each session.

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

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

-preserveTGTLocks

Prevents the action from taking out device locks on the target devices. The target devices must already be locked by the same lock holder ID.

-rbcv Uses the RBCV devices as the source devices and the RVDEV devices as the target devices.

This is used only with device or composite groups.


symsnap 735


-rdf Performs the action on the remote Symmetrix array.

-rdfg This option causes the command to perform 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.

This argument is a comma separated list in the form:

SID:GrpNum,SID:GrpNum,...

or a comma-separated list of predefined names in the form: name:Name,Name,...

GrpNum may be specified as "all" to use all of the RA Groups on a Symmetrix.

-recreated Verifies that the snap device pair(s) are in the Recreated state.

-restinprog Verifies that the snap device pair(s) are in the RestInProg (restore) state.

-restore Shows the VDEV where the snap pair was restored.

-restored Verifies that the snap device pair(s) are in the Restored state.

-sid Supplies the unique Symmetrix ID.

-skip Skips the source locks action. This option will not lock the source devices if all of the specified source devices are either locked or are unlocked.

-star Targets the action at devices in STAR mode.


-summary Shows device state summary.

-svp Filters the list based on the supplied

PoolName.

-symforce Forces the operation to execute when normally it would be rejected. On terminate, it causes the Symmetrix array to stop a snap session. IMPORTANT: Use extreme caution with this option.

-tgt Specifies to use VDEVs associated as TGT devices for snap targets. This uses local

TGT devices, remote RTGT devices, and two hop2TGT devices.

-v Provides a more detailed, verbose listing.

PARAMETERS

CgName Composite group name.

Count Number of iterations to execute before exiting.

DgName Device group name.

DeviceFileName Device Filename.

The device file contains device pairs

(SymDevNames) listing a pair of devices on each line (the source device first, a space, followed by the target device name on each line. Comments are prefixed with #.

GrpNum RDF (RA) group number.

Interval Interval between polls, in seconds.


symsnap 737


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

LockNum Hexadecimal value of the lock holder

ID.

Name Logical name associated with the RDF

(RA) group(s).

PdevName The device physical (host) name for the BCV device, such as /dev/rdsk/c2t0d2s2.

PoolName Name of the SAVE device pool.

ScriptFile Full pathname of a script file to be executed.

SymDevName Symmetrix device name, unique per

Symmetrix array, for the BCV device. For example 01C.

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 snap state.

19 CLI_C_GK_IS_LOCKED

All gatekeepers to the Symmetrix array are


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 symsnap verify

12 CLI_C_NOT_ALL_RESTORED

Not all source devices are in the Restored state.

13 CLI_C_NONE_RESTORED

No source devices are in the

Restored state.

29 CLI_C_NOT_ALL_RESTINPROG

Not all source devices are in the RestInProg state.

30 CLI_C_NONE_RESTINPROG


RestInProg state.

55 CLI_C_NOT_ALL_COPIED

Not all source devices are in the Copied state.

56 CLI_C_NONE_COPIED


Copied state.

60 CLI_C_NOT_ALL_CREATED


symsnap 739


Not all source devices are in the Created state.

61 CLI_C_NONE_CREATED


Created state.

66 CLI_C_NOT_ALL_COPYONWRITE

Not all source devices are in the CopyOnWrite state.

67 CLI_C_NONE_COPYONWRITE


CopyOnWrite state.

EXAMPLES

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

To define the 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 add the VDEV device /dev/rdsk/c2t0d2s2 to device group

ProdDB and name it myvdev1, enter: symdg add pd c2t0d2s2 myvdev1


To create a snap of the source device act1 in group ProdDB with a specified target device (associated with the group), enter: symsnap create act1 vdev ld myvdev1 symsnap activate act1 vdev ld myvdev1

To terminate the device act1 in group ProdDB, enter: symsnap terminate act1 vdev ld myvdev1

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


symsnap 741

EMC Solutions Enabler CLI Command Reference

symsnap

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symsnap

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents