Option Manager Update Options

Option Manager Update Options

Updates one or more options.

The options are changed one by one, and the operation is not atomic. This means that on failure some of the options may not be changed.

A nested option setting can be named using a dot notation; for example, system.cacheSize.

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

  • Global.Settings on the root folder, if this is used to modify the settings in the service node.
  • Host.Config.AdvancedConfig on the host, if this is used to set the advanced options in the host configuration.
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/OptionManager/{moId}/UpdateOptions
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
UpdateOptionsRequestType of type(s) application/json
Required
{
    "changedValue": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            }
        }
    ]
}
changedValue
Required

changedValue

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

InvalidName: if one or more OptionValue objects refers to a non-existent option.

InvalidArgument: if one or more OptionValue contains an invalid value.

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.