EMC Solutions Enabler CLI Command Reference

symrecover

Provides the user interface to the

EMC SRDF Automated Recovery tool.

SYNOPSIS symrecover [-h] symrecover [-env | -version] symrecover start -g <DgName> | -cg <CgName>

-mode SYNC | ASYNC [-out <LogPath>]

[-options <OptionFile>]

DESCRIPTION

The symrecover command provides the user interface to the EMC SRDF Automated Recovery tool. The various compound actions perform the necessary commands, in the proper order, to allow you to monitor and restart a single

EMC SRDF/S or SRDF/A session.

This command can be run from either the R1 or the R2 side as long as the group being monitored is fully viewable from the host. Either -g or -cg must be specified.

PATH is a REQUIRED environment variable setting.

The fully qualified path to the PERL binary directory that is shipped with Solutions Enabler must be added to the head of default system path. Optionally the monitor can be invoked by fully qualifying the perl executable.

ARGUMENTS start Starts the recovery session.

Chapter 1: SYMCLI Commands

symrecover 637


OPTIONS

-cg Specifies the name of the composite group to monitor.

-env Displays the default option settings.

All other coded options are ignored.

This option is ignored if coded in the options file.

-g Specifies the name of the device group to monitor.

-h Provides brief, online help information.

-mode Specifies the type of SRDF session to monitor. Valid values are SYNC and ASYNC.

There is no default and this option must be specified.

-options The fully-qualified file containing these program options.

Double quote characters are allowed to frame the option's value but are not required. If quotes are used, leading and trailing blanks are preserved in all enclosed values.

Options with no CLI value can be assigned 0 for disable and 1 for enable. Comments are allowed using the "#" character anywhere on the line. Blank lines are permitted.

'g' and 'cg' can not be placed in the options file.

638 EMC Solutions Enabler CLICommand Reference


Option names are case sensitive.

Example:

#

# Option file for cg TestCG01

# monitor_cycle_time = 180

# Changing monitor

# cycle time from 300

# (default) to 180

# seconds

# Currently installed symcli location symcli_dir =

#

C:\\program files\\tps\\emc\\symcli\\bin monitor_only = 1

#

-out Specifies an alternate fully-qualified directory location to use for the log file.

If the output directory cannot be created or written to, a warning message is issued and monitoring continues, and messages are displayed on the console but are not written to the log file.

The default is to the log in the current working directory.

-version Returns the installed symrecover version.

This option is ignored if coded in the options file.

PARAMETERS

symrecover 639


CgName Specifies the user-defined composite group name.

DgName Specifies the user-defined device group name.

LogPath Defines an alternate directory location for the log file directory. Overrides the default directory.

OptionFile Specifies the filename and path of the internal log file. If an alternate log file name is specified when starting a symreplicate session, the same log file name must be specified when issuing the stop, restart, query, show, and delete commands for the same symreplicate session.

RETURN CODES

Code # Code Symbol

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

0 CLI_C_SUCCESS

1 CLI_C_FAIL

FILES

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

#Comment cascaded_monitor_both_hops=[0 | 1] email_server= <e_srvr_addr> /

