Deactivate Supervisor Services Versions
DescriptionDeactivate a Supervisor Service version. This operation will change the Versions.State of the version to DEACTIVATED state, which will make sure the version cannot be created on any Supervisor cluster. Note that this operation should be called before deleting the version.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}?action=deactivate
Path Parameters
Path Parameters
string
supervisor_service
Required
Identifier for the Supervisor Service. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.
string
version
Required
Identifier of the version. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.
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 Service version cannot be deactivated in the current state, for example, the Supervisor Service is in ACTIVATED state and this version is the last version of the Supervisor Service in ACTIVATED state.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the SupervisorServices.Manage privilege.
404
com.vmware.vapi.std.errors.not_found : if Supervisor Service with the ID supervisorService or version with the ID version could not be located.
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-UpdateSupervisorServiceVersion_0 -SupervisorService "MySupervisorService" -Version "MyVersion"
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}?action=deactivate
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: deactivate
Availability
Added in 7.0.3.0
