This API has a deprecated equivalent from v7.0U1.
Get Hardware Ethernet
Returns information about a virtual Ethernet adapter.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}
Path Parameters
Path 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareEthernetInfo
of type application/json
Information about the specified virtual Ethernet adapter.
{
"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": "STANDARD_PORTGROUP"
},
"label": "string",
"mac_address": "string",
"mac_type": "MANUAL",
"pci_slot_number": 0,
"start_connected": false,
"state": "enum",
"type": "E1000",
"upt_compatibility_enabled": false,
"wake_on_lan_enabled": false
}
boolean
allow_guest_control
Required
Flag indicating whether the guest can connect and disconnect the device.
backing
Required
Physical resource backing for the virtual Ethernet adapter.
string
label
Required
Device label.
mac_type
Required
The Ethernet.MacAddressType enumerated type defines the valid MAC address origins for a virtual Ethernet adapter.
MANUAL : MAC address is assigned statically.
GENERATED : MAC address is generated automatically.
ASSIGNED : MAC address is assigned by vCenter Server.
Possible values are: MANUAL , GENERATED , ASSIGNED
boolean
start_connected
Required
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
state
Required
Connection status of the virtual device.
Possible values are: CONNECTED , RECOVERABLE_ERROR , UNRECOVERABLE_ERROR , NOT_CONNECTED , UNKNOWN
type
Required
The Ethernet.EmulationType enumerated type defines the valid emulation types for a virtual Ethernet adapter.
E1000 : E1000 ethernet adapter.
E1000E : E1000e ethernet adapter.
PCNET32 : AMD Lance PCNet32 Ethernet adapter.
VMXNET : VMware Vmxnet virtual Ethernet adapter.
VMXNET2 : VMware Vmxnet2 virtual Ethernet adapter.
VMXNET3 : VMware Vmxnet3 virtual Ethernet adapter.
Possible values are: E1000 , E1000E , PCNET32 , VMXNET , VMXNET2
boolean
wake_on_lan_enabled
Required
Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.
string
mac_address
Optional
MAC address. May be unset if Ethernet.Info.mac-type is MANUAL and has not been specified, or if Ethernet.Info.mac-type is GENERATED and the virtual machine has never been powered on since the Ethernet adapter was created.
integer
pci_slot_number
Optional
Address of the virtual Ethernet adapter on the PCI bus. If the PCI address is invalid, the server will change it when the VM is started or as the device is hot added. May be unset if the virtual machine has never been powered on since the adapter was created.
boolean
upt_compatibility_enabled
Optional
Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.Info.type is VMXNET3.
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.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmNicHardwareEthernet -Vm "MyVm" -Nic "MyNic"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/ethernet/{nic}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/ethernet/{nic}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Hardware Ethernet Operations
patch
delete
