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:
- Use a DVPortgroupConfigSpec to set the portgroup properties.
- Use the DVPortgroupConfigSpec returned by DVPortgroupRollback_Task to reset the portgroup to a previous state.
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.
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}.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"spec": {
"dynamicProperty": [
{
"_typeName": "string",
"name": "string",
"val": {
"_typeName": "string"
}
}
],
"configVersion": "string",
"name": "string",
"numPorts": 0,
"portNameFormat": "string",
"defaultPortConfig": {
"blocked": {
"value": false
},
"vmDirectPathGen2Allowed": {
"value": false
},
"inShapingPolicy": {
"enabled": {
"value": false
},
"averageBandwidth": {
"value": 0
},
"peakBandwidth": {
"value": 0
},
"burstSize": {
"value": 0
}
},
"outShapingPolicy": {
"enabled": {
"value": false
},
"averageBandwidth": {
"value": 0
},
"peakBandwidth": {
"value": 0
},
"burstSize": {
"value": 0
}
},
"vendorSpecificConfig": {
"keyValue": [
{
"_typeName": "string",
"key": "string",
"opaqueData": "string"
}
]
},
"networkResourcePoolKey": {
"value": "string"
},
"filterPolicy": {
"filterConfig": [
{
"_typeName": "string",
"inherited": false,
"key": "string",
"agentName": "string",
"slotNumber": "string",
"parameters": {
"parameters": [
"string"
]
},
"onFailure": "string"
}
]
}
},
"description": "string",
"type": "string",
"backingType": "string",
"scope": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"policy": {
"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"
}
}The DVPortgroupConfigSpec data object contains configuration data for a DistributedVirtualPortgroup.
Use the ReconfigureDVPortgroup_Task method to apply the configuration to the portgroup.
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}