Symaccess Cheatsheet | Vmax/PowerMax | Symcli | Solutions Enabler Cli Reference

The symaccess command is a powerful utility used in Dell EMC Symmetrix storage arrays to manage storage access control. It is primarily utilized for masking view operations, allowing administrators to define and control which hosts can access specific storage resources.

With symaccess, users can create and manage initiator groups, port groups, and storage groups, which collectively form masking views. These views ensure that only authorized hosts can communicate with designated storage devices. Additionally, the command facilitates security settings, backup and restore operations, and various administrative tasks related to Fibre Channel (FC) and iSCSI connectivity.

By leveraging symaccess, storage administrators can efficiently manage and enforce storage access policies, enhancing both security and operational efficiency in a Symmetrix storage environment.

Symaccess Summary

Heading	Summary
Actions	The `symaccess` command enables the management of initiator, port, and storage groups. It allows creating and deleting masking views, modifying groups, setting attributes, associating aliases, backing up and restoring data, and verifying database consistency.
Arguments	Various arguments define the operation being performed. Examples include `add` for adding elements, `delete` for removal, `rename` for name changes, `restore` for restoring configurations, and `list` for retrieving group information.
Keywords	Keywords refine the scope of operations, such as `assignments` for listing initiators, `hba_flags` for modifying HBA settings, `sg` for storage group lists, and `view` to specify actions on masking views.
Supported HBA Port Flags	A set of flags that configure port behaviors for HBAs, including options like `Disable_Q_Reset_on_UA`, `OpenVMS` support, `Avoid_Reset_Broadcast`, and `SPC2_Protocol_Version`.
Supported Initiator Group Port Flags	Similar to HBA port flags but applied to initiator groups, these include `Volume_Set_Addressing`, `Common_Serial_Number`, and `SCSI_3` support.

Symaccess Action

The symaccess command provides the ability to perform the following actions:

Create initiator, port, and storage groups.
Create masking views, each one containing a single initiator, port, and storage group.
Delete a masking view.
Delete initiator, port, and storage groups when they are not part of a masking view.
Rename masking views or initiator, port, or storage groups.
Associate an ASCII name with the initiator as a convenience. To NULL the alias, use a slash (/) as input.
Add or remove devices for a specifed storage group.
Add or remove ports or endpoints for a specified port group.
Add or remove initiators for a specified initiator group.
Copy masking views or initiator, port, or storage groups from one Symmetrix array to another.
Replace the host HBA without losing established permissions.
Set HBA port flags on a per initiator basis. This feature allows the user to change some attributes for a different host type on the FA or SE for the specified initiator.
Set the consistent LUN flag for an initiator group to force that any device masked to this group has the same LUN for all ports.
Display the login history table.
Associate the Fibre Channel ID (FCID) of a switch in a fabric to the path from a host HBA to a Symmetrix array. This further restricts the path by which a host can connect to a Symmetrix array.
Set, enable, disable, or delete CHAP credentials from the database for either the director/port or a specified iSCSI initiator.
Back up the Auto-provisioning Group data to a user-named file on the host.
Restore the Auto-provisioning Group data from a backup file stored on the host.
List the host HBA information.
List the group information.
List the view information.
Verifies that the AutoProvisioning Database is consistent.

Symaccess Arguements

Command	Description
add	Adds elements to the specified group.
backup	Creates a file containing all of the group and view information currently on the array.
copy	Copies views or groups from one Symmetrix array to another.
create	Creates a view or group of the specified type.
delete	Deletes the masking view or security information that was previously set for either a director/port or an iSCSI initiator.
disable	Disables security information that was previously set for a director/port or an iSCSI initiator.
discover	Discovers the WWN or iSCSI names of the HBAs on the host which has paths to the Symmetrix and writes the ASCII alias names to the login history table (if empty).
enable	Enables security information that was previously set for a director/port or an iSCSI initiator.
list	Lists the group, view, or security information.
remove	Removes elements from the specified group.
rename	Renames the ASCII name of a group or view, or renames the alias for the specified initiator within a group and the login history table.
replace	Replaces the WWN or iSCSI name within an initiator group with the specified new WWN or iSCSI name.
restore	Restores all of the group, view, and security information from the specified backup file.
set	Sets initiator attributes or CHAP credentials.
show	Shows detailed information about the groups or views.
verify	Checks the Auto-provisioning database to verify that it is consistent.

