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.

VmHardwareEthernetBackingInfo

backing Required

Physical resource backing for the virtual Ethernet adapter.

string

label Required

Device label.

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.

VmHardwareEthernetMacAddressType Enum

mac_type Required

MAC address type.

integer

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

start_connected Required

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

VmHardwareConnectionState

state Required

Connection status of the virtual device.

VmHardwareEthernetEmulationType Enum

type Required

Ethernet adapter emulation type.

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

wake_on_lan_enabled Required

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

Property Of

VmHardwareEthernetGetResponseBody

JSON Example

Show optional properties

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

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

VmHardwareEthernetInfo

Properties

Property Of

JSON Example

Was this page helpful?