QUICK REFERENCE

Solutions Enabler (SYMCLI)

Version 4.2
Quick Reference Card
P/N 300-999-353
Rev A

This quick reference card summarizes the SYMCLI

command set within the following SYMCLI licensed
components:

• Base Commands.................................................... 2
• TimeFinder Commands ....................................... 5
• SRDF Commands.................................................. 6
• Control Commands .............................................. 7
• Mapping Commands ........................................... 8
• SYMCLI Help Command .................................. 10
• Environment Variables....................................... 10
• Referencing Devices and Objects...................... 14
Base Commands Notes

This section decribes the SYMCLI Base commands, which

require an EMC Solutions Enabler Base Component license.
Table 1 lists the Base component commands.

Table 1 Base Component Commands

Command Description

symapisrv Starts or stops the remote SYMAPI server. (Also requires the
SYMAPI Server license.)

symbcv Performs support operations on BCV devices. Possible operations

are:
• Associates one or all BCV devices with an existing device group
• Lists all BCV devices
• Disassociates one or all BCV devices from a device group
• Associates remotely-attached BCV devices with an existing
device group
• Disassociates remotely-attached BCV devices with an existing
device group

symcfg Performs operations on one or more Symmetrix units. Possible

operations are:
• Discovers Symmetrix configuration information
• Displays configuration information for the following directors:
Channel, Disk, ESCON, RDF, SCSI, and Fibre Channel
• Refreshes the host’s Symmetrix database file or removes
Symmetrix information from the database file
• Views or releases a Symmetrix exclusive lock
• Displays attributes of the Symmetrix and host environment
• Lists application registrations and host connections
• Takes RA directors and SA ports offline (and online)

symchg Creates a DeltaMark session for data objects.

Deletes a DeltaMark session.
Marks an object to be monitored.
Lists the marked objects.
Views the marked objects for changes.
Removes the marked object from the symchg database without
session termination.
Generate a report on the amount of change for the specified object
in a specified log file.

symcli Provides brief help or descriptions of all the SYMCLI commands.

2 2 15
 Table 1 Base Component Commands
Referencing Devices and Objects
Command Description
There are a number of different types of names in which to
symdev Performs operations on a device given its Symmetrix device name.
specify a Symmetrix device using the SYMCLI commands: Possible operations are:
PdevName or pd — Indicates a Physical (host) device name • Lists all Symmetrix devices that are configured in one or more
Symmetrix units, which are reachable by this host (locally or
SymDevname or dev — Indicates a Symmetrix device name remotely via SRDF links)
• Shows detailed information about a Symmetrix device
LdevName or ld — Indicates a Logical device name
• Lists all Symmetrix devices that have SCSI reservations
Still, other Symmetrix objects require certain notation to
identify them in the command line. Table 8 lists and describes symdg Performs operations on a device group. Possible operations are:
the various SYMCLI command line notations and conventions • Create a device group
to identify objects. • Delete a device group
• Rename a device group
Table 8 Command Naming Conventions • List information about all device groups
• Show detailed information about a device group
Parameter/Ref. Description Examples
symgate Performs operations on a gatekeeper device. Possible operations
CgName (cg) Consistency group name mycg1 are:
• Lists the currently defined gatekeeper devices
DbName (db) Relational database name HR
• Defines a Symmetrix device as a gatekeeper device by adding it
DgName (dg) Device group name prod_1 to the gatekeeper device list
• Associates a gatekeeper device with a device group
FileName Relational database file name EMP_HIST.dbf • Disassociates a gatekeeper device from a device group
• Undefines a Symmetrix device as a gatekeeper device, which
LdevName (ld) Logical device name, either given at the DEV001
removes it from the gatekeeper list
command line or assigned automatically BCV001
when a device is added to a device group syminq Performs operations on a device given its physical device name.
Possible operations are:
LvolName (lv) Logical volume name logvol1
• Issues a SCSI INQUIRY and/or SCSI READ CAPACITY on one
PdevName (pd) Physical device name /dev/rdsk/ or all devices attached to a host
c2t0d0s2a • Lists Symmetrix standard or BCV devices
SchemaName Relational database schema name SCOTT symlabel Performs device label (signature) definitions on device(s) of a
device group on only Windows NT platforms.
SegmentName Relational database segment name EMP_SEG
symld Performs operations on standard devices of a device group (using
SymDevName Symmetrix device name, unique for each 00C logical device names). Possible operations are:
(dev) Symmetrix unit
• Add devices to a device group
SymmID (sid) Symmetrix unit identifier number 010012392173 • List all devices in a device group
• Remove a device from a device group
TableName Relational database table name EMP • Rename a device in the device group
TblSpName Relational database table space name tbl_space1 • Show detailed information about a device in a device group

