Distributed Virtual Portgroup Reconfigure DV Portgroup Task

Distributed Virtual Portgroup Reconfigure DV Portgroup Task

Reconfigures one or more distributed virtual portgroups.

You can use this method to set portgroup properties or to reset the portgroup to a previous state.

Reconfiguring a Standard Distributed Virtual Portgroup

To reconfigure a DistributedVirtualPortgroup, use a DVPortgroupConfigSpec to set the portgroup properties.

Reconfiguring a Portgroup Associated With a VMware Distributed Virtual Switch

If you use a VmwareDistributedVirtualSwitch, you can perform the following portgroup reconfiguration:

The following privileges are required to reconfigure a portgroup.

  • DVPortgroup.PolicyOp if you are changing the policy of the portgroup.
  • DVPortgroup.ScopeOp if you are changing the scope of the portgroup.
  • DVPortgroup.Modify for anything else.
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualPortgroup/{moId}/ReconfigureDVPortgroup_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method 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.2.0 APIs.


Request Body
ReconfigureDVPortgroupRequestType of type(s) application/json
Required
{
    "spec": {
        "_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"
    }
}
spec
Required

The DVPortgroupConfigSpec data object contains configuration data for a DistributedVirtualPortgroup.

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

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

DvsFault: if spec is not valid.

NotSupported: if the spec includes settings for any VDS feature that is not supported on this switch.

DvsNotAuthorized: if login-session's extension key does not match the switch's configured extensionKey.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

Distributed Virtual Portgroup 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