Quick References Symcli CommandsCheatsheet of symcli commands..

Symcli - Know about the version, list of symcli commands ect.. symcli Displays the version of symapi. symcli -v shows the version of symapi and total list of symcli commands with a short description. symcli -env The list of environmental variable that can be set for a SYMCLI session. symcli -def List of currently defined environmental variables .

Symcfg - Discovers or displays Symmetrix configuration information. symcfg discover Scans all the devices in hosts looking for new Symmetrix devices and rebuilds the Symmetrixconfiguration database . symcfg list A brief description of the all connected Symmetrix boxes. symcfg -sid 1234 verify Check whether the SYMAPI database is in sync with the current configuration of array 1234. symcfg list -status Check the configuration and SYMAPI database status of all arrays. symcfg -db Shows the configuration information about the current symapi database. symcfg -sid 1234 remove Remove the array 1234 from symcfg list. symcfg -sid 1234 list -lockn all List all the external locks held in Symmetrix array 1234. symcfg -sid 1234 -lockn 15 release -force Release the lock 15 held on array 1234 . symcfg -sid 1234 list -v Displays detailed information about the Symmetrix Array 1234. symcfg -sid 1234 list -dir all Displays the online status of all directors( Frontend+Backend). symcfg -sid 1234 list -sa all Displays the online status of all Front-end directors. symcfg -sid 1234 list -da all Displays the online status of all Back-end directors. symcfg -sid 1234 list -fa all Displays wwn of all front-end director ports. symcfg -sid 1234 list -fa all -port Displays online and connection status of all front-end director ports. symcfg -sid 1234 list -ra all List all RA ports with details like rdfg number , remote array sid and online status. symcfg -sid 1234 -dir 4a -p 0 list -addr -avail List the LUN information / availability of lun ids on port 4a0 in array 1234 . symcfg -sid 1234 list -rdfg all List details about all the rdf groups in array. symcfg -sid 1234 list -rdfg 3 List details about rdf group 3 . symcfg -sid 1234 list -rdfg all -dynamic List details about all the dynamic rdf groups in array . symcfg -sid 1234 list -rdfg all -static List details about all the static rdf groups in array . symcfg -sid 1234 list memory shows the amount and details of memory configure in the array . symcfg -sid 1234 list -env_data Dispalys the information and status of array's physical components like powersupply units,Fans etc.

Symdev - Performs operations on a Symmetrix device name. symdev -sid 1234 list List all devices in symmetrix 1234. symdev -sid 1234 list -noport List the devices which are not mapped to any ports. symdev -sid 1234 list -noport -meta List all unmapped meta devices . symdev -sid 1234 list -dynamic List all devices whose dyn_rdf attribute set . symdev -sid 1234 list -emulation celerra List all celerra devices . symdev -sid 1234 list -emulation FBA List all FB devices . symdev -sid 1234 list -hotspare Checks whether hotspare invoked in the array . symdev -sid 1234 list -inventory Lists the grouped list of various devices , like RAID-5,2-Way_Mirror,etc..

symdev -sid 1234 show ABC show the detailed information about device ABC. symdev -sid 1234 list -range ABC:ABE -v show the detailed information of devices ABC to ABE. symdev -sid 1234 list -range ABC:ABE -multiport List the devices from ABC:ABE with the mapped FAinformation if they are assigned to more than one FA port. symdev -sid 1234 write_disable ABC -SA all Write disable the device ABC from through all directors. symdev -sid 1234 write_disable ABC -SA 3a -p 0 Write disable the device ABC on FA port 3a:0. symdev -sid 1234 not_ready ABC -SA all Not ready the device ABC from through all directors. symdev -sid 1234 not_ready ABC -SA 3a -p 0 Not ready the device ABC on FA port 3a:0.

Symmaskdb - Initialize back-up, restore and show the contents of the device masking VCMDB. symmaskdb -sid 1234 -dev ABC list assign List the masking details of the dev ABC . symmaskdb -sid 1234 -wwn xxxxxxx list devs List the devices masked to given wwn number . symmaskdb -sid 1234 -awwn hba_alias list devs List the devices masked to given alias hba name .

