Developer Documentation

EthernetCreateSpec

The Ethernet.CreateSpec structure provides a specification for the configuration of a newly-created virtual Ethernet adapter.


Properties

Required Property Name Type Description
optional allow_guest_control boolean

Flag indicating whether the guest can connect and disconnect the device. Defaults to false if unset.

optional backing EthernetBackingSpec

Physical resource backing for the virtual Ethernet adapter. If unset, the system may try to find an appropriate backing. If one is not found, the request will fail.

optional mac_address string

MAC address. Workaround for PR1459647

optional mac_type EthernetMacAddressType Enum

MAC address type. If unset, defaults to GENERATED.

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 when it the VM is started or as the device is hot added. If unset, the server will choose an available address when the virtual machine is powered on.

optional start_connected boolean

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if unset.

optional type EthernetEmulationType Enum

Ethernet adapter emulation type. If unset, defaults to a guest-specific type.

optional upt_compatibility_enabled boolean

Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter. If unset, defaults to false.

optional wake_on_lan_enabled boolean

Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter. Defaults to false if unset.

Feedback

Was this page helpful?