Data Object Description

DVPortStatus

DistributedVirtualPort

Properties

Name	Type	Description
blocked	xsd:boolean	Indicates whether the port is blocked by switch implementation.
linkPeer*	xsd:string	Name of the connected entity.
linkUp	xsd:boolean	Indicates whether the port is in linkUp status.
macAddress*	xsd:string	The MAC address that is used at this port.
mtu*	xsd:int	Maximum transmission unit (MTU) of the port. You can set the MTU only at the switch level (VMwareDVSConfigSpec). If you attempt to change it at the portgroup or port level, the Server throws an exception.
statusDetail*	xsd:string	Additional information regarding the current status of the port. *Since* vSphere API 4.1
trunkingMode*	xsd:boolean	True if the port VLAN tagging/stripping is disabled.
vlanIds*	NumericRange[]	VLAN ID of the port.
vmDirectPathGen2Active*	xsd:boolean	Indicates whether VMDirectPath Gen 2 is active on this port. If false, the reason(s) for inactivity will be provided in one or more of vmDirectPathGen2InactiveReasonNetwork, vmDirectPathGen2InactiveReasonOther, and vmDirectPathGen2InactiveReasonExtended. If the host software is not capable of VMDirectPath Gen 2, this property will be unset. See HostCapability.vmDirectPathGen2Supported. *Since* vSphere API 4.1
vmDirectPathGen2InactiveReasonExtended*	xsd:string	If vmDirectPathGen2Active is false, this property may contain an explanation provided by the platform, beyond the reasons (if any) listed in vmDirectPathGen2InactiveReasonNetwork and/or vmDirectPathGen2InactiveReasonOther. *Since* vSphere API 4.1
vmDirectPathGen2InactiveReasonNetwork*	xsd:string[]	If vmDirectPathGen2Active is false, this array will be populated with reasons for the inactivity that are related to network state or configuration. The reasons are chosen from the DVPortStatusVmDirectPathGen2InactiveReasonNetwork values. Other reasons for inactivity will be provided in vmDirectPathGen2InactiveReasonOther. If there is a reason for inactivity that cannot be described by the available constants, vmDirectPathGen2InactiveReasonExtended will be populated with an additional explanation provided by the platform. Note that this list of reasons is not guaranteed to be exhaustive. *Since* vSphere API 4.1
vmDirectPathGen2InactiveReasonOther*	xsd:string[]	If vmDirectPathGen2Active is false, this array will be populated with reasons for the inactivity that are not related to network state or configuration. The reasons are chosen from the DVPortStatusVmDirectPathGen2InactiveReasonOther values. Network-related reasons for inactivity will be provided in vmDirectPathGen2InactiveReasonNetwork. If there is a reason for inactivity that cannot be described by the available constants, vmDirectPathGen2InactiveReasonExtended will be populated with an additional explanation provided by the platform. Note that this list of reasons is not guaranteed to be exhaustive. See vmDirectPathGen2Supported *Since* vSphere API 4.1
Properties inherited from DynamicData
dynamicProperty, dynamicType

Name

Type

Description

blocked

xsd:boolean

Indicates whether the port is blocked by switch implementation.

linkPeer*

xsd:string

Name of the connected entity.

linkUp

xsd:boolean

Indicates whether the port is in linkUp status.

macAddress*

xsd:string

The MAC address that is used at this port.

mtu*

xsd:int

Maximum transmission unit (MTU) of the port. You can set the MTU only at the switch level (VMwareDVSConfigSpec). If you attempt to change it at the portgroup or port level, the Server throws an exception.

statusDetail*

xsd:string

Additional information regarding the current status of the port.

Since vSphere API 4.1

trunkingMode*

xsd:boolean

True if the port VLAN tagging/stripping is disabled.

vlanIds*

NumericRange[]

VLAN ID of the port.

vmDirectPathGen2Active*

xsd:boolean

Indicates whether VMDirectPath Gen 2 is active on this port. If false, the reason(s) for inactivity will be provided in one or more of vmDirectPathGen2InactiveReasonNetwork, vmDirectPathGen2InactiveReasonOther, and vmDirectPathGen2InactiveReasonExtended.

If the host software is not capable of VMDirectPath Gen 2, this property will be unset. See HostCapability.vmDirectPathGen2Supported.

Since vSphere API 4.1

vmDirectPathGen2InactiveReasonExtended*

xsd:string

If vmDirectPathGen2Active is false, this property may contain an explanation provided by the platform, beyond the reasons (if any) listed in vmDirectPathGen2InactiveReasonNetwork and/or vmDirectPathGen2InactiveReasonOther.

Since vSphere API 4.1

vmDirectPathGen2InactiveReasonNetwork*

xsd:string[]

If vmDirectPathGen2Active is false, this array will be populated with reasons for the inactivity that are related to network state or configuration. The reasons are chosen from the DVPortStatusVmDirectPathGen2InactiveReasonNetwork values.

Other reasons for inactivity will be provided in vmDirectPathGen2InactiveReasonOther. If there is a reason for inactivity that cannot be described by the available constants, vmDirectPathGen2InactiveReasonExtended will be populated with an additional explanation provided by the platform.

Note that this list of reasons is not guaranteed to be exhaustive.

Since vSphere API 4.1

vmDirectPathGen2InactiveReasonOther*

xsd:string[]

If vmDirectPathGen2Active is false, this array will be populated with reasons for the inactivity that are not related to network state or configuration. The reasons are chosen from the DVPortStatusVmDirectPathGen2InactiveReasonOther values.

Network-related reasons for inactivity will be provided in vmDirectPathGen2InactiveReasonNetwork. If there is a reason for inactivity that cannot be described by the available constants, vmDirectPathGen2InactiveReasonExtended will be populated with an additional explanation provided by the platform.

Note that this list of reasons is not guaranteed to be exhaustive.
See vmDirectPathGen2Supported

Since vSphere API 4.1

Properties inherited from DynamicData

dynamicProperty, dynamicType

Need not be set

Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="DVPortStatus">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="linkUp" type="xsd:boolean"/>
                     <element name="blocked" type="xsd:boolean"/>
                     <element name="vlanIds" type="vim25:NumericRange" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="trunkingMode" type="xsd:boolean" minOccurs="0"/>
                     <element name="mtu" type="xsd:int" minOccurs="0"/>
                     <element name="linkPeer" type="xsd:string" minOccurs="0"/>
                     <element name="macAddress" type="xsd:string" minOccurs="0"/>
                     <element name="statusDetail" type="xsd:string" minOccurs="0"/>
                     <element name="vmDirectPathGen2Active" type="xsd:boolean" minOccurs="0"/>
                     <element name="vmDirectPathGen2InactiveReasonNetwork" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="vmDirectPathGen2InactiveReasonOther" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="vmDirectPathGen2InactiveReasonExtended" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

Data Object - DVPortStatus

Data Object Description