Get Hardware Adapter NVMe
Returns information about a virtual NVMe adapter.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/nvme/{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 NVMe adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter.
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
VmHardwareAdapterNvmeInfo
of type application/json
Information about the specified virtual NVMe adapter.
{
"bus": 0,
"label": "string",
"pci_slot_number": 0
}
integer
bus
Required
NVMe bus number.
string
label
Required
Device label.
integer
pci_slot_number
Optional
Address of the NVMe adapter on the PCI bus. 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 NVMe 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-GetVmAdapterHardwareNvme -Vm "MyVm" -Adapter "MyAdapter"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.1
