REST API - get

REST API - get

vcenter vm hardware adapter sata: get

Returns information about a virtual SATA adapter.

Request:

HTTP request

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

Path Parameters

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

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name	Type	Description
bold = required
value	info	Information about the specified virtual SATA adapter.
value.label	string	Device label.
value.type	string	Adapter type. Defines the valid emulation types for a virtual SATA adapter. Value is one of: AHCI: AHCI host bus adapter.
value.bus	long	SATA bus number.
value.pci_slot_number	long	Address of the SATA adapter on the PCI bus. 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 SATA 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.