Create Supervisor Services Cluster Supervisor Services
Create a Supervisor Service on the specified vSphere Supervisor. This operation will apply the Supervisor Service version’s service definition on the cluster. This operation is possible only when the Supervisor Service and Supervisor Service version are in the ACTIVATED state. 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 Supervisor on which to create the service. 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"
Request Body
Request Body
NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec of mimetype application/json
Required
Specification for the Supervisor Service on the cluster.
{
"supervisor_service": "string",
"version": "string"
}
string
supervisor_service
Required
Identifier of the Supervisor Service. This Supervisor Service must be in the ACTIVATED state. 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
version
Required
Identifier of the Supervisor Service version which contains the service definition. This Supervisor Service version must be in the ACTIVATED state. 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.supervisor_services.Version. 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.supervisor_services.Version.
map of
string
service_config
Optional
A generic key-value map for additional configuration parameters required during service creation. As an example, a third party operator might reference a private registry using parameters such as “registryName” for the registry name, “registryUsername” and “registryPassword” for the registry credentials. If unset, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.
string
yaml_service_config
Optional
A set of additional configuration parameters to be applied during service creation. These parameters should be formatted as a base64 encoded YAML document. Parameters should be set in at most one of ClusterSupervisorServices.CreateSpec.service-config or ClusterSupervisorServices.CreateSpec.yaml-service-config, and not both. The ClusterSupervisorServices.CreateSpec.yaml-service-config supports complex data types and nested properties.
If unset, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if spec contains any errors. | com.vmware.vapi.std.errors.already_exists : if a Supervisor Service ID defined in spec exists on the Supervisor | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the Supervisor doesn’t support Supervisor Services, or if the Supervisor Service cannot be created in the current state, e.g. the supervisor service version is in the DEACTIVATED state.
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 the specified cluster with ID cluster or Supervisor Service with the Supervisor Service ID defined in spec 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.
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
$NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec = Initialize-NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec -SupervisorService "MySupervisorService" -Version "MyVersion"
Invoke-CreateClusterNamespaceManagementSupervisorServices -Cluster "MyCluster" -NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec $NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec
PowerCLI Client SDK All Parameters Example
$NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec = Initialize-NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec -SupervisorService "MySupervisorService" -Version "MyVersion" -ServiceConfig @{ key_example = "MyInner" } -YamlServiceConfig "MyYamlServiceConfig"
Invoke-CreateClusterNamespaceManagementSupervisorServices -Cluster "MyCluster" -NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec $NamespaceManagementSupervisorServicesClusterSupervisorServicesCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"service_config":{"key":"string"},"supervisor_service":"string","version":"string","yaml_service_config":"string"}' 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: create
Availability
Added in 7.0.3.0
