com.vmware.vcenter.namespace_management

Interface Clusters

All Superinterfaces:

ClustersTypes, Service

All Known Implementing Classes:

ClustersStub

public interface Clusters
extends Service, ClustersTypes

The Clusters interface provides methods to enable and disable vSphere Namespaces on a vSphere cluster.

Nested Class Summary

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

ClustersTypes.ConfigStatus, ClustersTypes.EnableSpec, ClustersTypes.ImageRegistry, ClustersTypes.ImageStorageSpec, ClustersTypes.Info, ClustersTypes.Ipv4Range, ClustersTypes.KubernetesStatus, ClustersTypes.Message, ClustersTypes.NCPClusterNetworkEnableSpec, ClustersTypes.NCPClusterNetworkInfo, ClustersTypes.NCPClusterNetworkSetSpec, ClustersTypes.NCPClusterNetworkUpdateSpec, ClustersTypes.NetworkProvider, ClustersTypes.NetworkSpec, ClustersTypes.SetSpec, ClustersTypes.Stats, ClustersTypes.Summary, ClustersTypes.UpdateSpec, ClustersTypes.WorkloadNetworksEnableSpec, ClustersTypes.WorkloadNetworksInfo

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	disable(java.lang.String cluster) Disable vSphere Namespaces on the cluster.
void	disable(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback) Disable vSphere Namespaces on the cluster.
void	disable(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Disable vSphere Namespaces on the cluster.
void	disable(java.lang.String cluster, InvocationConfig invocationConfig) Disable vSphere Namespaces on the cluster.
void	enable(java.lang.String cluster, ClustersTypes.EnableSpec spec) Enable vSphere Namespaces on the cluster.
void	enable(java.lang.String cluster, ClustersTypes.EnableSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Enable vSphere Namespaces on the cluster.
void	enable(java.lang.String cluster, ClustersTypes.EnableSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Enable vSphere Namespaces on the cluster.
void	enable(java.lang.String cluster, ClustersTypes.EnableSpec spec, InvocationConfig invocationConfig) Enable vSphere Namespaces on the cluster.
ClustersTypes.Info	get(java.lang.String cluster) Returns information about a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback) Returns information about a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<ClustersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a specific cluster.
ClustersTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns information about a specific cluster.
java.util.List<ClustersTypes.Summary>	list() Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback) Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
void	list(AsyncCallback<java.util.List<ClustersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
java.util.List<ClustersTypes.Summary>	list(InvocationConfig invocationConfig) Returns information about all clusters on which vSphere Namespaces are enabled on this vCenter.
void	rotatePassword(java.lang.String cluster) Request a new root password for all control plane nodes in the cluster.
void	rotatePassword(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback) Request a new root password for all control plane nodes in the cluster.
void	rotatePassword(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Request a new root password for all control plane nodes in the cluster.
void	rotatePassword(java.lang.String cluster, InvocationConfig invocationConfig) Request a new root password for all control plane nodes in the cluster.
void	set(java.lang.String cluster, ClustersTypes.SetSpec spec) Set a new configuration on the cluster object.
void	set(java.lang.String cluster, ClustersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Set a new configuration on the cluster object.
void	set(java.lang.String cluster, ClustersTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Set a new configuration on the cluster object.
void	set(java.lang.String cluster, ClustersTypes.SetSpec spec, InvocationConfig invocationConfig) Set a new configuration on the cluster object.
void	update(java.lang.String cluster, ClustersTypes.UpdateSpec spec) Update configuration on the cluster object.
void	update(java.lang.String cluster, ClustersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Update configuration on the cluster object.
void	update(java.lang.String cluster, ClustersTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Update configuration on the cluster object.
void	update(java.lang.String cluster, ClustersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update configuration on the cluster object.

Method Detail

enable

void enable(java.lang.String cluster,
            ClustersTypes.EnableSpec spec)

Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces will be enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the Kubernetes API server and the worker nodes.

Throws:

AlreadyExists - if the cluster already has vSphere Namespaces enabled.

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

NotFound - if resources/objects could not be located.

InvalidArgument - if spec contain any errors.

UnableToAllocateResource - if the specified cluster is not licensed.

Unauthenticated - if the user can not be authenticated.

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

Unsupported - if the specified cluster is not supported for vSphere Namespaces, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

enable

void enable(java.lang.String cluster,
            ClustersTypes.EnableSpec spec,
            InvocationConfig invocationConfig)

Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.

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 on which vSphere Namespaces will be enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the Kubernetes API server and the worker nodes.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the cluster already has vSphere Namespaces enabled.

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

NotFound - if resources/objects could not be located.

InvalidArgument - if spec contain any errors.

UnableToAllocateResource - if the specified cluster is not licensed.

Unauthenticated - if the user can not be authenticated.

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

Unsupported - if the specified cluster is not supported for vSphere Namespaces, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

enable

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

Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.

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

Operation Errors:
AlreadyExists - if the cluster already has vSphere Namespaces enabled.
Error - if the system reports an error while responding to the request.
NotFound - if resources/objects could not be located.
InvalidArgument - if spec contain any errors.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the specified cluster is not supported for vSphere Namespaces, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces will be enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the Kubernetes API server and the worker nodes.

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

enable

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

Enable vSphere Namespaces on the cluster. This operation sets up Kubernetes instance for the cluster along with worker nodes.

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:
AlreadyExists - if the cluster already has vSphere Namespaces enabled.
Error - if the system reports an error while responding to the request.
NotFound - if resources/objects could not be located.
InvalidArgument - if spec contain any errors.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.Manage privilege.
Unsupported - if the specified cluster is not supported for vSphere Namespaces, the cluster's hosts do not have the required ESX version, or for any other incompatibilities.

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces will be enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Specification for setting up the Kubernetes API server and the worker nodes.

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

invocationConfig - Configuration for the method invocation.

disable

void disable(java.lang.String cluster)

Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.

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

Parameters:

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

Throws:

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

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.

disable

void disable(java.lang.String cluster,
             InvocationConfig invocationConfig)

Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled 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 for which vSphere Namespaces will be disabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Throws:

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

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.

disable

void disable(java.lang.String cluster,
             AsyncCallback<java.lang.Void> asyncCallback)

Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.

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

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

disable

void disable(java.lang.String cluster,
             AsyncCallback<java.lang.Void> asyncCallback,
             InvocationConfig invocationConfig)

Disable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.

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.
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 for which vSphere Namespaces will be disabled. 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.

get

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

Returns information about a specific cluster.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

Information about the desired state of the specified cluster.

Throws:

NotFound - if cluster could not be located.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

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 information about 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 on which vSphere Namespaces are enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the desired state of the specified cluster.

Throws:

NotFound - if cluster could not be located.

Unsupported - if the specified cluster does not have vSphere Namespaces enabled.

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 information about a specific cluster.

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

Invocation Result:
Information about the desired state of the specified cluster.

Operation Errors:
NotFound - if cluster could not be located.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.
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 on which vSphere Namespaces are enabled. 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 information about 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 desired state of the specified cluster.

Operation Errors:
NotFound - if cluster could not be located.
Unsupported - if the specified cluster does not have vSphere Namespaces enabled.
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 on which vSphere Namespaces are enabled. 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 information about all clusters on which vSphere Namespaces are enabled on this vCenter.

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

Returns:

List of summary of all clusters with vSphere Namespaces enabled.

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 information about all clusters on which vSphere Namespaces are enabled on this vCenter.

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 summary of all clusters with vSphere Namespaces enabled.

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 information about all clusters on which vSphere Namespaces are enabled on this vCenter.

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

Invocation Result:
List of summary of all clusters with vSphere Namespaces enabled.

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 information about all clusters on which vSphere Namespaces are enabled on this vCenter.

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 summary of all clusters with vSphere Namespaces enabled.

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.

set

void set(java.lang.String cluster,
         ClustersTypes.SetSpec spec)

Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

Throws:

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

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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.

set

void set(java.lang.String cluster,
         ClustersTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.

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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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.

set

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

Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

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

set

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

Set a new configuration on the cluster object. The specified configuration is applied in entirety and will replace the current configuration fully.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String cluster,
            ClustersTypes.UpdateSpec spec)

Update configuration on the cluster object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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

Parameters:

cluster - Identifier for the cluster on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

Throws:

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

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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.

update

void update(java.lang.String cluster,
            ClustersTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Update configuration on the cluster object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if spec contain any errors.

NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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.

update

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

Update configuration on the cluster object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

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

update

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

Update configuration on the cluster object. The specified configuration is applied partially and null fields in spec will leave those parts of configuration as-is.

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.
InvalidArgument - if spec contain any errors.
NotAllowedInCurrentState - if vSphere Namespaces is being disabled on this 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 on which vSphere Namespaces is enabled. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - New specification for the cluster.

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

invocationConfig - Configuration for the method invocation.

rotatePassword

void rotatePassword(java.lang.String cluster)

Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.

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

Parameters:

cluster - Identifier for the cluster for which the password is being generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

Throws:

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

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.

NotAllowedInCurrentState - if the cluster is in the process of password rotation.

rotatePassword

void rotatePassword(java.lang.String cluster,
                    InvocationConfig invocationConfig)

Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.

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 for which the password is being generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Throws:

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

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.

NotAllowedInCurrentState - if the cluster is in the process of password rotation.

rotatePassword

void rotatePassword(java.lang.String cluster,
                    AsyncCallback<java.lang.Void> asyncCallback)

Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.

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.
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.
NotAllowedInCurrentState - if the cluster is in the process of password rotation.

Parameters:

cluster - Identifier for the cluster for which the password is being generated. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

rotatePassword

void rotatePassword(java.lang.String cluster,
                    AsyncCallback<java.lang.Void> asyncCallback,
                    InvocationConfig invocationConfig)

Request a new root password for all control plane nodes in the cluster. This operation generates a new root password and configures every control plane node in the cluster to accept it for authentication.

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.
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.
NotAllowedInCurrentState - if the cluster is in the process of password rotation.

Parameters:

cluster - Identifier for the cluster for which the password is being generated. 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.