REST API - get

vcenter vm hardware adapter nvme: get

Returns information about a virtual NVMe adapter. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/adapter/nvme/{adapter}

Path Parameters

Name	Type	Description
Required
vm	string	Virtual machine identifier.
adapter	string	Virtual NVMe adapter identifier.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "bus" : 1,
        "pci_slot_number" : 1,
        "label" : "string"
    }
}

Response Type:

Name	Type	Description
bold = required
value	info	Information about the specified virtual NVMe adapter.
value.label	string	Device label. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.bus	long	NVMe bus number. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
value.pci_slot_number	long	Address of the NVMe adapter on the PCI bus. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. May be unset if the virtual machine has never been powered on since the adapter was created.

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request.
404	not_found	if the virtual machine or virtual NVMe adapter is not found.
500	resource_inaccessible	if the virtual machine's configuration state cannot be accessed.
503	service_unavailable	if the system is unable to communicate with a service to complete the request.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the required privileges.