Alarm Manager Get Description

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.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

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"
        }
    ]
}
expr
Required

Descriptions of expression types for a trigger.

stateOperator
Required

State Operator enum description

metricOperator
Required

MetricAlarmExpression Metric Operator enum description

hostSystemConnectionState
Required

Host System Connection State enum description

virtualMachinePowerState
Required

Virtual Machine Power State enum description

datastoreConnectionState
Required

DatastoreSummary.accessible and description

hostSystemPowerState
Required

Host System Power State enum description

virtualMachineGuestHeartbeatStatus
Required

Guest Heartbeat Status enum description

entityStatus
Required

ManagedEntity Status enum description

action
Required

Action class descriptions for an alarm.