REST API - set

vcenter namespaces supervisor services: set spec

The set_spec structure contains the specification required to set the desired state of a SupervisorService. This structure was added in vSphere API 7.0.0.10200.

Representation:

JSON
LEGACY JSON

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

{
    "service_config" : [
        {
            "value" : "string",
            "key" : "string"
        }
    ],
    "version" : "string",
    "enabled" : true
}

Attributes:

Name	Type	Description
Required
-.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.
-.service_config.*	string
Optional
-.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.

Attributes:

Name	Type	Description
Required
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.
service_config[].key	string
service_config[].value	string
Optional
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	list	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.