EMC Solutions Enabler CLI Command Reference

symstar

Performs SRDF/Star control operations on a composite group.

SYNOPSIS symstar -h symstar show <CgName> [-detail] symstar list [-c <Count>] [-i <Interval>]

[-full] [-offline] [-local] symstar -cg <CgName> [-noprompt] [-i <Interval>]

[-c <Count>] [-wkload <SiteName>]

[-opmode <concurrent | cascaded>] cleanup -site <SiteName> [-force] [-v] configure -add recovery_rdf_pairs configure -reset rdf_mode connect -site <SiteName> [-force] [-v] [-full]

[-keep_data <SiteName> [-remote]] disable [-force] [-v] disconnect -site <SiteName> [-force] [-trip] [-v] enable [-force] [-v] halt [-reset] [-force] [-v] isolate -site <SiteName> [-force] [-v] protect -site <SiteName> [-force] [-v]

Chapter 1: SYMCLI Commands

symstar 765

Chapter 1: SYMCLI Commands query [-detail] [-offline] reconfigure -path <SrcSiteName>:<TgtSiteName>

-site <TgtSiteName>

[-remove <SrcSiteName>:<TgtSiteName>]

[-full] [-reset] [-force] [-v] recover [-force] reset -site <SiteName> [-force] [-v] switch -site <SiteName> [-keep_data <SiteName>] [-force]

[-full] [-v] unprotect -site <SiteName> [-force] [-v] symstar -cg <CgName> [-i <Interval>] [-c <Count>]

[-noprompt] verify -site <SiteName> -connected | -disconnected |

-halted | -haltfail | -haltstarted | -isolated |

-pathfail [-cleanreq] | -pathfailinprog | -protected verify -protected | -tripped | -trip_inprogress |

-unprotected symstar -cg <CgName> [-noprompt] buildcg -site <SiteName> [-update] setup -options <OptionsFile> [-distribute]

[-site <SiteName>]

[-opmode <concurrent | cascaded>] setup -options <OptionsFile> -reload_options

766 EMC Solutions Enabler CLICommand Reference

setup -remove [-force] symstar -cg <CgName> [-i <Interval>] [-c <Count>]

[-noprompt] [-v]

-sid <SymmID>

-devs <<SymDevStart>:<SymDevEnd> | <SymDevName>

[,<<SymDevStart>:<SymDevEnd> | <SymDevName>>...]> |

-file <FileName>

-stg_rdfg <GrpNum>[,<GrpNum>]

-cg_rdfg <CgGrpNum>[,<CgGrpNum>]

[-stg_r21_rdfg <R21GrpNum> -cg_r21_rdfg <CgR21GrpNum>] modifycg -add [-force] modifycg -remove

DESCRIPTION

The symstar command provides query and composite control operations to manage an SRDF/Star environment.

ARGUMENTS buildcg Reads the internal definition for the

SRDF/Star configuration and creates the matching host composite group (CG).

cleanup Cleans up stale information after a disaster failure (loss of WorkloadSite).

configure Changes the SRDF configuration.

connect Makes an SRDF connection and starts the data flow.

disable Disables SRDF/Star consistency protection.


symstar 767

Chapter 1: SYMCLI Commands disconnect Suspends the SRDF data flow.

enable Enables SRDF/Star consistency protection.

halt Write disables devices and synchronizes

SRDF data to remote sites.

isolate Isolates the SyncTargetSite or AsyncTargetSite from the SRDF/Star replication. The RDF2 devices of the isolated site are made read/write enabled to their hosts.

list Displays information about all SRDF/Star configurations with an SRDF/Star definition file that is present either locally or on a locally-attached Symmetrix array.

modifycg Moves devices between the staging area and the

SRDF/Star CG, and updates the CG definition to reflect the changes. protect Waits for SRDF data to be synchronized to the remote SyncTargetSite or AsyncTargetSite and turns on SRDF consistency protection.

query Displays the status of the SRDF/Star configuration.

reconfigure

Changes the SRDF/Star replication data path.

rdf_mode Specifies that the SRDF mode for the connected sites in the CG be reset to adaptive copy. If the CG is configured with an R22 device, the recovery SRDF pairs are also reset to adaptive copy mode.


recover Recovers the failed modify add or modify remove operation and places the SRDF/Star CG into a known state.

reset Cleans up stale information after a transient failure (loss of connectivity) to the

SyncTargetSite or AsyncTargetSite.

setup Reads and validates the host composite group that manages the SRDF/Star replication.

Builds an internal representation of the composite group and saves it in the following directories:

