ScsiLun

The ScsiLun 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 ScsiLunTypeEnum 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 HostScsiDisk object, which inherits properties from the ScsiLun base class.
Other SCSI devices, for example SCSI passthrough devices for virtual machines. To represent one of these devices, the ESX Server creates a ScsiLun object.

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

deviceName - 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
deviceType - 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

AllOf

This class requires all of the following:

HostDevice

JSON Example

{
    "_typeName": "string",
    "deviceName": "string",
    "deviceType": "string",
    "key": "string",
    "uuid": "string",
    "descriptor": [
        {
            "_typeName": "string",
            "quality": "string",
            "id": "string"
        }
    ],
    "canonicalName": "string",
    "displayName": "string",
    "lunType": "string",
    "vendor": "string",
    "model": "string",
    "revision": "string",
    "scsiLevel": 0,
    "serialNumber": "string",
    "durableName": {
        "_typeName": "string",
        "namespace": "string",
        "namespaceId": 0,
        "data": [
            0
        ]
    },
    "alternateName": [
        {
            "_typeName": "string",
            "namespace": "string",
            "namespaceId": 0,
            "data": [
                0
            ]
        }
    ],
    "standardInquiry": [
        0
    ],
    "queueDepth": 0,
    "operationalState": [
        "string"
    ],
    "capabilities": {
        "_typeName": "string",
        "updateDisplayNameSupported": false
    },
    "vStorageSupport": "string",
    "protocolEndpoint": false,
    "perenniallyReserved": false,
    "clusteredVmdkSupported": false,
    "applicationProtocol": "string",
    "dispersedNs": false
}

string

key

Optional

Linkable identifier

string

uuid

Required

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.

array of ScsiLunDescriptor

descriptor

Optional

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.

string

canonicalName

Optional

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.