Option Manager Query Options

Option Manager Query Options

Returns a specific node or nodes in the option hierarchy.

This method might require any of the following privileges depending on where the property fits in the inventory tree.

  • System.View on the root folder, if this is used to read settings in the "client" subtree.
  • System.Read on the root folder, if this is used to read all settings or any settings beside those in the "client" subtree.
  • System.Read on the host, if this is used to read the advanced options for a host configuration.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/OptionManager/{moId}/QueryOptions
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 OptionManager/{moId}.

string
release
Required

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


Request Body
QueryOptionsRequestType of type(s) application/json
Required
{
    "name": "string"
}
string
name
Optional

name

Authentication
This operation uses the following authentication methods.
Responses
200

The option with the given name. If the name ends with a dot, all options for that subtree are returned.

Returns Array of OptionValue of type(s) application/json
[
    {
        "_typeName": "string",
        "key": "string",
        "value": {
            "_typeName": "string"
        }
    }
]

500

InvalidName: if no option or subtree exists with the given name.

Returns InvalidName 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"
        }
    ],
    "name": "string",
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
string
name
Required

The invalid name.

entity
Optional

Reference to an instance of the ManagedEntity managed object.