Alarm Get Info

Alarm Get Info

Information about this alarm.

Required privileges: System.View

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/Alarm/{moId}/info
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 Alarm/{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 AlarmInfo of type(s) application/json
This response body class contains all of the following: AlarmSpec 
{
    "_typeName": "string",
    "name": "string",
    "systemName": "string",
    "description": "string",
    "enabled": false,
    "expression": {
        "_typeName": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "actionFrequency": 0,
    "setting": {
        "_typeName": "string",
        "toleranceRange": 0,
        "reportingFrequency": 0
    },
    "key": "string",
    "alarm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "lastModifiedTime": "string",
    "lastModifiedUser": "string",
    "creationEventId": 0
}
string
key
Required

The unique key.

MoRefAlarm
alarm
Required

Reference to an instance of the Alarm managed object.

MoRefManagedEntity
entity
Required

Reference to an instance of the ManagedEntity managed object.

string As date-time As date-time
lastModifiedTime
Required

The time the alarm was created or modified.

string
lastModifiedUser
Required

User name that modified the alarm most recently.

integer As int32 As int32
creationEventId
Required

The event ID that records the alarm creation.


On This Page
Alarm Operations
GET
Alarm Get Available Field
GET
Alarm Get Info
GET
Alarm Get Value
POST
Alarm Reconfigure Alarm
POST
Alarm Remove Alarm
POST
Alarm Set Custom Value