Distributed Virtual Switch Manager Query Dvs Config Target

This operation returns the DistributedVirtualSwitch or DistributedVirtualPortgroup configuration target on a host.

Required privileges: System.View

Request

URI

POST

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

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.3.0 APIs.

Request Body

QueryDvsConfigTargetRequestType of type(s) application/json

Required

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

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

MoRefDistributedVirtualSwitch

dvs

Optional

Reference to an instance of the DistributedVirtualSwitch managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns DVSManagerDvsConfigTarget of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "distributedVirtualPortgroup": [
        {
            "_typeName": "string",
            "switchName": "string",
            "switchUuid": "string",
            "portgroupName": "string",
            "portgroupKey": "string",
            "portgroupType": "string",
            "uplinkPortgroup": false,
            "portgroup": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "networkReservationSupported": false,
            "backingType": "string",
            "logicalSwitchUuid": "string",
            "segmentId": "string"
        }
    ],
    "distributedVirtualSwitch": [
        {
            "_typeName": "string",
            "switchName": "string",
            "switchUuid": "string",
            "distributedVirtualSwitch": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "networkReservationSupported": false
        }
    ]
}

array of DistributedVirtualPortgroupInfo

distributedVirtualPortgroup

Optional

List of any DistributedVirtualPortgroup available for host Virtual NIC connection.

array of DistributedVirtualSwitchInfo

distributedVirtualSwitch

Optional

List of any DistributedVirtualSwitch available for host Virtual NIC connection.

On This Page

Description

Request

Path Parameters