NamespaceManagement_SupervisorServices_ClusterSupervisorServices_Info

NamespaceManagement_SupervisorServices_ClusterSupervisorServices_Info
NamespaceManagement_SupervisorServices_ClusterSupervisorServices_Info

The ClusterSupervisorServices.Info structure contains the detailed information about a Supervisor Service on the vSphere Supervisor.

JSON Example
{
    "desired_version": "string",
    "service_namespace": "string",
    "config_status": "string",
    "messages": [
        {
            "severity": "string",
            "details": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": {
                            "id": "string",
                            "params": {
                                "params": "Std_LocalizationParam Object"
                            }
                        },
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        }
    ],
    "current_version": "string",
    "display_name": "string",
    "description": "string",
    "prefix": "string",
    "yaml_service_config": "string"
}
string
desired_version
Required

The desired version of this Supervisor Service.

string
service_namespace
Optional

Identifier of the namespace to allocate the Supervisor Service's operators. If unset, there is an error when creating the service namespace or the namespace has not been created yet. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance.

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.

messages
Required

Current set of messages associated with the Supervisor Service on the vSphere Supervisor.

string
current_version
Optional

The current version for the Supervisor Service. If unset, there is no version installed for the Supervisor Service.

string
display_name
Required

A human readable name of the Supervisor Service.

string
description
Optional

A human readable description of the Supervisor Service. If unset, the description for the service version is empty.

string
prefix
Optional

The prefix that will be added to the names of the Supervisor Service's kubernetes resources. If unset, the prefix is not assigned yet.

string
yaml_service_config
Optional

The configuration parameters applied on this Supervisor Service, formatted as a base64 encoded YAML document. Any configuration that has been set will be returned as base64 encoded YAML, including the ClusterSupervisorServices.CreateSpec.service-config. If unset, the Supervisor Service has no configuration applied.