FMS Command Reference
This chapter describes the fault management system (FMS) commands:
fault-management (enable | disable)
Use this command to enable or disable the fault management system (FMS).
Note: If the loopback interface is down, FMS will not receive logs, preventing it from generating and clearing alarms, resulting in the loss of these logs.
Command Syntax
fault-management (enable | disable)
Parameters
enable
Enable FMS
disable
Disable FMS
Command Mode
Configuration mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
Enable FMS:
(config)# fault-management enable
(config)#commit
%% Warning : FMS requires logging level all to be configured to minimum 4, please configure accordingly
(config)#
Validation:
#show fms status
% FMS Status: Enabled
% FMS Node Application Status: Up
Disable FMS:
(config)# fault-management disable
(config)#commit
Validation:
#show fms status
% FMS Status: Disabled
fault-management close
Use this command to close an active alarm.
Command Syntax
fault-management close ACTIVE-ALARM-ID
Parameter
ACTIVE-ALARM-ID
Identifier of an active alarm
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
After closing an active alarm, it should not be displayed in the active alarms list.
The alarm ID can be found with
show alarm history, specifying the
all parameter.
#sh alarm history all
Alarm Count: 1
Severity Alarm_Type_ID Alarm_ID Description
--------------------------------------------------------
MAJOR EQPT IFMGR_IF_DOWN::ce3/1 2019-02-18T15:07:57.755Z : OcNOS [IFMGR_IF_DOWN] Interface ce3/1 changed state to down
#sh alarm active
Active Alarms received:-
Active Alarm Count: 1
Severity Status Alarm Description
------------------------------------------
MAJOR Active OcNOS [IFMGR_IF_DOWN] Interface ce3/1 changed state to down
#
#fault-management close IFMGR_IF_DOWN::ce3/1
% FMS Response: IFMGR_IF_DOWN::ce3/1 closed
#
#sh alarm active
Active Alarms received:-
There are no active alarms present in the Database
fault-management flush-db
Use this command to flush the alarms from the database.
Command Syntax
fault-management flush-db
Parameter
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#fault-management flush-db
% FMS Response: Database flush completed
Validation:
Check that after fault-management flush-db, all alarms in the database are flushed:
#show alarm active
Active Alarms received:-
There are no active alarms present in the Database
#show alarm history all
There are no alarms present in the Database
#show alarm closed
No alarms are manually closed
#show alarm shelved
No alarm-types are shelved
#show alarm statistics
There are no alarms present in the Database
#show alarm transitions
There are no transition alarms present in the Database
fault-management shelve
Use this command to shelve (disable) an alarm type.
Command Syntax
fault-management shelve ALARM-TYPE
Parameter
ALARM-TYPE
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#fault-management shelve CMM_MONITOR_CPU
% FMS Response: Alarm-type CMM_MONTOR_CPU shelved.
#
Validation:
Check that after shelving an alarm type, active alarms of that type are not being raised.
#fault-management shelve IFMGR_IF_DOWN
% FMS Response: Alarm-type IFMGR_IF_DOWN shelved.
#
#show alarm shelved
Alarm-type Count: 1
Alarm Type
-------------------
IFMGR_IF_DOWN
#
(config)#interface ce1/1
(config-if)#shutdown
(config-if)#commit
2019 Feb 18 15:21:31.229 : OcNOS : NSM : CRITI : [IFMGR_IF_DOWN_2]: Interface ce1/1 changed state to down
(config-if)#end
#
#show alarm history all
There are no alarms present in the Database
#show alarm active
Active Alarms received:-
There are no active alarms present in the Database
#
show alarm active
Use this command to display the current active alarms in the database.
Command Syntax
show alarm active
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0 and the output changed in OcNOS version 6.1.0.
Example
#show alarm active
Active Alarms received:-
Active-Alarms-Count: 1
Alarm-Date-Time Severity Alarm-ID Alarm-Description
------------------------------------------------------------------------------
2019-02-15T19:57:14.525Z MAJOR IFMGR_IF_DOWN::xe8 OcNOS [IFMGR_IF_DOWN] Interface xe8 changed state to down
#
show alarm closed
Use this command to display alarms that are manually closed.
Command Syntax
show alarm closed
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#show alarm closed
Alarm Count: 1
Severity Alarm_Type_ID Alarm_ID Description
--------------------------------------------------------
MAJOR EQPT IFMGR_IF_DOWN::xe7 FMS [IFMGR_IF_DOWN] Interface xe7 changed state to down
#
show alarm history
Use this command to show the alarm history.
Command Syntax
show alarm history (1-day | 1-hr | 1-week | all)
Parameters
1-day
Display alarms in the last 1 day
1-hr
Display alarms in the last 1 hour
1-week
Display alarms in the last 1 week
all
Display all the alarms
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show alarm history ?
1-day Display alarms in the last 1 day
1-hr Display alarms in the last 1 hour
1-week Display alarms in the last 1 week
all Display all the alarms
show alarm shelved
Use this command to display shelved (disabled) alarm types.
Command Syntax
show alarm shelved
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#show alarm shelved
Alarm-type Count: 1
Alarm Type
-------------------
IFMGR_IF_DOWN
#
show alarm statistics
Use this command to display the alarm statistics.
Command Syntax
show alarm statistics
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show alarm statistics
Alarm Statistics :-
Alarm Count: 1
Current Severity Count Alarm ID
--------------------------------------
MAJOR 1 IFMGR_IF_UP::ce3/1
#
#
show alarm transitions
Use this command to display severity transitions for every alarm in the device.
Command Syntax
show alarm transitions
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#show alarm transitions
Alarms received:-
Alarm Count: 3
Downgraded CRITI MAJOR CMM_MONITOR_CPU:1min_load:CPU
Upgraded MAJOR CRITI CMM_MONITOR_CPU:1min_load:CPU
Downgraded CRITI MAJOR CMM_MONITOR_CPU:1min_load:CPU
#
show fms status
Use this command to display the FMS status.
Command Syntax
show fms status
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#
#show fms status
% FMS Status: Enabled
% FMS Node Application Status: Up
#
show fms supported-alarm-types
Use this command to display the supported alarm types.
Command Syntax
show fms supported-alarm-types
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 6.0.0.
Example
#show fms supported-alarm-types
Alarm-types Count: 38
IFMGR_IF_DOWN
IFMGR_IF_UP
CMM_MONITOR_RAM
CMM_MONITOR_CPU
...
#
show running-config fault-management
Use this command to display FMS status in the running configuration.
Command Syntax
show running-config fault-management
Parameters
None
Command Mode
Exec and Privileged Exec mode
Applicability
This command was introduced in OcNOS version 3.0.
Example
#show running-config fault-management
!
fault-management enable
!
#