public interface Configuration extends Service, ConfigurationTypes
Configuration
interface provides methods to manage configuration of
a ESX host. This interface was added in vSphere API 8.0.1.0.ConfigurationTypes.ExtractResult
_VAPI_SERVICE_ID
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,.
|
ConfigurationTypes.ExtractResult extract(java.lang.String host)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.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 systemServiceUnavailable
- 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: VcIntegrity.ClusterConfiguration.Modify
. HostSystem
referenced by the parameter host
requires VcIntegrity.ClusterConfiguration.Modify
. ConfigurationTypes.ExtractResult extract(java.lang.String host, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.invocationConfig
- Configuration for the method invocation.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 systemServiceUnavailable
- 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: VcIntegrity.ClusterConfiguration.Modify
. HostSystem
referenced by the parameter host
requires VcIntegrity.ClusterConfiguration.Modify
. void extract(java.lang.String host, AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback)
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:
VcIntegrity.ClusterConfiguration.Modify
. HostSystem
referenced by the parameter host
requires VcIntegrity.ClusterConfiguration.Modify
. 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.void extract(java.lang.String host, AsyncCallback<ConfigurationTypes.ExtractResult> asyncCallback, InvocationConfig invocationConfig)
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:
VcIntegrity.ClusterConfiguration.Modify
. HostSystem
referenced by the parameter host
requires VcIntegrity.ClusterConfiguration.Modify
. 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.