6.10.3 Viewing Default Policy Details

 

By default, WebNMS provides a set of default policies. This section explains the purpose of those policies and the properties to be specified in them for execution.



 

Alert or Escalation Policy

 

Alert Policy, also known as Escalation Policy, is an example of periodic policy. This policy fetches alarms from the database and checks whether any alarm is in the same state (without any change in severity) for a specified period of time (specified by the user). If so, it performs the specified action configured by the administrator in this policy. Alert Policy, being periodic, is automatically scheduled by the Policy Manager.

 

On Execution

 

On executing this policy, an action is instigated (based on the type configured). For example, if an action type Send Email Action is configured, executing this policy results in sending an e-mail to the recipient's address. Similarly, for all the other action types, a particular action is triggered on executing this policy.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

 

 

The following table explains each of the fields (properties) in the Escalation Policy Object Properties dialog box.

 

Property Description

Policy Name

A non-editable field that displays the name of the instance of the policy. It helps to identify the policy while managing the list of policies.

Group Name

Displays the default group name. The default name is Escalation Policy. Edit this field to change the group name.

Status

Specify whether the policy is Enabled or Disabled. The policy can be executed only if the status is Enabled.

Periodicity

Specify the interval (in seconds) between two successive execution of the policy. Default value is 10 seconds.

Severity

It specifies the severity of an alarm. That is, the severity which does not change for a particular alarm until the time specified by the use (the corresponding action to be executed for the alarm is covered in the match criteria).

Category

Specify the category which serves as a match criterion.

Alert Group Name

Specify the name of the alert group (if created through a custom view).

Source

Specify the name of the source whose alerts are to be picked which serves as a match criterion for picking alerts.

Entity

Specify the name of the interface through which the source whose alerts are to be picked, communicates (serves as a match criterion).

Owners's List

Specify the e-mail IDs of only the owners to whom information about the picked alerts is to be informed (e-mailed). Applicable to 'Send E-mail Action'.

Action Time (in secs)

Specify the maximum time limit for an alarm to remain in a particular state. If an alarm remains in the same state for more than the specified period, then an action is triggered.

 

Action Types

 

The actions that can be triggered on executing the Escalation Policy are:

Suppress Action

 

This action suppresses alarms matching a particular criterion, either altogether, or multiple alarms of the same type within a given interval. On the occurrence of an alarm, you can suppress all of them, that match a particular filter.

 

To suppress alarms

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Suppress Action tab.

        2. In the General tab, provide the name in the Notification Name text box.

        3. To suppress all the events and alarms, select the Suppress All checkbox.

          To suppress multiple alarms for a given interval, deselect the checkbox. The Suppress Interval texbox is enabled. Specify the interval in seconds. On specifying the Suppress Interval, the first alarm is allowed and all subsequent alarms are suppressed for the given interval. After the suppress interval has elapsed, the first alarm is allowed again and the subsequent alarms are suppressed and so on.

Send Trap Action

 

This action sends SNMP v1 or v2c traps for the alarms matching the specified criteria.

 

To send traps

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Trap tab.

        2. In the General tab, specify appropriate values.

          • Notification Name: Specify a name for the trap action.

          • Trap Destination: Specify the host to which the trap has to be sent.

          • Destination Port: Specify the destination host port to which the trap has to be sent.

          • Trap Community: Specify the community string to be set for the generated trap.

          • SysUpTime: Specify the sysuptime value to be used in the trap.

        3. In the SNMP tab, specify appropriate values.

          • Enterprise: Specify the enterprise OID of the trap.

          • Generic Type: Specify the generic type number to be used for the trap.

          • Specific Type: Specify the type number to be used for the trap.

        4. You can also set variable bindings to the trap. To add a variable biding, click ListS. pecify the OID Value, SNMP Type, and Set Value. Click Update.

        5. In the Advanced tab, specify appropriate values.

          • Handler Impl For Events: Specify the class name that handles the execution of the particular notifier in separate thread for event processing.

          • Handler Impl For Alerts:Specify the class name that handles the execution of the particular notifier in separate thread for alert processing.

Send E-mail Action

 

This action sends an e-mail on receiving an alarm of a specific kind (specified in the filter match criteria).

 

To send e-mail

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Email tab.

        2. In the Action Details panel, specify appropriate values.

          • Notifications Name: Specify a name for the e-mail action.

          • SMTP Account: Select the SMPT from the drop down list.

        1. Click the Configure button against Click to manage SMTP accounts :

          • Select the Default SMTP Account, and modify the desired fields.

          • Specify New Account details and click Add to create a new account.

          • Account Name: Specify the name of the Account.

          • SMTP Server: Specify the SMTP server name.

          • From Address: Specify the sender's address from which the e-mail is being sent.

          • To Address: Specify the destination address to which the e-mail should be sent. Example: mail@action.com

          • SSL Mode: Select the checkbox to specify secured communication.

          • Authentication Required: Select the checkbox to enable authentication.

          • User Name: Specify the user name using which the mail server will authenticate you to send the e-mail.

          • Password: Specify the password using which the mail server will authenticate you to send the e-mail.

          • Click Add. The new account will be added to the SMTP list.

          • Click OK

          • Subject: Specify the subject of the mail.

          • Message: Specify the message to be sent in the mail.

          • File Attachment: Specify the location of file to be attached in the mail.

          • Click Add.

           

      Send SMS Action

    1.  

    2. This action sends an e-mail on receiving an alarm of a specific kind (specified in the filter match criteria).

    3.  

    4. To send SMS

    5.  

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the SMStab.

        2. In the Action Details panel, specify appropriate values.

          • Notifications Name: Specify a name for the e-mail action.

          • SMS Profile: Select the SMS profile from the drop down list.

        1. Click the Configure button against Click to manage SMS profiles :

          • Select the Default SMS profile, and modify the desired fields.

          • Specify New Profile details and click Add to create a new account.

          • Profile Name: Specify the name of the profile.

          • Recipient: Specify the recepient telephone number.

          • Click Add.

Custom Filter

 

Apart from the actions provided here, you can create your own custom filter and define rules for processing the alarms. To use custom filters, write your own filter class in JAVA. The custom filters that you implement must be compiled and placed in the CLASSPATH of the WebNMS Java Virtual Machine.

 

To use custom filters

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Custom tab.

        2. The available Filter Action is listed in the Filter Action List.

        3. To add a new filter action, in the General tab, specify the appropriate values.

          • Notification Name: Specify a name for the custom filter.

          • Program Name: Specify the custom filter class name. Example: you can specify the fully qualified name com.adventnet.nms.CustomFilter

        4. In the Advanced tab, specify appropriate values

          • Handler Impl For Events: Specify the class name that handles the execution of the particular notifier in separate thread for event processing.

          • Handler Impl For Alerts:Specify the class name that handles the execution of the particular notifier in separate thread for alert processing.

        1. Click Add.

Run Command Action

 

This action triggers a specific command when an alarm is received.

 

To run a command

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Run command tab.

        2. To add a new Run Command filter action, in the General tab, specify the appropriate values.

          • Notification Name: Specify a name for the run command action.

          • System Command: Specify the command string to be executed. The command string should be a machine executable program on the server that does not require a shell, i.e., it cannot be a batch or shell file. To use shell scripts or commands, you must invoke the shell as a part of the command string. The command string should be specified with the full path of the shell, where the server has been started.

          • Append Output with Message: Select this option if you want to append the output from the command to the event message text.

          • Append Error with Message: Select this option if you want to append the errors from the command to the event message text.

            Choosing either of the options Append Output with Message or Append Error with Message results in the command being run synchronously in the main event processing thread. This delays all alarms following the alarm being processed, until the command execution completes or is terminated by the timeout option.

          • Abort After: Specify the timeout for the command. After the time specified in this field, the command execution is stopped. This is important, if you are appending the output or errors, since all alarm processing is held up by the command execution.

            As part of the command string, you can specify alarm and associated trap object attributes as tokens to enable the user to pass event and associated trap information to the command.

        3. Click Add.

Set Severity

 

This action escalates or de-escalates the severity of an alarm.

 

To set severity

        1. In Escalation Policy dialog box, click on the Add Action icon to display the Action Action panel, select the Set severity tab.

        2. To add a new Set Severity filter action, in the General tab, specify the appropriate values.

          • Notification Name: Specify a name for the set severity action.

          • Set Severity: Choose the severity from this drop-down box.

          • Message: A default message is available. Edit this field to specify the required message.

          • Click Add.

Top

 

 

SNMP Device Configuration Backup Policy

 

This backs up SNMP devices and creates backup configuration data for the device. This data can later be used to restore a device, whose configuration has been lost. This is primarily useful for devices configured via SNMP, but can also be used to record data for auditing network activity (for example, what is being configured on network devices and when).

 

The backup is for a MIB sub-tree on the device. For example, interfaces group on a device, or the entire contents of any standard or enterprise MIB (for example, all variables in the bridge MIB). If you need to collect data on multiple MIB sub-trees, use multiple policies on the same set of devices.

 

The data is stored in a dated file in the specified directory (default is <DEVICE_BACKUPS>). The number of files that are created depends on the number of devices and the period between collections.

 

On Execution

 

When you execute this policy, a backup of the configuration data of the SNMP devices starts. This data can later be used to restore a device, whose configuration has been lost.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains each of the fields (properties) in the SNMP Device Configuration Backup Object Properties dialog box.

 

Property Description

groupName

Displays the default group name. This field can later be used to query for the matching policies and to organize the different policies.

Maximum Data (variables)

Specify the maximum amount of data (variables) to be collected from a device. Some devices store a lot of MIB data to avoid collecting too much data when the OID is configured erroneously. The default value of 1000 should meet most needs, but change it if you expect more than 1000 variables to be collected.

MIBs to be Loaded

Specify MIB to be loaded in the server before taking backups. This allows using variable names instead of typing the entire object identifiers when specifying what to back up. Use the path relative to the <Web NMS Home> directory, or the entire URL, e.g. mibs/Printer-MIB, when specifying the printer MIB in the mibs directory.

Backups Directory

Specify the location where the files with backup data should be saved. This directory is created only if configured. The default directory is <DEVICE_BACKUP> created under the <WebNMS Home> directory.

Device Type

Specify the prefix of the device types you need to back up. For example, specifying bay backs up the chosen MIB tree for all devices whose type begins with bay.

MIB Sub-Tree to Backup

This is the object identifier for the sub-tree to collect data. You can use the label of the MIB node if the MIB is loaded, e.g. interfaces for the interfaces group. Otherwise, use the numeric OID, e.g. .1.3.6.1.2.1.2 for the interfaces group.

period ( in seconds )

This specifies how often to back up the data, in seconds. The default value is once a day, which can be changed if required.

name

A non-editable field that displays the name of the policy - SNMPDeviceConfigurationBackupPolicy.

status

This determines if this policy is Enabled or Disabled. The policy can be executed only if the status is Enabled.

 

Top

 

 

 

Status Test Policy

 

Status Test Policy can be used to change the tester class for a particular object at runtime for a specific match criterion.

 

On Execution

 

This policy fetches the managed objects from the database which matches the given criteria and changes the tester class of the managed object with the specified one in the Status Test Policy properties form.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains the fields (properties) in the Status Test Policy Object Properties dialog box.

 

Property Description

Policy Name

A non-editable field that displays the name of the status test policy.

Group Name

Specify the group with which the policy is associated.

Type

Specify the type of the managed object. Examples: Network, snmp-node, Interface, and LinkObject.

Change tester to

Choose the max, ping, snmpping, or usertester to which the tester is to be changed.

Tester Class

Specify the name of the new tester class to be executed.

Status

Specify if the policy is Enabled or Disabled. The policy can be executed only if the status is Enabled.

Community

Specify the community - public or private. This is used to choose the managed object for changing the tester class.

Parent Network

Specify the parentnet of the managed object, whose testerclass has to be changed.

 

Top

 

 

Event Logging Policy

 

Event Logging Policy is used to log the events generated for a particular period of time in a file. It is a periodic policy.

 

On Execution

 

By default, the Event Logging policy's period over which it has to be executed, is set as one day. When this policy is executed, the events that are recorded over a certain period of time are read from the events database and stored in a file. For example, if 1000 events are read during a certain period, the next time, when the policy is executed, the next set of events are read (from the 1001st event).

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains each of the fields (properties) in the Event Logging Policy Object Properties dialog box.

 

Property Description

Policy Name

A non-editable field that displays the name of the policy.

Group Name

Specify the name of the group to which the policy belongs. If default is specified, the policy does not belong to any group. You can execute different policies at the same time by associating them with a common group name.

Status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

Period

Specify the period over which the policy is to be executed. By default, it is set as one day, i.e. 86400 seconds. For the specified period, the policy fetches event's data from the database and stores it in a file.

Event's Directory

Specify the directory in which the file containing the events generated for that particular period is to be stored.

 

Top

 

 

 

Failed Node Deletion Policy

 

Failed Node Deletion Policy allows you to delete the nodes in the database with Major and Critical status that exist for more than 7 days (by default) in the database. Such nodes are deleted, provided the nodes have only one interface. Nodes with multiple interfaces remain in the database.

 

On Execution

 

When you execute this policy, all the nodes with Major and Critical status available in the database for more than seven days are deleted. Such nodes are deleted only if they have only one interface.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains each of the fields (properties) in the Failed Node Deletion Policy Object Properties dialog box.

 

Property Description

Delete After (days)

Specify how long the node can exist in the database (after which it is deleted on executing this policy). The default value is 7 days.

Period

Specify (in seconds) how often to back up the data. The default value is once a day.

groupName

Specify the name of the group to which the policy belongs. If default is specified, the policy does not belong to any group. You can execute different policies at the same time by associating them with a common group name.

Status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

name

A non-editable field that denotes the name of the policy - FailedNodeDeletionPolicy.

 

Top

 

WebNMS Backup Policy

 

WebNMS provides backup facility, for taking backups of the WebNMS system. Apart from this, backups can be started as policies, which can be configured during runtime. The load on the server is reduced by running WebNMS backup as a policy service, than running backup as a separate process.

 

On Execution

 

On execution, this policy enables WebNMS to take its system backups. The running of WebNMS backup as a policy reduces the load on the server.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains the fields (properties) in the WebNMS Backup Policy Object Properties dialog box.

 

Property

Description

Status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

BackUpClassNames

Specify the class name implementing com.adventnet.nms.startnms.BackUpInterface with the package structure. Multiple class names can also be specified.

name

A non-editable field that displays the name of the backup policy.

groupname

Specify the name of the group to which the policy belongs. If default is specified, the policy does not belong to any group. You can execute different policies at the same time by associating them with a common group name.

 

Top

 

Statistics Table Cleanup Policy

 

The Statistics Table Cleanup policy allows the cleanup of statistical data from the database. This is necessary to ensure that the database does not outgrow as data is collected each day. You can decide how many days' data has to be saved using this policy. This policy deletes the data that is older than the specified number of days. The hour of execution of this policy can also be specified.

 

On Execution

 

On executing this policy, the statistical data is cleaned up in the database. This saves your time from cleaning up unwanted data manually.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains the fields (properties) in the Statistics Table Cleanup Policy Object Properties dialog box.

 

Property Description

Delete data after (days)

Specify how long to store the data in the database, before it is deleted. The default value is seven days.

status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

name

A non-editable field that displays the name of the policy - StatsTableCleanupPolicy.

Period

A non-editable field that specifies the interval (default interval - 3600 seconds) at which the policy checks whether it is time for cleanup.

groupName

Specify the name of the group to which the policy belongs. If default is specified, the policy does not belong to any group. You can execute different policies at the same time by associating them with a common group name.

Table Name

Specify the name of the table that stores the statistical data. By default, the name is STATSDATA%, unless you have changed the data collection parameters. If you have specified your own table name in the data collection parameters, that table name should be specified in this field. In fact, any table which stores the time in the time field can be specified. However, this is intended only for the statistics tables.

Cleanup Hour (0-23)

Specify (hour of the day) when to clean up the statistics. It can happen at any point of time during the specified hour which cannot be controlled. The default value is 0, i.e., done between 12 at midnight and 1 a.m.

 

Top

 

 

Report Generation Policy

 

The Report generation policy generates report based on the data collected at runtime. It is a non-periodic policy. You can specify the time of execution of the policy during runtime.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains each of the fields (properties) in the Report Generation Policy Object Properties dialog box.

 

Property Description

Status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

Name

A non-editable field that displays the name of the report generation policy.

ReportGenClassName

Specify the class name implementing com.adventnet.nms.poll.Reporter, with the package structure. Multiple class names can also be specified.

groupName

Specify the name of the group to which the report generation policy belongs.

 

Top

 

 

Alert Log Policy

 

The Alert Log Policy is used to control the number of alarms in the database. You can specify the alarm count, and if the number of alarms exceeds the specified count, the older alarms are deleted from the database. This is done to maintain the specified count in the database.

 

On Execution

 

On executing this policy, you can delete the older alarms from the database which had surpassed the specified alarm count value. Thereby, you can control the alarm count in the database.

 

Properties

 

For information on updating the policy properties, refer to Updating Policies.

 

The following table explains each of the fields (properties) in the Alert Log Policy Object Properties dialog box.

 

Property Description

alertLogsize

Specify the count to control the number of alarms in the database. If the number of alarms goes above the specified value, the older alarms are deleted from the database.

Status

Specify whether the status of the policy is Enabled or Disabled. The policy can be executed only when its status is Enabled.

name

A non-editable field that displays the name of the Alert Log Policy.

groupname

Specify the name of the group with which the Alert Log Policy is associated.

 

Top

 


Copyright © 2013, ZOHO Corp. All Rights Reserved.