Alarm Manager Get Description

The static descriptive strings used in alarms.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/AlarmManager/{moId}/description

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case AlarmManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns AlarmDescription of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "expr": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "stateOperator": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "metricOperator": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "hostSystemConnectionState": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "virtualMachinePowerState": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "datastoreConnectionState": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "hostSystemPowerState": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "virtualMachineGuestHeartbeatStatus": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "entityStatus": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "action": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ]
}

array of TypeDescription

expr

Required

Descriptions of expression types for a trigger.

array of ElementDescription

stateOperator

Required

State Operator enum description

array of ElementDescription

metricOperator

Required

MetricAlarmExpression Metric Operator enum description