Symaccess keywords

Keyword	Description
assignments	Lists the currently assigned initiators for the specified devices.
bw_limit	Sets the bandwidth limits in MB per second for an initiator group.
chap	Specifies the iSCSI CHAP credential.
consistent_lun	Sets the consistent LUN for the specified initiator group.
devinfo	Lists the device information by initiator group.
devs	Specifies devices to be added or removed.
hba	Specifies the WWN or iSCSI name of the HBA on the host.
hba_flags	Sets the HBA port settings for an initiator within a group for any settings that should differ from the current settings on the port.
ig_flags	Sets the port settings for an initiator group for any settings that should differ from the current settings on the port.
lockdown	Sets the FCID value for an initiator within a group.
logins	Specifies the entries in the login history table.
no_assignment	Lists devices that are mapped, but not yet assigned within a masking view.
sg	Indicates a list of storage group names.
src	Limits the action to the source devices in a device file.
tgt	Limits the action to the target devices in a device file.
view	Indicates that the action will be performed on a view.

Supported HBA Port Flags

Flag Name	Code
Common_Serial_Number	C
Disable_Q_Reset_on_UA	D
Environ_Set	E
Avoid_Reset_Broadcast	ARB
AS400	AS4
OpenVMS	OVMS
SCSI_3	SC3
SPC2_Protocol_Version	SPC2
SCSI_Support1	OS2007

Supported Initiator Group Port Flags

Flag Name	Code
Volume_Set_Addressing	V
Common_Serial_Number	C
Disable_Q_Reset_on_UA	D
Environ_Set	E
Avoid_Reset_Broadcast	ARB
AS400	AS4
OpenVMS	OVMS
SCSI_3	SC3
SPC2_Protocol_Version	SPC2
SCSI_Support1	OS2007

Symaccess Example: Masking View, Initiator Group, Port Group, Storage Group

Action	Command
Create an initiator group named igroup_alpha, adding WWN 210000e08b04abcd	`symaccess -sid 567 -type initiator -wwn 210000e08b04abcd -name igroup_alpha create`
Create a storage group named sgroup_beta, adding device 0034	`symaccess -sid 567 -type storage devs 0034 -name sgroup_beta create`
Create a port group named pgroup_gamma, adding director 5F and port 2	`symaccess -sid 567 -type port -dirport 5F:2 -name pgroup_gamma create`
Add device 0035 to storage group sgroup_beta	`symaccess -sid 567 -type storage -name sgroup_beta add devs 0035`
Add storage groups storgrp_X and storgrp_Y to storage group storgrp_Z	`symaccess -sid 567 -type storage -name storgrp_Z add -sg storgrp_X,storgrp_Y`
Remove WWN 210000e08b04abcd from initiator group igroup_alpha	`symaccess -sid 567 -type initiator -wwn 210000e08b04abcd -name igroup_alpha remove`
Delete initiator group igroup_alpha	`symaccess -sid 567 -type initiator -name igroup_alpha delete`
List all initiator, port, and storage groups	`symaccess -sid 567 list`
Create a view named view_delta, containing initiator group igroup_alpha, port group pgroup_gamma, and storage group sgroup_beta	`symaccess -sid 567 -name view_delta -sg sgroup_beta -pg pgroup_gamma -ig igroup_alpha create view`
Delete a view named view_delta	`symaccess -sid 567 -name view_delta delete view`
Rename view view_delta to view_omega	`symaccess -sid 567 rename view -name view_delta -new_name view_omega`
Create a view, storage, port, and initiator group named TESTVIEW, adding devices, initiators, and ports	`symaccess -sid 567 create view -name TESTVIEW -wwn 210000e08b04abcd -dirport 5F:2 devs 0034`
Backup groups and views of Symmetrix ID 567 to file backup_file123	`symaccess -sid 567 backup -file backup_file123`
Restore group and view information from file backup_file123 to Symmetrix ID 567	`symaccess -sid 567 restore -file backup_file123`

1. Discovery & Array Configuration (`symcfg`)

Table

Command	Description	Example
`symcfg discover`	Discover all manageable arrays	`symcfg discover`
`symcfg list`	List discovered arrays	`symcfg list -status`
`symcfg list -env_data`	Overall hardware health check	`symcfg list -sid 1234 -env_data`
`symcfg list -env_data -v`	Detailed hardware health	`symcfg list -sid 1234 -env_data -v`
`symcfg list -env_data -service_state_failed`	Show only failed components	`symcfg list -sid 1234 -env_data -service_state_failed`
`symcfg list -srp`	List Storage Resource Pools	`symcfg list -sid 1234 -srp`
`symcfg list -srp -detail`	Detailed SRP info	`symcfg -sid 1234 list -srp -detail`
`symcfg list -slo`	List available SLOs	`symcfg list -sid 1234 -slo`
`symcfg list -slo -detail -by_resptime -all`	SLOs sorted by response time	`symcfg list -sid 1234 -slo -detail -by_resptime -all`
`symcfg list -dir all`	List director (FA/RA) status	`symcfg -sid 1234 list -dir all`
`symcfg list -pool -thin -GB`	List thin pools in GB	`symcfg -sid 1234 list -pool -thin -GB`

2. Device Management (`symdev`, `symconfigure`)

Table

Command	Description	Example
`symdev list`	List all devices on array	`symdev -sid 1234 list`
`symdev list -v`	Verbose device listing	`symdev -sid 1234 -v list`
`symdev show`	Show details of one device	`symdev -sid 1234 show 0200`
`symdev list -range`	List a range of devices	`symdev -sid 1234 -range 6D0:6D4 list`
`symdev list -multiport`	Show multi-port mappings	`symdev -sid 1234 -range 6D0:6D4 list -multiport`
`symdev list -noport`	Devices not mapped to any port	`symdev -sid 1234 -noport list`
`symdev list -tdev`	List all thin devices (TDEVs)	`symdev -sid 1234 -tdev list`
`symdev list -tdev -unbound`	TDEVs not bound to any pool	`symdev -sid 1234 -tdev list -unbound`
`symdev list -tdev -noport -bound`	Bound TDEVs not assigned to host	`symdev -sid 1234 -tdev list -noport -bound`
`symdev list -datadev`	List data devices	`symdev -sid 1234 -datadev list`
`symdev write_disable`	Write-disable a device	`symdev -sid 1234 write_disable 0123 -SA all`
`symdev write_disable -file`	Write-disable devices from file	`symdev -sid 1234 write_disable -file devs -SA 8C -p 0`
`symconfigure`	Create/modify devices	`symconfigure -sid 1234 -cmd "create dev count=1, size=1 GB, emulation=FBA, config=TDEV, device_name=test_vol;" commit`
`symconfigure`	Create multiple TDEVs	`symconfigure -sid 1234 -cmd "create dev count=5, config=TDEV, emulation=FBA, size=2048 GB, sg=myapp_sg;" preview`
`symconfigure`	Bind TDEV to pool	`symconfigure -sid 1234 -cmd 'bind tdev 1001 to pool fast_pool preallocate size = 24802 CYL;' prepare`
`symconfigure`	Unbind TDEV from pool	`symconfigure -sid 1234 -cmd 'unbind tdev 1001:1004 from pool fast_pool;' prepare`
`symconfigure`	Form meta device	`symconfigure -sid 1234 -cmd 'form meta from dev 1000, config=STRIPED, stripe_size=1920; add dev 1001:100F to meta 1000;' prepare`
`symconfigure`	Zero-space reclaim	`symconfigure -sid 1234 -cmd 'free tdev 1A1B start_cyl=0 end_cyl=last_cyl type=zero;' prepare`
`symconfigure`	Set device attributes	`symconfigure -sid 1234 -cmd 'set dev 1001:1004 attribute=dyn_rdf;' prepare`
`symconfigure`	Set SCSI3 persistent reserve	`symconfigure -sid 1234 -cmd 'set dev 2500:2502 attribute=SCSI3_persist_reserv;' prepare`
`symconfigure`	Rebalance thin pool	`symconfigure -sid 1234 -cmd "start balancing on pool fast_pool type=thin;" prepare`

3. Storage Groups (`symsg`)

Table

