Create Hardware Adapter NVMe
Adds a virtual NVMe adapter to the virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/nvme
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
VmHardwareAdapterNvmeCreateSpec of mimetype application/json
Required
Specification for the new virtual NVMe adapter.
{
"bus": 0,
"pci_slot_number": 0
}
integer
bus
Optional
NVMe 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 NVMe adapter on the PCI bus. If unset, the server will choose an available address when the virtual machine is powered on.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
Virtual NVMe adapter identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter.
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 NVMe bus or PCI address is in use. | com.vmware.vapi.std.errors.invalid_argument : if the specified NVMe 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 reports an error while responding to the request. if the system reported that the NVMe 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.unable_to_allocate_resource : if there are no more available NVMe 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
$VmHardwareAdapterNvmeCreateSpec = Initialize-VmHardwareAdapterNvmeCreateSpec -Bus 0 -PciSlotNumber 0
Invoke-CreateVmHardwareAdapterNvme -Vm "MyVm" -VmHardwareAdapterNvmeCreateSpec $VmHardwareAdapterNvmeCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"bus":0,"pci_slot_number":0}' https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/nvme
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.0.1
