REST API - info

vcenter services service: info

The info structure contains information about a service. This structure was added in vSphere API 6.7

Representation:

JSON

{
    "description_key": "string",
    "health": "DEGRADED",
    "health_messages": [
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        }
    ],
    "name_key": "string",
    "startup_type": "MANUAL",
    "state": "STARTING"
}

Attributes:

Name	Type	Description
Required
name_key	string	Service name key. Can be used to lookup resource bundle. This attribute was added in vSphere API 6.7
description_key	string	Service description key. Can be used to lookup resource bundle. This attribute was added in vSphere API 6.7
startup_type	string	Startup Type. This attribute was added in vSphere API 6.7 Defines valid Startup Type for vCenter Server services. This enumeration was added in vSphere API 6.7 Value is one of: MANUAL: Service Startup type is Manual, thus issuing an explicit start on the service will start it. This constant was added in vSphere API 6.7 AUTOMATIC: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it. This constant was added in vSphere API 6.7 DISABLED: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic. This constant was added in vSphere API 6.7
state	string	Running State. This attribute was added in vSphere API 6.7 Defines valid Run State for services. This enumeration was added in vSphere API 6.7 Value is one of: STARTING: Service Run State is Starting, it is still not functional. This constant was added in vSphere API 6.7 STOPPING: Service Run State is Stopping, it is not functional. This constant was added in vSphere API 6.7 STARTED: Service Run State is Started, it is fully functional. This constant was added in vSphere API 6.7 STOPPED: Service Run State is Stopped. This constant was added in vSphere API 6.7
Optional
health	string	Health of service. This attribute was added in vSphere API 6.7 Defines the possible values for health of a service. This enumeration was added in vSphere API 6.7 Value is one of: DEGRADED: Service is in degraded state, it is not functional. This constant was added in vSphere API 6.7 HEALTHY: Service is in a healthy state and is fully functional. This constant was added in vSphere API 6.7 HEALTHY_WITH_WARNINGS: Service is healthy with warnings. This constant was added in vSphere API 6.7Optional. It is only relevant when state has value STARTED. This field is optional and it is only relevant when the value of `state` is STARTED.
health_messages	localizable_message[]	Localizable messages associated with the health of the service. This attribute was added in vSphere API 6.7 Optional. It is only relevant when state has value STARTED. This field is optional and it is only relevant when the value of `state` is STARTED.