List Supervisor Services Cluster Supervisor Services
Return the summaries about all Supervisor Services on the specified vSphere Supervisor. A Supervisor can be running on one or multiple vSphere Zones, and each vSphere Zone is associated with one or more vSphere Clusters. If a Supervisor running on the specified vSphere Cluster is running on additional vSphere Clusters, this operation will apply to Supervisor components running on the other vSphere Clusters in addition to the specified vSphere Cluster. To call this API on a Supervisor with multiple vSphere Clusters, use com.vmware.vcenter.namespace_management.supervisors.Topology#get to get the vSphere Clusters associated with the given Supervisor. Any cluster from the list returned can be used as the input of this API.
Request
URLURL
https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services
Path Parameters
Path Parameters
string
cluster
Required
Identifier for the cluster on which to list the services. 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.
Response
Response
Response BodyResponse Body
200 OK returns
array of
NamespaceManagementSupervisorServicesClusterSupervisorServicesSummary
of type application/json
The list of summaries of all Supervisor Services on the cluster.
[
{
"config_status": "CONFIGURING",
"current_version": "string",
"desired_version": "string",
"supervisor_service": "string"
}
]
config_status
Required
The ClusterSupervisorServices.ConfigStatus enumerated type describes the status of reaching the desired state configuration for the Supervisor Service.
CONFIGURING : The Supervisor Service is being installed.
REMOVING : The Supervisor Service is being deleted.
CONFIGURED : The Supervisor Service has been configured correctly (i.e. the provided YAML content has been applied successfully to the cluster)
ERROR : Failed to install the Supervisor Service, user intervention needed.
Possible values are: CONFIGURING , REMOVING , CONFIGURED , ERROR
string
desired_version
Required
The desired version of this Supervisor Service.
string
supervisor_service
Required
The identifier of the Supervisor Service. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.
string
current_version
Optional
The current version for the Supervisor Service. If unset, there is no version installed for the Supervisor Service.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the Supervisor doesn’t support Supervisor Services.
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the SupervisorServices.Manage privilege on the specified cluster.
404
com.vmware.vapi.std.errors.not_found : if Supervisor with the ID cluster 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-ListClusterNamespaceManagementSupervisorServices -Cluster "MyCluster"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.3.0
