VmHardwareEthernetInfo

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


Properties

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

MAC address type.

Possible values are: MANUALGENERATEDASSIGNED


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: CONNECTEDRECOVERABLE_ERRORUNRECOVERABLE_ERRORNOT_CONNECTEDUNKNOWN


type Required

Ethernet adapter emulation type.

Possible values are: E1000E1000EPCNET32VMXNETVMXNET2VMXNET3


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 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
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.

JSON Example

{
    "allow_guest_control": false,
    "backing": {
        "type": "enum"
    },
    "label": "string",
    "mac_type": "enum",
    "start_connected": false,
    "state": "enum",
    "type": "enum",
    "wake_on_lan_enabled": false
}
Returned By

Get Hardware Ethernet
Feedback

Was this page helpful?