public interface Apply extends Service, ApplyTypes
Apply
interface provides methods to configure the policies that will
impact how the software and configuration specification documents are applied to
an ESXi host. This interface was added in vSphere API 8.0.0.1.ApplyTypes.ConfiguredPolicySpec, ApplyTypes.FailureAction
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
ApplyTypes.ConfiguredPolicySpec |
get(java.lang.String host)
Returns the configured policy that has been set for the ESXi host.
|
void |
get(java.lang.String host,
AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)
Returns the configured policy that has been set for the ESXi host.
|
void |
get(java.lang.String host,
AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback,
InvocationConfig invocationConfig)
Returns the configured policy that has been set for the ESXi host.
|
ApplyTypes.ConfiguredPolicySpec |
get(java.lang.String host,
InvocationConfig invocationConfig)
Returns the configured policy that has been set for the ESXi host.
|
void |
set(java.lang.String host,
ApplyTypes.ConfiguredPolicySpec spec)
This API will set the configured policy for an ESXi host.
|
void |
set(java.lang.String host,
ApplyTypes.ConfiguredPolicySpec spec,
AsyncCallback<java.lang.Void> asyncCallback)
This API will set the configured policy for an ESXi host.
|
void |
set(java.lang.String host,
ApplyTypes.ConfiguredPolicySpec spec,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
This API will set the configured policy for an ESXi host.
|
void |
set(java.lang.String host,
ApplyTypes.ConfiguredPolicySpec spec,
InvocationConfig invocationConfig)
This API will set the configured policy for an ESXi host.
|
ApplyTypes.ConfiguredPolicySpec get(java.lang.String host)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.Error
- If there is an 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.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Read
. ApplyTypes.ConfiguredPolicySpec get(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
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.invocationConfig
- Configuration for the method invocation.Error
- If there is an 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.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Read
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Read
. void get(java.lang.String host, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
The configured policies that impact the apply method
Operation Errors:
Error
- If there is an 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.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Read
. host
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String host, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> 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 configured policies that impact the apply method
Operation Errors:
Error
- If there is an 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.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Read
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Read
. host
- The host identifier.
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.void set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
host
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.spec
- The policy specification.Error
- If there is an 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.InvalidArgument
- If invalid value is provided.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Write
. void set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, 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
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.spec
- The policy specification.invocationConfig
- Configuration for the method invocation.Error
- If there is an 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.InvalidArgument
- If invalid value is provided.ServiceUnavailable
- If the service is not available.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.Unauthorized
- if you do not have all of the privileges described as follows: VcIntegrity.lifecycleSettings.Write
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Write
. void set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
Error
- If there is an 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.
InvalidArgument
- If invalid value is provided.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Write
. host
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.spec
- The policy specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void set(java.lang.String host, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> 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.
Operation Errors:
Error
- If there is an 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.
InvalidArgument
- If invalid value is provided.
ServiceUnavailable
- If the service is not available.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
Unauthorized
- if you do not have all of the privileges described as follows:
VcIntegrity.lifecycleSettings.Write
. HostSystem
referenced by the parameter host
requires
VcIntegrity.lifecycleSettings.Write
. host
- The host identifier.
The parameter must be an identifier for the resource type: HostSystem
.spec
- The policy specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.