com.vmware.vcenter.namespaces

Interface NamespaceSelfService

All Superinterfaces:

NamespaceSelfServiceTypes, Service

All Known Implementing Classes:

NamespaceSelfServiceStub

public interface NamespaceSelfService
extends Service, NamespaceSelfServiceTypes

The NamespaceSelfService interface provides methods to activate and deactivate a namespace template that empowers users as self-service namespace users. If the service is activated on a cluster, users can create Supervisor Namespaces through kubectl create namespace command without the need of extra assistance. This interface was added in vSphere API 7.0.2.00100.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.namespaces.NamespaceSelfServiceTypes

NamespaceSelfServiceTypes.ActivateTemplateSpec, NamespaceSelfServiceTypes.Capability, NamespaceSelfServiceTypes.Info, NamespaceSelfServiceTypes.Status, NamespaceSelfServiceTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.namespaces.NamespaceSelfServiceTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	activate(java.lang.String cluster) Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	activate(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback) Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	activate(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	activate(java.lang.String cluster, InvocationConfig invocationConfig) Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	activateWithTemplate(java.lang.String cluster, NamespaceSelfServiceTypes.ActivateTemplateSpec spec) Activate Namespace Self Service on the cluster after configuring namespace template.
void	activateWithTemplate(java.lang.String cluster, NamespaceSelfServiceTypes.ActivateTemplateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Activate Namespace Self Service on the cluster after configuring namespace template.
void	activateWithTemplate(java.lang.String cluster, NamespaceSelfServiceTypes.ActivateTemplateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Activate Namespace Self Service on the cluster after configuring namespace template.
void	activateWithTemplate(java.lang.String cluster, NamespaceSelfServiceTypes.ActivateTemplateSpec spec, InvocationConfig invocationConfig) Activate Namespace Self Service on the cluster after configuring namespace template.
void	deactivate(java.lang.String cluster) Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	deactivate(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback) Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	deactivate(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
void	deactivate(java.lang.String cluster, InvocationConfig invocationConfig) Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled.
NamespaceSelfServiceTypes.Info	get(java.lang.String cluster) Returns information about Namespace Self Service of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<NamespaceSelfServiceTypes.Info> asyncCallback) Returns information about Namespace Self Service of a specific cluster.
void	get(java.lang.String cluster, AsyncCallback<NamespaceSelfServiceTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about Namespace Self Service of a specific cluster.
NamespaceSelfServiceTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns information about Namespace Self Service of a specific cluster.
java.util.List<NamespaceSelfServiceTypes.Summary>	list() Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
void	list(AsyncCallback<java.util.List<NamespaceSelfServiceTypes.Summary>> asyncCallback) Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
void	list(AsyncCallback<java.util.List<NamespaceSelfServiceTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.
java.util.List<NamespaceSelfServiceTypes.Summary>	list(InvocationConfig invocationConfig) Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter.

Method Detail

activate

void activate(java.lang.String cluster)

Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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.

Throws:

AlreadyExists - if the cluster already has Namespace Self Service activated.

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

NotFound - if cluster with vSphere Namespaces enabled could not be located or no namespace templates exists.

UnableToAllocateResource - if the specified cluster is not licensed.

Unauthenticated - if the user can not be authenticated.

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

NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled or no namespace template exists in the system.

activate

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

Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the cluster already has Namespace Self Service activated.

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

NotFound - if cluster with vSphere Namespaces enabled could not be located or no namespace templates exists.

UnableToAllocateResource - if the specified cluster is not licensed.

Unauthenticated - if the user can not be authenticated.

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

NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled or no namespace template exists in the system.

activate

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

Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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

Operation Errors:
AlreadyExists - if the cluster already has Namespace Self Service activated.
Error - if the system reports an error while responding to the request.
NotFound - if cluster with vSphere Namespaces enabled could not be located or no namespace templates exists.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled or no namespace template exists in the system.

Parameters:

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

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

activate

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

Activate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation empowers Dev Users/Groups as self-service namespace users to create Supervisor Namespaces through kubectl create namespace command. activate requires the availability of one or more templates in the system. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 Namespace Self Service activated.
Error - if the system reports an error while responding to the request.
NotFound - if cluster with vSphere Namespaces enabled could not be located or no namespace templates exists.
UnableToAllocateResource - if the specified cluster is not licensed.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled or no namespace template exists in the system.

Parameters:

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

deactivate

void deactivate(java.lang.String cluster)

Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 with vSphere Namespaced enabled is not found.

Unauthenticated - if the user can not be authenticated.

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

NotAllowedInCurrentState - if the service is not activated.

deactivate

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

Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 with vSphere Namespaced enabled is not found.

Unauthenticated - if the user can not be authenticated.

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

NotAllowedInCurrentState - if the service is not activated.

deactivate

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

Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 with vSphere Namespaced enabled is not found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is not activated.

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.

deactivate

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

Deactivate Namespace Self Service on the cluster on which vSphere Namespaces enabled. This operation reverses Dev Users/Group's self-service namespace capability on the cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 with vSphere Namespaced enabled is not found.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user does not have Namespaces.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is not activated.

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

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

Returns information about Namespace Self Service of a specific cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 namespace self service associated with the specified cluster.

Throws:

NotFound - if cluster with vSphere Namespaced enabled 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

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

Returns information about Namespace Self Service of a specific cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 namespace self service associated with the specified cluster.

Throws:

NotFound - if cluster with vSphere Namespaced enabled 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<NamespaceSelfServiceTypes.Info> asyncCallback)

Returns information about Namespace Self Service of a specific cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
Information about the namespace self service associated with the specified cluster.

Operation Errors:
NotFound - if cluster with vSphere Namespaced enabled 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 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<NamespaceSelfServiceTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about Namespace Self Service of a specific cluster. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 namespace self service associated with the specified cluster.

Operation Errors:
NotFound - if cluster with vSphere Namespaced enabled 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 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<NamespaceSelfServiceTypes.Summary> list()

Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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

Returns:

List of summary of Namespace Self Service associated with 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<NamespaceSelfServiceTypes.Summary> list(InvocationConfig invocationConfig)

Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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 Namespace Self Service associated with 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<NamespaceSelfServiceTypes.Summary>> asyncCallback)

Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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

Invocation Result:
List of summary of Namespace Self Service associated with 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<NamespaceSelfServiceTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns basic information about Namespace Self Service on all clusters on which vSphere Namespaces are enabled on this vCenter. This method was added in vSphere API 7.0.2.00100.

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 Namespace Self Service associated with 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.

activateWithTemplate

void activateWithTemplate(java.lang.String cluster,
                          NamespaceSelfServiceTypes.ActivateTemplateSpec spec)

Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 activating namespace self service on the cluster by granting users/groups to create Supervisor Namespaces.

Throws:

AlreadyExists - if the cluster already has Namespace Self Service activated.

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

NotFound - if cluster with vSphere Namespaces enabled 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.SelfServiceManage privilege.

NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled.

activateWithTemplate

void activateWithTemplate(java.lang.String cluster,
                          NamespaceSelfServiceTypes.ActivateTemplateSpec spec,
                          InvocationConfig invocationConfig)

Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 activating namespace self service on the cluster by granting users/groups to create Supervisor Namespaces.

invocationConfig - Configuration for the method invocation.

Throws:

AlreadyExists - if the cluster already has Namespace Self Service activated.

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

NotFound - if cluster with vSphere Namespaces enabled 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.SelfServiceManage privilege.

NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled.

activateWithTemplate

void activateWithTemplate(java.lang.String cluster,
                          NamespaceSelfServiceTypes.ActivateTemplateSpec spec,
                          AsyncCallback<java.lang.Void> asyncCallback)

Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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

Operation Errors:
AlreadyExists - if the cluster already has Namespace Self Service activated.
Error - if the system reports an error while responding to the request.
NotFound - if cluster with vSphere Namespaces enabled 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.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled.

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 activating namespace self service on the cluster by granting users/groups to create Supervisor Namespaces.

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

activateWithTemplate

void activateWithTemplate(java.lang.String cluster,
                          NamespaceSelfServiceTypes.ActivateTemplateSpec spec,
                          AsyncCallback<java.lang.Void> asyncCallback,
                          InvocationConfig invocationConfig)

Activate Namespace Self Service on the cluster after configuring namespace template. This is another variant of activate except configures template before activation. The template configuration includes either creating a new template or updating the existing template, depending on the template's existence. Here is supported the flow of actions using the activateWithTemplate call: 1. Activate with the new template using activateWithTemplate call. 2. Deactivate using deactivate call. 3. Active with updating the existing template using activateWithTemplate. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API. This method was added in vSphere API 7.0.2.00100.

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 Namespace Self Service activated.
Error - if the system reports an error while responding to the request.
NotFound - if cluster with vSphere Namespaces enabled 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.SelfServiceManage privilege.
NotAllowedInCurrentState - if the service is marked for deactivation or the associated cluster is being disabled.

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 activating namespace self service on the cluster by granting users/groups to create Supervisor Namespaces.

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

invocationConfig - Configuration for the method invocation.