Vcenter Services Service Info

Vcenter Services Service Info

The Vcenter Services Service Info schema contains information about a service.

This schema was added in vSphere API 6.7.

JSON Example

{
    "name_key": "string",
    "description_key": "string",
    "startup_type": "string",
    "state": "string",
    "health": "string",
    "health_messages": [
        {
            "id": "string",
            "default_message": "string",
            "args": [
                "string"
            ],
            "params": {
                "params": {
                    "s": "string",
                    "dt": "string",
                    "i": 0,
                    "d": "number",
                    "l": "Vapi Std NestedLocalizableMessage Object",
                    "format": "string",
                    "precision": 0
                }
            },
            "localized": "string"
        }
    ]
}

string

name_key

Required

Service name key. Can be used to lookup resource bundle

This property was added in vSphere API 6.7.

string

description_key

Required

Service description key. Can be used to lookup resource bundle

This property was added in vSphere API 6.7.

string

startup_type

Required

Startup Type.

For more information see: Vcenter Services Service StartupType.

This property was added in vSphere API 6.7.

string

state

Required

Running State.

For more information see: Vcenter Services Service State.

This property was added in vSphere API 6.7.

string

health

Optional

Health of service.

For more information see: Vcenter Services Service Health.

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of state is Vcenter Services Service State.STARTED.

array of Vapi Std LocalizableMessage

health_messages

Optional

Localizable messages associated with the health of the service

This property was added in vSphere API 6.7.

This property is optional and it is only relevant when the value of state is Vcenter Services Service State.STARTED.

Returned By

Vcenter Services Service get