Vm_Hardware_Ethernet_Info

Vm_Hardware_Ethernet_Info
Vm_Hardware_Ethernet_Info

The Ethernet.Info structure contains information about a virtual Ethernet adapter.

JSON Example
{
    "label": "string",
    "type": "string",
    "upt_compatibility_enabled": false,
    "upt_v2_compatibility_enabled": false,
    "mac_type": "string",
    "mac_address": "string",
    "pci_slot_number": 0,
    "wake_on_lan_enabled": false,
    "backing": {
        "type": "string",
        "network": "string",
        "network_name": "string",
        "host_device": "string",
        "distributed_switch_uuid": "string",
        "distributed_port": "string",
        "connection_cookie": 0,
        "opaque_network_type": "string",
        "opaque_network_id": "string"
    },
    "state": "string",
    "start_connected": false,
    "allow_guest_control": false
}
string
label
Required

Device label.

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.

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.

boolean
upt_v2_compatibility_enabled
Optional

Flag indicates whether Uniform Pass-through version 2(UPTv2) compatibility is enabled on this network adapter. This field is optional and it is only relevant when the value of Ethernet.Info.type is VMXNET3.

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.

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 As int64
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
wake_on_lan_enabled
Required

Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.

backing
Required

The Ethernet.BackingInfo structure contains information about the physical resource backing a virtual Ethernet adapter.

state
Required

The ConnectionState enumerated type defines the valid states for a removable device that is configured to be connected.
CONNECTED : The device is connected and working correctly.
RECOVERABLE_ERROR : Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
UNRECOVERABLE_ERROR : Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
NOT_CONNECTED : The device is not connected.
UNKNOWN : The device status is unknown.

boolean
start_connected
Required

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

boolean
allow_guest_control
Required

Flag indicating whether the guest can connect and disconnect the device.