Command	Description	Example
`symsg list`	List all storage groups	`symsg -sid 1234 list`
`symsg list -srp -demand -type slo`	SRP consumption by SLO	`symsg -sid 1234 list -srp -demand -type slo`
`symsg list -by_SLO -detail`	Storage groups by SLO	`symsg -sid 1234 list -by_SLO -detail`
`symsg create`	Create a storage group	`symsg -sid 007 create myapp_sg -slo gold -workload oltp`
`symsg set`	Change SLO on existing SG	`symsg -sid 123 -sg test set -slo Platinum -wl OLTP_REP`
`symsg move dev`	Move devices between SGs	`symsg -sid 123 -sg staging_sg move dev 345 gold_sg`
`symsg set -compression`	Enable compression on SG	`symsg -sid 1234 -sg data_sg set -srp SRP_1 -compression`

4. Masking & Access Control (`symaccess`)

Table

Command	Description	Example
`symaccess list view`	List all masking views	`symaccess -sid 1234 list view`
`symaccess list view -v`	Detailed view listing	`symaccess -sid 1234 list view -v`
`symaccess show view`	Show view details	`symaccess -sid 1234 show view hostname_vwa -detail`
`symaccess list -type`	List groups by type	symaccess -sid 1234 list -type storage
`symaccess show`	Show group details	`symaccess -sid 1234 show hostname_sga -type storage`
`symaccess create` (initiator)	Create initiator group	`symaccess -sid 1234 create -name hostname_iga -type initiator -wwn 100000000000001`
`symaccess add` (initiator)	Add WWN to IG	`symaccess -sid 1234 add -name hostname_iga -type initiator -wwn 100000000000001`
`symaccess remove` (initiator)	Remove WWN from IG	`symaccess -sid 1234 remove -name hostname_iga -type initiator -wwn 100000000000001`
`symaccess create` (storage)	Create storage group	`symaccess -sid 1234 create -name hostname_sga -type storage devs 1001:1005`
`symaccess add` (storage)	Add device to SG	`symaccess -sid 1234 add -name hostname_sga -type storage dev 1001`
`symaccess remove` (storage)	Remove device from SG	`symaccess -sid 1234 remove -name hostname_sga -type storage dev 1001 -unmap`
`symaccess create` (port)	Create port group	`symaccess -sid 1234 create -name arrayname_5e0_pga -type port -dirport 5E:0`
`symaccess add` (port)	Add port to PG	`symaccess -sid 1234 add -name arrayname_5e0_pga -type port -dirport 5E:0`
`symaccess create view`	Create masking view	`symaccess -sid 1234 create view -name hostname_vwa -sg hostname_sga -ig hostname_iga -pg arrayname_5e0_pga`
`symaccess delete view`	Delete view (unmap devs)	`symaccess -sid 1234 delete view -name hostname_vwa -unmap`
`symaccess delete`	Delete group (force if not empty)	`symaccess -sid 1234 delete -name hostname_sga -type storage -nop -force`
`symaccess rename`	Rename a group	`symaccess -sid 1234 rename -name hostname_sga -type storage -new_name newhost_sga`
`symaccess rename view`	Rename a view	`symaccess -sid 1234 rename view -name hostname_vwa -new_name newviewname_vwa`
`symaccess replace`	Replace WWN in IG	`symaccess -sid 1234 replace -wwn 100000000000001 -new_wwn 2000000000000002`
`symaccess rename -alias`	Alias a WWN	`symaccess -sid 1234 rename -wwn 100000000000001 -alias hostname/hba_a`
`symaccess list logins`	Show logged-in WWNs	`symaccess -sid 1234 list logins -dirport 5E:0`

5. Legacy Masking (`symmask`, `symmaskdb`) — Pre-VMAX3 / DMX

Table

Command	Description	Example
`symmask list database`	List masking database	`symmaskdb -sid 1234 list database -wwn 10000000c979bf7e`
`symmask list database -dir`	Per-port masking DB	`symmaskdb -sid 1234 list database -dir 07A -p 1`
`symmask list devs`	Devices masked to WWN	`symmaskdb -sid 1234 list devs -wwn 10000000c9598ed5`
`symmask list logins`	Logged-in WWNs	`symmask -sid 1234 list logins`
`symmask list logins -dir`	Logins on specific port	`symmask -sid 1234 list logins -dir 3A -p 0`
`symmask add devs`	Mask devices to WWN	`symmask -sid 1234 -dir 8A -p 0 -wwn 100000012345678 add devs 200,200:205`
`symmask remove devs`	Unmask devices	`symmask -sid 1234 -dir 8A -p 0 -wwn 100000012345678 remove devs 20C,201:203`
`symmask refresh`	Refresh masking DB	`symmask -sid 1234 refresh`
`symmask discover hba`	Discover host HBAs	`symmask discover hba`
`symmask list hba`	List host HBAs	`symmask list hba -v`

