REST API - backing

vcenter vm hardware ethernet: backing info

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

Representations:

JSON
XML

{
    "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"
}

<?xml version="1.0" ?>
<ns0:BackingInfo xmlns:ns0="http://vmware.com/vcenter/vm/hardware/ethernet" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <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>
</ns0:BackingInfo>

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.