com.vmware.esx.settings.hosts

Interface Configuration

All Superinterfaces:

ConfigurationTypes, Service

All Known Implementing Classes:

ConfigurationStub

public interface Configuration
extends Service, ConfigurationTypes

The Configuration interface provides methods to manage configuration of a ESX host. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.hosts.ConfigurationTypes

ConfigurationTypes.ExtractResult

Field Summary

Fields inherited from interface com.vmware.esx.settings.hosts.ConfigurationTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ConfigurationTypes.ExtractResult	extract(java.lang.String host) Extracts a configuration document from the ESXi host,.
void	extract(java.lang.String host, AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback) Extracts a configuration document from the ESXi host,.
void	extract(java.lang.String host, AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback, InvocationConfig invocationConfig) Extracts a configuration document from the ESXi host,.
ConfigurationTypes.ExtractResult	extract(java.lang.String host, InvocationConfig invocationConfig) Extracts a configuration document from the ESXi host,.

Method Detail

extract

ConfigurationTypes.ExtractResult extract(java.lang.String host)

Extracts a configuration document from the ESXi host,. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

Returns:

The result contains the configuration of the ESXi host encoded as JSON.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no host associated with host in the system

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.

extract

ConfigurationTypes.ExtractResult extract(java.lang.String host,
                                         InvocationConfig invocationConfig)

Extracts a configuration document from the ESXi host,. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

The result contains the configuration of the ESXi host encoded as JSON.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no host associated with host in the system

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

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

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.

extract

void extract(java.lang.String host,
             AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback)

Extracts a configuration document from the ESXi host,. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Invocation Result:
The result contains the configuration of the ESXi host encoded as JSON.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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

extract

void extract(java.lang.String host,
             AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback,
             InvocationConfig invocationConfig)

Extracts a configuration document from the ESXi host,. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 result contains the configuration of the ESXi host encoded as JSON.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no host associated with host in the system
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource HostSystem referenced by the parameter host requires VcIntegrity.ClusterConfiguration.Modify.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.