Symmask - Mask or Unmask the symmetrix devices or list the wwn logins. symmask list hba List HBA details of the host. symmask -sid 1234 -dir 4a -p 0 list logins List out wwns logged through port 4a0 . symmask -sid 1234 list logins -wwn xxx Check whether wwn xxx logged in to any of the FAs on array1234.

symmask -sid 1234 delete -logins -wwn xxx Delete the login history of wwn xxx from all FA logged ports. symmask -sid 1234 refresh Refresh the VCM Data Base after a masking and unmasking operation. symmask -sid 1234 -wwn xxxx -dir 4a -p 0 add devs ABC,ABD Mask the devices ABC and ABD togiven wwn in 1234 arrray .

symmask -sid 1234 -wwn xxxx -dir 4a -p 0 remove devs ABC,ABD Unmask the devices ABC andABD from given wwn in 1234 arrray .

symmask -sid 1234 -wwn xxxx replace yyyy Replace all occurance of wwn xxxx with yyyy in array 1234.

Symdg - Performs various operations on Symmetrix Device Group like creation,deletion and importing. symdg -sid 1234 list List device groups which include the devices from array 1234. symdg create mydg -type rdf1 Create device group mydg of rdf1 type . symdg show mydg Shows members/details of mydg. symdg rename mydg yourdg Renames the mydg to yourdg. symdg -sid 1234 export mydg -f mydgfile.txt Export mydg to file mydgfile.txt. symdg -sid 1234 import mydg -f mydgfile.txt Create mydg from the file mydgfile.txt which created earlierusing export option.

symdg -sid 1234 exportall -f mydgfile.txt Export all device groups created in array 1234 to filemydgfile.txt.

symdg -sid 1234 importall -f mydgfile.txt Create all device groups from the file mydgfile.txt which createdearlier using exportall option.

