ServicesServiceInfo

The Service.Info structure contains information about a service.


Properties

string
description_key Required

Service description key. Can be used to lookup resource bundle


health Optional

The Service.Health enumerated type defines the possible values for health of a service.
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.

Possible values are: DEGRADEDHEALTHYHEALTHY_WITH_WARNINGS


health_messages Optional

Localizable messages associated with the health of the service This field is optional and it is only relevant when the value of Service.Info.state is STARTED.


string
name_key Required

Service name key. Can be used to lookup resource bundle


startup_type Required

The Service.StartupType enumerated type defines valid Startup Type for vCenter Server services.
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.

Possible values are: MANUALAUTOMATICDISABLED


state Required

The Service.State enumerated type defines valid Run State for services.
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

Possible values are: STARTINGSTOPPINGSTARTEDSTOPPED

JSON Example

{
	"description_key": "string",
	"name_key": "string",
	"startup_type": "MANUAL",
	"state": "STARTING"
}

Feedback

Was this page helpful?