Data Object - DistributedVirtualPort(vim.dvs.DistributedVirtualPort)

Returned by: FetchDVPorts
Extends: DynamicData
See also: DistributedVirtualSwitchPortConnectee, DVPortConfigInfo, DVPortState, HostSystem
Since: vSphere API Release 4.0

Data Object Description

The DistributedVirtualPort data object represents a port in a DistributedVirtualSwitch. Virtual ports are part of a distributed virtual portgroup. Servers create virtual ports according to the portgroup type (DistributedVirtualPortgroup.Config.type). See DistributedVirtualPortgroupPortgroupType.

To configure host network access by port, set the distributed virtual port in the host virtual NIC specification (HostVirtualNicSpec.distributedVirtualPort.portKey).

To configure virtual machine network access by port, set the port in the virtual Ethernet card backing (VirtualEthernetCard.backing.port.portKey).

Properties

Name	Type	Description
config	DVPortConfigInfo	Port configuration, including identifying information, network settings, and the set of entities that can connect to the port.
conflict	xsd:boolean	Specifies whether the port is a conflict port. A port could be marked as conflict if an entity is discovered connecting to a port that is already occupied, or if the host creates a port without conferring with vCenter Server. The distributed virtual switch does not persist the runtime state of a conflict port. Also, the port cannot move away from the host. vCenter Server will not move a virtual machine (VMotion) that is using a conflict port.
conflictPortKey*	xsd:string	If the port is marked conflict in the case of two entities connecting to the same port (see conflict), this is the key of the port which the connected entity is contending for.
connectee*	DistributedVirtualSwitchPortConnectee	Entity that connects to the port.
connectionCookie*	xsd:int	Cookie representing the current instance of association between a port and a virtual or physical NIC. See DistributedVirtualSwitchPortConnection. The same cookie is present in the physical or virtual NIC configuration (DistributedVirtualSwitchPortConnection.connectionCookie) so that the Server can verify that the entity is the rightful connectee of the port.
dvsUuid	xsd:string	UUID of the DistributedVirtualSwitch to which the port belongs.
externalId*	xsd:string	Populate the Id assigned to vmknic or vnic by external management plane to port, if the port is connected to the nics. *Since* vSphere API Release 7.0
hostLocalPort*	xsd:boolean	Specifies whether the port is a host local port. A host local port is created to resurrect the management network connection on a VMkernel virtual NIC. You cannot use vCenter Server to reconfigure this port and you cannot reassign the port. *Since* vSphere API Release 5.1
key	xsd:string	Port key.
lastStatusChange	xsd:dateTime	The last time the state.runtimeInfo value was changed.
portgroupKey*	xsd:string	Key of the portgroup DistributedVirtualPortgroup to which the port belongs, if any.
proxyHost*	ManagedObjectReference to a HostSystem	HostSystem that services this port.
segmentPortId*	xsd:string	Populate the segmentPortId assigned to LSP. *Since* vSphere API Release 7.0
state*	DVPortState	Runtime state of the port.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DistributedVirtualPort">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="key" type="xsd:string"/>
                     <element name="config" type="vim25:DVPortConfigInfo"/>
                     <element name="dvsUuid" type="xsd:string"/>
                     <element name="portgroupKey" type="xsd:string" minOccurs="0"/>
                     <element name="proxyHost" type="vim25:ManagedObjectReference" minOccurs="0"/>
                     <element name="connectee" type="vim25:DistributedVirtualSwitchPortConnectee" minOccurs="0"/>
                     <element name="conflict" type="xsd:boolean"/>
                     <element name="conflictPortKey" type="xsd:string" minOccurs="0"/>
                     <element name="state" type="vim25:DVPortState" minOccurs="0"/>
                     <element name="connectionCookie" type="xsd:int" minOccurs="0"/>
                     <element name="lastStatusChange" type="xsd:dateTime"/>
                     <element name="hostLocalPort" type="xsd:boolean" minOccurs="0"/>
                     <element name="externalId" type="xsd:string" minOccurs="0"/>
                     <element name="segmentPortId" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - DistributedVirtualPort(vim.dvs.DistributedVirtualPort)

Data Object Description