Alarm Manager Get Alarm State

The state of instantiated alarms on the entity.

Request

URI

POST

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

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

GetAlarmStateRequestType of type(s) application/json

Required

{
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}

MoRefManagedEntity

entity

Required

Reference to an instance of the ManagedEntity managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The state of instantiated alarms.

Returns Array of AlarmState of type(s) application/json

[
    {
        "_typeName": "string",
        "key": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "alarm": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "overallStatus": "string",
        "time": "string",
        "acknowledged": false,
        "acknowledgedByUser": "string",
        "acknowledgedTime": "string",
        "eventKey": 0,
        "disabled": false
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Alarm Manager Operations

POST

Alarm Manager Acknowledge Alarm

POST