Distributed Virtual Portgroup Get Config

Distributed Virtual Portgroup Get Config

Configuration of the portgroup.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualPortgroup/{moId}/config
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case DistributedVirtualPortgroup/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns DVPortgroupConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "key": "string",
    "name": "string",
    "numPorts": 0,
    "distributedVirtualSwitch": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "defaultPortConfig": {
        "_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"
                }
            ]
        }
    },
    "description": "string",
    "type": "string",
    "backingType": "string",
    "policy": {
        "_typeName": "string",
        "blockOverrideAllowed": false,
        "shapingOverrideAllowed": false,
        "vendorConfigOverrideAllowed": false,
        "livePortMovingAllowed": false,
        "portConfigResetAtDisconnect": false,
        "networkResourcePoolOverrideAllowed": false,
        "trafficFilterOverrideAllowed": false
    },
    "portNameFormat": "string",
    "scope": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "vendorSpecificConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "opaqueData": "string"
        }
    ],
    "configVersion": "string",
    "autoExpand": false,
    "vmVnicNetworkResourcePoolKey": "string",
    "uplink": false,
    "transportZoneUuid": "string",
    "transportZoneName": "string",
    "logicalSwitchUuid": "string",
    "segmentId": "string"
}
string
key
Required

Key of the portgroup.

string
name
Required

Name of the portgroup.

integer As int32 As int32
numPorts
Required

Number of ports in the portgroup.

distributedVirtualSwitch
Optional

Reference to an instance of the DistributedVirtualSwitch managed object.

defaultPortConfig
Optional

The DVPortSetting data object describes the network configuration of a DistributedVirtualPort.

string
description
Optional

Description of the portgroup.

string
type
Required

Type of portgroup.

See DistributedVirtualPortgroup.DistributedVirtualPortgroupPortgroupTypeEnum for possible values.

string
backingType
Optional

Backing type of portgroup.

See DistributedVirtualPortgroup.DistributedVirtualPortgroupBackingTypeEnum for possible values. The default value is "standard"

policy
Required

The DistributedVirtualPortgroup policies.

This field is not applicable when queried directly against an ESX host.

string
portNameFormat
Optional

If set, a name will be automatically generated based on this format string for a port when it is created in or moved into the portgroup.

The format string can contain meta tags that will be resolved to the corresponding values in generating a name, if applicable for the port at the time of name generation.

To insert a meta tag in the format string, enclose the names defined as meta tag names inside angle brackets. See DistributedVirtualPortgroupMetaTagNameEnum for a list of currently available meta tags. For example, "redNetwork-<portIndex>" and "<dvsName>-pnic<portIndex>" result in generated port names like "redNetwork-2" and "switch-pnic3".

If a meta tag is recognized, but there is no applicable value, the tag will be expanded to empty string. If an arbitrary name appears inside a "<>" pair and is not recognized as one of the defined meta tags, the substring is treated as-is and appear unchanged in the generated name.

To prevent a meta tag from being expanded, prefix the meta tag with a '\' (backslash). For example, the format string "abc\<portIndex>def" results in the generated port name "abc<portIndex>def".

scope
Optional

Deprecated as of vSphere API 5.5.

Eligible entities that can connect to the portgroup.

If unset, there is no restriction on which entity can connect to the portgroup. If set, only the entities in the specified list or their child entities are allowed to connect to the portgroup. If scopes are defined at both port and portgroup level, they are taken as an "AND" relationship. If such a relationship doesn't make sense, the reconfigure operation will raise an exception.

vendorSpecificConfig
Optional

Opaque binary blob that stores vendor specific configuration.

string
configVersion
Optional

Configuration version number.

boolean
autoExpand
Optional

If set to true, this property ignores the limit on the number of ports in the portgroup.

When a Virtual Machine/Host tries to connect to the portgroup and there are no free ports available in the portgroup, new ports will be automatically added to the portgroup. The flag is currently supported only for static portgroups.

When this property is set to true, the portgroup becomes a potential candidate for auto-shrink. Once the portgroup has auto-expanded then its disconnected ports are likely to be deleted automatically, as a part of auto-shrink step, if there are more than certain number of free ports. If the portgroup never auto-expanded, then it will never lose any free ports.

string
vmVnicNetworkResourcePoolKey
Optional

The key of virtual NIC network resource pool to be associated with a portgroup.

The default value for this property is unset, indicating that this portgroup is not associated with any virtual NIC network resource pool. To clear the value of this property and revert to unset, set the DVPortgroupConfigSpec.vmVnicNetworkResourcePoolKey to "-1" in an update operation.

boolean
uplink
Optional

Indicates whether the portgroup is an uplink portroup.

string
transportZoneUuid
Optional

The UUID of transport zone to be associated with a NSX portgroup.

string
transportZoneName
Optional

The name of transport zone to be associated with a NSX portgroup.

string
logicalSwitchUuid
Optional

The logical switch UUID, which is used by NSX portgroup

string
segmentId
Optional

The segment ID of logical switch


Virtual Infrastructure Operations
POST
Distributed Virtual Portgroup Destroy Task
POST
Distributed Virtual Portgroup Destroy Network
POST
Distributed Virtual Portgroup DV Portgroup Rollback Task
GET
Distributed Virtual Portgroup Get Alarm Actions Enabled
GET
Distributed Virtual Portgroup Get Available Field
GET
Distributed Virtual Portgroup Get Config
GET
Distributed Virtual Portgroup Get Config Issue
GET
Distributed Virtual Portgroup Get Config Status
GET
Distributed Virtual Portgroup Get Custom Value
GET
Distributed Virtual Portgroup Get Declared Alarm State
GET
Distributed Virtual Portgroup Get Disabled Method
GET
Distributed Virtual Portgroup Get Effective Role
GET
Distributed Virtual Portgroup Get Host
GET
Distributed Virtual Portgroup Get Key
GET
Distributed Virtual Portgroup Get Name
GET
Distributed Virtual Portgroup Get Overall Status
GET
Distributed Virtual Portgroup Get Parent
GET
Distributed Virtual Portgroup Get Permission
GET
Distributed Virtual Portgroup Get Port Keys
GET
Distributed Virtual Portgroup Get Recent Task
GET
Distributed Virtual Portgroup Get Summary
GET
Distributed Virtual Portgroup Get Tag
GET
Distributed Virtual Portgroup Get Triggered Alarm State
GET
Distributed Virtual Portgroup Get Value
GET
Distributed Virtual Portgroup Get Vm
POST
Distributed Virtual Portgroup Reconfigure DV Portgroup Task
POST
Distributed Virtual Portgroup Reload
POST
Distributed Virtual Portgroup Rename Task
POST
Distributed Virtual Portgroup Set Custom Value