DistributedVirtualPort

DistributedVirtualPort
DistributedVirtualPort

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

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": "string",
    "config": {
        "_typeName": "string",
        "name": "string",
        "scope": [
            {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        ],
        "description": "string",
        "setting": {
            "_typeName": "string",
            "blocked": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "vmDirectPathGen2Allowed": {
                "_typeName": "string",
                "inherited": false,
                "value": false
            },
            "inShapingPolicy": {
                "_typeName": "string",
                "inherited": false,
                "enabled": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "averageBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "peakBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "burstSize": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                }
            },
            "outShapingPolicy": {
                "_typeName": "string",
                "inherited": false,
                "enabled": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": false
                },
                "averageBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "peakBandwidth": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                },
                "burstSize": {
                    "_typeName": "string",
                    "inherited": false,
                    "value": 0
                }
            },
            "vendorSpecificConfig": {
                "_typeName": "string",
                "inherited": false,
                "keyValue": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "opaqueData": "string"
                    }
                ]
            },
            "networkResourcePoolKey": {
                "_typeName": "string",
                "inherited": false,
                "value": "string"
            },
            "filterPolicy": {
                "_typeName": "string",
                "inherited": false,
                "filterConfig": [
                    {
                        "_typeName": "string",
                        "inherited": false,
                        "key": "string",
                        "agentName": "string",
                        "slotNumber": "string",
                        "parameters": {
                            "_typeName": "string",
                            "parameters": [
                                "string"
                            ]
                        },
                        "onFailure": "string"
                    }
                ]
            }
        },
        "configVersion": "string"
    },
    "dvsUuid": "string",
    "portgroupKey": "string",
    "proxyHost": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "connectee": {
        "_typeName": "string",
        "connectedEntity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "nicKey": "string",
        "type": "string",
        "addressHint": "string"
    },
    "conflict": false,
    "conflictPortKey": "string",
    "state": {
        "_typeName": "string",
        "runtimeInfo": {
            "_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"
        },
        "stats": {
            "_typeName": "string",
            "packetsInMulticast": 0,
            "packetsOutMulticast": 0,
            "bytesInMulticast": 0,
            "bytesOutMulticast": 0,
            "packetsInUnicast": 0,
            "packetsOutUnicast": 0,
            "bytesInUnicast": 0,
            "bytesOutUnicast": 0,
            "packetsInBroadcast": 0,
            "packetsOutBroadcast": 0,
            "bytesInBroadcast": 0,
            "bytesOutBroadcast": 0,
            "packetsInDropped": 0,
            "packetsOutDropped": 0,
            "packetsInException": 0,
            "packetsOutException": 0,
            "bytesInFromPnic": 0,
            "bytesOutToPnic": 0
        },
        "vendorSpecificState": [
            {
                "_typeName": "string",
                "key": "string",
                "opaqueData": "string"
            }
        ]
    },
    "connectionCookie": 0,
    "lastStatusChange": "string",
    "hostLocalPort": false,
    "externalId": "string",
    "segmentPortId": "string"
}
string
key
Required

Port key.

config
Required

Management related configuration of a DistributedVirtualPort.

string
dvsUuid
Required

UUID of the DistributedVirtualSwitch to which the port belongs.

string
portgroupKey
Optional

Key of the portgroup DistributedVirtualPortgroup to which the port belongs, if any.

proxyHost
Optional

Reference to an instance of the HostSystem managed object.

connectee
Optional

Information about the entity that connects to a DistributedVirtualPort.

boolean
conflict
Required

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.

string
conflictPortKey
Optional

If the port is marked conflict in the case of two entities connecting to the same port (see DistributedVirtualPort.conflict), this is the key of the port which the connected entity is contending for.

state
Optional

The state of a DistributedVirtualPort.

integer As int32 As int32
connectionCookie
Optional

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.DistributedVirtualSwitchPortConnection.connectionCookie) so that the Server can verify that the entity is the rightful connectee of the port.

string As date-time As date-time
lastStatusChange
Required

The last time the DistributedVirtualPort.state.DVPortState.runtimeInfo value was changed.

boolean
hostLocalPort
Optional

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.

string
externalId
Optional

Populate the Id assigned to vmknic or vnic by external management plane to port, if the port is connected to the nics.

string
segmentPortId
Optional

Populate the segmentPortId assigned to LSP.