EMC Solutions Enabler CLI Command Reference

Chapter 1: SYMCLI Commands

symmask

Allows the administrator to set up and modify

Symmetrix device masking functionality.

SYNOPSIS symmask -h symmask discover hba [-rename] [-v] symmask list hba [-v] symmask -sid <SymmID> <-wwn <wwn> | -awwn <awwn>> |

<-iscsi <iscsi> | -aiscsi <aiscsi> -name <name>> |

-host <hostname> -dir <#|all> -p <#|all>

[-celerra] [-rp]

[-reserve_id <ResvID>[,<ResvID>[,<ResvID>]]] add devs <SymDevStart:SymDevEnd> |

<SymDevName> | <<SymDevName>,<SymDevName>...>

[-dynamic_lun | -lun <Addr> | <<Addr>,<Addr>...>]

[-noprompt] [-remove_unmapped] [-map] add -g <DgName> [-std] [-bcv] [-vdev] [-tgt] [-noprompt]

[-dynamic_lun | -lun <Addr>] [-remove_unmapped] add -file <DeviceFileName> [src] [tgt] [-noprompt]

[-dynamic_lun | -lun <Addr>] [-remove_unmapped] remove devs <SymDevStart:SymDevEnd> | <SymDevName> |

<SymDevName,SymDevName,SymDevName...> [-unmap] [-force] remove -g <DgName> [-std] [-bcv] [-vdev] [-tgt] [-force] remove -file <DeviceFileName> [src] [tgt] [-force] symmask -sid <SymmID> -wwn <wwn> | -awwn <awwn> |

438 EMC Solutions Enabler CLICommand Reference

-iscsi <iscsi> | -aiscsi <aiscsi> | -host <hostname> set heterogeneous

<on <host> | off> -dir <#|all> -p <#|all> set hba_flags

<on <<flag>,<flag>...> <-enable | -disable> | off [<flag>,<flag>...] >

-dir <#|all> -p <#|all> symmask -sid <SymmID> -wwn <wwn> | -awwn <awwn> |

