Professional Documents
Culture Documents
Quick Reference
P/N 300-000-873
Rev A05
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.emc.com
Copyright © 2002, 2003, 2004 EMC® Corporation. All rights reserved.
Trademark Information
2 2
Contents
License Matrix..................................................................................... 4
SYMCLI Commands .......................................................................... 6
symacl............................................................................................ 6
symapisrv...................................................................................... 6
symaudit ....................................................................................... 7
symbcv .......................................................................................... 7
symcfg ........................................................................................... 9
symcg........................................................................................... 10
symchg ........................................................................................ 11
symchksum................................................................................. 11
symcli........................................................................................... 12
symclone ..................................................................................... 12
symconfigure.............................................................................. 13
symdev ........................................................................................ 14
symdg .......................................................................................... 15
symdisk ....................................................................................... 15
symdrv ........................................................................................ 16
symerase...................................................................................... 16
symevent ..................................................................................... 16
symgate ....................................................................................... 16
symhost ....................................................................................... 17
symhostfs .................................................................................... 17
syminq ......................................................................................... 17
symioctl ....................................................................................... 18
symlabel ...................................................................................... 18
symld ........................................................................................... 19
symlv ........................................................................................... 20
symmask ..................................................................................... 21
symmaskdb................................................................................. 22
symmir ........................................................................................ 22
symoptmz ................................................................................... 24
sympd.......................................................................................... 25
symqos......................................................................................... 25
symrdb ........................................................................................ 26
symrdf ......................................................................................... 27
symreplicate ............................................................................... 30
symrslv ........................................................................................ 30
symsnap ...................................................................................... 31
symstat ........................................................................................ 33
symvg .......................................................................................... 34
Environment Variables .................................................................... 35
3
License Matrix
This section can be used to determine which SYMCLI commands are
licensed with each Solutions Enabler component.
Table 1 lists the component command licensing:
symacl
symaudit
symbcv
symcfg
symcg
symcli
symdev
symdg
symdisk
Base
symdrv
symevent
symgate
syminq
symlabel
symld
sympd
symqos
symstat
DeltaMark symchg
(Change Tracker)
symmask
Device Masking
symmaskdb
4 4
Table 1 License Matrix (Continued)
symhost
symhostfs
symioctl
Mapping Solution symlv
(SRM)
symrdb
symrslv
symvg
Optimization symoptmz
(Control)
SRDF or symrdf
SRDF/Synchronous
symioctl
symmir
TimeFinder or
TimeFinder/Mirror symioctl
symclone
TimeFinder/Snap or symsnap
EMC Snap
5
SYMCLI Commands
This section provides a quick reference to each SYMCLI command’s
syntax. In addition, it identifies the component license(s) necessary to
run each command and the EMC Solutions Enabler Product Guide to
refer to for additional information.
symacl -h
symacl -unique
Starts or stops an executable image, called the SYMAPI server, which executes
remote SYMAPI routines with the remotely-connected Symmetrix arrays.
symapisrv -h
symapisrv [-background]
start
[-service Servicename] |
[-node Node][-port Port] |
[-address Address][-port Port]
symapisrv
stop
[-service Servicename] |
[-node Node][-port Port] |
[-address Address][-port Port]
6 6
symaudit Component License: Base
Product Guide: Symmetrix Base Management CLI
7
When specifying logical device names:
symbcv -g DgName [-offline] [-force]
[[[-rdf] [-bcv]] | [-rrdf]]
disassociate ld LdevName
move ld LdevName DestDgName [-rename]
When moving or removing all devices:
symbcv -g DgName [-offline] [-force]
[[[-rdf] [-bcv]] | [-rrdf]]
moveall DestDgName [-rename] [-SA <#|ALL>]
[-P #] [-CAP #]
[-N #] [-R1|-NOR1] [-R2|-NOR2]
[-RANGE SymDevStart:SymDevEnd]
rmall [-SA <#|ALL>][-P #] [-CAP #][-N #]
[-R1|-NOR1] [-R2|-NOR2]\
[-RANGE SymDevStart:SymDevEnd]
8 8
symcfg Component License: Base
Product Guide: Symmetrix Base Management CLI
symcfg -h
symcfg
discover [-all | -symmetrix | -clariion]
scan
symcfg
sync [-sid SymmID]
[-rdf | -bcv | -local | -dirsts | -snap |
-cfgmgr]
remove [-sid SymmID] [-noprompt]
release [-sid SymmID] [-noprompt] [-lockn <#>]
[-force]
verify -sid SymmID
9
symcfg list -authorization
add -authorization -host HostName
-username UserName
-password PassWord
update -authorization -host HostName
-username UserName
-password PassWord
delete -authorization -host HostName
-username UserName
symcg -h
symcg
enable
disable
hold
unhold
10 10
symchg Component License: DeltaMark
Product Guide: Symmetrix Change Tracker CLI
Marks areas of Symmetrix disk storage so that objects occupying those areas
can be monitored for changes by the Change Tracker.
symchg -h
symchg
create|delete|mark|remove [-v]
dev SymDevname [-sid SymmID]
-g DgName [ld LdevName] [-bcv]
symchksum -h
enable [-reject_io][-fractured_reject_io]
[-phone_home] [-discard]
[-suppress_feature MagicNumber|NonZeroDba]
disable
validate
verify
11
symcli Component License: Base
Product Guide: Symmetrix Base Management CLI
symclone -h
12 12
symclone -file DeviceFilename |redirect stdin
-sid SymmID [-v] [-force] [-not_ready]
[-i Interval] [-c Count] [-noprompt]
[-preserveTGTLocks -lockid <lock_id>
create [-copy] [-skip]
terminate [-symforce] [-skip] [-not_ready]
activate [-skip] [-preaction Script]
[-postaction Script]
[-vxfs <MountPoint...> |
-ppath <SRCDEVS|PowerPathPdevName...> |
-rdb -dbtype DbType [-db DbName]]]|
[-consistent]
activate
terminate [-symforce] [-skip]
symconfigure -h
13
symdev Component License: Base
Product Guide: Symmetrix Base Management CLI
symdev -h
list -resv
14 14
symdg Component License: Base
Product Guide: Symmetrix Base Management CLI
symdg -h
symdg
list [-inactive]
activate [-noprompt]
activateall [-noprompt]
Reports on the configuration and status of disks and their hypers within
Symmetrix arrays.
symdisk [-h]
15
symdrv Component License: Base
Product Guide: Symmetrix Base Management CLI
symdrv -h
symevent [-h]
symevent [-sid SymmID] [-v] [-warn | -error | -fatal]
monitor [-i Interval] [-c Count]
list [-start <date:time>] [-stop <date:time>]
symgate -h
16 16
symhost Component License: Mapping Solution
Product Guide: Symmetrix SRM CLI
Displays mapping information about file systems, directories, and regular files
that are defined on the host system.
symhostfs -h
syminq [-sym][-bcv][-powerpath][PdevName]
[-symmids][-la | -nocapacity] [-Pdevfile]
[-v [-nocapacity]]
[-copa]
syminq [-hds][PdevName]
[-hids] [-la | -nocapacity]
[-v [-nocapacity]]
syminq [-storworks][PdevName]
[-swids] [-la | -nocapacity]
[-v [-nocapacity]]
17
symioctl Component License: TimeFInder , SRDF, or Mapping
Solution
Product Guide: Symmetrix TimeFinder Family CLI
Symmetrix SRDF Family CLI
Symmetric SRM CLI
Sends I/O control commands to a specified database server application.
symioctl -h
symlabel -h
18 18
symld Component License: Base
Product Guide: Symmetrix Base Management CLI
symld -h
show LdevName
symld -g DgName
[-noprompt] [-bcv|-rbcv|-brbcv|-rrbcv|-vdev]
hold [LdevName [LdevName...]]
unhold [LdevName [LdevName...]]
19
symlv Component License: Mapping Solution
Product Guide: Symmetrix SRM CLI
Displays mapping information about one or more logical volumes that are
defined in a specific logical volume manager’s volume group.
symlv -h
delete LVolName
20 20
symmask Component License: Device Masking
Product Guide: Symmetrix Device Masking CLI
symmask -h
21
symmaskdb Component License: Device Masking
Product Guide: Symmetrix Device Masking CLI
Backs up, restores, initializes, and shows the contents of the device masking
database.
symmaskdb -h
list devs
-wwn wwn |
-awwn awwn |
-iscsi iscsi |
-aiscsi aiscsi |
remove -meta_member
22 22
split [-diff] [-remote] [-bypass] [-not_ready] [-skip]
[-reverse] [-both_sides][-protect][-instant
[-vxfs <MountPoint...> |
-ppath <STDDEVS|PowerPathPdevName...> |
-rdb -dbtype DbType [-db DbName] |
-consistent]]
<[LdevName [BCV pd PdevName]]>…> |
<[LdevName [BCV dev SymDevname]]>…> |
<[LdevName [BCV ld LdevName]]>…>
23
establish [-full] [-protbcvest] [-skip]
restore [-full] [-bypass] [-not_ready] [-protect]
split [-diff] [-bypass] [-not_ready] [-skip]
[ -instant [-vxfs <MountPoint...> |
Sets parameters that control the behavior of the Symmetrix Optimizer and
displays its current status.
symoptmz -h
24 24
sympd Component License: Base
Product Guide: Symmetrix Base Management CLI
Displays information about one or all Symmetrix devices that are visible to your
host.
sympd -h
show PdevName
symqos -h
symqos -g DgName [-bcv|-nobcv]
set <BCV|RDF|BCS|MIR|CLONE pace Value> [LdevName]
set LRU <#,#,#|ALL> [LdevName]
set LRUname LruName [LdevName]
query [-lru]
symqos [-sid SymmID]
list [-range SymdevStart:SymdevEnd][-lru <#|ALL>]
list [-range SymdevStart:SymdevEnd]
[-lruname <LruName|ALL>]
25
symrdb Component License: Mapping Solution
Product Guide: Symmetrix SRM CLI
symrdb -h
26 26
symrdf Component Licenses: SRDF, SRDF/CG (only for symcg)
SRDF/A (Asynchronous mode)
Product Guide: Symmetrix SRDF Family CLI
Performs Symmetrix SRDF ping, control, or modify operations on a device
group, composite group, device file, or on a device within a device group. The
device group must have a type of either RDF1 or RDF2. Lists all RDF devices,
regardless if they are in a device group. Performs Dynamic RDF group controls
to add, modify or remove a dynamic RDF group.
symrdf -h
Device Groups
symrdf -g DgName
[-v|-noecho] [-noprompt] [-force][-symforce]
[-bypass] [-bcv|-rbcv|-brbcv|-all]
[-RDFG GrpNum] [-i Interval][-c Count]]
establish [-full] [LdevName [LdevName…]]
restore [-full] [LdevName [LdevName…]] [-remote]
split [LdevName [LdevName…]]
failover [LdevName [LdevName…]]
[-establish]
failback [LdevName [LdevName…]] [-remote]
suspend [LdevName [LdevName…]]
resume [LdevName [LdevName…]]
merge [LdevName [LdevName…]]
update [-until InvalidTracks]
[LdevName [LdevName…]
[-remote]
deletepair
ready [LdevName [LdevName…]] r1|r2
not ready [LdevName [LdevName…]] r1|r2
rw_enable [LdevName [LdevName…]] r1|r2
write_disable [LdevName [LdevName…]] r1|r2
refresh [LdevName [LdevName…]] r1|r2
invalidate [LdevName [LdevName…]] r1|r2
rw_disable [LdevName [LdevName…]] r2
27
symrdf -g DgName [-v] [-noprompt] [-bcv|-rbcv|-brbcv|-all]
[-bypass] [-i Interval][-c Count]
[-RDFG GrpNum]
set mode sync|semi|async|acp_disk|acp_wp|acp_off
[skew SkewVal] [LdevName [LdevName…]]
set domino on|off [LdevName [LdevName…]]
set acp_skew SkewVal [LdevName [LdevName…]]
set nr_if_invalid on|off [LdevName [LdevName…]]
Composite Groups
symrdf -cg CgName [-v|-noecho] [-noprompt] [-force]
[-symforce]
[-bypass] [-i Interval][-c Count]
[-bcv] [-RDFG sid:GrpNum,...]
establish [-full]
restore [-full]
split
failover
failback
suspend
resume
merge
update [-until InvalidTracks]
ready r1|r2
not ready r1|r2
rw_enable r1|r2
write_disable r1|r2
refresh r1|r2
invalidate r1|r2
Device File
symrdf -file Filename -sid SymmID -RDFG GrpNum [-v|
-noecho] [-noprompt] [-force][-symforce]
[-i Interval][-c Count][-bypass]
establish [-full]
restore [-full]
split
failover [-establish]
failback
suspend
resume
merge
update [-until InvalidTracks]
28 28
createpair -type <RDF1 | RDF2> -RDFG GrpNum
-establish |
-restore |
-invalidate [R1 | R2]
[-g NewDg] [-remote]
deletepair
swap [-refresh R1|R2]
Dynamic Groups
symrdf addgrp -label GrpLabel -rdfg GrpNum -sid SymmID
-dir Dir -remote_rdfg GrpNum
-remote_sid SymmID -remote_dir Dir
[-i Interval] [-c count]
[-link_domino] [-remote_link_domino]
[-farpoint] [-fibre] [-gige]
[-auto_link_recovery]
[-remote_auto_link_recovery]
[-link_limbo PeriodSec]
[-rem_link_limbo PeriodSec]
symrdf modifygrp <-add|-remove> <-rdfg GrpNum|
-label GrpLabel>
-sid SymmID [-dir Dir] [-remote_dir Dir]
[-i Interval] [-c count]
29
symreplicate Component Licenses: TimeFinder/Mirror,
TimeFinder/CG, SRDF, and SRDF/AR
Product Guide: Symmetrix SRDF Family CLI
Performs automated, consistent replication of data via BCV pairs and over
SRDF links.
symreplicate -h
symrslv -h
pd PdevName
fs MountPoint
30 30
symsnap Component License: TimeFinder/Snap
Product Guide: Symmetrix TimeFinder Family CLI
symsnap -h
verify [-created|-copied|-copyinprog|
-copyonwrite|-restinprog|-restored]
<[LdevName [VDEV pd PdevName]]>…> |
<[LdevName [VDEV dev SymDevName]]>…> |
<[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]]>…>
31
<[LdevName [VDEV dev SymDevName]]>…> |
<[LdevName [VDEV ld LdevName]]>…>
symsnap -cg CgName [-h] [-v] [-noprompt]
[-force] [-i Interval] [-c Count]
create [-exact] [-bcv] [-skip]
activate [-not_ready] [-bcv] [-skip]
[-preaction Script] [-postaction Script]
[-vxfs <MountPoint...> |
-ppath <SRCDEVS|PowerPathPdevName...> |
-rdb -dbtype DbType [-db DbName]|
-consistent]]
terminate [-symforce] [-bcv] [-skip] [-restored]
restore [-full [-bcv]] [-not_ready]
symsnap -cg CgName [-h] [-offline][-i Interval][-c Count]
query [-multi] [-restore]
verify [-created | -copied |-copyinprog |
-copyonwrite|-restinprog |-restored]
32 32
symstat Component License: Base
Product Guide: Symmetrix Base Management CLI
symstat -h
-dir <#|ALL>
-type PREFETCH [-sid SymmID][-DA <#|ALL>]
-type CACHE [-sid SymmID][-CA <#|ALL>]
-type CACHE [-sid SymmID][-EA <#|ALL>]
-type CACHE [-sid SymmID][-RA <#|ALL>]
-type CACHE [-sid SymmID][-SA <#|ALL>]
-type CACHE [-sid SymmID][-dir <#|ALL>]
-type CACHE [-sid SymmID][-lru <#|ALL|name>]
33
symvg Component License: Mapping Solution
Product Guide: Symmetrix SRM CLI
Displays mapping information about one or more logical volume groups (vg)
that are defined by your specific platform’s Logical Volume Manager.
symvg -h
show VgName
rescan
destroy VgName
34 34
Environment Variables
SYMCLI provides a group of environment variables that can be preset
to streamline and expedite your command line session. Table 2 lists
and describes the supported environment variables.
These environment variables can be preset to be default settings for
your given session.
To see what environment variables can be set, enter:
symcli -env
35
Table 2 Environment Variables (Continued)
36 36
Table 2 Environment Variables (Continued)
37
Table 2 Environment Variables (Continued)
38 38
Table 2 Environment Variables (Continued)
For more information about these environment variables, see the EMC
Solutions Enabler SYMCLI Base Management CLI Guide.
39
40 40