- /var/symapi/config/STAR/def (for UNIX) or

- %Program Files%\\EMC\\SYMAPI\\config\\Star\\ def (for Windows) show Displays the contents of the internal definition for the SRDF/Star configuration.

switch Performs the necessary operations to start the workload at the SyncTargetSite or

AsyncTargetSite.

unprotect Disables SRDF consistency protection for the devices on the SRDF links to the remote


verify Verifies a given site or checks if SRDF/Star is in a desired state.

KEYWORDS cascaded Sets the mode of operation for the SRDF/Star configuration to cascaded.


symstar 769

Chapter 1: SYMCLI Commands concurrent Sets the mode of operation for the SRDF/Star configuration to concurrent.

recovery_rdf_pairs

Configures the existing SRDF/Star configuration to incorporate R22 devices for the recovery SRDF pairs.

OPTIONS

-add Specifies the element of configuration to add.

-c Specifies the number (count) of times to display or to acquire an exclusive lock on the Symmetrix host database, the local

Symmetrix array, and the remote Symmetrix arrays. If this option is not specified and an interval (-i) is specified, the display shows continuously, or until the SRDF/Star operation starts.

-cg Identifies the name of the host composite group.

-cg_rdfg The SRDF group(s) within the SRDF/Star CG in which to add or remove devices. For a concurrent

SRDF/Star CG, two SRDF groups must be specified, separated by a comma. These SRDF groups are associated with the SRDF groups in the

-stg_rdfg option. This association is based on their order in this option and -stg_rdfg.

-cg_r21_rdfg

The SRDF group connecting the R21 and R2

Symmetrix arrays of a cascaded SRDF/Star CG.

It is only valid for operations involving cascaded R1 devices. This SRDF group is


associated with the SRDF group specified in the

-stg_r21_rdfg option.

-cleanreq Verifies the site is in the pathfail state and needs cleaning.

-connected Verifies the site is in the connected state.

-detail Includes extended information in the output when used with the query and show commands.

-devs Specifies the ranges of Symmetrix devices to add or remove.

-disconnected

Verifies the site is in the disconnected state.

-distribute

Performs an automatic SRDF/Star definition file distribution. This form of setup does not disrupt an active protected SRDF/Star setup.

-file Specifies the filename containing the list of devices to act upon. Only the SymDevName specified in the first column of each line is used.

-force Allows the action to proceed even if the

SRDF/Star environment is not currently in the proper state for that action. When used with the switch action, this lets you specify the -keep_data SiteName option if the current state of that site's data is not consistent. When used with the setup -remove action, this removes all SRDF/Star metadata


symstar 771

Chapter 1: SYMCLI Commands associated with the SRDF/Star CG, even when the

CG is not defined in the symapi database.

-full Used by reconfigure, switch, and connect.

Performs a full SRDF resynchronization if

SRDF incremental resync is not available.

Used by the list action to display full names instead of abbreviations.

-h Provides brief, online help information.

-halted Verifies the site is in the halted state.

-haltfail Verifies the site is in the haltfail state.

-haltstarted

Verifies the site is in the haltstarted state.

-i Specifies the repeat interval in seconds to display or to acquire an exclusive lock on the Symmetrix host database, the local

Symmetrix array, and the remote Symmetrix arrays.

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.

-isolated Verifies the site is in the isolated state.

-keep_data Identifies which site's data is retained when used with the switch and connect action.


If you switch to the SyncTargetSite and choose to keep the data of the AsyncTargetSite, the

SRDF devices are reconfigured to make a new

R1->R2 pairing. For the connect action, an SRDF establish or restore operation is performed, depending on which site's data is retained. By default, the workload site data is retained.

-local Lists only the locally-defined CGs. Available only for the list action.

-noprompt Requests no prompt before performing action.

-offline Obtains data from the configuration database on the host. No connections are made to any Symmetrix arrays. Available only for query and list actions.

-opmode Specifies the mode of operation

(concurrent or cascaded).

-options Identifies the name of the file containing the options to use for this SRDF/Star configuration.

-path Specifies the sites on which the new SRDF pairs are created when the reconfigure action is issued.

-pathfail Verifies the site is in the pathfail state.

-pathfailinprog

Verifies the site in in the pathfailinprog state.

-protected Verifies the site is in the protected


symstar 773

Chapter 1: SYMCLI Commands state. If -site is not specified, verifies that SRDF/Star is in the protected state.

-reload_options

Reads the specified options file to update the SRDF/Star definition file when using the setup action. Do not change any

