Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Metadata list
hiddentrue
||Product on coverpage|SBC Core|
||Product Release|10.x|
||Document Title|REST API Reference Guide - alarms|
||Document Number|550-xxxx|
||Document Revision|01.01|
||Filename|alarms_01|


Resources | alarms


Image Modifiedalarms

The alarms object allows you to configure parameters for the alarms which are individually configurable. When viewing alarms from the CLI, the alarm timestamp is Greenwich Mean Time (GMT) regardless of the time zone set on the system.


Configuration


ParameterPresenceTypeDefaultDescription
Image Modified
clearO

Clear Alarms.
Image Modified
currentO

set Alarms acknowledge state or comment for an outstanding alarm.

Operational Data


ParameterDescription
Image Modified
currentStatusStatus table for Current Outstanding Alarms.
Image Modified
historyStatusStatus table for History-Alarms.


REST API: GET Example

curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/alarms