1. Types
  2. vcenter
  3. vm
  4. hardware
  5. ethernet

vcenter vm hardware ethernet: info

The info structure contains information about a virtual Ethernet adapter.

Representations:

{
    "allow_guest_control": true,
    "backing": {
        "connection_cookie": 1,
        "distributed_port": "string",
        "distributed_switch_uuid": "string",
        "host_device": "string",
        "network": "obj-103",
        "network_name": "string",
        "opaque_network_id": "string",
        "opaque_network_type": "string",
        "type": "STANDARD_PORTGROUP"
    },
    "label": "string",
    "mac_address": "string",
    "mac_type": "MANUAL",
    "pci_slot_number": 1,
    "start_connected": true,
    "state": "CONNECTED",
    "type": "E1000",
    "upt_compatibility_enabled": true,
    "wake_on_lan_enabled": true
}
<?xml version="1.0" ?>
<ns0:Info xmlns:ns0="http://vmware.com/vcenter/vm/hardware/ethernet" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <pci_slot_number>1</pci_slot_number>
  <mac_address>string</mac_address>
  <upt_compatibility_enabled>true</upt_compatibility_enabled>
  <mac_type>MANUAL</mac_type>
  <state>CONNECTED</state>
  <label>string</label>
  <allow_guest_control>true</allow_guest_control>
  <type>E1000</type>
  <backing>
    <connection_cookie>1</connection_cookie>
    <opaque_network_type>string</opaque_network_type>
    <distributed_switch_uuid>string</distributed_switch_uuid>
    <network_name>string</network_name>
    <distributed_port>string</distributed_port>
    <type>STANDARD_PORTGROUP</type>
    <opaque_network_id>string</opaque_network_id>
    <network>obj-103</network>
    <host_device>string</host_device>
  </backing>
  <wake_on_lan_enabled>true</wake_on_lan_enabled>
  <start_connected>true</start_connected>
</ns0:Info>

Attributes:

Name Type Description
Required
label string Device label.
type string Ethernet adapter emulation type.

Defines the valid emulation types for a virtual Ethernet adapter. Value is one of:
E1000: E1000 ethernet adapter.
E1000E: E1000e ethernet adapter.
PCNET32: AMD Lance PCNet32 Ethernet adapter.
VMXNET: VMware Vmxnet virtual Ethernet adapter.
VMXNET2: VMware Vmxnet2 virtual Ethernet adapter.
VMXNET3: VMware Vmxnet3 virtual Ethernet adapter.
mac_type string MAC address type.

Defines the valid MAC address origins for a virtual Ethernet adapter. Value is one of:
MANUAL: MAC address is assigned statically.
GENERATED: MAC address is generated automatically.
ASSIGNED: MAC address is assigned by vCenter Server.
wake_on_lan_enabled boolean Flag indicating whether wake-on-LAN is enabled on this virtual Ethernet adapter.
backing backing_info Physical resource backing for the virtual Ethernet adapter.
state string Connection status of the virtual device.

Defines the valid states for a removable device that is configured to be connected. Value is one of:
CONNECTED: The device is connected and working correctly.
RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
NOT_CONNECTED: The device is not connected.
UNKNOWN: The device status is unknown.
start_connected boolean Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
allow_guest_control boolean Flag indicating whether the guest can connect and disconnect the device.
Optional
upt_compatibility_enabled boolean Flag indicating whether Universal Pass-Through (UPT) compatibility is enabled on this virtual Ethernet adapter.

Optional. It is only relevant when type has value VMXNET3. This field is optional and it is only relevant when the value of type is VMXNE_t3.
mac_address string MAC address.

Optional. May be unset if vcenter.vm.hardware.ethernet.info.mac_type is MANUAL and has not been specified, or if vcenter.vm.hardware.ethernet.info.mac_type is GENERATED and the virtual machine has never been powered on since the Ethernet adapter was created.
pci_slot_number long 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.

Optional. May be unset if the virtual machine has never been powered on since the adapter was created.