SITE_NAME values with this option.

-remote Indicates the remote data copy flag. Used with the connect action when keeping remote data and the concurrent link is ready. Data is also copied to the concurrent SRDF mirror. Not required if the concurrent link is suspended.

-remove For the reconfigure action, specifies the sites on which the SRDF pairs are removed.

For the setup action, specifies that all

SRDF/Star mode settings for all SRDF groups be set to off if the CG is defined in the symapi database, and to remove all

SRDF/Star metadata associated with the group.

For the modifycg action, indicated to remove the specified devices from the SRDF/Star CG to the staging area.

-reset Performs a reset action on the path when the reconfigure action is issued. When used with the halt action, allows the application to be restarted at the same site after the halt command has completed or failed. When used with the configure action, specifies the element of the reset operation.

-sid Specifies the unique Symmetrix ID.


-site Specifies the SiteName to apply the given action.

-stg_r21_rdfg

For modifycg operations, indicates the SRDF group comprising the staging area at the R21 Symmetrix array when the configuration is cascaded. It is required for an add or remove operation when the setup is cascaded. This SRDF group is associated with the SRDF group in the

-cg_r21_rdfg option.

-stg_rdfg For the modifycg operations, indicates the

SRDF group(s) comprising the staging area. For a concurrent CG, two groups must be specified, separated by a comma. These SRDF groups are associated with the SRDF groups in the

-cg_rdfg option. This association is based on their order in this option and -cg_rdfg.

-trip Transitions the site to pathfail state when used with disconnect action.

-tripped Verifies SRDF/Star is in the tripped state.

-trip_inprogress

Verifies SRDF/Star is in the trip_inprogress state.

-unprotected

Verifies the site is in the unprotected state. If -site is not specified, verifies

SRDF/Star is in the unprotected state.

-update Allows the updating of the existing host composite group from the STAR definition file.


symstar 775


-v Provides a more detailed, verbose listing.

-wkload Specifies the current workload site name if symstar fails to determine the current workload site name.

PARAMETERS

CgGrpNum The SRDF (RA) group number in the CG.

CgName The name of the host composite group.

Count The number of times (count) to repeat.

FileName The name of the file that contains a list. Only the SymDevName specified on the first column of each line is used.

GrpNum The SRDF (RA) group number.

Interval The repeat interval in seconds.

OptionsFile The name of a file containing the symstar options.

R21GrpNum The SRDF (RA) group number of the R1 mirror of the R21 device.

SiteName The user-specified name for the


SrcSiteName The name of the source (R1) site in a path.

SymDevEnd The last Symmetrix device name in a sequence, such as 00B6.

SymDevName The Symmetrix device name , unique per


Symmetrix array, such as 001C.

SymDevStart The first Symmetrix device name in a sequence, such as 001C.

SymmID The 12-digit ID of the Symmetrix array.

TgtSiteName The name of the target (R2) site in a path.

RETURN CODES

Code # Code Symbol

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

0 CLI_C_SUCCESS

The action was successful.

1 CLI_C_FAIL

The action was unsuccessful.

18 CLI_C_ALREADY_IN_STATE

The system is already in the desired state.

22 CLI_C_NEED_FORCE_TO_PROCEED

The system is not in the proper state to execute this procedure. Use -force to execute this procedure anyway.

90 CLI_C_NONE_VERIFIED

The system is not in desired state.

191 CLI_C_FEATURE_NOT_AVAILABLE

The feature is not available in this version.

FILES

The options file is created by the user. It must conform to the following syntax:


symstar 777


SYMCLI_STAR_WORKLOAD_SITE_NAME = <Wname>

SYMCLI_STAR_SYNCTARGET_SITE_NAME = <Sname>

SYMCLI_STAR_ASYNCTARGET_SITE_NAME = <Aname>

SYMCLI_STAR_ADAPTIVE_COPY_TRACKS = <Numtracks>

SYMCLI_STAR_ACTION_TIMEOUT = <Numseconds>

SYMCLI_STAR_TERM_SDDF = <YES/NO>

SYMCLI_STAR_ALLOW_CASCADED_CONFIGURATION = <YES/NO>

SYMCLI_STAR_SYNCTARGET_RDF_MODE = <ACP/SYNC>

SYMCLI_STAR_ASYNCTARGET_RDF_MODE = <ACP/ASYNC>

The supported options include:

Option Description

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

SYMCLI_STAR_WORKLOAD_SITE_NAME

Value: <Wname>

<Wname> is the name for the site where the concurrent RDF1 devices are local.

