Distributed Virtual Switch Manager DVS Manager Lookup Dv Port Group

Returns the portgroup identified by the key within the specified VDS identified by its UUID.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/DistributedVirtualSwitchManager/{moId}/DVSManagerLookupDvPortGroup

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 DistributedVirtualSwitchManager/{moId}.

string

release

Required

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

Request Body

DVSManagerLookupDvPortGroupRequestType of type(s) application/json

Required

{
    "switchUuid": "string",
    "portgroupKey": "string"
}

string

switchUuid

Required

The UUID of the DistributedVirtualSwitch.

string

portgroupKey

Required

The key that identifies a DistributedVirtualPortgroup.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefDistributedVirtualPortgroup of type(s) application/json

This response body class contains all of the following: MoRefNetwork

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

500

NotFound: If the portgroup for the specified inputs was not found.

NotSupported: If the operation is not supported.

Returns NotFound of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_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

Distributed Virtual Switch Manager Operations

POST

Distributed Virtual Switch Manager DVS Manager Export Entity Task