6. Snapshots — SnapVX (`symsnapvx`)

Table

Command	Description	Example
`symsnapvx establish`	Create a snapshot	`symsnapvx -sid 1234 -sg test -snapshotname hourlysnapshot establish -ttl -delta 1 -nop`
`symsnapvx list`	List snapshots	`symsnapvx -sid 1234 -sg groupname list -detail`
`symcfg list -srp -demand -type sg`	Snapshot capacity by SG	`symcfg list -sid 1234 -srp -demand -type sg`

7. SRDF / Remote Replication (`symrdf`)

Table

Command	Description	Example
`symrdf query`	Query SRDF pair status	`symrdf -g mydg query`
`symrdf establish`	Establish SRDF pair	`symrdf -g mydg establish -full`
`symrdf split`	Split SRDF pair	`symrdf -g mydg split`
`symrdf addgrp`	Create dynamic RDF group	`symrdf -sid 1234 -label dynagrp100 -dir 1E:4,2E:4,3E:4,4E:4 -rdfg 100 -remote_sid 5678 -remote_dir 1E:4,2E:4,3E:4,4E:4 -remote_rdfg 100 addgrp`
`symrdf modifygrp`	Modify RDF group	`symrdf -sid 1234 -rdfg 100 modifygrp -add -dir 1E:24,2E:24`
`symrdf modifygrp`	Add remote ports	`symrdf -sid 1234 -rdfg 100 modifygrp -add -dir 1E:24,2E:24 -remote_dir 3E:24,4E:24`
`symrdf modifygrp`	Remove local ports	`symrdf -sid 1234 -rdfg 100 modifygrp -remove -dir 1E:24,2E:24`

8. Device Groups (`symdg`, `symld`)

Table

Command	Description	Example
`symdg create`	Create device group	`symdg create testdg`
`symdg delete`	Delete device group	`symdg delete testdg -force`
`symdg list`	List device groups	`symdg list -sid 1234`
`symdg show`	Show DG details	`symdg show testdg`
`symld list`	List devices in DG	`symld -g testdg list`
`symld addall`	Bulk add devices to DG	`symld -sid 1234 addall -range 0200:0205 -g testdg`
`symld add`	Add single device to DG	`symld -sid 1234 add dev 0200 -g testdg`
`symld rmall`	Bulk remove from DG	`symld -sid 1234 rmall -range 0200:0205 -g testdg`
`symld remove`	Remove single device	`symld remove dev DEV001 -g testdg`
`symld write_disable`	Write-disable DG devices	`symld -sid 1234 -g testdg -sa ALL write_disable`

9. Monitoring & Events (`symstat`, `symevent`, `symdisk`)

Table

Command	Description	Example
`symstat -type disk`	Disk performance stats	`symstat -sid 1234 -type disk -disk all -i 5 -c 1`
`symstat -type port`	FA port IOPS/KBPS	`symstat -sid 1234 -type port -dir all -i 5 -c 1`
`symstat -type port -dir`	Specific director stats	`symstat -sid 1234 -type port -dir 5F -i 5 -c 1`
`symevent list`	List array events	`symevent -sid 1234 list`
`symdisk list -failed`	List failed disks	`symdisk -sid 1234 list -failed`

10. Host Inquiry (`syminq`, `sympd`)

Table

Command	Description	Example
`syminq -fibre hba`	Check all path status	`syminq -fibre hba`
`sympd list`	List accessible devices	`sympd list`
`syminq -pdevfile`	Device IDs & serial numbers	`syminq -pdevfile`

11. Licensing (`symlmf`)

Table

