vxddladm (1M)

NAME

vxddladm - Device Discovery Layer subsystem administration

SYNOPSIS

vxddladm [-a | -f | -n] addforeign blockdir=pathname chardir=pathname

vxddladm [-a | -f | -n] addforeign blockpath=pathname charpath=pathname

vxddladm [-a | -f | -n] addforeign dir=pathname

vxddladm [-a | -f | -n] addforeign path=pathname

vxddladm addjbod vid=vendor-id [pid=product-id] [serialnum=opcode/pagecode/offset/length]
    [cabinetnum=opcode/pagecode/offset/length] policy={aa|ap}]

vxddladm addvscsi array_vid

vxddladm [-c] assign names [file=pathname]

vxddladm disablescsi3

vxddladm disablevscsi

vxddladm enablescsi3 [policy={aa|ap}]

vxddladm enablevscsi

vxddladm excludearray libname=libname

vxddladm excludearray vid=vendor-id pid=product-id

vxddladm excludearray vid=vendor-id

vxddladm excludearray pid=product-id

vxddladm excludearray all

vxddladm get namingscheme

vxddladm getiscsi target=target-id [all | parameter]

vxddladm includearray libname=libname

vxddladm includearray vid=vendor-id pid=product-id

vxddladm includearray vid=vendor-id

vxddladm includearray pid=product-id

vxddladm includearray all

vxddladm list

vxddladm list hbas

vxddladm list ports [{hba=hba-id|target=target-id}]

vxddladm list targets [{hba=hba-id|port=port-id}]

vxddladm list devices [target=target-id]

vxddladm listexclude [all]

vxddladm listforeign [all]

vxddladm listjbod [vid=vendor-id [pid=product-id]]

vxddladm listsupport [all | libname=libname]

vxddladm listversion [all | libname=libname]

vxddladm listvscsi

vxddladm modescsi3

vxddladm rmforeign dir=pathname

vxddladm rmforeign blockdir=pathname chardir=pathname

vxddladm rmforeign blockpath=pathname charpath=pathname

vxddladm rmforeign path=pathname

vxddladm rmjbod vid=vendor-id [pid=product-id]

vxddladm rmvscsi array_vid

vxddladm set namingscheme={ebn|osn}[persistence={yes|no}]
    [lowercase={yes|no}] [use_avid={yes|no}]

vxddladm setiscsi target=target-id [parameter=value]

vxddladm start eventsource [logfile=logfilename]

vxddladm status eventsource

vxddladm stop eventsource

DESCRIPTION

The vxddladm utility is an administrative interface to the dynamic array support facility of the Device Discovery Layer (DDL). This utility lists the types of arrays supported, adds or removes array support from DDL, and allows dynamic addition of JBOD support for disks from different vendors. It also lists supported JBODs, and allows addition or removal of JBOD support. The vxddladm utility is also used to customize the set of array libraries that can participate in device discovery.

DDL cannot discover some devices that are controlled by third-party drivers (for example, RAM disks). Additionally, it may be preferable to use the multipathing capability that is provided by the third-party drivers for some arrays rather than use the Veritas Dynamic Multipathing (DMP) feature. Such foreign devices can be made available as simple disks to VxVM by using the vxddladm addforeign command. This command also has the effect of bypassing DMP for the specified devices.

If a foreign device has alias devices in the OS-maintained device tree, DDL/DMP creates additional disk access records that point to the same physical device. As such additional records are usually not required, specify the -a option to prevent them from being created.

After adding or removing foreign device entries, use either the vxdisk scandisks command or the vxdctl enable command to discover the foreign devices as simple disks. These disks then behave in the same way as autoconfigured disks.

The vxddladm utility supports automatic command completion for the bash shell. While entering the command, press Tab to complete the command line as far as possible, and display the next valid options for the command. A value in brackets indicates a user-specified value. Platform-specific options are not supported with command completion in this release.

KEYWORDS

addforeign Adds an entry to the list of foreign devices to be manually configured into VxVM. The changes become effective upon the next invocation of DDL device discovery.
See the ATTRIBUTES section for a description of the attributes that can be used with addforeign: blockdir, blockpath, chardir, charpath, dir, and path. All directory and device arguments to these attributes must be specified as absolute pathnames. Device paths may include the * wildcard.
To define how VxVM should treat alternate device entries that refer to the same physical device, specify one of the following options:
-a Suppresses any entries for matching devices in the OS-maintained device tree that are found by the VxVM autodiscovery mechanism. This is the default action if no option is specified to addforeign.
-f Retains any entries for matching devices found by the VxVM autodiscovery mechanism, and suppresses any foreign device entries that are defined.
-n Does not suppress any entries. Duplicate entries for foreign devices are allowed.
addjbod Adds disks having the specified VID and PID in the JBOD category (DISKS). The policy option may be specified to handle JBOD arrays in either active/active (aa) or active/passive (ap) mode. If the disk array conforms to ALUA standards, the disks are handled as ALUA JBOD disks. Otherwise by default, JBOD disks are handled as active/active arrays. The user can optionally specify the SCSI inquiry command opcode, the inquiry page code, the offset and length for obtaining the lun serial number and cabinet serial number for individual disks. The changes become effective upon the next invocation of DDL device discovery.
addvscsi Adds DMP support to the new VSCSI array.
assign names
  Triggers DDL to again assign names to DMP devices.
-c Clears any existing user-defined names and replaces them with auto-generated names.
file Assigns names of the enclosures and the DMP devices from the file specified by the pathname, rather than auto-generated names. The format of the input file is as follows:
enclosure vendor=vendor-ID product=product-ID serial=cabinet-serial#
name=enclosure-name
     dmpnode serial=lun-serial# name=DMP device name
     dmpnode serial=lun-serial# name=DMP device name
.
.
.
enclosure vendor=vendor-ID product=product-ID serial=cabinet-serial#
name=enclosure-name
     dmpnode serial=lun-serial# name=DMP device name
.
.
.

Use the vxgetdmpnames utility to obtain a sample file using the current DMP device names.
disablescsi3
  Disables the automatic discovery of SCSI3 disks in the JBOD category. The change in the method comes into effect when the discovery operation is subsequently invoked.
Note: If an ASL is excluded and no other ASL is available to claim the devices and disablescsi3 has been specified, the devices are claimed in the OTHER_DISK category. Since claiming an A/P array in the OTHER_DISK category leads to trespass, it is not advisable to exclude ASLs for A/P array and have SCSI3 claiming disabled.
disablevscsi
  Disables DMP on VSCSI devices.
enablescsi3
  Initiates the method to automatically discover SCSI3-conformant disks in the JBOD category. The method comes into effect when the discovery operation is subsequently invoked.
The policy option may be specified to discover devices in active/active (aa) or active/passive (ap) mode. If the disk array conforms to ALUA standards, they are claimed as ALUAdisks. Otherwise by default, devices are discovered in active/active mode.
enablevscsi
  Disables MPIO and enables DMP on VSCSI devices. By default, MPIO is enabled on the VIO client and all VSCSI devices are under MPIO control.
excludearray
  Excludes the specified array support libraries from participating in device discovery. This does not remove the specified libraries from the system. As a result, vxddladm listsupport displays the corresponding disk arrays. The changes become effective upon the next invocation of DDL device discovery.
Note : If an ASL is excluded and no other ASL is available to claim the devices and disablescsi3 has been specified, the devices are claimed in the OTHER_DISK category. Since claiming an A/P array in the OTHER_DISK category leads to trespass, it is not advisable to exclude ASLs for A/P array and have SCSI3 claiming disabled.
get namingscheme
  Returns the current setting of the disk device naming scheme.
getiscsi Obtains the list of operational parameters for an iscsi target. Parameters can be DataPDUInOrder, DataSequenceInOrder, InitialR2T, ImmediateData, MaxConnections, MaxOutStandingR2T, errorRecoveryLevel, DefaultTime2Retain, DefaultTime2Wait, FirstBurstLength, MaxBurstLength, MaxRecvDataSegmentLength
includearray
  Includes the array support libraries previously excluded by excludearray. The changes become effective upon the next invocation of DDL device discovery.
list Provides a hierarchical listing of the FC and iSCSI entities (hbas, ports, targets, and devices) discovered by DDL. To display the details of each type of entity, use one of the following attributes:
devices Display the details of all the devices. You can filter based on the target.
hbas Displays the details of all the HBAs.
ports Displays the details of all the ports. You can filter based on the HBA or the target.
targets Displays the details of all the targets. You can filter based on the HBA or the array port.
listexclude
  Lists information about the disk array libraries excluded from device discovery functionality.
listforeign
  Lists information about foreign devices that have been defined to VxVM.
listjbod Lists information about the types of disks supported in JBOD category (DISKS).
listsupport
  Lists summary information about supported disk arrays. The libname attribute can be used to display a detailed list of attributes for a specified library.
listversion
  Lists the version numbers of array support libraries and the minimum VxVM release that is required for each library. The libname attribute can be used to request that the information is to be displayed only for the specified library.
listvscsi Lists the arrays supported by DMP in VSCSI mode.
modescsi3 Displays the mode for SCSI3 disk discovery.
rmforeign Removes a matching entry from the list of foreign directories and devices configured into VxVM. See the ATTRIBUTES section for a description of the attributes that can be used with rmforeign: blockdir, blockpath, chardir, charpath, dir, and path. The changes become effective upon the next invocation of DDL device discovery.
rmjbod Removes disk with the specified VID and PID from the JBOD category (DISKS). For these disks if SCSI3 discovery is enabled then if the disk confirm to SCSI3 specifications then also they go into DISK category. Otherwise, these disks are categorized as OTHER_DISKS and are not multipathed. The changes become effective upon the next invocation of DDL device discovery.
rmvscsi Removes DMP support on a VSCSI array.
set namingscheme
  Bases the name of a device on the enclosure name (ebn), or on the device name that is used by the operating system (osn). The change is immediate, and does not require vxconfigd to be restarted.
For TPD devices, the effect of the device naming scheme also depends on the setting of the enclosure-specific attribute tpdmode. If the tpdmode is set to pseudo, the TPD naming is used, regardless of the device naming scheme. To use enclosure-based naming for TPD devices, set the tpdmode to native for the enclosure. Set the tpdmode attribute with the vxdmpadm setattr command. See the vxdmpadm(1) man page for details.
The following options can be set:
persistence
  Specifies whether the names of disk devices that are displayed by VxVM remain unchanged after disk hardware has been reconfigured and/or the system rebooted.
If persistence is on, the DDL assigns device names from the persistent device name database, rather than generating new names according to the OSN or EBN naming scheme.
If the naming scheme is OSN, name persistence is off by default. The generated names are not likely to differ from the names in the persistent name database, unless a change causes the OS to assign a new path name for a device.
If the naming scheme is EBN, name persistence is on by default. Certain configuration changes on the array side could cause the generated name to be different from the name in the persistent name database. When name persistence is on, the name from the persistent names repository is used for the DMP meta-device, unless
the user changes it. .
lowercase By default, the names of the enclosure are converted to lowercase, regardless of the case of the name specified by the ASL. The EBN names are therefore in lowercase. Use the lowercase=no option to suppress the conversion to lowercase.
use_avid For EBN scheme, indicates that the Array Volume ID (AVID) is used together with the enclosure name for the disk device name. The disk devices are named as enclosure_avid. The default value is yes. If use_avid is set to no, the devices are named as enclosure_name_index_of_device where index is obtained by sorting the DMP devices based on the LUN_SERIAL_NO.
setiscsi Sets the value of an operational parameter for an iscsi target. Parameters can be DataPDUInOrder, DataSequenceInOrder, InitialR2T, ImmediateData, MaxConnections, MaxOutStandingR2T, errorRecoveryLevel, DefaultTime2Retain, DefaultTime2Wait, FirstBurstLength, MaxBurstLength, MaxRecvDataSegmentLength
start eventsource
  Starts the event source daemon. This daemon passes disk- and SAN-related events to DDL. For example, if a disk is added, removed, or changed, DDL invokes the device discovery actions that are related to that disk event. The event source daemon also gathers information about SAN entities, and monitors the SAN for RSCN events. It notifies DDL and DMP about any changes to the SAN configuration. The logfile attribute can be used to specify the location for a log file.
status eventsource
  Shows the status of the event source daemon.
stop eventsource
  Stops the event source daemon.

ATTRIBUTES

The attribute all selects all objects for an operation.

Other attributes are specified using the format attribute=value.

blockdir Absolute pathname of a directory that contains block device entries for foreign devices.
blockpath Absolute pathname of the block device for a foreign device.
chardir Absolute pathname of a directory that contains character device entries for foreign devices.
charpath Absolute pathname of a character device for a foreign device.
dir Absolute pathname of a directory that contains character and block device entries for foreign devices.
length Size of the field containing unique disk serial number.
libname Name of the array library on which the operation is to be performed.
offset Offset on the page code.
opcode SCSI opcode.
pagecode Page code for SCSI command.
path Absolute pathname of a single character or block device for a foreign device.
pid Product ID of the disk array.
policy Sets the policy of the specified device to aa (active/active) or ap (active/passive).
vid Vendor ID of the disk array.

NOTES

If you specify values for vid or pid to the excludearray or includearray operations, this excludes or includes all arrays that are supported by the corresponding array library.

The value for vid and pid should be taken from the output of the vxddladm listsupport command. These values may be different from the actual vid and pid values of the disks within an array.

See the vxdiskadm(1M) manual page for information on using the vxdiskadm command to suppress or unsuppress individual devices from the view of VxVM, or to disable or enable multipathing for these devices.

EXAMPLES

Example to set an enclosure-based-naming for the emc powerpath devices. vxddladm set namingscheme=osn vxdmpadm setattr enclosure pp_emc0 tpdmode=native

FILES

/etc/vx/darecs Used to store records for foreign devices.

SEE ALSO

vxconfigd(1M), vxdctl(1M), vxdisk(1M), vxdiskadm(1M), vxdmpadm(1M)


VxVM 6.0.1 vxddladm (1M)