1. Types
  2. appliance
  3. vmon
  4. service

appliance vmon service: info

The info structure contains information about a service.

Representation:

{
    "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
description_key string Service description key. Can be used to lookup resource bundle
startup_type string Startup Type.

Defines valid Startup Type for services managed by vMon. Value is one of:
MANUAL: Service Startup type is Manual, thus issuing an explicit start on the service will start it.
AUTOMATIC: Service Startup type is Automatic, thus during starting all services or issuing explicit start on the service will start it.
DISABLED: Service Startup type is Disabled, thus it will not start unless the startup type changes to manual or automatic.
state string Running State.

Defines valid Run State for services. Value is one of:
STARTING: Service Run State is Starting, it is still not functional
STOPPING: Service Run State is Stopping, it is not functional
STARTED: Service Run State is Started, it is fully functional
STOPPED: Service Run State is Stopped
Optional
health string Health of service.

Defines the possible values for health of a service. Value is one of:
DEGRADED: Service is in degraded state, it is not functional.
HEALTHY: Service is in a healthy state and is fully functional.
HEALTHY_WITH_WARNINGS: Service is healthy with warnings.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.
health_messages localizable_message[] Localizable messages associated with the health of the service

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.