VgName Volume group name vol1

a. For Windows NT, the physical device name is of the form:

\\.\physicaldevice2

14 33
 Table 1 Base Component Commands Table 7 Environment Variables (Continued)

Command Description Variable Name Description Default

sympd Performs operations on a device given its physical device name. SYMCLI_RETURN_MOD When set to FORMATTED for UNISYS DEFAULT
Possible operations are: E platforms only, prints return code
• List all Symmetrix devices that are visible to your host mnemonics and error strings following the
• Show detailed information about a Symmetrix device that is execution of each SYMCLI command.
visible to your host DEFAULT disables this feature
• List all Symmetrix devices that are visible to your host and have SYMCLI_SCHEMA_NAM Specifies a relational database schema NULL
SCSI reservations E name (SchemaName)
symstat Returns performance statistics for: SYMCLI_SID Specifies a default Symmetrix ID None
• The entire Symmetrix unit
• One or all directors of a specified type SYMCLI_SKIP_ON_FAILU When set to 1, causes the symcfg discover 0
RE command (which scans all bus-connected
• A device
devices) to skip over any Symmetrix unit
• A device group encountered in an error state. This allows
the command to complete the scan of the
For more information on the Base commands, refer to the EMC remaining units. (Otherwise, the command
Solutions Enabler (SYMCLI) Base Component Product Guide. faults as it fails to complete the interrogation
of all the Symmetrix units.)

SYMCLI_TBS_NAME Specifies a relational database table space NULL

name (TblSpName)

SYMCLI_UPPERCASE When set to 1, specifies that any user input 0

in lowercase is entered as uppercase

SYMCLI_VERBOSE When set to 1, enables the verbose 0

response mode

SYMCLI_VG Specifies a default logical volume group None

name

SYMCLI_WAIT_ON_DB When set to 1, causes the SYMCLI to wait 0

for SYMAPI DB access when locked by
another user. Otherwise, a busy DB will
cause an error

SYMCLI_WAIT_ON_GK When set to 1, Causes the SYMCLI to wait 0

for the retrieval of Symmetrix information
when all gatekeepers are busy. Otherwise,
a busy gatekeeper will cause an error

For more information about these environment variables, see

the EMC Solutions Enabler SYMCLI Base Component Product
Guide.

4 44 4 44 13
 Table 7 Environment Variables (Continued)
TimeFinder Commands
Variable Name Description Default
This section decribes the SYMCLI TimeFinder commands,
SYMCLI_LDEV_NAMING Specifies a default device naming DEFAULT
which require an EMC Solutions Enabler TimeFinder
convention other than logical device names. (LdevNam
Possible values are: DEFAULT, SYMDEV, or ing) Component license.
PDEV. SYMDEV, or PDEV are for Table 2 lists the TimeFinder component commands.
Symmetrix device names or physical device
names respectively. (DEFAULT =
Table 2 TimeFinder Component
LdevNaming)
Commands
SYMCLI_LOG Specifies a single file to be used as the log 0
file where all new entries are appended to Command Description
the file
symioctl Sends I/O control commands to a specified relational database:
SYMCLI_MAX_BCV_PAIR Normally, SYMCLI allows up to 8 BCV 8 • Places objects into hot backup mode:
S device pairs, which can be incrementally • Freezes or thaws I/O to a specifed database application
established with standard devices. The • Issues a checkpoint to the RDBMS
maximum number of pairs can be custom
adjusted from 1 to 16 pairs with this variable • Archives the current log

