listAlarms
Retrieve alarms from OpManager by device, severity, category, alert type, or time range to monitor network issues.
Instructions
listAlarms
Category: Manage and query alarms/alerts in OpManager
Key parameters:
deviceName: Device Name of the alarm. The device name can be taken from
severity: Severity of the alarm. The severity could range anywhere fro
category: Device category of the alarm
alertType: alertType of the alarm. The alert type can be any of the fol
fromTime: Start time for the custom time period range. It could be of
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| host | Yes | OpManager host address (e.g., 'opmanager.example.com' or 'opmanager.example.com:8061'). Default port is 8061 (HTTPS). | |
| apiKey | Yes | OpManager API key for authentication | |
| toTime | No | End time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day). | |
| category | No | Device category of the alarm | |
| fromTime | No | Start time for the custom time period range. It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M(start of the day). | |
| severity | No | Severity of the alarm. The severity could range anywhere from 1 to 5. 1 = Critical, 2 = Trouble, 3 = Attention, 4 = Service Down, 5 = Clear . | |
| alertType | No | alertType of the alarm. The alert type can be any of the following: ActiveAlarms, EventLogAlarms, SyslogAlarms, TrapAlarms, NCMAlarms, NFAAlarms, WebAlarms, FWAAlarms, StorageAlarms . | |
| probeName | No | The name of the Probe. The probe name could be obtained by executing the listProbes API , where the parameter name in the response refers to the probeName. [Applicable only for Central Server] | |
| deviceName | No | Device Name of the alarm. The device name can be taken from the URL of the device snapshot page. |