Update Supervisor Services
Update a Supervisor Service.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}
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.
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"
Request Body
Request Body
NamespaceManagementSupervisorServicesUpdateSpec of mimetype application/json
Required
Specification for the Supervisor Service metadata to be updated.
{
"description": "string",
"display_name": "string"
}
string
description
Optional
A human readable description of the Supervisor Service. If unset, the description of the service will not be modified.
string
display_name
Optional
A human readable name of the Supervisor Service. If unset, the display name of the service will not be modified.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if spec contain any errors or if an invalid name is specified.
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 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
$NamespaceManagementSupervisorServicesUpdateSpec = Initialize-NamespaceManagementSupervisorServicesUpdateSpec -DisplayName "MyDisplayName" -Description "MyDescription"
Invoke-UpdateSupervisorServiceNamespaceManagement -SupervisorService "MySupervisorService" -NamespaceManagementSupervisorServicesUpdateSpec $NamespaceManagementSupervisorServicesUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","display_name":"string"}' https://{api_host}/api/vcenter/namespace-management/supervisor-services/{supervisor_service}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: update
Availability
Added in 7.0.3.0
