Search

Class VcScsiLun

Extends VcHostDevice
The VcScsiLun data object describes a SCSI logical unit. A SCSI logical unit is a host device that an ESX Server or virtual machine can use for I/O operations.

An ESX Server creates SCSI logical unit objects to represent devices in the host configuration. (See the definition of VcScsiLunType for a list of the supported device types.) The vSphere API uses one of two object types to represent a SCSI logical unit, depending on the device type.

  • Disks containing file system volumes or parts of volumes for hosts or raw disks for virtual machines. To represent disks, the ESX Server creates a VcHostScsiDisk object, which inherits properties from the VcScsiLun base class.
  • Other SCSI devices, for example SCSI passthrough devices for virtual machines. To represent one of these devices, the ESX Server creates a VcScsiLun object.

When the Server creates a VcHostScsiDisk or VcScsiLun object, it specifies a valid device name and type:

  • VcHostDevice - A string representing the name of the device that is meaningful to the host. The following are some examples of device names.
            /dev/cdrom
            /vmkdev/vmhba0:0:1:0
            PhysicalDrive0
  • VcHostDevice - A string describing the type of device. The following are some examples of device types.
            scsi-cdrom
            scsi-tape
            scsi-disk
            scsi-processor
            scsi-unknown

Attributes

Name Type Description
alternateName VcScsiLunDurableName[] 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.
canonicalName String Canonical name of the SCSI logical unit. <p> 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. <p><br>See <a href="VcHostScsiDiskPartition.html#diskName">VcHostScsiDiskPartition</a><br>
capabilities VcScsiLunCapabilities Capabilities of SCSI device.
descriptor VcScsiLunDescriptor[] List of descriptors that can be used to identify the LUN object. The uuid will also appear as a descriptor. <p> 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. <p> 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.
deviceName String The name of the device on the host. For example, /dev/cdrom or \\serverX\device_name.
deviceType String Device type when available: floppy, mouse, cdrom, disk, scsi device, or adapter.
displayName 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.
durableName VcScsiLunDurableName 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 String Linkable identifier
lunType String The type of SCSI device. Must be one of the values of <a href="VcScsiLunType.html">VcScsiLunType</a>.
model String The model number of the SCSI device.
operationalState 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.<br>See <a href="VcScsiLunState.html">VcScsiLunState</a><br>
queueDepth Number The queue depth of SCSI device.
revision String The revision of the SCSI device.
scsiLevel Number The SCSI level of the SCSI device.
serialNumber 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 Number[] 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.
uuid String Universally unique identifier for the LUN used to identify ScsiLun across multiple servers. <p> This identifier can be used to identify analogous objects in other views such as <a href="VcHostMultipathInfoLogicalUnit.html">VcHostMultipathInfoLogicalUnit</a> and <a href="VcHostScsiTopologyLun.html">VcHostScsiTopologyLun</a>. <p><br>See <a href="VcHostMultipathInfoLogicalUnit.html">VcHostMultipathInfoLogicalUnit</a><br>See <a href="VcHostScsiTopologyLun.html">VcHostScsiTopologyLun</a><br>
vendor String The vendor of the SCSI device.
vStorageSupport String vStorage hardware acceleration support status. This property represents storage acceleration provided by the SCSI logical unit. See <a href="VcScsiLunVStorageSupportStatus.html">VcScsiLunVStorageSupportStatus</a> for valid values. <p> If a storage device supports hardware acceleration, the ESX host can offload specific virtual machine management operations to the storage device. With hardware assistance, the host performs storage operations faster and consumes less CPU, memory, and storage fabric bandwidth. <p> For vSphere 4.0 or earlier hosts, this value will be unset.

Methods

Name Returns
VcScsiLun() constructor
equals(Object ) boolean
getDeserializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Deserializer
getSerializer(String , java.lang.Class , javax.xml.namespace.QName ) org.apache.axis.encoding.Serializer
getTypeDesc() org.apache.axis.description.TypeDesc
hashCode() Number

Returned by

None

Referenced in

None