Disable Clusters
DescriptionDisable vSphere Namespaces on the cluster. This operation tears down the Kubernetes instance and the worker nodes associated with vSphere Namespaces enabled cluster.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=disable
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster for which vSphere Namespaces will be disabled. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the Supervisor cluster is being restored from a backup. When a Supervisor cluster is restored, there’s a window of time during which the restored Supervisor cluster’s state is being synchronized back to vCenter. During that time, Supervisor cluster’s disablement is not allowed.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Manage privilege.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-DisableCluster -Cluster "MyCluster"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=disable
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: disable
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
get
put
patch
post
post