Command	Description	Example
`symlmf list`	Array-based licenses	`symlmf -sid 1234 list -type emclm`
`symlmf list`	Host-based licenses	`symlmf list -type host`
`symlmf query`	License state & usage	`symlmf -sid 1234 query -type emclm`
`symlmf add`	Install array license	`symlmf -sid 1234 add -type emclm -file <filename> -v`
`symlmf add`	Install host license	`symlmf add -type se -license <LicenseNumber>`
`symlmf delete`	Delete license	`symlmf delete -type se -license FAST`

12. Utilities

Table

Command	Description	Example
`symcli -v`	Show SYMCLI version	`symcli -v`
`symapierr`	Translate error codes	`symapierr <error_code>`
`symaudit`	List audit log records	`symaudit -sid 1234 list`
`symcfg refresh`	Refresh Symmetrix DB	`symcfg -sid 1234 refresh`
`symaccess list -type storage -dev`	Find SG for a device	`symaccess -sid 1234 list -type storage -dev 1001`
`symaccess list -type initiator -wwn`	Find IG for a WWN	`symaccess -sid 1234 list -type initiator -wwn 100000000000001`
`symaccess list -type port -dirport`	Find PG for a port	`symaccess -sid 1234 list -type port -dirport 7F:1`

Notes

Replace 1234 with your actual array SID (last 4 digits of serial number work too).
Most symconfigure commands use prepare first to validate, then commit to execute.
On PowerMax/VMAX3+, use symaccess for masking; symmask is legacy for DMX/VMAX.
Commands are typically located at /opt/emc/SYMCLI/bin/ on Linux hosts.

Symaccess Cheatsheet | Vmax/PowerMax | Symcli | Solutions Enabler Cli Reference

Symaccess Summary

Symaccess Action

Symaccess Arguements

Symaccess keywords

Supported HBA Port Flags

Supported Initiator Group Port Flags

Symaccess Example: Masking View, Initiator Group, Port Group, Storage Group

1. Discovery & Array Configuration (`symcfg`)

2. Device Management (`symdev`, `symconfigure`)

3. Storage Groups (`symsg`)

4. Masking & Access Control (`symaccess`)

5. Legacy Masking (`symmask`, `symmaskdb`) — Pre-VMAX3 / DMX

6. Snapshots — SnapVX (`symsnapvx`)

7. SRDF / Remote Replication (`symrdf`)

8. Device Groups (`symdg`, `symld`)

9. Monitoring & Events (`symstat`, `symevent`, `symdisk`)

10. Host Inquiry (`syminq`, `sympd`)

11. Licensing (`symlmf`)

12. Utilities

Notes

Leave a Comment Cancel reply

Reach out to me for sponsorship opportunities

Symaccess Cheatsheet | Vmax/PowerMax | Symcli | Solutions Enabler Cli Reference

Symaccess Summary

Symaccess Action

Symaccess Arguements

Symaccess keywords

Supported HBA Port Flags

Supported Initiator Group Port Flags

Symaccess Example: Masking View, Initiator Group, Port Group, Storage Group

1. Discovery & Array Configuration (symcfg)

2. Device Management (symdev, symconfigure)

3. Storage Groups (symsg)

4. Masking & Access Control (symaccess)

5. Legacy Masking (symmask, symmaskdb) — Pre-VMAX3 / DMX

6. Snapshots — SnapVX (symsnapvx)

7. SRDF / Remote Replication (symrdf)

8. Device Groups (symdg, symld)

9. Monitoring & Events (symstat, symevent, symdisk)

10. Host Inquiry (syminq, sympd)

11. Licensing (symlmf)

12. Utilities

Notes

Related posts:

Leave a Comment Cancel reply

Reach out to me for sponsorship opportunities

1. Discovery & Array Configuration (`symcfg`)

2. Device Management (`symdev`, `symconfigure`)

3. Storage Groups (`symsg`)

4. Masking & Access Control (`symaccess`)

5. Legacy Masking (`symmask`, `symmaskdb`) — Pre-VMAX3 / DMX

6. Snapshots — SnapVX (`symsnapvx`)

7. SRDF / Remote Replication (`symrdf`)

8. Device Groups (`symdg`, `symld`)

9. Monitoring & Events (`symstat`, `symevent`, `symdisk`)

10. Host Inquiry (`syminq`, `sympd`)

11. Licensing (`symlmf`)