com.vmware.esx.settings.clusters.enablement

Interface Software

All Superinterfaces:

Service, SoftwareTypes

All Known Implementing Classes:

SoftwareStub

public interface Software
extends Service, SoftwareTypes

The Software interface provides methods to control whether the cluster is managed with a single software specification.

Nested Class Summary

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

SoftwareTypes._VAPI_OPERATIONS, SoftwareTypes.CheckResult, SoftwareTypes.CheckSpec, SoftwareTypes.CheckType, SoftwareTypes.EnableSpec, SoftwareTypes.Info

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.enablement.SoftwareTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec) Checks the possibility to manage the cluster with a single software specification.
void	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback) Checks the possibility to manage the cluster with a single software specification.
void	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Checks the possibility to manage the cluster with a single software specification.
java.lang.String	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, InvocationConfig invocationConfig) Checks the possibility to manage the cluster with a single software specification.
java.lang.String	enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec) Enables the feature which manages the cluster with a single software specification.
void	enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback) Enables the feature which manages the cluster with a single software specification.
void	enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Enables the feature which manages the cluster with a single software specification.
java.lang.String	enable_Task(java.lang.String cluster, SoftwareTypes.EnableSpec spec, InvocationConfig invocationConfig) Enables the feature which manages the cluster with a single software specification.
SoftwareTypes.Info	get(java.lang.String cluster) Returns whether the given cluster is managed with a single software specification.
void	get(java.lang.String cluster, AsyncCallback<SoftwareTypes.Info> asyncCallback) Returns whether the given cluster is managed with a single software specification.
void	get(java.lang.String cluster, AsyncCallback<SoftwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns whether the given cluster is managed with a single software specification.
SoftwareTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns whether the given cluster is managed with a single software specification.

Method Detail

get

SoftwareTypes.Info get(java.lang.String cluster)

Returns whether the given cluster is managed with a single software specification.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Information about the feature enablement.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster 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.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

get

SoftwareTypes.Info get(java.lang.String cluster,
                       InvocationConfig invocationConfig)

Returns whether the given cluster is managed with a single software specification.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the feature enablement.

Throws:

Error - If there is unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster 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.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String cluster,
         AsyncCallback<SoftwareTypes.Info> asyncCallback)

Returns whether the given cluster is managed with a single software specification.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about the feature enablement.

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 cluster associated with cluster 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.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String cluster,
         AsyncCallback<SoftwareTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns whether the given cluster is managed with a single software specification.

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:
Information about the feature enablement.

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 cluster associated with cluster 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.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

check_Task

java.lang.String check_Task(java.lang.String cluster,
                            SoftwareTypes.CheckSpec spec)

Checks the possibility to manage the cluster with a single software specification.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Check specification. If null, all checks are performed.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

NotAllowedInCurrentState - If the feature is already enabled for the given cluster.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

check_Task

java.lang.String check_Task(java.lang.String cluster,
                            SoftwareTypes.CheckSpec spec,
                            InvocationConfig invocationConfig)

Checks the possibility to manage the cluster with a single software specification.

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:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Check specification. If null, all checks are performed.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some unknown error. The accompanying error message will give more details about the failure.

NotAllowedInCurrentState - If the feature is already enabled for the given cluster.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

check_Task

void check_Task(java.lang.String cluster,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback)

Checks the possibility to manage the cluster with a single software specification.

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 some unknown error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the feature is already enabled for the given cluster.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Check specification. If null, all checks are performed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

check_Task

void check_Task(java.lang.String cluster,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Checks the possibility to manage the cluster with a single software specification.

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 some unknown error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the feature is already enabled for the given cluster.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Check specification. If null, all checks are performed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

enable_Task

java.lang.String enable_Task(java.lang.String cluster,
                             SoftwareTypes.EnableSpec spec)

Enables the feature which manages the cluster with a single software specification.

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

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Enablement specification. If null, all checks are performed.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If feature enablement failed for the given cluster. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.

NotAllowedInCurrentState - If the feature is already enabled for the given cluster.

NotFound - If there is no cluster associated with cluster in the system

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

enable_Task

java.lang.String enable_Task(java.lang.String cluster,
                             SoftwareTypes.EnableSpec spec,
                             InvocationConfig invocationConfig)

Enables the feature which manages the cluster with a single software specification.

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:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Enablement specification. If null, all checks are performed.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If feature enablement failed for the given cluster. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.

NotAllowedInCurrentState - If the feature is already enabled for the given cluster.

NotFound - If there is no cluster associated with cluster in the system

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

enable_Task

void enable_Task(java.lang.String cluster,
                 SoftwareTypes.EnableSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Enables the feature which manages the cluster with a single software specification.

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 feature enablement failed for the given cluster. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.
NotAllowedInCurrentState - If the feature is already enabled for the given cluster.
NotFound - If there is no cluster associated with cluster in the system
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Enablement specification. If null, all checks are performed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

enable_Task

void enable_Task(java.lang.String cluster,
                 SoftwareTypes.EnableSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Enables the feature which manages the cluster with a single software specification.

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 feature enablement failed for the given cluster. The value of the data property of Error will be a class that contains all the properties defined in SoftwareTypes.CheckResult.
NotAllowedInCurrentState - If the feature is already enabled for the given cluster.
NotFound - If there is no cluster associated with cluster in the system
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Enablement specification. If null, all checks are performed.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.