Get Hardware Ethernet
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Returns information about a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
| required |
|
string | Virtual Ethernet adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
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
}
}| Property Name | Type | Description |
|---|---|---|
| value | VmHardwareEthernetInfo |
Information about the specified virtual Ethernet adapter. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine or virtual Ethernet adapter is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | ErrorRest | Not available |
Hardware Ethernet Operations
delete
patch
