HostPlugStoreTopologyDevice

HostPlugStoreTopologyDevice
HostPlugStoreTopologyDevice

This data object type is an association class that describes a ScsiLun and its associated Path objects.

The ScsiLun is a Device that is formed from a set of Paths.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "lun": {
        "_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,
        "deviceReservation": "string"
    },
    "path": [
        {
            "_typeName": "string",
            "key": "string",
            "name": "string",
            "channelNumber": 0,
            "targetNumber": 0,
            "lunNumber": 0,
            "adapter": "HostPlugStoreTopologyAdapter Object",
            "target": {
                "_typeName": "string",
                "key": "string",
                "transport": {
                    "_typeName": "string"
                }
            },
            "device": "HostPlugStoreTopologyDevice Object"
        }
    ]
}
string
key
Required

Linkable identifier.

lun
Required

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
path
Optional

The array of paths available to access this LogicalUnit.