Managed Object - OptionManager(vim.option.OptionManager)

Property of: HostConfigManager, ServiceContent
See also: OptionDef, OptionValue
Since: 2.0

Managed Object Description

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

You can define options on the fly only if the option is supported by the concrete implementation, in a logical tree using a dot notation for keys. For example, "Ethernet.Connection" describes the Connection option as child of the Ethernet option.
Options can be updated even if not visible in supportedOption or settings or the queryMethod returned values only if supported by the concrete implementation.
Attempt to add random Options that are not supported by the concrete implementation may result in unexpected side-effects.
You can use the queryMethod to retrieve a single property or a subset of properties based on the dot notation path.

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.

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.

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the OptionManager used to make the method call.
name* P	xsd:string	*Since* 2.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the OptionManager used to make the method call.

name* P

xsd:string

Since 2.0

*Need not be set P Required privilege: name

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
InvalidName	Thrown if no option or subtree exists with the given name.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryOptions" type="vim25:QueryOptionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryOptionsResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:OptionValue" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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.

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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the OptionManager used to make the method call.
changedValue P	OptionValue[]	*Since* 2.0

Name

Type

Description

_this

ManagedObjectReference

A reference to the OptionManager used to make the method call.

changedValue P

OptionValue[]

Since 2.0

P Required privilege: changedValue

Return Value

Type	Description
None

Faults

Type	Description
InvalidName	Thrown if one or more OptionValue objects refers to a non-existent option.
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateOptions" type="vim25:UpdateOptionsRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="UpdateOptionsResponse">
                  <complexType/>
               </element>