DVPortStatus

DVPortStatus
DVPortStatus

The DVPortStatus data object contains runtime information about a DistributedVirtualPort.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "linkUp": false,
    "blocked": false,
    "vlanIds": [
        {
            "_typeName": "string",
            "start": 0,
            "end": 0
        }
    ],
    "trunkingMode": false,
    "mtu": 0,
    "linkPeer": "string",
    "macAddress": "string",
    "statusDetail": "string",
    "vmDirectPathGen2Active": false,
    "vmDirectPathGen2InactiveReasonNetwork": [
        "string"
    ],
    "vmDirectPathGen2InactiveReasonOther": [
        "string"
    ],
    "vmDirectPathGen2InactiveReasonExtended": "string"
}
boolean
linkUp
Required

Indicates whether the port is in linkUp status.

boolean
blocked
Required

Indicates whether the port is blocked by switch implementation.

vlanIds
Optional

VLAN ID of the port.

boolean
trunkingMode
Optional

True if the port VLAN tagging/stripping is disabled.

integer As int32 As int32
mtu
Optional

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.

string
linkPeer
Optional

Name of the connected entity.

string
macAddress
Optional

The MAC address that is used at this port.

string
statusDetail
Optional

Additional information regarding the current status of the port.

boolean
vmDirectPathGen2Active
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

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.

array of string
vmDirectPathGen2InactiveReasonNetwork
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

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 DVPortStatusVmDirectPathGen2InactiveReasonNetworkEnum 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.

array of string
vmDirectPathGen2InactiveReasonOther
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

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 DVPortStatusVmDirectPathGen2InactiveReasonOtherEnum 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 also vmDirectPathGen2Supported.

string
vmDirectPathGen2InactiveReasonExtended
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

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.