public interface Software extends Service, SoftwareTypes
Software
interface provides methods to manage desired software
specification of a standalone ESX host.SoftwareTypes._VAPI_OPERATIONS, SoftwareTypes.ApplyResult, SoftwareTypes.ApplySpec, SoftwareTypes.ApplyStatus, SoftwareTypes.CheckInfo, SoftwareTypes.CheckIssue, SoftwareTypes.CheckResult, SoftwareTypes.CheckSpec, SoftwareTypes.CheckStatus, SoftwareTypes.EntityCheckResult, SoftwareTypes.ExportSpec, SoftwareTypes.ExportType, SoftwareTypes.StageResult, SoftwareTypes.StageSpec, SoftwareTypes.StageStatus, SoftwareTypes.Status
_VAPI_SERVICE_ID
Modifier and Type | Method and Description |
---|---|
java.lang.String |
apply_Task(java.lang.String host,
SoftwareTypes.ApplySpec spec)
Applies the desired software document associated with the given host.
|
void |
apply_Task(java.lang.String host,
SoftwareTypes.ApplySpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Applies the desired software document associated with the given host.
|
void |
apply_Task(java.lang.String host,
SoftwareTypes.ApplySpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Applies the desired software document associated with the given host.
|
java.lang.String |
apply_Task(java.lang.String host,
SoftwareTypes.ApplySpec spec,
InvocationConfig invocationConfig)
Applies the desired software document associated with the given host.
|
java.lang.String |
check_Task(java.lang.String host,
SoftwareTypes.CheckSpec spec)
Runs checks on the host before applying the desired software document.
|
void |
check_Task(java.lang.String host,
SoftwareTypes.CheckSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Runs checks on the host before applying the desired software document.
|
void |
check_Task(java.lang.String host,
SoftwareTypes.CheckSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Runs checks on the host before applying the desired software document.
|
java.lang.String |
check_Task(java.lang.String host,
SoftwareTypes.CheckSpec spec,
InvocationConfig invocationConfig)
Runs checks on the host before applying the desired software document.
|
java.util.Map<SoftwareTypes.ExportType,java.net.URI> |
export(java.lang.String host,
SoftwareTypes.ExportSpec spec)
Exports the desired software specification document and/or image.
|
void |
export(java.lang.String host,
SoftwareTypes.ExportSpec spec,
AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback)
Exports the desired software specification document and/or image.
|
void |
export(java.lang.String host,
SoftwareTypes.ExportSpec spec,
AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback,
InvocationConfig invocationConfig)
Exports the desired software specification document and/or image.
|
java.util.Map<SoftwareTypes.ExportType,java.net.URI> |
export(java.lang.String host,
SoftwareTypes.ExportSpec spec,
InvocationConfig invocationConfig)
Exports the desired software specification document and/or image.
|
SoftwareInfo |
get(java.lang.String host)
Returns the complete desired software specification.
|
void |
get(java.lang.String host,
AsyncCallback<SoftwareInfo> asyncCallback)
Returns the complete desired software specification.
|
void |
get(java.lang.String host,
AsyncCallback<SoftwareInfo> asyncCallback,
InvocationConfig invocationConfig)
Returns the complete desired software specification.
|
SoftwareInfo |
get(java.lang.String host,
InvocationConfig invocationConfig)
Returns the complete desired software specification.
|
java.lang.String |
scan_Task(java.lang.String host)
Scans the host against the host's desired state..
|
void |
scan_Task(java.lang.String host,
AsyncCallback<java.lang.String> asyncCallback)
Scans the host against the host's desired state..
|
void |
scan_Task(java.lang.String host,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Scans the host against the host's desired state..
|
java.lang.String |
scan_Task(java.lang.String host,
InvocationConfig invocationConfig)
Scans the host against the host's desired state..
|
java.lang.String |
stage_Task(java.lang.String host,
SoftwareTypes.StageSpec spec)
Stages the desired software document associated with the given host.
|
void |
stage_Task(java.lang.String host,
SoftwareTypes.StageSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Stages the desired software document associated with the given host.
|
void |
stage_Task(java.lang.String host,
SoftwareTypes.StageSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Stages the desired software document associated with the given host.
|
java.lang.String |
stage_Task(java.lang.String host,
SoftwareTypes.StageSpec spec,
InvocationConfig invocationConfig)
Stages the desired software document associated with the given host.
|
java.lang.String scan_Task(java.lang.String host)
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
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 system or if desired
software document is not found.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.java.lang.String scan_Task(java.lang.String host, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
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 system or if desired
software document is not found.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.void scan_Task(java.lang.String host, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
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 or if desired
software document is not found.
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.
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 scan_Task(java.lang.String host, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
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 or if desired
software document is not found.
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.
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.SoftwareInfo get(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 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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
SoftwareInfo 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
- 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 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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void get(java.lang.String host, AsyncCallback<SoftwareInfo> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Host software specification.
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.
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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
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 get(java.lang.String host, AsyncCallback<SoftwareInfo> 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:
Host software specification.
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.
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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
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.java.util.Map<SoftwareTypes.ExportType,java.net.URI> export(java.lang.String host, SoftwareTypes.ExportSpec spec)
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
.spec
- Error
- If there is am 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 or if desired
software document is not found.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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
java.util.Map<SoftwareTypes.ExportType,java.net.URI> export(java.lang.String host, SoftwareTypes.ExportSpec 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
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- invocationConfig
- Configuration for the method invocation.Error
- If there is am 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 or if desired
software document is not found.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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
void export(java.lang.String host, SoftwareTypes.ExportSpec spec, AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
A map from export type to URL of the exported data for that type.
Operation Errors:
Error
- If there is am 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 or if desired
software document is not found.
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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void export(java.lang.String host, SoftwareTypes.ExportSpec spec, AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> 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:
A map from export type to URL of the exported data for that type.
Operation Errors:
Error
- If there is am 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 or if desired
software document is not found.
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.lifecycleSoftwareSpecification.Read
.
HostSystem
referenced by the parameter host
requires VcIntegrity.lifecycleSoftwareSpecification.Read
.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String stage_Task(java.lang.String host, SoftwareTypes.StageSpec spec)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#stage
method should use,
however if subsequent commits have been made to the desired state document the
stage method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- stage specification.Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit,
or the StageSpec#hosts
property of spec
specifies an invalid
host or the host
is not managed with a single software specification.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone hostjava.lang.String stage_Task(java.lang.String host, SoftwareTypes.StageSpec spec, InvocationConfig invocationConfig)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#stage
method should use,
however if subsequent commits have been made to the desired state document the
stage method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
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
.spec
- stage 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.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit,
or the StageSpec#hosts
property of spec
specifies an invalid
host or the host
is not managed with a single software specification.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone hostvoid stage_Task(java.lang.String host, SoftwareTypes.StageSpec spec, AsyncCallback<java.lang.String> asyncCallback)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#stage
method should use,
however if subsequent commits have been made to the desired state document the
stage method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit,
or the StageSpec#hosts
property of spec
specifies an invalid
host or the host
is not managed with a single software specification.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- stage specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void stage_Task(java.lang.String host, SoftwareTypes.StageSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#stage
method should use,
however if subsequent commits have been made to the desired state document the
stage method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- If there is an unknown internal error. The accompanying error message will give
more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit,
or the StageSpec#hosts
property of spec
specifies an invalid
host or the host
is not managed with a single software specification.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- stage specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String apply_Task(java.lang.String host, SoftwareTypes.ApplySpec spec)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#apply
method should use,
however if subsequent commits have been made to the desired state document the
apply method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Apply specification.AlreadyInDesiredState
- If the host is already at specified commit as described in the apply
specification.Error
- If there is an unknown internal error or if the EULA has not been accepted. The
accompanying error message will give more details about the failure.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.java.lang.String apply_Task(java.lang.String host, SoftwareTypes.ApplySpec spec, InvocationConfig invocationConfig)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#apply
method should use,
however if subsequent commits have been made to the desired state document the
apply method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
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
.spec
- Apply specification.invocationConfig
- Configuration for the method invocation.AlreadyInDesiredState
- If the host is already at specified commit as described in the apply
specification.Error
- If there is an unknown internal error or if the EULA has not been accepted. The
accompanying error message will give more details about the failure.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.NotAllowedInCurrentState
- If there is another operation in progress.NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.void apply_Task(java.lang.String host, SoftwareTypes.ApplySpec spec, AsyncCallback<java.lang.String> asyncCallback)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#apply
method should use,
however if subsequent commits have been made to the desired state document the
apply method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
AlreadyInDesiredState
- If the host is already at specified commit as described in the apply
specification.
Error
- If there is an unknown internal error or if the EULA has not been accepted. The
accompanying error message will give more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Apply specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void apply_Task(java.lang.String host, SoftwareTypes.ApplySpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
getCommit()
property is Set
, it implies the minimum commit
that the com.vmware.esx.settings.hosts.Software#apply
method should use,
however if subsequent commits have been made to the desired state document the
apply method will use the most recent desired state document. The result of this
operation can be queried by calling the cis/tasks/{task-id} where the task-id is
the response of this operation. This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
AlreadyInDesiredState
- If the host is already at specified commit as described in the apply
specification.
Error
- If there is an unknown internal error or if the EULA has not been accepted. The
accompanying error message will give more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.
NotAllowedInCurrentState
- If there is another operation in progress.
NotFound
- If there is no host associated with host
in the system or if desired
software document is not found.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Apply specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec)
getCommit()
property is Set
it implies the minimum
commit that the check method should use, however if subsequent commits have been
made to the desired state document the check method will use the most recent
desired state document. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this operation.
This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Check specification.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.NotAllowedInCurrentState
- If there is another operation in progress or if the getCommit()
property
of spec
specifies a commit that has already been applied.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.java.lang.String check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, InvocationConfig invocationConfig)
getCommit()
property is Set
it implies the minimum
commit that the check method should use, however if subsequent commits have been
made to the desired state document the check method will use the most recent
desired state document. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this operation.
This method was added in vSphere API 8.0.0.1.
Synchronous method overload. Result of the invocation is a task
identifier which will be returned by this method.
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
.spec
- Check specification.invocationConfig
- Configuration for the method invocation.Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.NotAllowedInCurrentState
- If there is another operation in progress or if the getCommit()
property
of spec
specifies a commit that has already been applied.NotFound
- If there is no host associated with host
in the system.ServiceUnavailable
- If the service is not available.TimedOut
- If the operation times out.Unauthenticated
- If the caller is not authenticated.Unsupported
- If the host is not a vLCM managed standlone host.void check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback)
getCommit()
property is Set
it implies the minimum
commit that the check method should use, however if subsequent commits have been
made to the desired state document the check method will use the most recent
desired state document. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this operation.
This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.
NotAllowedInCurrentState
- If there is another operation in progress or if the getCommit()
property
of spec
specifies a commit that has already been applied.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Check specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void check_Task(java.lang.String host, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
getCommit()
property is Set
it implies the minimum
commit that the check method should use, however if subsequent commits have been
made to the desired state document the check method will use the most recent
desired state document. The result of this operation can be queried by calling
the cis/tasks/{task-id} where the task-id is the response of this operation.
This method was added in vSphere API 8.0.0.1.
Asynchronous method overload. Result of the invocation which is
a task identifier will be reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
identifier for the task created by this API invocation
Operation Errors:
Error
- If there is unknown internal error. The accompanying error message will give
more details about the failure.
InvalidArgument
- If the getCommit()
property of spec
specifies an invalid commit.
NotAllowedInCurrentState
- If there is another operation in progress or if the getCommit()
property
of spec
specifies a commit that has already been applied.
NotFound
- If there is no host associated with host
in the system.
ServiceUnavailable
- If the service is not available.
TimedOut
- If the operation times out.
Unauthenticated
- If the caller is not authenticated.
Unsupported
- If the host is not a vLCM managed standlone host.
host
- Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem
.spec
- Check specification.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.