Alarm Manager Get Alarm

Alarm Manager Get Alarm

Available alarms defined on the entity.

These alarms do not include any inherited alarms; that is, alarms associated with parent entities.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/AlarmManager/{moId}/GetAlarm
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method 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.

Request Body
GetAlarmRequestType of type(s) application/json
Required 
{
    "entity": {
        "type": "string",
        "value": "string"
    }
}
MoRefManagedEntity
entity
Optional

Reference to an instance of the ManagedEntity managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

A reference to the Alarm objects returned by the operation.

Returns Array of MoRefAlarm of type(s) application/json 
[
    {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
]

On This Page
Alarm Manager Operations
POST
Alarm Manager Acknowledge Alarm
POST
Alarm Manager Are Alarm Actions Enabled
POST
Alarm Manager Clear Triggered Alarms
POST
Alarm Manager Create Alarm
POST
Alarm Manager Disable Alarm
POST
Alarm Manager Enable Alarm
POST
Alarm Manager Enable Alarm Actions
POST
Alarm Manager Get Alarm
POST
Alarm Manager Get Alarm State
GET
Alarm Manager Get Default Expression
GET
Alarm Manager Get Description