This API has a deprecated equivalent from v7.0U1.
Get Hardware Adapter SCSI
Returns information about a virtual SCSI adapter.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
adapter
Required
Virtual SCSI adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareAdapterScsiInfo
of type application/json
Information about the specified virtual SCSI adapter.
{
"label": "string",
"pci_slot_number": 0,
"scsi": {
"bus": 0,
"unit": 0
},
"sharing": "NONE",
"type": "BUSLOGIC"
}
string
label
Required
Device label.
sharing
Required
The Scsi.Sharing enumerated type defines the valid bus sharing modes for a virtual SCSI adapter.
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.
Possible values are: NONE , VIRTUAL , PHYSICAL
type
Required
The Scsi.Type enumerated type defines the valid emulation types for a virtual SCSI adapter.
BUSLOGIC : BusLogic host bus adapter.
LSILOGIC : LSI Logic host bus adapter.
LSILOGICSAS : LSI Logic SAS 1068 host bus adapter.
PVSCSI : Paravirtualized host bus adapter.
Possible values are: BUSLOGIC , LSILOGIC , LSILOGICSAS , PVSCSI
integer
pci_slot_number
Optional
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. May be unset if the virtual machine has never been powered on since the adapter was created.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual SCSI adapter is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine’s configuration state cannot be accessed.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmAdapterHardwareScsi -Vm "MyVm" -Adapter "MyAdapter"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/adapter/scsi/{adapter}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
