Rotate Password Clusters
DescriptionRequest 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.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=rotate_password
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster for which the password is being generated. 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 cluster is in the process of password rotation.
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-RotatePasswordCluster -Cluster "MyCluster"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}?action=rotate_password
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: rotate_password
Availability
Added in 7.0.0.0
On This Page
Clusters Operations
get
put
patch
get
post
post
