Get Hardware Ethernet
DescriptionReturns information about a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
string
nic
Required
Virtual Ethernet adapter identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
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
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareEthernetGetResponseBody
of type application/json
Information about the specified virtual Ethernet adapter.
{
"value": {
"allow_guest_control": false,
"backing": {
"connection_cookie": 0,
"distributed_port": "string",
"distributed_switch_uuid": "string",
"host_device": "string",
"network": "string",
"network_name": "string",
"opaque_network_id": "string",
"opaque_network_type": "string",
"type": "enum"
},
"label": "string",
"mac_address": "string",
"mac_type": "enum",
"pci_slot_number": 0,
"start_connected": false,
"state": "enum",
"type": "enum",
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
}cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
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 Ethernet 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.
Hardware Ethernet Operations
patch
delete
