Alarm Manager Get Description

Alarm Manager Get Description

The static descriptive strings used in alarms.

Required privileges: System.View

Request
URI
GET
https://{api_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 
"AlarmDescription Object"
array of object
expr
Required

Descriptions of expression types for a trigger.

array of object
stateOperator
Required

State Operator enum description

array of object
metricOperator
Required

MetricAlarmExpression Metric Operator enum description

array of object
hostSystemConnectionState
Required

Host System Connection State enum description

array of object
virtualMachinePowerState
Required

Virtual Machine Power State enum description

array of object
datastoreConnectionState
Required

DatastoreSummary.accessible and description

array of object
hostSystemPowerState
Required

Host System Power State enum description

array of object
virtualMachineGuestHeartbeatStatus
Required

Guest Heartbeat Status enum description

array of object
entityStatus
Required

ManagedEntity Status enum description

array of object
action
Required

Action class descriptions for an alarm.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/AlarmManager/{moId}/description
On This Page
Alarm Manager Operations
POST
Alarm Manager Acknowledge Alarm
POST
Alarm Manager Clear Triggered Alarms
POST
Alarm Manager Create Alarm
POST
Alarm Manager Disable Alarm
POST
Alarm Manager Enable Alarm
POST
Alarm Manager Get Alarm
POST
Alarm Manager Are Alarm Actions Enabled
POST
Alarm Manager Get Alarm State
POST
Alarm Manager Enable Alarm Actions
GET
Alarm Manager Get Default Expression
GET
Alarm Manager Get Description