SYMCLI_MODE Specifies the command output reporting None symmir Performs control operations on BCV device pairs including:
style to be compatible with prior SYMCLI • Establishes (mirror) one or all standard devices in a device
versions. Possible are V32, V40, or V41 group with one or more BCV devices that are associated locally
or remotely with the group. The operation can be a full or
SYMCLI_NOLOGGING When set to 1, disables logging 0 incremental establish
• Restores one or all standard devices in a device group from one
SYMCLI_NOPROMPT When set to 1, disables verification prompts 0 or more BCV devices that are associated locally or remotely with
the group. The operation can be a full or incremental restore.
SYMCLI_OFFLINE When set to 1, disables online access to 0
• Splits one or all BCV devices from the standard device(s) in a
Symmetrix device status (database access
device group
only)
• Returns information about the state of mirroring of one or all
SYMCLI_OSM_VERSION Specifies the version reported by the 4.0.0 BCV device pairs in a device group
SYMCLI OSM SRDF Compatibility mode

SYMCLI_PDEV_FILE The physical device file name to be used in NULL For more information on the TimeFinder commands, refer to
lieu of the SYMAPI database the EMC Solutions Enabler (SYMCLI) TimeFinder
Component Product Guide.
SYMCLI_RDB_CONNECT Specifies a user name, password, and NULL
remote service name for a user’s relational
database account (user/
password@service)

SYMCLI_RDB_NAME Specifies the default relational database NULL

name (DbName)

SYMCLI_RDB_TYPE Specifies a specific type (DbType) of NULL

database. Possible values:
Oracle
Informix
SQL Server
Sybase
MVS DB2

12 55
SRDF Commands Table 7 Environment Variables
This section decribes the SYMCLI SRDF commands, which
Variable Name Description Default
require an EMC Solutions Enabler SRDF Component license.
SYMCLI_BCV_PAIR_POLI Specifies the BCV pair cancel policy that CANCEL_
Table 3 lists the SRDF component commands. CY OLDEST
SYMCLI subsequently uses when
incrementallly establishing a new BCV pair
Table 3 SRDF Component Commands or when the maximum number of BCV pairs
is reached. Possible values:
Command Description CANCEL_OLDEST (the default)
CANCEL_NEWEST
symcg Performs the following control operations on a Symmetrix RDF DONT_CANCEL
consistency groups:
• Creates and deletes consistency groups SYMCLI_CG Specifies a default constency group name None
• Adds and removes devices of a consistency group
SYMCLI_CONNECT Specifies the service name when running NULL
• Shows detailed information about a consistency group
the client server symapisrv
• Enables or disables the consistency state of a consistency
group SYMCLI_CONNECT_TYP Defines the local or remote mode of the NULL
E host or client connection to the Symmetrix.
symioctl Sends I/O control commands to a specified server application: Possible values for the client are:
• Places objects into hot backup mode REMOTE
• Freezes or thaws I/O to a specifed database application Defines a client operation in which all the
• Issues a checkpoint to the RDBMS remote SYMCLI commands are strictly
• Archives the current log executed on the server, and the
Symmetrix database is strictly read and
symrdf • Performs the following control operations on RDF devices: updated remotely
• Establishes (mirror) an RDF pair by initiating a data copy from REMOTE_CACHED
the source (R1) side to the target (R2) side. This operation can Defines a client operation in which the
be a full or incremental establish remote database is modified remotely
• Restores remote mirroring. Initiates a data copy from the target but cached in memory locally. Those
(R2) side to the source (R1) side. This operation can be a full or functions that are control operations or
incremental restore which modify the database are executed
• Splits an RDF pair, which stops mirroring for the RDF pair(s) in a remotely. These modifications to the
device group remote database are then cached locally
• Failover from the source (R1) side to the target (R2) side, LOCAL
switching data processing to the target (R2) side Defines a local connection to the
• Failback from the target (R2) side to the source (R1) side, Symmetrix. (Not used for a client-server
switching data processing to the source (R1) side connection.)
• Updates the source (R1) side after a failover, while the target
(R2) side may still be operational to its local host(s) SYMCLI_CTL_ACCESS Specifies how to obtain a lock on the Exclusive
symapi database file before starting a
Symmetrix control operation. Possible
For more information on the SRDF commands, refer to the values are: Exclusive or Parallel
EMC Solutions Enabler (SYMCLI) SRDF Component Product
Guide. SYMCLI_DB_FILE Specifies the default database file for the symapi_
Symmetrix configuration data db.bin

SYMCLI_DG Specifies a default device group name None

6 6 11
SYMCLI Help Command Control Commands
Table 6 lists the various help options that the symcli command This section decribes the SYMCLI Control commands, which
offers. require an EMC Solutions Enabler Optimzer license.

Table 6 SYMCLI Help Options Table 4 lists the Control component commands.

Command Description Table 4 Control Component Commands

symcli Provides the version number of the installed Symmetrix Command Command Description
Line Interface
symoptmz Performs operations on the Symmetrix Optimizer. Possible
symcli -h Describes how to use the symcli command operations are:
• Displays a list of information about all Symmetrix devices that
symcli -v Displays the Symmetrix Command Line Interface commands and a are configured in one or more Symmetrix units connected to this
brief description of each command host
• Shows specific information about the current Optimizer
symcli -env Displays a list of the environment variables that can be set for a parameters
SYMCLI session
• Enables the Optimizer algorithm processing
symcli -def Displays a list of the environment variables that are set for the • Disables the Optimizer algorithm processing
current SYMCLI session • Sets the values of the parameters that control the Optimizer
algorithm

symqos Invokes quality of service controls on certain devices. Possible

operations are:
• Displays a list of quality of service priorities assigned to devices
Environment Variables and mirrors
• Sets the values and parameters for QOS priorities on the
SYMCLI provides a group of environment variables that can be devices and mirrors
preset to streamline and expedite your command line session. • Queries the QOS copy priorities for members of a specified
Table 7 lists and describes the environment variables that are group
supported. • Lists the LRU cache assignments
• Sets the LRU cache assignments to a device or device group
These environment variables can be preset to be default settings
for your given session.
For more information on the Control commands, refer to the
To see what environment variables can be set, enter: EMC Solutions Enabler (SYMCLI) Control Component Product
Guide.
symcli -env

To see what environment variables you have set, enter:

symcli -def

10 77
 Table 5 Mapping Component Commands
Mapping Commands (Continued)

This section decribes the SYMCLI Mapping commands, which Command Description
require an EMC Solutions Enabler Mapping Solution license.
symrslv Displays logical to phycical mapping about a logical object:
Table 5 lists the Mapping component commands. • Displays logical to physical mapping information about any
physical device
Table 5 Mapping Component Commands • Displays logical to physical mapping information about a logical
volume
• Displays logical to physical mapping information about a regular
Command Description host file or a Symmetrix file
• Displays logical to physical mapping information about a
symchksum Enables or disables Symmetrix checksum operations on the directory
RDBMS table space devices or on a Symmetrix device.
• Displays logical to physical mapping information about a host file
Lists all devices that have database checksum checking enabled system
Shows the extents of a specified device that are having checksum
checking performed symvg Displays a list of volume groups defined on your host system by the
(This command needs both the Cache and Mapping solution logical volume manager
licenses.) Displays more detail information about a volume group listing its
logical volumes
symhostfs Displays a list of file systems, files, or directories Translates a logical volume group to a Symmetrix device group
Displays more detail information about a file system or file system Translates a logical volume group to a consistency group
object

symioctl Sends I/O control commands to a specified relational database: For more information on the Mapping commands, refer to the
• Places objects into hot backup mode EMC Solutions Enabler (SYMCLI) Mapping Component Product
• Freezes or thaws I/O to a specifed database application Guide.
• Issues a checkpoint to the RDBMS
• Archives the current log

symlv Displays a list of logical volumes on a specified volume group.

Displays detail information (including extent data) about a logical
volume

symrdb Lists various physical and logical database objects:

• Current relational database instances available
• Tablespaces, files, tables, or schemas of a database
• Files, segments, or tables of a database tablespace or schema
Shows information about a database object:
• Tablespace, file, table, or schema of a database
• File, segment, or a table of a specified tablespace or schema
Translates the devices of a specified database into a device group
or a consistency group

8 8 9