REST API - get

vcenter vm hardware adapter scsi: get

Returns information about a virtual SCSI adapter.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}

Path Parameters

Name Type Description
Required
vm string Virtual machine identifier.
adapter string Virtual SCSI adapter identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "scsi"{
            "bus"1,
            "unit"1
        },
        "pci_slot_number"1,
        "label""string",
        "type""BUSLOGIC",
        "sharing""NONE"
    }
}

Response Type:

Name Type Description
bold = required
value info Information about the specified virtual SCSI adapter.
value.label string Device label.

value.type string Adapter type.

Defines the valid emulation types for a virtual SCSI adapter. Value is one of:
BUSLOGIC: BusLogic host bus adapter.
LSILOGIC: LSI Logic host bus adapter.
LSILOGICSAS: LSI Logic SAS 1068 host bus adapter.
PVSCSI: Paravirtualized host bus adapter.

value.scsi scsi_address_info Address of the SCSI adapter on the SCSI bus.

value.scsi.bus long Bus number of the adapter to which the device is attached.

value.scsi.unit long Unit number of the device.

value.pci_slot_number long Address of the SCSI adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added.

Optional. May be unset if the virtual machine has never been powered on since the adapter was created.

value.sharing string Bus sharing mode.

Defines the valid bus sharing modes for a virtual SCSI adapter. Value is one of:
NONE: The virtual SCSI bus is not shared.
VIRTUAL: The virtual SCSI bus is shared between two or more virtual machines. In this case, no physical machine is involved.
PHYSICAL: The virtual SCSI bus is shared between two or more virtual machines residing on different physical hosts.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the virtual machine or virtual SCSI adapter is not found.
500 resource_inaccessible if the virtual machine's configuration state cannot be accessed.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.