Alarm Manager Acknowledge Alarm

Acknowledge the alarm on a managed entity.

The actions associated with the alarm will not fire until the alarm's next distinct occurrence; that is, until after the alarm has entered the green or gray states at least once. Calling this method on an acknowledged or non-triggered alarm.

Request

URI

POST

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

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

Request Body

AcknowledgeAlarmRequestType of type(s) application/json

Required

Show optional properties

{
    "alarm": {},
    "entity": {}
}

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

MoRefAlarm

alarm

Required

Reference to an instance of the Alarm managed object.

MoRefManagedEntity

entity

Required

Reference to an instance of the ManagedEntity managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses