Data Object - ScsiLun

Property of
HostMultipathInfoLogicalUnit, HostPlugStoreTopologyDevice, HostScsiTopologyLun, HostStorageDeviceInfo
Extended by
HostScsiDisk
Extends
HostDevice
See also
ScsiLunCapabilities, ScsiLunDescriptor, ScsiLunDurableName

Data Object Description

This data object type describes the SCSI logical unit. A SCSI logical unit is a host device against which I/O operations can be performed. A SCSI logical unit can be used by hosts and virtual machines.

Examples of SCSI logical unit objects include disks which may contain file system volumes or parts of volumes for the host or might serve as raw disks to a virtual machine. Other examples include SCSI passthrough devices that can be used by virtual machines.

When the Device data object type is instantiated, the following valid values are used:

deviceName
A string representing the name of the device that is meaningful to the host. For example, /dev/cdrom, /vmkdev/vmhba0:0:1:0, and "PhysicalDrive0".
deviceType
A string describing the type of device. For example, scsi-cdrom, scsi-tape, scsi-disk, scsi-processor, and scsi-unknown.

Properties

Name Type Description
alternateName*ScsiLunDurableName[]

Alternate durable names. Records all available durable names derived from page 80h of the Vital Product Data (VPD) and the Identification Vital Product Data (VPD) page 83h as defined by the SCSI-3 Primary Commands. For devices that are not SCSI-3 compliant this property is not defined.

Since VI API 2.5
canonicalName*xsd:string

Canonical name of the SCSI logical unit.

Disk partition or extent identifiers refer to this name when referring to a disk. Use this property to correlate a partition or extent to a specific SCSI disk.


See diskName

capabilities*ScsiLunCapabilities

Capabilities of SCSI device.

Since vSphere API 4.0
descriptor*ScsiLunDescriptor[]

List of descriptors that can be used to identify the LUN object. The uuid will also appear as a descriptor.

The id field in the descriptor is a string that can be used to correlate the ScsiLun across multiple servers. A ScsiLun may have multiple descriptors. The choice and order of these descriptors may be different on different servers.

Not all descriptors are suitable for correlation. Some descriptors are only sufficient to identify the ScsiLun within a single host. Each descriptor contains a quality property that indicates whether or not the descriptor is suitable for correlation.

Since vSphere API 4.0
displayName*xsd:string

User configurable display name of the SCSI logical unit. A default display name will be used if available. If the display name is not supported, it will be unset. The display name does not have to be unique but it is recommended that it be unique.

Since vSphere API 4.0
durableName*ScsiLunDurableName

The durable name of the SCSI device. For a SCSI-3 compliant device this property is derived from the payloads of pages 80h and 83h of the Vital Product Data (VPD) as defined by the T10 and SMI standards. For devices that do not provide this information, this property is not defined.
key*xsd:string

Linkable identifier
lunTypexsd:string

The type of SCSI device. Must be one of the values of ScsiLunType.
model*xsd:string

The model number of the SCSI device.
operationalStatexsd:string[]

The operational states of the LUN. When more than one item is present in the array, the first state should be considered the primary state. For example, a LUN may be "ok" and "degraded" indicating I/O is still possible to the LUN, but it is operating in a degraded mode.
See ScsiLunState

queueDepth*xsd:int

The queue depth of SCSI device.
revision*xsd:string

The revision of the SCSI device.
scsiLevel*xsd:int

The SCSI level of the SCSI device.
serialNumber*xsd:string

The serial number of the SCSI device. For a device that is SCSI-3 compliant, this property is derived from page 80h of the Vital Product Data (VPD), as defined by the SCSI-3 Primary Commands (SPC-3) spec. Not all SCSI-3 compliant devices provide this information. For devices that are not SCSI-3 compliant, this property is not defined.
standardInquiry*xsd:byte[]

Standard Inquiry payload. For a SCSI-3 compliant device this property is derived from the standard inquiry data. For devices that are not SCSI-3 compliant this property is not defined.

Since VI API 2.5
uuidxsd:string

Universally unique identifier for the LUN used to identify ScsiLun across multiple servers.

This identifier can be used to identify analogous objects in other views such as HostMultipathInfoLogicalUnit and HostScsiTopologyLun.


See HostMultipathInfoLogicalUnit
See HostScsiTopologyLun

vendor*xsd:string

The vendor of the SCSI device.
Properties inherited from HostDevice
deviceName, deviceType
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set
Show WSDL type definition