Delete Supervisor Services Versions
DescriptionDelete a Supervisor Service version. This operation only deletes the Supervisor Service version from vCenter if the version is in DEACTIVATED state and all instances of the version are removed from all Supervisors. Note that the Versions.deactivate operation should be called to deactivate the version before the version can be deleted. Note that deleting the last version of the supervisorService does not delete the supervisorService instance automatically.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}
Path Parameters
Path Parameters
string
supervisor_service
Required
Identifier of 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 deleted in the current state, e.g. the version is not in DEACTIVATED state.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t 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 {param.name version} could not be located.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request, e.g. if it is unable to reach a vSphere Supervisor that has the version enabled.
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-DeleteSupervisorServiceVersionNamespaceManagement -SupervisorService "MySupervisorService" -Version "MyVersion"
cURL Command
curl -X DELETE -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}/versions/{version}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: delete
Availability
Added in 7.0.3.0
