com.vmware.vcenter.namespace_management.software

Interface Clusters

All Superinterfaces:

ClustersTypes, Service

All Known Implementing Classes:

ClustersStub

public interface Clusters
extends Service, ClustersTypes

The Clusters interface provides methods to upgrade the vSphere clusters.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespace_management.software.ClustersTypes

ClustersTypes.Info, ClustersTypes.Message, ClustersTypes.Result, ClustersTypes.State, ClustersTypes.Summary, ClustersTypes.UpgradeProgress, ClustersTypes.UpgradeSpec, ClustersTypes.UpgradeStatus

Field Summary

Fields inherited from interface com.vmware.vcenter.namespace_management.software.ClustersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ClustersTypes.Info	get(java.lang.String cluster) Returns upgrade related information of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback) Returns upgrade related information of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns upgrade related information of a specific cluster.
ClustersTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns upgrade related information of a specific cluster.
java.util.List<ClustersTypes.Summary>	list() Returns upgrade related information about all WCP enabled clusters.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback) Returns upgrade related information about all WCP enabled clusters.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns upgrade related information about all WCP enabled clusters.
java.util.List<ClustersTypes.Summary>	list(InvocationConfig invocationConfig) Returns upgrade related information about all WCP enabled clusters.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Upgrade the cluster to a specific version.
void	upgrade(java.lang.String cluster, ClustersTypes.UpgradeSpec spec, InvocationConfig invocationConfig) Upgrade the cluster to a specific version.
java.util.Map<java.lang.String,ClustersTypes.Result>	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs) Upgrade a set of clusters to its corresponding specific version.
void	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback) Upgrade a set of clusters to its corresponding specific version.
void	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback, InvocationConfig invocationConfig) Upgrade a set of clusters to its corresponding specific version.
java.util.Map<java.lang.String,ClustersTypes.Result>	upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs, InvocationConfig invocationConfig) Upgrade a set of clusters to its corresponding specific version.

Method Detail

upgrade

void upgrade(java.lang.String cluster,
             ClustersTypes.UpgradeSpec spec)

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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

Parameters:

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

spec - Specification for upgrading the cluster.

Throws:

Error - if the system reports an error while responding to the request.

Unsupported - if pre-check failed of the cluster.

NotFound - if cluster could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege.

upgrade

void upgrade(java.lang.String cluster,
             ClustersTypes.UpgradeSpec spec,
             InvocationConfig invocationConfig)

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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 for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for upgrading the cluster.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

Unsupported - if pre-check failed of the cluster.

NotFound - if cluster could not be located.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege.

upgrade

void upgrade(java.lang.String cluster,
             ClustersTypes.UpgradeSpec spec,
             AsyncCallback<java.lang.Void> asyncCallback)

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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

Operation Errors:
Error - if the system reports an error while responding to the request.
Unsupported - if pre-check failed of the cluster.
NotFound - if cluster could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.

Parameters:

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

spec - Specification for upgrading the cluster.

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

upgrade

void upgrade(java.lang.String cluster,
             ClustersTypes.UpgradeSpec spec,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Upgrade the cluster to a specific version. This operation upgrades the components on control plane VMs and worker plane hosts based on the selected version. Before upgrading, this operation performs pre-checks and sets the evaluation response in Info.UpgradeStatus.messages with various Message.Severity levels. Depending on the severity, the upgrade may or may not proceed beyond prechecks. Here is a list of severities and corresponding behavior: - ERROR: Upgrade does not proceed beyond precheck operation - WARNING: Upgrade proceeds beyond precheck operation only if UpgradeSpec.ignorePrecheckWarnings is set to true - INFO: Upgrade proceeds beyond precheck operation uninterrupted

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 the system reports an error while responding to the request.
Unsupported - if pre-check failed of the cluster.
NotFound - if cluster could not be located.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.

Parameters:

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

spec - Specification for upgrading the cluster.

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

invocationConfig - Configuration for the method invocation.

upgradeMultiple

java.util.Map<java.lang.String,ClustersTypes.Result> upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs)

Upgrade a set of clusters to its corresponding specific version.

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

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

upgradeMultiple

java.util.Map<java.lang.String,ClustersTypes.Result> upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                                                                     InvocationConfig invocationConfig)

Upgrade a set of clusters to its corresponding specific version.

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:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

upgradeMultiple

void upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                     AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback)

Upgrade a set of clusters to its corresponding specific version.

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

Invocation Result:
Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map must be an identifier for the resource type: ClusterComputeResource.

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

upgradeMultiple

void upgradeMultiple(java.util.Map<java.lang.String,ClustersTypes.UpgradeSpec> specs,
                     AsyncCallback<java.util.Map<java.lang.String,ClustersTypes.Result>> asyncCallback,
                     InvocationConfig invocationConfig)

Upgrade a set of clusters to its corresponding specific version.

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:
Pre-check result when invoking upgrade for each cluster. The key in the return value Map will be an identifier for the resource type: ClusterComputeResource.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege on all specified clusters.

Parameters:

specs - Specifications for upgrading selected clusters. The key in the parameter Map 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.

get

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

Returns upgrade related information of a specific cluster.

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

Parameters:

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

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Throws:

NotFound - if cluster could not be located.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

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

Returns upgrade related information of a specific cluster.

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 for the cluster which will be upgraded. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the upgrade of the specified WCP enabled cluster.

Throws:

NotFound - if cluster could not be located.

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

get

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

Returns upgrade related information of a specific cluster.

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

Invocation Result:
Information about the upgrade of the specified WCP enabled cluster.

Operation Errors:
NotFound - if cluster could not be located.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier for the cluster which will be upgraded. 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<ClustersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns upgrade related information of a specific cluster.

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 upgrade of the specified WCP enabled cluster.

Operation Errors:
NotFound - if cluster could not be located.
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

cluster - Identifier for the cluster which will be upgraded. 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.

list

java.util.List<ClustersTypes.Summary> list()

Returns upgrade related information about all WCP enabled clusters.

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

Returns:

List of upgrade summary of all WCP enabled clusters.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

java.util.List<ClustersTypes.Summary> list(InvocationConfig invocationConfig)

Returns upgrade related information about all WCP enabled clusters.

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:

invocationConfig - Configuration for the method invocation.

Returns:

List of upgrade summary of all WCP enabled clusters.

Throws:

Error - if the system reports an error while responding to the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user does not have System.Read privilege.

list

void list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback)

Returns upgrade related information about all WCP enabled clusters.

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

Invocation Result:
List of upgrade summary of all WCP enabled clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

list

void list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns upgrade related information about all WCP enabled clusters.

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:
List of upgrade summary of all WCP enabled clusters.

Operation Errors:
Error - if the system reports an error while responding to the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have System.Read privilege.

Parameters:

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

invocationConfig - Configuration for the method invocation.