com.vmware.vcenter.environment_browser

Interface ConfigOptions

All Superinterfaces:

ConfigOptionsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ConfigOptionsStub

public interface ConfigOptions
extends com.vmware.vapi.bindings.Service, ConfigOptionsTypes

The ConfigOptions interface provides access to virtual machine configuration options. The get(com.vmware.vcenter.environment_browser.ConfigOptionsTypes.GetParams) provides the keys for various config options available on certain hardware. Further the results of get(com.vmware.vcenter.environment_browser.ConfigOptionsTypes.GetParams) describe the supported execution environment for a virtual machine on a particular set of hardware. This interface was added in vSphere API 8.0.2.00300.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.environment_browser.ConfigOptionsTypes

ConfigOptionsTypes.GetParams, ConfigOptionsTypes.Info

Field Summary

Fields inherited from interface com.vmware.vcenter.environment_browser.ConfigOptionsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConfigOptionsTypes.Info	get(ConfigOptionsTypes.GetParams params) Query for the vim.vm.ConfigOption from the hosts in the specified clusters.
void	get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback) Query for the vim.vm.ConfigOption from the hosts in the specified clusters.
void	get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Query for the vim.vm.ConfigOption from the hosts in the specified clusters.
ConfigOptionsTypes.Info	get(ConfigOptionsTypes.GetParams params, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Query for the vim.vm.ConfigOption from the hosts in the specified clusters.

Method Detail

get

ConfigOptionsTypes.Info get(ConfigOptionsTypes.GetParams params)

Query for the vim.vm.ConfigOption from the hosts in the specified clusters. The filter spec may be optionally used to narrow the result to a specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams) as well as one or more guest OS identifier(s). If the config option key is not specified, then the default config option for the specified cluster(s) is returned.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

params - The query specification used to provide key, guest OS identifier(s), clusters.

Returns:

the VI/JSON representation of the (vim.vm.ConfigOption) object. If none of the specified clusters have any available hosts, or if the information requested in filters is not available in any of the the specified clusters, then null is returned.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if invalid input is passed like invalid key, OS or cluster.

NotFound - if at least one of the specified clusters cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges for all the specified clusters.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigOptionsTypes.GetParams.getClusters() requires System.View.

get

ConfigOptionsTypes.Info get(ConfigOptionsTypes.GetParams params,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Query for the vim.vm.ConfigOption from the hosts in the specified clusters. The filter spec may be optionally used to narrow the result to a specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams) as well as one or more guest OS identifier(s). If the config option key is not specified, then the default config option for the specified cluster(s) is returned.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

params - The query specification used to provide key, guest OS identifier(s), clusters.

invocationConfig - Configuration for the method invocation.

Returns:

the VI/JSON representation of the (vim.vm.ConfigOption) object. If none of the specified clusters have any available hosts, or if the information requested in filters is not available in any of the the specified clusters, then null is returned.

Throws:

Error - if the system reports an error while responding to the request.

InvalidArgument - if invalid input is passed like invalid key, OS or cluster.

NotFound - if at least one of the specified clusters cannot be located.

Unauthenticated - if the user cannot be authenticated.

Unauthorized - if the user doesn't have the required privileges for all the specified clusters.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigOptionsTypes.GetParams.getClusters() requires System.View.

get

void get(ConfigOptionsTypes.GetParams params,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback)

Query for the vim.vm.ConfigOption from the hosts in the specified clusters. The filter spec may be optionally used to narrow the result to a specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams) as well as one or more guest OS identifier(s). If the config option key is not specified, then the default config option for the specified cluster(s) is returned.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
the VI/JSON representation of the (vim.vm.ConfigOption) object. If none of the specified clusters have any available hosts, or if the information requested in filters is not available in any of the the specified clusters, then null is returned.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if invalid input is passed like invalid key, OS or cluster.
NotFound - if at least one of the specified clusters cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges for all the specified clusters.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigOptionsTypes.GetParams.getClusters() requires System.View.

Parameters:

params - The query specification used to provide key, guest OS identifier(s), clusters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(ConfigOptionsTypes.GetParams params,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigOptionsTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Query for the vim.vm.ConfigOption from the hosts in the specified clusters. The filter spec may be optionally used to narrow the result to a specific config option by the key returned from ConfigOptionDescriptors.list(com.vmware.vcenter.environment_browser.ConfigOptionDescriptorsTypes.ListParams) as well as one or more guest OS identifier(s). If the config option key is not specified, then the default config option for the specified cluster(s) is returned.

This method requires additional api_release request parameter which must be used to guarantee compatibility with future releases of the API. Consult the vSphere Automation SDKs Programming Guide for more information.

. This method was added in vSphere API 8.0.2.00300.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
the VI/JSON representation of the (vim.vm.ConfigOption) object. If none of the specified clusters have any available hosts, or if the information requested in filters is not available in any of the the specified clusters, then null is returned.

Operation Errors:
Error - if the system reports an error while responding to the request.
InvalidArgument - if invalid input is passed like invalid key, OS or cluster.
NotFound - if at least one of the specified clusters cannot be located.
Unauthenticated - if the user cannot be authenticated.
Unauthorized - if the user doesn't have the required privileges for all the specified clusters.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource ClusterComputeResource referenced by the property ConfigOptionsTypes.GetParams.getClusters() requires System.View.

Parameters:

params - The query specification used to provide key, guest OS identifier(s), clusters.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.