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

vcenter vm hardware ethernet: backing info

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

Representation:

{
    "connection_cookie" : 1,
    "distributed_switch_uuid" : "string",
    "distributed_port" : "string",
    "network_name" : "string",
    "opaque_network_type" : "string",
    "type" : "STANDARD_PORTGROUP",
    "host_device" : "string",
    "opaque_network_id" : "string",
    "network" : "obj-103"
}

Attributes:

Name Type Description
Required
type string Backing type for the virtual Ethernet adapter.

Defines the valid backing types for a virtual Ethernet adapter. Value is one of:
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.
Optional
network string Identifier of the network backing the virtual Ethernet adapter.

Optional. It is only relevant when type has value [STANDARD_PORTGROUP, DISTRIBUTED_PORTGROUP, OPAQUE_NETWORK]. 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.
network_name string Name of the standard portgroup backing the virtual Ethernet adapter.

Optional. It is only relevant when type has value STANDARD_PORTGROUP. This field is optional and it is only relevant when the value of type is STANDARD_PORTGROUP.
host_device string Name of the device backing the virtual Ethernet adapter.

Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of type is HOST_DEVICE.
distributed_switch_uuid string UUID of the distributed virtual switch that backs the virtual Ethernet adapter.

Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. This field is optional and it is only relevant when the value of type is DISTRIBUTED_PORTGROUP.
distributed_port string Key of the distributed virtual port that backs the virtual Ethernet adapter.

Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. 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.
connection_cookie long 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.

Optional. It is only relevant when type has value DISTRIBUTED_PORTGROUP. 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.
opaque_network_type string Type of the opaque network that backs the virtual Ethernet adapter.

Optional. It is only relevant when type has value OPAQUE_NETWORK. This field is optional and it is only relevant when the value of type is OPAQUE_NETWORK.
opaque_network_id string Identifier of the opaque network that backs the virtual Ethernet adapter.

Optional. It is only relevant when type has value OPAQUE_NETWORK. This field is optional and it is only relevant when the value of type is OPAQUE_NETWORK.