[email_addr_target= <e_addr1, e_addr2, ..., ...>


[email_subject= <err_subject_string>]

[email_log_level= <severity_level>]

[email_frequency= <email_frequency>] goldcopy_location= <location> goldcopy_type= <copytype> goldcopy_state_startup= <copystate> goldcopy_state_post_restart= <copystate> goldcopy_resync_interval= <resynctime> goldcopy_max_wait= <maxwaittime> goldcopy_clone_list= <list> log_level= <severity_level> monitor_cycle_time= <cyc_time> monitor_only=[0 | 1] | run_once=[0 | 1]

| run_until_first_failure=[0 | 1] rdfg <concur_def> restart_adcopy_resynch_threshold= <tracks> restart_attempt_pause= <time> restart_delay= <time> restart_group_on_startup restart_max_attempts= <attempts> restart_max_wait_adcopy_sync= <time> restart_max_wait_state_change= <statetime> restart_max_wait_warn_interval= <warntime> restart_rdfa_min_cycle_warn_interval= <cyclewarntime> restart_rdfa_min_cycle_warn_value= <warntime> restart_state_syncinprog_wait_time= <time> restart_state_transmit_warn_interval= <time> restart_state_transmit_wait_time= <transwaittime> restart_sync_type= <synctype> restart_window= <time>

# End of Option File script


symrecover 641


The following are the descriptions of the various option parameters available within an option file:

Option Description

---------------- -------------------cascaded_monitor_both_hops

Values: 0 or 1

Specifies to monitor both hops of a cascaded SRDF configuration. This option is not enabled by default.

This option requires the R1->R21 session to be in SYNC mode and R21->R2 session to be in ASYNC mode.

Note: If this option is enabled, the -mode option is ignored.

email_addr_source Value: an email address, e_addr1

Specifies the email address to use in the 'from' field of all emails sent by symrecover. No checks are done about the validity of this email address. If this value is not set, then a default value is generated based on the system's hostname and current user.

email_addr_target Value: a list of valid email addresses, e_addr1,e_addr2, ..., ...

Specifies the email notification address(es) to alert on errors. If any of the email_* options are specified, this option must also be


specified to activate email alerts.

Multiple comma-delimited addresses may be specified.

There is no default value.

email_server Value: e_srvr_addr

Specifies the host target email server.

If any of the email_* options are specified, then this option must also be specified to activate email alerts.

There is no default value.

email_subject Value: err_subject_string

Specifies the email notification subject on errors. The default value is:

SymRecover Alert: Host [HostName]

Group [DgName] email_log_level Value: severity_level

Specifies the severity level desired for the email alert-triggering message.

Possible values are:

Value Meaning

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

0 Off

1 Only errors are reported

2 Errors and Warnings are reported

3 Errors, Warnings, and


symrecover 643


Informational messages are reported

4 All messages are reported including all SYMCLI commands and responses.

Note: For each message that meets the particular logging level requirement, an email is shipped with that message.

It is highly recommended that at most this be set to either a 1 or a 2.

If the required email options

(email_server and email_addr_target) are not specified, then the default value is 0. If they are specified, then the default value is 1.

email_frequency Value: email_frequency

Specifies the email frequency desired.


Value Meaning

--------------------------per_log_msg Email per log msg that meets logging level requirement.

per_monitor_loop Email per monitor loop per_restart Email when error is detected, when session is restarted and finished.

default: per_restart.

goldcopy_location Value: location



Specifies the location of the backup

(gold copy). Possible values are:

Location Meaning

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

NONE No gold copy is desired.

All other goldcopy_* options are ignored.

R2 A gold copy on the R2 side is desired.

ALL A gold copy on the R21 side and R2 side is desired.

The default is R2 and this value is case insensitive.

goldcopy_type Value: copytype

Specifies the type of goldcopy to create on the R2 side. Possible values are: copytype Meaning

-------- --------------none No gold copy is desired.

bcv A BCV gold copy on the R2 side is desired.

clone A Clone gold copy on the R2 will be created.

The default is bcv and this value is

symrecover 645

Chapter 1: SYMCLI Commands not case sensitive.

Note: When bcv copytype is selected,

BCVs must be paired with the R2 devices before starting symrecover.

Note: When clone copytype is selected, target devices must have a clone session with the R2 devices before starting symrecover.

goldcopy_state_startup

Value: copystate

Specifies the desired state of the

R2 BCV gold copy upon routine startup.

Possible values are: copystate Meaning

--------- ------------establish The devices should be established (BCV only).

split The devices should be split

(BCV only).

activated The devices should be activated (Clone only).

created The devices should be in created state

(Clone only).

none The devices should be unchanged.

The default is none and this value is


case insensitive.

Note: If the goldcopy type is BCV and the default state of the BCVs is establish, this may drop an SRDF/A session under certain conditions.

goldcopy_state_post_restart

Value: copystate

Following a successful SRDF/A session, restart or BCV resync, specifies the required state of the R2 gold copy.

Possible values are: copystate Meaning

--------- ------------establish The devices should be left established

(BCV only).

split The devices should be split

(BCV only).

activated The devices should be activated (Clone only).

created The devices should be in created state

(Clone only).

The default is split and this value is case insensitive.

Note: If the goldcopy type is BCV and the default state of the BCVs is establish this drop an SRDF/A session


symrecover 647

Chapter 1: SYMCLI Commands under certain conditions.

goldcopy_max_wait Value: maxwaittime

Specifies the maximum length of time in seconds for the program to wait for a group to finish synchronizing the standard devices with the goldcopies during a restart.

Possible values are 0 to maxint.

The default is 0 which is to wait forever.

goldcopy_clone_list

Value: list

If goldcopy_type is set to CLONE, this option tells symrecover which list within the DG or CG to use to find the

CLONE devices.

Possible values are: list Meaning

--------- ------------tgt Use the TGT list.

bcv Use the BCV list.

goldcopy_resync_interval

Value: resynctime

Defines the amount of time in minutes when the gold copy BCV mirror or clone is automatically resynchronized. If the


goldcopy_state_post_restart is split or activated, the resynchronization causes the BCV mirror to be established and then the split or clone to be recreated and activated. If the goldcopy_state_post_restart is establish, or created then resynchronization, this ensures the BCVs or Clones are in the requested state.

This action only takesplace during non-error periods.

Valid values are 0, and 15 to maxint.

Zero (0) indicates that the mirrors are never to be automatically synchronized outside of error producing events. The default is 0.

Note: If the goldcopy type is BCV, then the act of frequently synchronizing the

R2 BCVs may drop an SRDF/A session under certain conditions.

monitor_cycle_time Value: cycletime

Defines the number of seconds to pause between monitor status scans.

The minimum value is 60 seconds; the maximum is 3600 seconds.

The default value is 300 seconds.

monitor_only Values allowed: 0 or 1


symrecover 649


Specifies whether to monitor only the state of the specified group. No recovery actions are performed.

This option is not enabled by default.

Note: monitor_only, run_once, and run_until_first_failure are mutually exclusive options.

run_once Values allowed: 0 or 1

Specifies whether to check the status of the group once. If the group required recovery actions, it performs them.

Exits after one check.


This option ignores the setting of restart_max_attempts.


run_until_first_failure

Values allowed: 0 or 1

Specifies whether to monitor the group until the first failure occurs, and then exits without performing any recovery action.


This option ignores the setting of


restart_max_attempts.


rdfg Specifies the concurrent RDF definition for the group. This value is taken directly as specified and no data validation is done on it.

Monitoring RDF1 type DG/CG containing concurrent R1 devices or monitoring RDF2 type DG/CG containing concurrent R2 devices requires that the -rdfg option is specified.

This option is not set by default and non-concurrent RDF groups are assumed.

Note: If the group is a composite group and consistency is enabled, then this must be of the "name:" format and this value is case sensitive.

restart_adcopy_resynch_threshold

Value: tracks

Specifies the number of tracks outstanding that, during recovery, will trigger a switch over to SRDF/A.

The default value is 30000.

restart_attempt_pause

Value: time (seconds)


symrecover 651


Specifies the wait time before an attempt is made to restart a failed session to allow for things to settle down. Then after the restart_attempt_pause is complete, symrecover restarts the overall monitor loop.

If there is still a problem, the restart failure count is incremented and a restart is attempted.

Valid values are 30 to 3600 seconds.

The default is 60 seconds.

restart_delay Value: time (seconds)

Specifies the wait time after an attempt is made to restart a failed session and the attempt itself fails.

Valid values are 0 (no delay, immediately restart) to maxint.


restart_group_on_startup

On symrecover startup, if the group being monitored is not initially in a

CONSISTENT state, symrecover, by default, considers that an error occurred and exits.

If this option is specified, symrecover attempts to recover the group on startup.



restart_max_attempts

Value: attempts

Specifies the maximum number of restart attempts to perform within the restart_window interval. After this limit is reached, the program terminates.

The valid range is from 0 to maxint.

The value of 0 means to infinitely attempt.

The default is 5 attempts.

restart_max_wait_adcopy_sync


Specifies the length of time in seconds that, during a restart, the program waits for a group to achieve the restart_adcopy_resync_threshold number of tracks pending.

Valid values are 0 to maxint.

The value of 0 means to infinitely wait.

The default is 0.

restart_max_wait_state_change

Value: statetime (seconds)


symrecover 653


Specifies the length of time in seconds, during a restart, that the program waits for a group to change to a desired state once the change is requested.


The value of 0 means to infinitely wait.

The default is 0.

restart_max_wait_warn_interval

Value: warntime (seconds)

Specifies the length of time in seconds, while waiting for a state change to occur during a restart, for a progress warning message to be displayed.

Valid values are 0 and 30 to maxint.

The value of 0 means to wait forever.


restart_rdfa_min_cycle_warn_interval

Value: cyclewarntime (seconds)

Specifies the length of time in seconds for a warning message to be repetitively displayed when the RDFA minimum cycle time exceeds the restart_rdfa_min_cycle_warn_value parameter.



The default is 600.

restart_rdfa_min_cycle_warn_value

Value: warntime (seconds)

Specifies the maximum value in seconds which a trigger can occur with a warning message, indicating that the

RDFA minimum cycle time has exceeded this value.

Valid values are 0 and 30 to maxint.

The value of 0 means this feature is turned off.

The default is 0.

restart_state_syncinprog_wait_time


Specifies the maximum length of time in seconds, during a group syncinprog state, that a sleep is done before rechecking the group status.



restart_state_transmit_warn_interval


Specifies the interval of time in seconds, while a group remains in a transmit idle state, that a warning message is generated.


symrecover 655


Possible values are 0 to maxint.


restart_state_transmit_wait_time

Value: transwaittime (seconds)

Specifies the maximum length of time in seconds during a group transmit idle state, that a sleep is done before rechecking the group status.



restart_sync_type Value: synctype

Specifies the type of synchronization to use following the detection of a failed

SRDF/A session. Possible values are: synctype Meaning

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

ADCOPY Adaptive copy disk

SYNC Synchronous mode

NONE Intermediate track resynch stage is attempted. A direct re-establish using the existing SRDF session mode is attempted.

The default is ADCOPY.


restart_window Value: time (seconds)

Specifies the length of time in seconds, starting with the first failure, that begins the clock for counting all successive failures.

Any failures that occur within this timespan are considered grouped.

This window is used to determine the maximum number of restarts that are permitted per window of time.

The minimum value is 1800 seconds; the maximum is 86400 seconds.


log_level Value: The desired logging level.


Value Meaning

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

0 Off.

1 Only Errors are reported.

2 Errors and Warnings are reported.

3 Errors, Warnings, and

Informational messages are reported.

4 All messages are reported.


symrecover 657


The default is 3.


EMC Solutions Enabler CLI Command Reference

symrecover

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symrecover

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents