Auto Generating the Alarm Configuration File

OcNOS-RON : System Management Guide : System Management Configuration Guide : Fault Management System Configuration : Auto Generating the Alarm Configuration File

The auto_yaml_generator.js file is a NodeJS script that generates the alarm configuration file (alarm_def_config.yaml) for the oper logs which are listed in the oper_logs_list.yaml file with the default values as shown below.

# Integer number identifying alarm

ALARM_ID: 1000

# Event name (oper_log)

EVENT: oper_log string

# Event name for the Generalization Event Group

GENERALIZED_EVENT_NAME: null

# Alarm string which will be generated

ALARM_DESC: oper_log string

# Correlation logic type (0: No-Correlation, 1: Generalization, 2: Time Bound, 3: Counting, 4: Compression, 5: Drop-Event)

CORRELATION_TYPE: 0

# Correlation type, in which generalized event will be sent

GENERALISED_CORRELATION_TYPE: null

# Counter value that will be considered during counting logic to raise alarm

CORRELATION_COUNTER: 3

# Timer duration to be considered for time bound logic

CORRELATION_TIMER_DURATION: 20000

# Alarm Severity(1:Emergency, 2:Alert, 3:Critical, 4:Error, 5:Warning, 6:Notification, 7:Informational, 8:Debugging, 9:Cli)

CORRELATION_SEVERITY: null

# QUALIFIER_STRING_POSITION

QUALIFIER_POSITION_1_EVENT_1: null

# RESOURCE_STRING_POSITION

RESOURCE_POSITION_1_EVENT_1: null

SNMP_TRAP: 0

# OID for SNMP TRAP

SNMP_OID: null

# Netconf Notification (true (1) or false (0))

NETCONF_NOTIFICATION: 1

# Clear Alarm (oper_log enum, Status for Alarm will be made In-active if this event is received)

CLEAR_ALARM: null

# Clear Event's pattern values which will be searched in event's description to identify clear event

CLEAR_EVENT_PATTERN_VALUES: null

# True (1) or False (0, if CLEAR_ALARM is null then SNMP_TRAP_CLEAR will be null)

SNMP_TRAP_CLEAR: 0

# OID for SNMP TRAP CLEAR

SNMP_CLEAR_OID: null

# Clear Netconf Notification information

NETCONF_CLEAR_NOTIFICATION: 0

Alarm Configuration File Generation Steps

1. List all the oper_log enums in the oper_logs_list.yaml file and keep the file in the same path with auto_yaml_generator.js.

2. Copy auto_yaml_generator.js and oper_logs_list.yaml files into /usr/local/bin/js.

3. Run the auto_yaml_generator.js script with the following command.

# node auto_yaml_generator.js

4. After executing the above commands, you will see the alarm-def-config.yaml file in the same directory.

Sample oper_logs_list.yaml File

EVENT_GROUP:

IFMGR_IF_DOWN,

IFMGR_IF_UP,

STP_SET_PORT_STATE,

STP_IPC_COMMUNICATION_FAIL,

STP_ROOTGUARD_PORT_BLOCK,

Last modified date: 08/28/2023