Managed Object - OptionManager(vim.option.OptionManager)

Property of
HostConfigManager, ServiceContent
See also
OptionDef, OptionValue


Managed Object Description

This managed object type is used for managing key/value pair options.

Properties

Name Type Description
setting*OptionValue[]

A list of the current settings for the key/value pair options.
supportedOption*OptionDef[]

A list of supported key/value pair options including their type information.
*May not be present

Methods

Methods defined in this Managed Object
QueryOptions, UpdateOptions

QueryOptions(queryView)

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.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the OptionManager used to make the method call.
name*xsd:string


*Need not be set

Return Value

Type Description
OptionValue[]The option with the given name. If the name ends with a dot, all options for that subtree are returned.

Faults

Type Description
InvalidNameThrown if no option or subtree exists with the given name.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition



UpdateOptions(updateValues)

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.

Required Privileges
Dynamic - See discussion above

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the OptionManager used to make the method call.
changedValueOptionValue[]



Return Value

Type Description
None

Faults

Type Description
InvalidArgumentThrown if one or more OptionValue contains an invalid value.
InvalidNameThrown if one or more OptionValue objects refers to a non-existent option.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition