REST API - set

vcenter namespaces supervisor services: set

Update the desired state for a Supervisor Service. The desired state is stored and updated in the vCenter Namespaces Supervisor Kubernetes layer. It may also be updated directly within Kubernetes, where the state is authoratively kept. Desired state is a combination of the enabled and version fields. The desired state is set and will be asynchronously remediated. This operation was added in vSphere API 7.0.0.10200.

Request:

HTTP request

PUT https://{server}/api/vcenter/namespace-management/clusters/{cluster}/supervisorservices/{serviceID}

{
    "service_config" : {
        "<string>" : "string"
    },
    "version" : "string",
    "enabled" : true
}

Path Parameters

Name	Type	Description
Required
cluster	string	Identifier for the cluster on which to enable the service.

Body Parameters:

Name	Type	Description
bold = required
-	set_spec	Specification for the service and its desired state.
-.enabled	boolean	Desired state for service enablement. If the state is changed to be enabled, the service will be deployed. Typically this involves creation of a namespace, a Kubernetes operator, RBAC rules, Kubernetes Service objects, as well as registration of new CustomResourceDefinitions. Thus, as new pods may be scheduled, additional CPU, memory and possibly storage resources may be consumed. The amount depends on the specific service. If the state if changed to be disabled, the service is marked for deletion. Note though that disabling may block if the service is still using resources it doesn't want to release. Hence it is recommended to explicitly delete any instances before disabling the service. This is done to prevent accidental deletion of critical customer data. This attribute was added in vSphere API 7.0.0.10200.
-.version	string	Desired version. Changing the version only relates to the version of the service operator, i.e. its control plane, not to any running instances, if applicable. Updating may lead to temporary service disruption of the operator. Available versions are published by the service, and only published versions are allowed to be set. This attribute was added in vSphere API 7.0.0.10200. Optional. If unset, when initially enabling a service, the latest version (at the time) is used. If already enabled, an empty input is ignored.
-.service_config	object	The third party operator might need additional configuration parameters during enablement. This generic key-value map allows the operator to take such inputs from the user. As an example, an operator might reference a private registry using parameters like "registryName" for the registry name, "registryUsername" and "registryPassword" for the registry credentials. This attribute was added in vSphere API 7.0.1.0. Optional. This field is optional because it was added in a newer version than its parent node.
-.service_config.*	string

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code	Type	Description
500	error	if the system reports an error while responding to the request, e.g. if the Kubernetes cluster is unhealthy or can't be reached.
400	invalid_argument	if `spec` contain any errors or if an invalid name is specified.
404	not_found	if `cluster` is not registered or not fully enabled on this vCenter server.
401	unauthenticated	if the user can not be authenticated.
403	unauthorized	if the user doesn't have the Namespaces.Manage privilege.