Vcenter NamespaceManagement SupervisorServices ClusterSupervisorServices create
This operation is deprecated as of vSphere API 9.0.0.0. Use POST /vcenter/namespace-management/supervisors/{supervisor}/supervisor-services instead.
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.
This operation was added in vSphere API 7.0.3.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
ClusterComputeResourcereferenced by the parameter cluster requiresSupervisorServices.Install.
Identifier for the cluster on which to install the service.
The parameter must be an identifier for the resource type: ClusterComputeResource.
Specification for the Supervisor Service on the cluster.
Show optional properties
{
"supervisor_service": "string",
"version": "string"
}{
"supervisor_service": "string",
"version": "string",
"service_config": {
"service_config": "string"
},
"yaml_service_config": "string"
}This property is deprecated as of vSphere API 9.0.0.0.
Identifier of the Supervisor Service. This Supervisor Service must be in the ACTIVATED state.
This property was added in vSphere API 7.0.3.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.SupervisorService.
This property is deprecated as of vSphere API 9.0.0.0.
Identifier of the Supervisor Service version which contains the service definition. This Supervisor Service version must be in the ACTIVATED state.
This property was added in vSphere API 7.0.3.0.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.namespace_management.supervisor_services.Version.
This property is deprecated as of vSphere API 9.0.0.0.
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.
This property was added in vSphere API 7.0.3.0.
If missing or null, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.
This property is deprecated as of vSphere API 9.0.0.0.
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 service_config or yaml_service_config, and not both. The yaml_service_config supports complex data types and nested properties.
This property was added in vSphere API 8.0.0.1.
If missing or null, no additional configuration parameters will be applied when installing a Supervisor Service in the vSphere Supervisor.
Success!
Vapi Std Errors InvalidArgument if spec contains any errors.
Vapi Std Errors AlreadyExists if a Supervisor Service ID defined in spec exists on the Supervisor
Vapi Std Errors NotAllowedInCurrentState 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.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user cannot be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user does not have the SupervisorServices.Install privilege on the specified cluster.
"Vapi Std Errors Unauthorized Object"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.
"Vapi Std Errors NotFound Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"supervisor_service:"string","version:"string"}' https://{api_host}/api/vcenter/namespace-management/clusters/{cluster}/supervisor-services