Versions Compared

Old Version 1

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version 2

changes.mady.by.user Ribbon Communications

Saved on

Key

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

...

Noprint
Panel
borderColorgreen
bgColortransparent
borderWidth2

Back to Table of Contents

Back to CLI System-Level Mode

Back to request Command Details

 

Panel

In this section:

Table of Contents
maxLevel2

The request alarms command is available from both system-level and configure modes, and includes is used to accomplish the following objects:
activities:

  • Clear current outstanding alarms or clear all alarms from the history buffer.

  • Set alarm's acknowledge state and/or add a comment to an outstanding alarm.

Command Syntax

The command syntax to clear or set alarms is listed below.

Code Block
languagenone
> request alarms 
	clear 
		current
			alarmId <id><integer>
			deleteMatchingAlarms <no | yes>
		history
	current
		comment alarm
			id <integer>
			text <operator comment>
		state alarm
			acknowledgeState <acknowledge | unAcknowledge>
			id <integer>

Command Parameters

Caption
0Table
1'request alarms' Parameters
Clear If alarm ID or "deleteMatchingAlarms" is not given, this command will delete all current alarms.alarmId <id> – The
ParameterLength/RangeDescriptionsDescriptions
request alarms clear

Use this command to either clear current outstanding alarms or clear all alarms from history buffer.

  • current – Use this parameter to clear all
currentN/A
  • current/outstanding alarm(s).
  • To clear a specific alarm, include the alarmId option below.
    • alarmId – Unique alarm identifier.
    • deleteMatchingAlarms– Set this flag to "yes" to delete all alarms matching the alarm Id.
      • no
      • yes
  • history
N/A
  • – Clear all alarms from the history buffer.
request alarms current

Use this commend to either set alarm's acknowledge state and/or add a comment to an outstanding alarm.

  • comment alarm – Add a comment to an outstanding alarm.
    • id <integer> – Unique alarm identifier.
    • text <operator comment> – Operator comments
  • state alarm – Set operator state of a specific alarm using alarm Id.
    • acknowledgeState – The current operator state of the outstanding alarm.  
      • acknowledge
      • unAcknowledge (default)
    • id <integer> – Unique alarm identifier.

Command Example

To clear all current alarms/outstanding alarm(s):

Code Block
languagenone
admin@SBXUK24-1>> request alarms clear current
result success
reason All current/outstanding alarms have been purged

To clear all alarms from the history buffer:

Code Block
languagenone
admin@server1>> request alarms clear history
Deleted all alarm entries in history-table

To set the acknowledgeState of alarm Id 222 to 'acknowledge':

Code Block
languagenone
% request alarms current state alarm id 222 acknowledgeState acknowledge
result success
reason
[ok]