com.vmware.esx.settings.hosts

Interface Software

All Superinterfaces:

Service, SoftwareTypes

All Known Implementing Classes:

SoftwareStub

public interface Software
extends Service, SoftwareTypes

The Software interface provides methods to manage desired software specification of a standalone ESX host.

Nested Class Summary

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

SoftwareTypes._VAPI_OPERATIONS

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
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..

Method Detail

scan_Task

java.lang.String scan_Task(java.lang.String host)

Scans the host against the host's desired state.. 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.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

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

Returns:

identifier for the task created by this API invocation

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 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 standlone host, but instead part of a cluster.

scan_Task

java.lang.String scan_Task(java.lang.String host,
                           InvocationConfig invocationConfig)

Scans the host against the host's desired state.. 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.

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.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

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 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 standlone host, but instead part of a cluster.

scan_Task

void scan_Task(java.lang.String host,
               AsyncCallback<java.lang.String> asyncCallback)

Scans the host against the host's desired state.. 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.

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 standlone host, but instead part of a cluster.

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.

scan_Task

void scan_Task(java.lang.String host,
               AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

Scans the host against the host's desired state.. 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.

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 standlone host, but instead part of a cluster.

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.