DVPortgroupConfigSpec

The DVPortgroupConfigSpec data object contains configuration data for a DistributedVirtualPortgroup.

Use the ReconfigureDVPortgroup_Task method to apply the configuration to the portgroup.

AllOf

This class requires all of the following:

JSON Example

{
    "_typeName": "string",
    "dynamicProperty": [
        {
            "_typeName": "string",
            "name": "string",
            "val": {
                "_typeName": "string"
            }
        }
    ],
    "configVersion": "string",
    "name": "string",
    "numPorts": 0,
    "portNameFormat": "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",
    "scope": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "policy": {
        "_typeName": "string",
        "blockOverrideAllowed": false,
        "shapingOverrideAllowed": false,
        "vendorConfigOverrideAllowed": false,
        "livePortMovingAllowed": false,
        "portConfigResetAtDisconnect": false,
        "networkResourcePoolOverrideAllowed": false,
        "trafficFilterOverrideAllowed": false
    },
    "vendorSpecificConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "opaqueData": "string"
        }
    ],
    "autoExpand": false,
    "vmVnicNetworkResourcePoolKey": "string",
    "transportZoneUuid": "string",
    "transportZoneName": "string",
    "logicalSwitchUuid": "string",
    "segmentId": "string"
}

array of DynamicProperty

dynamicProperty

Optional

Set of dynamic properties.

This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future.

string

configVersion

Optional

Version string of the configuration that this spec is trying to change.

This property is required in reconfiguring a portgroup and should be set to the same value as the configVersion. This property is ignored in creating a portgroup if set.

string

name

Optional

Name of the portgroup.

integer As int32 As int32

numPorts

Optional

Number of ports in the portgroup.

Setting this number larger than the number of existing ports in the portgroup causes new ports to be added to the portgroup to meet the number. Setting this property smaller than the number of existing ports deletes the free ports from the portgroup. If the number cannot be met by deleting free ports, a fault is raised. If new ports are added to the portgroup, they are also added to the switch. For portgroups of type ephemeral this property is ignored.

string

portNameFormat

Optional

Format of the name of the ports when ports are created in the portgroup.

For details see portNameFormat.

DVPortSetting

defaultPortConfig

Optional

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

string

description

Optional

Description of the portgroup.

string

type

Optional

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"

array of MoRefManagedEntity

scope

Optional

Deprecated as of vSphere API 5.5.

Eligible entities that can connect to the port.

See DVPortgroupConfigInfo.scope.

DVPortgroupPolicy

policy

Optional

The DistributedVirtualPortgroup policies.

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

array of DistributedVirtualSwitchKeyedOpaqueBlob

vendorSpecificConfig

Optional

Opaque binary blob that stores vendor specific configuration.

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.

Setting this property to true makes the portgroup 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.

Setting this property to "-1", would mean that this portgroup is not associated with any virtual NIC network resource pool.

string

transportZoneUuid

Optional

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

string

transportZoneName

Optional