Get Supervisor Services
Return the information for the specified 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
NamespaceManagementSupervisorServicesInfo
of type application/json
Information for the specified Supervisor Service.
{
"description": "string",
"display_name": "string",
"state": "ACTIVATED"
}
string
display_name
Required
The human readable name of the Supervisor Service.
state
Required
The SupervisorServices.State enumerated type defines the state of a Supervisor Service.
ACTIVATED : The is the default state of a Supervisor Service upon creation. In this state, at least one version of the Supervisor Service is activated.
DEACTIVATED : The is the deactivated state of a Supervisor Service. In this state, all existing versions of the Supervisor Service will be deactivated, and cannot be activated. In addition to that, no new versions can be added to the Supervisor Service.
Possible values are: ACTIVATED , DEACTIVATED
string
description
Optional
A human readable description of the Supervisor Service. If unset, no description is available for the Supervisor Service.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the System.Read 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
Invoke-GetSupervisorServiceNamespaceManagement -SupervisorService "MySupervisorService"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" 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: get
Availability
Added in 7.0.3.0