The default value is SITE_A.

SYMCLI_STAR_SYNCTARGET_SITE_NAME

Value: <Sname>

<Sname> is the name for the synchronous target site. It must match the name assigned to the SRDF/S RDF groups in the composite group.

The default value is SITE_B.

SYMCLI_STAR_ASYNCTARGET_SITE_NAME

Value: <Aname>

<Aname> is the name for the asynchronous target site. It must


match the name assigned to the SRDF/A

RDF groups in the composite group.

The default value is SITE_C.

SYMCLI_STAR_ADAPTIVE_COPY_TRACKS

Value: <Numtracks>

<Numtracks> is the number of invalid tracks to reach before transitioning out of adaptive copy mode and setting the mode to SRDF/S or SRDF/A.

The default value is 30000.

SYMCLI_STAR_ACTION_TIMEOUT

Value: <Numseconds>

<Numseconds> is the maximum number of seconds to wait to achieve consistency protection or R2_Recoverable STAR protection, or for devices to reach

<Numtracks> invalid tracks while syncing RDF devices.

The default value is 18000.

SYMCLI_STAR_TERM_SDDF

Allowed values: YES or NO

If set to YES, SDDF sessions are terminated on both the SYNC and ASYNC target sites at the time of symstar disable.

If set to NO, SDDF sessions on both

SYNC and ASYNC target sites are not


symstar 779

Chapter 1: SYMCLI Commands terminated (deactivated instead) at the time of symstar disable.

SYMCLI_STAR_ALLOW_CASCADED_CONFIGURATION

Allowed values: YES or NO

If set to YES, cascaded configurations are allowed.

In cascaded configurations, the data flows from the workload site to the synchronous target site and then to the asynchronous target site.

SYMCLI_STAR_SYNCTARGET_RDF_MODE

Valid values: ACP or SYNC

If set to ACP, the SRDF mode between the workload site and the synchronous target site is transitioned to adaptive copy mode at the end of

'symstar unprotect'. If set to SYNC, the SRDF mode between the workload site and synchronous target site remains in synchronous mode at the end of 'symstar unprotect'.

The default value is ACP.

SYMCLI_STAR_ASYNCTARGET_RDF_MODE

Valid values: ACP or ASYNC

If set to ACP, the SRDF mode between the workload site and the asynchronous target site is transitioned to adaptive copy mode at the end of

'symstar unprotect'. If set to ASYNC,


the SRDF mode between the workload site and asynchronous target site remains in asynchronous mode at the end of 'symstar unprotect'.

The default value is ACP.

EXAMPLES

To create the composite group for SRDF/Star protection, enter: symcg create MyStar -type RDF1 -rdf_consistency

To add the concurrent SRDF devices to the MyStar composite group where the SRDF/A group is 30 and the SRDF/A group is 31, enter: symcg -cg MyStar addall dev -sid 63 -rdfg 31

To assign the SRDF group names in the MyStar composite group, enter: symcg -cg MyStar -rdfg 63:30 set -name synctgt symcg -cg MyStar -rdfg 63:31 set -name asynctgt

To assign the recovery SRDF groups in the MyStar composite group, enter: symcg -cg MyStar -rdfg 63:30 set -recovery_rdfg 20 symcg -cg MyStar -rdfg 63:31 set -recovery_rdfg 21

To create the SRDF/Star definition file, enter: symstar -cg MyStar setup -option options.file

To connect the synchronous target site, enter:


symstar 781

Chapter 1: SYMCLI Commands symstar -cg MyStar connect -site synctgt

To protect the synchronous target site, enter: symstar -cg MyStar protect -site synctgt

To connect the asynchronous target site, enter: symstar -cg MyStar connect -site asynctgt

To protect the asynchronous target site, enter: symstar -cg MyStar protect -site asynctgt

To enable the SRDF/Star protection for the composite group, enter: symstar -cg MyStar enable

To verify synctgt is in a protected state, enter: symstar -cg MyStar verify -site synctgt -protected

To change the flow of data from: workload site to synctgt and workload site to asynctgt to: workload site to synctgt to asynctgt,

Enter: symstar -cg MyStar reconfigure -path synctgt:asynctgt

-site asynctgt


To change the flow of data from: workload site to synctgt to asynctgt.

to: workload site to synctgt and workload site to asynctgt,

Enter: symstar -cg MyStar reconfigure -path workload:asynctgt

-site asynctgt


symstar 783

EMC Solutions Enabler CLI Command Reference

symstar

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symstar

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents