Vmware Distributed Virtual Switch Add DV Portgroup Task

Creates one or more DistributedVirtualPortgroups and adds them to the distributed virtual switch.

Required privileges: DVPortgroup.Create

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VmwareDistributedVirtualSwitch/{moId}/AddDVPortgroup_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 VmwareDistributedVirtualSwitch/{moId}.

string

release

Required

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

Request Body

AddDVPortgroupRequestType of type(s) application/json

Required

Show optional properties

{
    "spec": [
        {}
    ]
}

{
    "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"
        }
    ]
}

array of DVPortgroupConfigSpec

spec

Required

The specification for the portgroup.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns a Task object with which to monitor the operation. The method does not return a value in the Task.info.result property. Use the portgroup property to obtain managed object references to the new portgroups.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

NotSupported: If called directly on a host.

DvsFault: if operation fails on any host or if there are other update failures.

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"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations