This API has a deprecated equivalent from v7.0U1.
Create Hardware Adapter SCSI
Adds a virtual SCSI adapter to the virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/scsi
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
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"
Request Body
Request Body
VmHardwareAdapterScsiCreateSpec of mimetype application/json
Required
Specification for the new virtual SCSI adapter.
{
"bus": 0,
"pci_slot_number": 0,
"sharing": "NONE",
"type": "BUSLOGIC"
}
integer
bus
Optional
SCSI bus number. If unset, the server will choose an available bus number; if none is available, the request will fail.
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. If unset, the server will choose an available address when the virtual machine is powered on.
sharing
Optional
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
Optional
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
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Virtual SCSI adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is suspended | com.vmware.vapi.std.errors.resource_in_use : if the specified SCSI bus is in use. | com.vmware.vapi.std.errors.invalid_argument : if the specified SATA bus or PCI address is out of bounds. | com.vmware.vapi.std.errors.unsupported : if the guest operating system of the virtual machine is not supported and spec includes unset fields that default to guest-specific values.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
500
com.vmware.vapi.std.errors.error : if the system reported that the SCSI adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined. if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if there are no more available SCSI buses on the virtual machine. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | 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
$VmHardwareAdapterScsiCreateSpec = Initialize-VmHardwareAdapterScsiCreateSpec -Type "BUSLOGIC" -Bus 0 -PciSlotNumber 0 -Sharing "NONE"
Invoke-CreateVmHardwareAdapterScsi -Vm "MyVm" -VmHardwareAdapterScsiCreateSpec $VmHardwareAdapterScsiCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"bus":0,"pci_slot_number":0,"sharing":"NONE","type":"BUSLOGIC"}' https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/scsi
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/adapter/scsi
x-vmw-doc-operation: create
Availability
Added in 7.0U2