symdg -sid 1234 -g mydg move DEV002 yourdg Move the device DEV003 from mydg to yourdg( bothDGs must be in same RDFG.

symdg -sid 1234 -g mydg moveall yourdg Move all the devices from mydg to yourdg( both DGs must bein same RDFG.

symdg delete mydg -force Delete device group mydg.

Symld -Performs operations on one or more STD, BCV, TGT or VDEV devices in a device group (DG). symld -g mydg -sid 1234 add dev ABC DEV006 Add the RDF device ABC to device group mydg asDEV006

symld -g mydg remove DEV006 Remove DEV006 form device group mydg.

Symrdf - Performs various SRDF operations symmetrix devices.Also performs dynamic RDF groupcontrols:Adding,modifying or removing a dynamic RDF group. symrdf -sid 1234 -rdfg 3 -type rdf1 -file rdf.txt -g mydg createpair -establish Establish the SRDFrelation between the devices given in the file rdf.txt from array 1234(R1) and remote box according to the rdf group . This command start sync between R1 and R2, and also add these devices after creating the device group mydg. symrdf -sid 1234 -rdfg 3 -file rdf.txt query Query the Devices by using device pair file. symrdf -g mydg set mode acp_disk Set synching mode to Adaptive Copy. symrdf -g mydg query Query device group. symrdf -g mydg split Split the srdf pair for devices given in mydg. symrdf -sid 1234 -rdfg 3 -file rdf.txt deletepair.txt -force Delete the srdf pairing between R1/R2 and return them to stanadard.

Syminq- SCSI Disk and HBA information on the local host. syminq Lists all physical devices attached to local host. syminq hba Shows the HBA details of the local host like HBA Name , WWN etc.. syminq -mapinfo Lists all physical devices with target ports which are mapped.

Symdisk - Displays configuration and status of disks and their hypers within Symmetrix arrays. Groups. symaccess -sid 1234 list List all Initiator,Port and Storage Groups Created for Array 1234 symaccess -sid 1234 list -v List all Initiator,Port and Storage Groups Created for Array 1234 along with relatedMasking Views

symdisk -sid 1234 list List of total disks in the array. symdisk -sid 1234 show 1A:C12 Shows the detailed information like speed and HYPERS of the disk 1A:C12. symdisk -sid 1234 show 1A:C12 -gaps Shows the available space(GAPS) on the disk 1A:C12. symdisk -sid 1234 show 1A:C12 -gaps_only Shows only the available space(GAPS) on the disk 1A:C12. symdisk -sid 1234 list -hotspare List Hotspares configured in the array. symdisk -sid 1234 list -v -spare_info Displays the details of all hotspare in the array. symdisk -sid 1234 list -by_diskgroup Displays all the disks in array by disk groups. symdisk -sid 1234 list -diskg_roup 1 Displays all the disks in disk group 1.

Symaccess - Specifically using for Vmax Allocation to do various operations on Masking view and related

symaccess -sid 1234 list -type storage List all Storage Groups Created for Array 1234 symaccess -sid 1234 list -type initiator List all Initiator Groups Created for Array 1234 symaccess -sid 1234 list -type port List all Port Groups Created for Array 1234 symaccess -sid 1234 list view List masking views Created for Array 1234 with related groups details symaccess -sid 1234 list assignment -dev 9A0:9AF Shows the masking details of devices from 9A0 to9AF

symaccess -sid 1234 -wwn xxxx replace -new_wwn yyyy Replace all occurance of wwn xxxx withyyyy in array 1234

symaccess -sid 1234 list logins -wwn xxxx Check whether wwn xxx logged in to any of the FAs on array1234. sudo symconfigure -sid 2029 -f meta_5571925 commit dirport 8e:0 symaccess -sid 1234 list -type initiator -wwn xxxx Check whether the HBA WWN xxxx is a member of any Initiator Group. symaccess -sid 1234 list -type storage -dev AAA Check whether the HBA WWN xxxx is a member of

any Initiator Group.

symaccess -sid 1234 list no_assignments -dirport 12f:1 Shows the devices are mapped to 12f:1 butnot masked.

symaccess -sid 1234 list -name MyGroup List all groups named MyGroup symaccess -sid 1234 list -name MyGroup -v List all groups named MyGroup and also shows the relatedMasking Views

symaccess -sid 1234 list devinfo -ig MyInitiator List the details of devices assigned to the initiatorgroupMyInitiator

symaccess -sid 1234 show MyStorageGroup -type storage Shows the contents of storage groupMyStorageGroup Created on Array 1234

symaccess -sid 1234 show MyInitiatorGroup -type initiator Shows the contents of initiator groupMyInitiatorGroup Created on Array 1234

symaccess -sid 1234 show MyPortGroup -type port Shows the contents of port group MyPortGroupCreatedon Array 1234

symaccess -sid 1234 show view MyView Shows the contents of view MyView Created on Array 1234 symaccess -sid 1234 -f MyBackup.txt backup Creates a file MyBackup containing all the group and viewinformation currently on the Symmetrix array 1234

symaccess -sid 1234 -f MyBackup.txt restore Restores all the group, view and security information fromthe specified backupup file

symaccess -sid 1234 -type initiator -name Host1 create -wwn 1000000000000001 Creates andinitiator group called Host1 by adding the specified wwn

symaccess -sid 1234 -type initiator -name Host1 rename -new_name Host2 Rename the InitiatorGorup Host1 as Host2

symaccess -sid 1234 -type port -name 3E0_4E0_13E0_14E0 -dirport 3e:0,4e:0,13e:0,10e:0 create Create the portgroup E0_4E0_13E0_14E0 with specified ports symaccess -sid 1234 -type port -name 3E0_4E0_13E0_14E0 rename -new_name 3E1_4E1_13E1_14E1 Rename the Port Gorup 3E0_4E0_13E0_14E0 as 3E1_4E1_13E1_14E1 symaccess -sid 1234 -type storage -name Host1 create devs AAA:AAB Create the storage groupHost1 with specified range of devices

symaccess -sid 1234 -type storage -name Host1 add devs AAA:AAB Create the storage groupHost1 with specified range of devices

symaccess -sid 1234 -type storage -name Host1 remove devs AAA:AAB Remove the deviceAAA to AAB from storage group Host1

symaccess -sid 1234 -type storage -name Host1 remove devs AAA:AAB -unmap Remove thedevice AAA to AAB from storage group Host1 and also unmap from the FAs

symaccess -sid 1234 -type storage -name Host1 rename -new_name Host2 Rename the StorageGorup Host1 as Host2

symaccess -sid 1234 create view -name Host1_Allocation -sg Host1 -pg 3E0_4E0_13E0_14E0 -ig Host1 Create a masking view combined with specified groups symaccess -sid 1234 create view -name Host1_Allocation rename -new_name Host2_Allocation Rename name of view Host1_Allocation as Host2_Allocation symaccess -sid 1234 delete view -name Host1_Allocation Delete view Host1_Allocation. symaccess -sid 1234 delete view -name Host1_Allocation -unmap Delete view Host1_Allocationand also unmap all the device in associated storage group.

SYMCLI BASE Commands

symapierr

- Used to translate SYMAPI error code numbers into

SYMAPI error messages. symaudit symbcv symcfg - List records from a Symmetrix audit log file. - Perform BCV support operations on Symmetrix BCV devices. - Discover or display Symmetrix configuration information. Refresh the host's Symmetrix database file or remove Symmetrix info from the file. Can also be used to view or release a 'hanging' Symmetrix exclusive lock. symchg - Monitor changes to Symmetrix devices or to logical objects stored on Symmetrix devices. symcli - Provides the version number and a brief description of the commands included in the Symmetrix Command Line symdev - Perform operations on a device given the device's Symmetrix name. Can also be used to view Symmetrix device locks. symdg symdisk symdrv symevent symgate symhost - Perform operations on a device group (dg). - Display information about the disks within a Symmetrix. - List DRV devices on a Symmetrix. - Monitor or inspect the history of events within a Symmetrix. - Perform operations on a gatekeeper device. - Display host configuration information and performance statistics. syminq - Issues a SCSI Inquiry command on one or all devices. Interface. symipsec - Administers IPSec encryption on Gigabit Ethernet connections. symlabel - Perform label support operations on a Symmetrix device.

symld symlmf sympd

- Perform operations on a device in a device group (dg). - Registers SYMAPI license keys. - Perform operations on a device given the device's physical name.

symsg symstat

- Perform operations on a storage device group (sg). - Display statistics information about a Symmetrix, a Director, a device group, or a device.

symreturn

- Used for supplying return codes in pre-action and

post-action script files.

SYMCLI CONTROL Commands

symaccess symacl symauth symcg

- Administer Symmetrix Access Logix. - Administer Symmetrix access control information. - Administer Symmetrix user authorization information. - Perform operations on an composite group (cg). - Administer checksum checks when an Oracle database writes

symchksum

data files on Symmetrix devices. symclone - Perform Clone control operations on a device group or on a device within the device group. symconfigure - Perform modifications on the Symmetrix configuration. symconnect - Setup or Modify Symmetrix Connection Security functionality. symfast - Administer Symmetrix FAST (Fully Automated Storage Tiering) policies, associations, and the FAST Controller. symmask symmaskdb - Setup or Modify Symmetrix Device Masking functionality. - Backup, Restore, Initialize or Show the contents of

the device masking database. symmigrate - Migrates the physical disk space associated with a Symmetrix device to a different data protection scheme, or to disks with different performance characteristics. symmir - Perform BCV control operations on a device group or on a device within the device group. symoptmz symqos symrcopy - Perform Symmetrix Optimizer control operations. - Perform Quality of Service operations on Symmetrix Devices. - Perform Symmetrix Rcopy control operations on devices in

a device file. symrdf - Perform RDF control operations on a device group or on a device within the device group. symrecover - Perform automated SRDF session recovery operations. symreplicate - Perform automated, consistent replication of data given a pre-configured SRDF/Timefinder setup. symsan symsnap - List ports and LUNs visible on the SAN - Perform Symmetrix Snap control operations on a device group or on devices in a device file. symstar symtier - Perform SRDF STAR management operations. - Create and manage storage tiers within a Symmetrix.

SYMCLI SRM(Mapping) Commands

symhostfs

- Display information about a host File, Directory,

or host File System. symioctl - Send IO control commands to a specified application.

symlv

- Display information about a volume in Logical Volume Group (vg).

sympart symrdb

- Display partition information about a host device. - Display information about a third-party Relational Database.

symrslv

- Display detailed Logical to Physical mapping information about a logical object stored on Symmetrix devices.

symvg

- Display information about a Logical Volume Group (vg).

SYMCLI optional environmental variables:

SYMCLI_ACCESS_PIN

: Must specify your Access PIN when using either

the COMMIT, PREPARE, RELEASE keywords of SYMACL. If this value is not set then you are prompted for the Access PIN SYMCLI_ASM_CONNECT : When mapping Oracle ASM, this must be set to

connection information for the ASM instance. Format: user/passwd@service SYMCLI_BCV_EST_TYPE : Specifies the BCV pair establish type, that SYMAPI

uses when establishing a BCV pair. Can be set to SINGULAR, SERIAL, or PARALLEL SYMCLI_BCV_DELAY : Specifies the delay in seconds between establish

operations when a SYMCLI_BCV_EST_TYPE of SINGULAR or PARALLEL is specified Delay value can range from 0 to 30 seconds. The default value is 0. SYMCLI_BCV_PAIR_POLICY : Specifies the BCV pair cancel policy, that SYMCLI

uses when establishing a new BCV pair and the maximum number of BCV pairs has been reached. Can be set to CANCEL_OLDEST, CANCEL_NEWEST or DONT_CANCEL. The default is to automatically cancel the oldest BCV pair. SYMCLI_BLOCK_SYMMASK : Can be set to 1 to block the use of symmask and

symmaskdb (compatibility mode) for a Symmetrix with Enginuity 5874. SYMCLI_CG : Can be set as the default composite group name.

SYMCLI_CLONE_COPY_MODE : Specifies the mode in which Clone sessions are created. Can be set to NOCOPY_NODIFF, COPY_NODIFF, PRECOPY_NODIFF, COPY_DIFF, or PRECOPY_DIFF. SYMCLI_CLONE_EMULATION : Specifies whether TimeFinder commands should be mapped to Clone commands by default. Can be set to ENABLED or DISABLED. The default is DISABLED. SYMCLI_CLONE_LARGER_TGT : Can be set to ENABLED to allow the creation of Clone sessions where the target device is larger than the source device. The default is to block this type of operation SYMCLI_CLONE_PAIR_POLICY : Specifies the CLONE terminate policy, that SYMCLI uses when establishing a new clone and the maximum number of clones has been reached. Can be set to TERM_OLDEST or DONT_TERM. The default is DONT_TERM which causes the clone operations to fail. SYMCLI_COMMAND_SCOPE : Sets the scope of the device selection process.

ENABLED limits the operation to the devices within

the scope of the command. DISABLED performs the operation on the devices within the scope of the command plus any additional devices associated by session and/or state. The default is DISABLED. SYMCLI_CONNECT : Can be set to specify the SYMAPI Server connection

information. SYMCLI_CONNECT_TYPE : Can be set to specify the SYMAPI Server connection

type. Valid values are: LOCAL, REMOTE, and REMOTE_CACHED. The default is LOCAL when SYMCLI_CONNECT is not set. When it is set, the default is REMOTE. SYMCLI_CTL_ACCESS : Can be set to either EXCLUSIVE or PARALLEL to

specify how to obtain a lock on the symapi database file before starting a Symmetrix control operation. The default is to obtain an EXCLUSIVE lock. SYMCLI_DB_FILE : Can be set to the host's Symmetrix database pathname. SYMCLI_DG SYMCLI_FILE : Can be set as the default device group name. : Can be set to the default file for various operations. SYMCLI_FULL_PDEVNAME SYMCLI_GENERATOR_FILE : Can be set to 1 to preserve the complete pdevname. : Specifies a file to which to write a log of all

active commands (BCV, SRDF, and Snap). SYMCLI_INQ_DATA_CACHED : Can be set to 1 to use the cached inquiry data SYMCLI_LDEV_NAMING : Can be set to DEFAULT, SYMDEV or PDEV to specify

the naming preference for Logical Device Names. The default is to name devices DEV001, DEV002... for standard devices and BCV001, BCV002.... for BCV devices. SYMCLI_LOCKID : Specifies the lock holder ID for commands that require the lock ID. SYMCLI_LOG : Can be set to specify a non-default logging pathname. SYMCLI_MANPATH : Can be set to specify a non-default location

for the symcli online help files. If set, it should be a complete specification of the path to the directory/folder containing those files. SYMCLI_MAP_PRESERVE_CASE : Can be set to 1 to preserve case of output fields on Windows. SYMCLI_MAX_BCV_PAIRS : By default, SYMCLI allows up to 8 BCV pairs to be

incrementally paired with a standard device. This variable can be used to set a new maximum (other than 8) in the range 1 to 16. SYMCLI_MODE : Can be set to specify compatibility mode for SYMCLI utilities output. Valid modes include 'V55', 'V60', 'V61', 'V62', 'V63', 'V64', 'V65', 'V70' SYMCLI_MULTI_VIRTUAL_SNAP: Specifies if more than 16 Snap sessions can be created on the same SRC device. Can be set to ENABLED or DISABLED. The default is DISABLED.

SYMCLI_NOLOGGING SYMCLI_NOPROMPT SYMCLI_OFFLINE SYMCLI_OSM_VERSION

: Can be set to 1 to disable logging. : Can be set to 1 to disable prompting. : Can be set to 1 for offline access. : Can be set as the version reported by the SYMCLI

OSM SRDF Compatibility Mode. SYMCLI_OUTPUT_MODE : Can be set to specify output mode for SYMCLI

utilities output. Valid modes are limited to 'Standard', 'XML', 'XML_ELEMENT' and 'XML_ATTRIBUTE'. SYMCLI_PDEV_FILE : Can be set to specify the pathname for a pdev

definitions file. These definitions replace the pdev's previously discovered or defined. SYMCLI_RCOPY_COPY_MODE : Specifies the mode in which Rcopy sessions are created. Can be set to COPY_DIFF, NOCOPY_DIFF, COPY_NODIFF, NOCOPY_NODIFF, PRECOPY_DIFF or PRECOPY_NODIFF. SYMCLI_RDB_CONNECT : Can be set as the default relational database

Connection information. Format: user/passwd@service SYMCLI_RDB_NAME SYMCLI_RDB_TYPE : Can be set as the default relational database name. : Can be set as the default relational database type.

SYMCLI_RDFG_CONSISTENCY : Can be set to ENABLED to provide consistency verification on the RDF Group level when performing operations using consistency technology SYMCLI_REMOVE_SYMS : Can be set to 1 to cause discover to remove from

the symapi database, any Symmetrix record and its

dependent devices and device groups, when the symm is no longer reachable. SYMCLI_RETURN_MODE : Prints return code mnemonics and error strings

concluding the execution of SYMCLI commands. Possible values are DEFAULT and FORMATTED. DEFAULT is equivalent to an unset SYMCLI_RETURN_MODE FORMATTED enables the printing of return code mnemonics and error strings. SYMCLI_SCHEMA_NAME : Can be set as the default relational database

schema name. SYMCLI_SID : Can be set as the default Symmetrix ID.

SYMCLI_SKIP_ON_FAILURE : Can be set to 1 to cause discover to skip loading devices from any Symmetrix units when errors are encountered when loading from those units. SYMCLI_SNAP_PAIR_POLICY : Specifies the SNAP terminate policy, that SYMCLI uses when establishing a new snap and the maximum number of snaps has been reached. Can be set to TERM_OLDEST or DONT_TERM. The default is DONT_TERM which causes the snap operations to fail. SYMCLI_SVP SYMCLI_TBS_NAME : Can be set as the default savedev pool name. : Can be set as the default relational database

table space name. SYMCLI_UPPERCASE : Can be set to 1 to convert names that the

user enters to uppercase SYMCLI_VERBOSE : Can be set to 1 to enable verbose mode for SRDF,

BCV, Snap, and Clone control operations. SYMCLI_VG : Can be set as the default logical volume group name. SYMCLI_WAIT_ON_DB : Can be set to 1 to cause the SYMCLI to block

when it needs to exclusively lock the symapi database file. The process will wait until the lock on the database file can be obtained. The default is to NOT wait on the lock. SYMCLI_WAIT_ON_GK : Can be set to 1 to cause the SYMCLI to block

when getting information from the Symmetrix if all GateKeeper devices are currently busy. The process will wait until a GateKeeper becomes available. SYMCLI_XML_SCHEMA : Can be set to specify a URL to the XML Schema

document describing the output of SYMCLI in XML mode. It is advised that the schema is placed in a public location and this variable set to point to it. Without this variable set, no mention of a schema will occur. Note that this setting does nothing in non-XML mode.