Create Hardware Adapter SATA
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Adds a virtual SATA adapter to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/adapter/sata
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VmHardwareAdapterSataCreateRequestBody
of type application/json
(required)
{
"spec": {
"bus": 0,
"pci_slot_number": 0,
"type": "enum"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VmHardwareAdapterSataCreateSpec |
Specification for the new virtual SATA adapter. |
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareAdapterSataCreateResponseBody
of type application/json
Virtual SATA adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Virtual SATA adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"bus":0,"pci_slot_number":0,"type":"enum"}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/adapter/sata
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the specified SATA bus or PCI address is out of bounds. |
| 409 | ErrorRest | 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 SATA bus or PCI address is in use. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if there are no more available SATA buses on the virtual machine. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 405 | ErrorRest | 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. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
