com.vmware.esx.settings.hosts

Class ConfigurationStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.hosts.ConfigurationStub

All Implemented Interfaces:

Configuration, ConfigurationTypes, Service

public class ConfigurationStub
extends com.vmware.vapi.internal.bindings.Stub
implements Configuration

Remote stub implementation of the Configuration API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

ConfigurationTypes.ExtractResult

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, retryPolicy, securityContext

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
ConfigurationStub(ApiProvider apiProvider, StubConfigurationBase config)
ConfigurationStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

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,.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ConfigurationStub

public ConfigurationStub(ApiProvider apiProvider,
                         com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                         StubConfigurationBase config)

ConfigurationStub

public ConfigurationStub(ApiProvider apiProvider,
                         StubConfigurationBase config)

Method Detail

extract

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

Description copied from interface: Configuration

Extracts a configuration document from the ESXi host,. This method was added in vSphere API 8.0.1.0.

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

Specified by:

extract in interface Configuration

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.

extract

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

Description copied from interface: Configuration

Extracts a configuration document from the ESXi host,. This method was added in vSphere API 8.0.1.0.

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

Specified by:

extract in interface Configuration

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.

extract

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

Description copied from interface: Configuration

Extracts a configuration document from the ESXi host,. This method was added in vSphere API 8.0.1.0.

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.

Specified by:

extract in interface Configuration

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

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

Description copied from interface: Configuration

Extracts a configuration document from the ESXi host,. This method was added in vSphere API 8.0.1.0.

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.

Specified by:

extract in interface Configuration

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.