Environment Browser Query Config Option Ex

Query for a virtual machine configuration option matching the key or host or both given in the EnvironmentBrowserConfigOptionQuerySpec.

For more details see QueryConfigOption

If the Environment Browser belongs to a virtual machine and the spec argument is omitted, the method returns the ConfigOption object corresponding to the vmx version of the virutal machine and the guestOSDescriptor list contains only the guestId of the virutal machine.

Required privileges: System.View

Request

URI

POST

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

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

QueryConfigOptionExRequestType of type(s) application/json

Required

"QueryConfigOptionExRequestType Object"

spec

Optional

Search criteria and filters to control the result. If a EnvironmentBrowserConfigOptionQuerySpec.key or EnvironmentBrowserConfigOptionQuerySpec.host (or both) are specified, they will be used to search for a config option. If EnvironmentBrowserConfigOptionQuerySpec.guestId is nonempty, the VirtualMachineConfigOption.guestOSDescriptor array of the config option is filtered to match against the guest IDs in the spec. If there is no match, the whole list is returned. If the spec argument is omitted, the default VirtualMachineConfigOption for this environment browser is returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns the VirtualMachineConfigOption object. If invoked on a cluster with no hosts, or if the VirtualMachineConfigOption 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}/QueryConfigOptionEx

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations

POST

Environment Browser Query Config Option

POST