VmHardwareEthernetCreateSpec

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


Properties

boolean
allow_guest_control Optional

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


backing Optional

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.


string
mac_address Optional

MAC address. Workaround for PR1459647


mac_type Optional

MAC address type. If unset, defaults to GENERATED.

Possible values are: MANUALGENERATEDASSIGNED


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


boolean
start_connected Optional

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


type Optional

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

Possible values are: E1000E1000EPCNET32VMXNETVMXNET2VMXNET3


boolean
upt_compatibility_enabled Optional

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


boolean
wake_on_lan_enabled Optional

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

JSON Example

{
    "allow_guest_control": false,
    "backing": {
        "distributed_port": "string",
        "network": "string",
        "type": "enum"
    },
    "mac_address": "string",
    "mac_type": "enum",
    "pci_slot_number": 0,
    "start_connected": false,
    "type": "enum",
    "upt_compatibility_enabled": false,
    "wake_on_lan_enabled": false
}
Feedback

Was this page helpful?