Environment Browser Query Config Option

Query for a specific virtual machine configuration option (the ConfigOption).

If the EnvironmentBrowser is from a ComputeResource or ClusterComputeResource, the key or host, or both arguments can be used to return the required config options. If a key is specified, then the ConfigOption corresponding to that key value is returned. If a host is specified, then the default ConfigOption for that host is returned. If key and host both are specified, the ConfigOption corresponding to the given key for that host is returned. If neither is specified, then the default ConfigOption for this environment browser is returned. Typically, the default contains the options for the most recent virtual hardware supported.

If the EnvironmentBrowser is from a VirtualMachine neither a host nor a key should be specified.

Required privileges: System.View

Request

URI

POST

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

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

QueryConfigOptionRequestType of type(s) application/json

Required

"QueryConfigOptionRequestType Object"

string

key

Optional

The key found in the VirtualMachineConfigOptionDescriptor, obtained by invoking the EnvironmentBrowser.QueryConfigOptionDescriptor operation.

host

Optional

The host whose ConfigOption is requested.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns the ConfigOption object. If invoked on a cluster with no hosts, or if the ConfigOption with given key is not found for the given host, null is returned.

This response body class contains all of the following: VirtualMachineConfigOption

{
    "0": "V",
    "1": "i",
    "2": "r",
    "3": "t",
    "4": "u",
    "5": "a",
    "6": "l",
    "7": "M",
    "8": "a",
    "9": "c",
    "10": "h",
    "11": "i",
    "12": "n",
    "13": "e",
    "14": "C",
    "15": "o",
    "16": "n",
    "17": "f",
    "18": "i",
    "19": "g",
    "20": "O",
    "21": "p",
    "22": "t",
    "23": "i",
    "24": "o",
    "25": "n",
    "26": " ",
    "27": "O",
    "28": "b",
    "29": "j",
    "30": "e",
    "31": "c",
    "32": "t"
}

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Environment Browser Query Config Option

POST