Developer Documentation

EthernetInfo

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


Properties

Required Property Name Type Description
required allow_guest_control boolean

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

required backing EthernetBackingInfo

Physical resource backing for the virtual Ethernet adapter.

required label string

Device label.

optional mac_address string

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.

required mac_type EthernetMacAddressType Enum

MAC address type.

optional pci_slot_number integer

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.

required start_connected boolean

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

required state HardwareConnectionState

Connection status of the virtual device.

required type EthernetEmulationType Enum

Ethernet adapter emulation type.

optional upt_compatibility_enabled boolean

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.

required wake_on_lan_enabled boolean

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

Feedback

Was this page helpful?