-iscsi <iscsi> | -aiscsi <aiscsi> list logins [-dir all [-p all] | -dir # [-p <#|all>]]

[-pdev <PdevName>] [-v] set lunoffset <on <offset> <base>|off> -dir <#> -p <#> set visibility <on|off> -dir <#> -p <#> replace <wwn | iscsi> [-noprompt] symmask -sid <SymmID> <-wwn <wwn> | -awwn <awwn>> |

<-iscsi <iscsi> | -aiscsi <aiscsi> [-name <name>]> delete [-dir all -p all | -dir # -p #] [-login]

[-reserve_id <ResvID>[,<ResvID>[,<ResvID>]]] symmask -sid <SymmID> -wwn <wwn> | -awwn <awwn> set lockdown <on <fcid> | off> -dir <#> -p <#> symmask -sid <SymmID> -wwn <wwn> | -iscsi <iscsi> rename <awwn | aisci> symmask -sid <SymmID> [-noprompt]


symmask 439

Chapter 1: SYMCLI Commands refresh [-verify] symmask -sid <SymmID> -iscsi <iscsi> | -aiscsi <aiscsi> set authentication -type <authentication_type>

-credential <credential_name> -secret <secret_value> authentication [ enable | disable | show ]

DESCRIPTION

The symmask command discovers the HBAs on the host and assigns ASCII or alias names to the login history table entries for those initiators that are not set.

This command also provides the following functions:

- Lists the hosts' HBA information.

- Adds devices to and removes devices from the device masking database (VCMDB).

- Displays the login history table.

- Sets a LUN offset. This feature was added to address the restrictions of LUN values allowed to be assigned to HBAs.

- Sets a heterogeneous host. This feature was added to allow the user to change some attributes for a different host type.

- Sets the HBA port flags. This feature is similar to the hetergeneous host feature, but the user is able to specify which settings are enabled and disabled.

- Sets volume visibility. This feature allows HP hosts to find all assigned devices, even if they are


assigned non-continuously.

- Replaces the host HBA without losing established permissions.

- Removes an initiator from the device masking database, along with all of the devices associated with that initiator.

- Associates 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.

- Associates an ASCII name with the initiator as a convenience. To NULL the alias, use a slash (/) as input.

- Refreshes Fibre Channel and Gige directors with the latest copy of the data in the device masking VCMDB.

- Manages the authentication data for connections using iSCSI paths.

ARGUMENTS add Adds devices to the record in the database with the matching WWN, iSCSI name or the hostname part of the alias.

delete Deletes the record(s) matching the WWN or iSCSI name from the database.

disable Disables the use of authentication by the

Symmetrix for the indicated host HBA.

discover Discovers the WWN or iSCSI names of the

HBAs on the host and writes the ASCII


symmask 441

Chapter 1: SYMCLI Commands names to the login history table, if empty.

enable Enables the use of authentication by the

Symmetrix for the indicated host HBA. The authentication data must have previously been established using the set command.

list Lists the requested data.

refresh Updates the fiber and gige adapters with changes to the database.

remove Removes devices from the record in the database with the matching WWN or iSCSI name.

rename Changes the ASCII name or alias in the database and the login history table.

replace Changes the WWN or iSCSI name in the database.

set Allows certain device masking features to be enabled or disabled. Allows authentication data to be established for iSCSI connections.

show Shows the current authentication data for the specified iSCSI host HBA. The CHAP secret will not be displayed.

KEYWORDS authentication

Indicates iSCSI authentication data is being managed.


devs Specifies devices to be added or removed.

hba Specifies the WWN or iSCSI name of the HBA on the host.

heterogeneous Sets the record in the database to hold information on the host type that may differ than the current setting on the corresponding FA.

hba_flags Sets the record in the database to hold information on the HBA port setting that may differ than the current setting on the corresponding FA.

lockdown Sets the FCID value in the database to correlate that entry with a specific path.

logins Specifies the entries in the login history table.

lunoffset Sets the record in the database to hold information of a LUN offset and base or starting values.

src Acts on only the source devices when used with a device file.

tgt Acts on only the target devices when used with a device file.

visibility Sets information in the device masking database to note that the host should find all devices, even if they are not contiguous.

OPTIONS


symmask 443


-aiscsi Specifies a user-given name, or alias iSCSI name.

-awwn Specifies a user-given name, or alias WWN.

-bcv Acts on only the BCV devices when used with a device group.

-celerra Allows controls on Celerra FBA devices.

-credential Specifies the credential name associated with the CHAP protocol's authentication data.

-disable Disables the overridden HBA port flags on a per initiator basis.

-dynamic_lun Specifies to use the dynamic LUN addressing features but does not require the user to give a LUN address for each device. The LUN addresses will be assigned based on what may already be in use for that host HBA.

-enable Enables the overided HBA port flags on a per initiator basis.

-file Applies a device file to the command. The device file contains device pairs

(SymDevnames) listing a pair per each line

(the source device first, a space, and the target device last within each line entry).

Device files can include comment lines that begin with the pound sign (#). A Symmetrix

ID is required for this option. -f is synonymous with -file.


-force Forces the SYMAPI server to allow actions that ordinarily would fail. The force flag should be used when removing devices that should not be masked, such as metamembers, or when a range of devices covers devices that may not be masked.

-g Applies a device group name to the command.

-h Provides brief, online help.

-host Specifies the host name.

-iscsi Specifies the iSCSI name.

-login Deletes the entries in the login history table and the entries in the masking database.

-lun Specifies the starting LUN addresses to be used for the devices being added to the host

HBA. The user may supply a single starting

LUN address for all devices being added, or a list of starting LUN addresses equal to the number of device ranges in the list.

-map Allows the user to map the devices while adding them to the masking database. This option is supported for Enginuity 5773 only.

-name Specifies the access logix record name.

This option to be used along with -iscsi or -aiscsi option for Symmetrix arrays running Enginuity 5874.

-noprompt Requests that no prompts are returned after the command is entered. The default


symmask 445

Chapter 1: SYMCLI Commands is to prompt the user for confirmation.

-pdev Applies a physical device name (host path) to the list login action, which allows you to determine if an

HBA is logged on to this device.

-p Applies a port number designation.

-remove_unmapped

Assists the user to convert an existing device masking record to use the new dynamic feature in a single step. Records that currently contain unmapped devices are not able to be converted until those devices are removed. This option will allow the user to remove those unmapped devices at the same time as adding devices with dynamic addressing.

-rename Forces the hostname/adapter or hostname/IP to be written out to both the login history table and device masking VCMDB, even if one is present. Overwrites any existing alias in the record.

-reserve_id Specifies the device reservation IDs for the devices in the operation. For Enginuity

5874, device reservation IDs must be specified when a record is being deleted.

-rp Allows controls on devices tagged for RecoverPoint use.

-secret Specifies the secret associated with the CHAP protocol's authentication data.

-sid Specifies the unique Symmetrix ID.


-std Acts on only the standard devices when used with a device group.

-tgt Acts on only the target devices when used with a device group.

-type Specifies the type of authentication protocol being established, currently only CHAP is supported.

-unmap Allows the user to unmap the devices while removing them from the masking database. This option is supported for Enginuity 5773 only.

-v Provides a more detailed, verbose listing.

-vdev Acts on only the vdevs when used with a device group.

-verify Allows the user to compare the information in the database to what's currently on the local directors to all changes before the refreshed.

-wwn Specifies a World Wide Name.

PARAMETERS

# A specific director or port number.

Addr The LUN address to be used for the corresponding device.

aiscsi A user-given name, in two parts separated by a slash (/).


symmask 447

Chapter 1: SYMCLI Commands all All directors or ports.

authentication_type

The security protocol. The only type supported is CHAP.

awwn A user-given name, in two parts separated by a slash (/).

base The base value of the offset value in hexadecimal.

credential_name

The CHAP protocol's credential name, a user-defined string of between 8 and 256 characters.

DeviceFileName The name of the file where device pairings are listed.

DgName The device group name.

fcid A Fibre Channel ID associated with the switch.

flag The overridden HBA port flags from the following values in []:

Port Flag Value Indicator

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

Common_Serial_Number [C]

Disable_Q_Reset_on_UA [D]

Environ_Set [E]

Siemens [S]

Volume_Set_Addressing [V]

Avoid_Reset_Broadcast [ARB]

AS400 [AS4]


OpenVMS [OVMS]

SCSI_3 [SC3]

Sunapee [SCL]

Sequent [SEQ]

SPC2_Protocol_Version [SPC2]

SCSI_Support1 [OS2007] host The host type from the following:

Valid Host Types

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

AS400 AS400_LSE

BULL_AIX BULL_AIX_PP15

CELERRA DEC_OVMS

DEC_UNIX DG_AViiON

HP-UX IBM_AIX

IBM_AIX_PP15 IBM_AIX_DMP

IBM_AIX_DMP_PP15 IBM_EMC

IBM_EMC_PP15 ICL_OPEN

FSC_BS2000 LINUX

LINUX_DMP NCR

NCR_MP NCR_NT

NCR_NT_MP NOVELL

NOVELL_CLUSTER PRIMEPOWER

PRIMEPOWER_DMP PRIMEPOWER_PP15

RELIANT SEQUENT

SEQUENT_FCSW SOLARIS

SOLARIS_DMP SOLARIS_PP15

SUN_CLUSTER SUN_CLUSTER30

VERITAS VERITAS20

VERITAS_DMP VMWARE

WINDOWS WINDOWS_DMP

WINDOWS_DMP_PP15 WINDOWS_HP

WINDOWS_HP_DMP WINDOWS_HP_DMP_PP15

WINDOWS_HP_PP15 WINDOWS_PP15

LINUX_DMP_VCS


symmask 449

Chapter 1: SYMCLI Commands hostname The host name.

iscsi An iSCSI name.

on Turn feature on.

off Turn feature off.

offset The hex value of the offset in

LUN addressing.

PdevName A physical device name for the specified action.

ResvID A device reservation ID.

secret_value The CHAP protocol's secret value, a user-defined string of up to 32 ASCII characters, or 64 binary characters.

Binary values should be prefixed with the string 0X. Microsoft users must specify between 12 and 16 characters.

SymDevEnd The end of a range of logical devices.

SymDevName A Symmetrix device to be added or removed.

SymDevStart The start of a range of logical devices.

SymmID The 12-digit ID of the Symmetrix array.

wwn The World Wide Name.


EMC Solutions Enabler CLI Command Reference

symmask

Related manuals

Table of contents

EMC Solutions Enabler CLI Command Reference

symmask

Related manuals

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Dell

Solutions Enabler

Table of contents