Environment Browser Query Config Target

Queries for information about a specific target, a "physical" device that can be used to back virtual devices.

The ConfigTarget that is returned specifies the set of values that can be used in the device backings to connect the virtual machine to physical (or logical) host devices.

If the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, the host argument can be used to return the ConfigTarget provided by a particular host in the compute resource or cluster. If host is not specified and the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, then the union of all the devices is returned and the vim.vm.TargetInfo.configurationTag field indicates how widely the device is available across the compute resource or cluster.

If the EnvironmentBrowser is from a VirtualMachine a host should not be specified.

Required privileges: System.View

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/EnvironmentBrowser/{moId}/QueryConfigTarget

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

string

release

Required

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

Request Body

QueryConfigTargetRequestType of type(s) application/json

Required

"QueryConfigTargetRequestType Object"

host

Optional

If specified, the host whose default BackingInfo is requested.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns the ConfigTarget object. If invoked on a cluster with no hosts, null is returned.

This response body class contains all of the following: ConfigTarget

{
    "0": "C",
    "1": "o",
    "2": "n",
    "3": "f",
    "4": "i",
    "5": "g",
    "6": "T",
    "7": "a",
    "8": "r",
    "9": "g",
    "10": "e",
    "11": "t",
    "12": " ",
    "13": "O",
    "14": "b",
    "15": "j",
    "16": "e",
    "17": "c",
    "18": "t"
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/EnvironmentBrowser/{moId}/QueryConfigTarget

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Environment Browser Query Config Option

POST