Vm_Hardware_Ethernet_BackingInfo

Vm_Hardware_Ethernet_BackingInfo
Vm_Hardware_Ethernet_BackingInfo

The Ethernet.BackingInfo structure contains information about the physical resource backing a virtual Ethernet adapter.

JSON Example
{
    "type": "string",
    "network": "string",
    "network_name": "string",
    "host_device": "string",
    "distributed_switch_uuid": "string",
    "distributed_port": "string",
    "connection_cookie": 0,
    "opaque_network_type": "string",
    "opaque_network_id": "string"
}
type
Required

The Ethernet.BackingType enumerated type defines the valid backing types for a virtual Ethernet adapter.
STANDARD_PORTGROUP : vSphere standard portgroup network backing.
HOST_DEVICE : Legacy host device network backing. Imported VMs may have virtual Ethernet adapters with this type of backing, but this type of backing cannot be used to create or to update a virtual Ethernet adapter.
DISTRIBUTED_PORTGROUP : Distributed virtual switch backing.
OPAQUE_NETWORK : Opaque network backing.

string
network
Optional

Identifier of the network backing the virtual Ethernet adapter. If unset, the identifier of the network backing could not be determined. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network.

string
network_name
Optional

Name of the standard portgroup backing the virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.BackingInfo.type is STANDARD_PORTGROUP.

string
host_device
Optional

Name of the device backing the virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.BackingInfo.type is HOST_DEVICE.

string
distributed_switch_uuid
Optional

UUID of the distributed virtual switch that backs the virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.BackingInfo.type is DISTRIBUTED_PORTGROUP.

string
distributed_port
Optional

Key of the distributed virtual port that backs the virtual Ethernet adapter. This field will be unset if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

integer As int64
connection_cookie
Optional

Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port. This field will be unset if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

string
opaque_network_type
Optional

Type of the opaque network that backs the virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.BackingInfo.type is OPAQUE_NETWORK.

string
opaque_network_id
Optional

Identifier of the opaque network that backs the virtual Ethernet adapter. This field is optional and it is only relevant when the value of Ethernet.BackingInfo.type is OPAQUE_NETWORK.