The nas Auto-Operator Tab

The Auto-Operator (AO) feature is meant to aid the administrator in managing the alarm database. You can define various profiles, based on matching rules (such as severity level, alarm message text, subsystem ID) to:
uimpga-ga
The Auto-Operator (AO) feature is meant to aid the administrator in managing the alarm database. You can define various profiles, based on matching rules (such as severity level, alarm message text, subsystem ID) to:
  • Close/acknowledge certain alarms.
  • Automatically assign an alarm to a person/group.
  • Send an e-mail or a GSM/SMS message whenever a specific rule is met.
Contents
The Properties Tab
On the
Auto-Operator
tab, it is possible to configure the auto-operator with profiles containing selection criteria for various fields, such as severity level(s), subsystem Id, message string etc. When an alarm event passes the selection criteria as well as the action time, an action is triggered.
The properties on this
Setup > Auto Operator
tab let you activate the Auto-Operator. When not checked, the Auto-Operator tab will be disabled (greyed out).
2002215.png.jpg
The fields are:
  • Activate Auto-Operator
    Enables/disables the auto-operator feature.
    When this option is selected, the Auto-Operator sections are enabled.
  • Auto-Operator interval
    This is a global interval that can be used by AO profiles and AO scheduler.
  • Ignore imported alarms
    The Auto-operator ignores alarms imported from other nas probes. If this option is not selected, replicated alarms will trigger Auto-operator rules.
  • Assignment roster
    The
    Assignment roster
    list allows you to specify assignment targets, such as a helpdesk. By adding a target to this list, you will be able to assign alarm(s) to the target from within the Auto-Operator.
    You add new assignment targets by right-clicking in the window and selecting
    New
    . A new target will by default be named
    New operator
    . Select the new target, right-click and select
    Rename
    and type a name of your own choice.
    The right-click menu also allows you to delete assignment targets.
The Profiles Tab
This tab lists all Auto-operator defined profiles.
Note the different icons for the defined profiles in the list:
  • Not activated
    1942467.png
  • Activated
    1942468.png
  • Not manually activated, but activated by a calendar profile defined on the Calendar tab
    1942469.png
  • Manually activated, but deactivated by a calendar profile defined on the Calendar tab
    1942470.png
    1942471.png
You can perform the following actions from the right-click menu:
New
Allows you to create a new profile.
Edit
Allows you to edit the selected profile properties.
Copy
Copies the selected profile and allows you to rename the new profile.
Delete
Deletes the selected profile. A confirmation screen appears.
Rename
Allows you to rename the selected profile.
Activate
Activates the selected profile.
Deactivate
Deactivates the selected profile.
Move Up
Moves the selected profile one place up in the list.
Move Down
Moves the selected profile one place down in the list.
Set Order
The profiles will be executed in the order they were created (see the order column in the list). If modifying the list, using the move up and move down options mentioned above, you may select this to be the new executing order by selecting the Set Order option.
Edit Script
This option is activated only if a script is selected to be run on match in the profile, otherwise the option is not enabled.
The script defined in the profile will be opened in the script editor.
Export as Trigger
The properties defined in the Matching Criteria section of the profile will be exported as a Trigger.
The Matching Criteria section of the profile properties dialog opens. Edit the properties if needed and click
OK
.
Enter the new trigger name, then click
OK
.
The trigger will appear in the list under the Triggers tab.
View Activity
Opens the activity log, where you can view the activity for the profile for a specific time frame. Valid options are:
  • Today
  • Last hour
  • Last week
  • Last month
  • Last 24 hours
  • Last 7 days
  • Last 3 days
  • Last 50 days
  • Select a date
This option allows you to specify a start day and an end day for the period.
1942494.png
1942495.png  Clicking the
Preferences
button  opens the
Activity Log Preferences
dialog, enabling you to select additional items to be logged in the Activity log. Click
Enable Activity Log
option to enable the options on the dialog.
1942496.png
Creating or Editing a Profile
The Profile dialog allows you to create or edit the profile properties.
  2002266.png.jpg
The fields are:
Action type
Specify what the auto-operator does when receiving an alarm meeting the matching criteria specified for this profile.
The options in the section below the action type field change depending on the action type selected from the drop down menu.
The options are:
assign
Assigns alarms matching the filters below to an operator selected from the pull-down menu.
Select the username you want to assign the alarm to in the section below the action type field.
These alarms will also be sent to recipients defined in profiles in the emailgtw probe.
attach_note
Attaches a note to the alarm. Select the note in the section below the action type field. Available notes are defined under the Notes tab.
close
Closes / acknowledges alarms matching the filter(s) defined in the matching criteria section of the screen. This is useful for removing old alarms etc.
command
Executes the specified command locally. This may be a command beeping on a pager, or something that actually tries to fix the problem the alarm reports about.
Enter the command in the section below the action type field.
EMAIL
Sends the alarm as an e-mail to the emailgtw when the defined alarms matching criteria are met.
Note that you are allowed to use a comma-separated list of e-mail addresses.
      • If an e-mail address is specified in the recipient field
        :
        The alarm is sent as an e-mail to the specified e-mail address.
      • If a profile (defined in the emailgtw) is specified in the recipient field
        :
        The nas checks the profile in the emailgtw to find the e-mail address defined for the profile, and the alarm is sent as an e-mail to that address.
      • If the recipient field is empty
        :
        The alarms matching the criteria will be collected in a report.
This report will be sent as an e-mail to profiles defined as
Report recipients
in the emailgtw at regular intervals (approximately 5 minutes).
Enter the recipient, subject and message body in the section below the action type field.
The
Subject
and the
Message Body
parameters are enabled only for the
On Trigger
action mode. For the other action modes, the subject and message body is taken by nas from the values defined in the emailgtw probe.
escalate_level
Escalates the severity level of the alarm(s) matching the filter criteria selected below. The severity level is incremented to the next level.
Note that the options on the
Advanced tab
are grayed out and can not be selected if this action type is selected.
new_alarm
Composes and sends a new alarm message onto the UIM bus. The message field accepts expansion.
The alarm may contain the following optional elements in addition to a message body and severity level:
      • Subsystem ID.
      • Source.
      • Suppression ID.
post_message
Alarms will be posted as a message with the specified subject and message text.
Enter the subject and message text in the section below the action type field.
If you enter the subject as EMAIL, the alarms with the message body specified will also be sent to recipients defined in the profiles in the
emailgtw
probe.
repost
Retransmits the alarm message under another subject ID. This may be useful if you want to send special alarm messages to your 'own' correlation engine.
Select the subject ID in the section below the action type field.
If you enter the subject EMAIL, these alarms will also be sent to recipients defined in the profiles in the
emailgtw
probe.
script
Executes the script specified.
Select the script to execute and any parameters in the section under the action type field.
Use the Script editor to create and edit these scripts.
set_visibility
Select the visibility for the alarm message.
This mode is a filter type for incoming alarms under the pre-processing tab. Alarm messages set to invisible will be managed by the nas and will be listed under the Status tab, provided that the option
Show Invisible Alarms
(on the Status tab) is selected. However, they will not be visible in the Alarm sub console in Infrastructure Manager and Enterprise Console, unless the ACL the UIM user is associated with allows the user to see the invisible alarms.
Select the visibility option in the section below the action type field:
      • Make event invisible
      • Make event visible (if invisible).
SMS
Composes and sends a message destined for the SMS gateway. The message field accepts field expansion.
Enter the phone number and message in the section below the action type field.
webhook
A webhook is a simple notification message using an HTTP POST to an external application. In CA UIM, a webhook is triggered based on the occurrence of an alarm.
Specify the following required fields for webhooks:
Action type
- webhook (Specifies that the auto-operator sends a message to the configured webhooks).
Path to Messagegtw Probe
- Specifies the path of the hub or robot where the messagegtw probe is deployed and configured. The nas auto-operator profile will publish to the instance of the messagegtw probe that you specify here.
Webhook Name
- Select the webhook from the drop-down. The webhook is populated based on the webhooks that are configured in the selected instance of the messagegtw probe.
Subject
- Specifies the message queue name. This field is auto populated based on the webhook you select.
Additional Properties
- Specifes any additional property or metadata that you want to send to the messagegtw. You need to add a new config key with key-value pairs.
For example, if you want to delay the message being sent to Slack. Create a new config key with the following key value pair. (key= delay; value = 5 seconds).
Then, create a new config key in the messagegtw probe > Endpoint Details > payload mapping section with the same key as above (delay = $delay). The messagetgtw probe will pick the value from the alarm for this key from the value specified in the Additional Properties field.
Now, if you have configured for an action to be triggered in Slack, on receiving the payload from messagegtw, and have specified a delay. The payload will have the delay value. 
Action category
Select the action category to be used. The action category is a way to group profiles to ease the administration of multiple profiles. You can create new categories by placing the cursor in the field and typing a new category.
Action mode
On messages arrival
Performs the selected action immediately when the alarms arrive.
Note that this time setting is disabled for some of the actions (close, command, new_alarm and escalate_level), as it is not advisable to perform these actions if the same alarm message (with the same source, sub-system and severity) arrives hundreds of times (
Message suppression
).
On overdue age
Performs the selected action when the age of the alarm exceeds the specified threshold. Select one of the predefined values in the list or type another value of your own choice (use the same format as used in the list).
On every AO interval
Performs the selected action on every Auto Operator check interval.
On every interval
Performs the selected action on every interval specified. Select one of the predefined values in the list or type another value of your own choice (use the same format as used in the list).
If you set
On every interval
, the action type defined in the profile will occur at the set interval as long as the matching criteria is true. For example, if you create a profile that sends an email when an alarm is at critical severity and set
On every interval
to 1 minute, an email will be sent every minute until the alarm severity changes.
On trigger
Select this option when the
Trigger
mode is selected in the action category.
The lower portion of this screen displays the options for setting triggers.
You can select one or more triggers. The Auto operator performs the selected action immediately when the trigger specified is true.
Example
:
Provided that the profile is not de-activated due to
operating period
and/or
scheduler
settings:
You select
Action type
= script and
Action mode
= trigger. You select a
script
to be executed and a
trigger
to trigger the action.
Imagine that the properties dialog for the selected trigger is set to trigger on
Message string
*Oslo*, the selected script will be run as soon as an alarm message containing the word "Oslo" in the message text appears.
Note that this choice will restrict the number of
Action types
available.
Matching Criteria 
This tab will appear only if an Action mode other than Trigger is selected.
Note that
Matching criteria
fields marked with a ‘*‘ can be inverted (set to
NOT Expression)
by clicking the small button above each of the fields. The buttons becomes activated as soon as the field contains information.
Pressing
F1
in the Matching Criteria fields (except for the Message field), will list all parameters available. Pressing
F2
in the Matching Criteria fields gives you the option to specify a target string, a pattern/regular expression and test that it works before selecting it.
Severity level
Select the severity level(s) for the alarms you want to be treated by this profile.
Message Visibility
Select the matching criteria to be valid for:
    • Ignore (both visible and invisible alarm messages)
    • Visible
    • Invisible
* Hostname
Specify the hostname (string matching) sending alarms to be treated by this profile.
* Source
Specify the source (string matching) for alarms to be treated by this profile.
* NMS Domain
Specify the name of the Domain (string matching) the host sending alarms to be treated by this profile belongs to.
* Subsystem ID
Specify the subsystem ID (string matching) for alarms to be treated by this profile.
* Subsystem String
Specify the subsystem (string matching) for alarms to be treated by this profile.
* NMS Hub Name
Specify the name of the Hub (string matching) the host sending alarms to be treated by this profile belongs to.
User Tag 1
User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
User Tag 2
User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
* NMS Robot Name
Specify the name of the Robot (string matching) sending alarms to be treated by this profile belongs to.
Message assigned to
Select this option to send a message to a specific user.
Specify the user name to which alarms are assigned to be treated by this profile.
Message counter
Specify a Message Counter operand (
Less than
,
Equals to
, or
Greater than or equal
) and the trigger message count.
* NMS Probe Name
Specify the probe (string matching) sending alarms to be treated by this profile.
Message string
Specify a text string found in alarms (string matching) for alarms to be treated by this profile.
* NMS Origin
Specify the origin (string matching) sending alarms to be treated by this profile.
Using F1 and F2 in Matching Criteria Fields
Pressing
F1
in the Matching Criteria fields (except for the Message field) displays the Select Source screen. This screen displays a list of parameters retrieved from the transaction summary table. This table contains entries for alarms (such as hostname, source origin) processed recently.
Select an entry in the list or type another source.
1942499.png
Pressing
F2
in a Matching Criteria field displays the Pattern and Regular Expression Validator screen.
Type the string you want to use as the target string and the pattern/regular expression you want to use. Click the
Test
button and verify that the output is "Expression matches the target string". Clicking the
OK
button, the pattern/regular expression will be inserted into the field.
1942500.png
If creating an AO profile, using
Message
assigned to
as matching criteria, the profile will trigger when an alarm has been assigned to a user or a group by another AO profile. Note that profiles using the
Message assigned to
should NOT use Action mode
On arrival
to ensure that the processing acts as expected.
All filters take pattern matching and regular expressions. You may also combine patterns/strings using a comma, for example:
host1 , host2 matches host1 or host2 as two separate patterns
host1 , host2 matches host1 or host2, but as a single pattern
If you specify multiple mask criteria, all of them must be fulfilled for the action to be performed.
Field expansion
is made available to some of the action fields. This feature is triggered by typing a dollar sign ($) and then wait for 1 sec.  A list of available field codes is listed, and may be used to create your own mixture.
String matching
is accomplished with a mixture of pattern matching rules and/or regular expressions.
Profile Advanced
The options on this tab are available only if an Action mode other than
on trigger
is selected and apply only when
Severity level Clear
is selected as a matching criteria.
The options on this tab are grayed out and cannot be selected if Action type
escalate_level
is selected for the profile.
Ignore User Acknowledgment (Delete)
Alarms acknowledged by a user will be ignored and not trigger any action from the profile.
Expect the previous severity level to be part of the severity filter
When an alarm with severity level Clear occurs, the previous severity level of the alarm must also be a part of the matching criteria to trigger an action from the profile.
Example
:
An alarm with severity level Clear occurs. Severity level
Critical
and
Clear
is selected as matching criteria, and the previous severity level of the alarm was
Warning
(which is not selected as matching criteria). No action will be triggered.
Same example as above, but the previous severity level of the alarm was
Critical
(which is selected as matching criteria).
The selected action will be triggered by the profile.
Execute action on user acknowledgment of open 'clear' messages
When checked, the profile is executed when a user performs alarm acknowledgment of open ’clear’ messages.
Skip further profile checks on match
This option is available in case of multiple profiles. Normally all the auto-operator profiles will be checked during the filter validation. Selecting this checkbox will stop the further checks.
It is also a good idea to use "ordering" to ensure that the proper order is maintained for checking the AO profiles.
Profile Operating Period
Defines the time-slots when the profile is active within a week. The Operating Period settings are closely related to the Scheduling settings.
Profile Scheduling
The scheduling profiles available (these are defined and listed under the Auto-Operator > Scheduler tab) can be used to administer the running properties for the Auto-Operator profiles. The scheduler profiles can activate or deactivate Auto-operator profiles for defined time periods.
All scheduling profiles defined will be listed here. Activate the one(s) you want to administer the running properties for the selected Auto-operator profile.
Setting Triggers
This tab will appear only if Action mode
on trigger
is selected.
The Matching criteria tab disappears when Action Mode
on trigger
is selected and is replaced by the Trigger tab. You can select one or more of the triggers defined to act as a matching criteria for the profile.
2006516.png.jpg
If using more than one trigger, you can use Boolean AND or OR, or you can build your own Boolean expression.
Activate when state changes:
The profile will be executed when the trigger changes its state (false/true).
Please note that the term
state
in the option "Activate when state changes" refers to the state of the
Auto Operator Profile
and not to the selected triggers within the Auto Operator Profile.
Activate on change in trigger alarmlist:
The profile will be executed when the alarmlist (the alarm(s) that sets the trigger to true) changes, for instance when an alarm changes from severity
major
to
critical
.
1942498.png  Select the triggers you want to use from the list of available triggers and add them, using the
Add
button.
The Triggers Tab
This tab allows you to define triggers to "sort" alarm messages based on properties set for the trigger. That means that alarms matching the criteria defined for the trigger will not be handled by an Auto-operator.
You can define triggers, using matching criteria (such as message text, severity, hostname etc.) and time restrictions (defining the periods when the filter should be active).
1942502.png
Note the following icons
1942503.png  Alarm events have occurred.
1942504.png  Alarm events have NOT occurred.
Right-clicking in the list gives you the following options:
  • New
    Opens the Trigger properties dialog, allowing you to create a new trigger.
  • Edit
    Opens the Trigger properties dialog for the selected trigger, allowing you to edit the trigger properties.
  • Delete
    Deletes the selected trigger.
    You are asked to confirm the deletion.
  • Rename
    Allows you to give the selected trigger another name. The current trigger name is highlighted; just type the new name.
  • Copy
    Makes a copy of the selected trigger. Rename the new trigger, using a descriptive name. If you want to modify the properties, you just double-click it and make your modifications.
  • Activate
    Activates the selected trigger.
  • Deactivate
    Deactivates the selected trigger.
  • Refresh State
    Refreshes the list to display the most current contents.
  • View events
    The column Events in the list of triggers shows how many events have occurred for the trigger. When you select this option, the events will be listed in the lower window.
  • View Activity
    Opens the activity log for the selected trigger.
    You can select a period, such as last hour, last week, last month etc., or you can specify a time range (start day and end day).
    The activity log shows information like: when the trigger was run, the time used, the status etc.
    1942507.png  Clicking the
    Refresh
    button refreshes the list to reflect the most updated contents.
    1942495.png Clicking the
    Preferences
    button opens the
    Activity Log Preferences
    dialog, enabling you to select additional items to be logged in the Activity log. Click the
    Enable Activity Log
    option (by default not selected) to enable the options on the dialog. Otherwise the options are deactivated (greyed out).
    1942496.png
Adding new triggers
If you right-click in the triggers list and select
New
in the menu, a dialog box appears where you can define a new trigger by filling out some of these fields.
2044725.png.jpg
You can use F1 and F2 in the matching criteria fields.
If more than one of the filtering criteria is specified, all of them must apply for the alarm to be treated by the trigger (logical AND).
The fields are:
  • Severity Level
    Select the severity level(s) for the alarms you want to be treated by this trigger. Only alarms with the specified severity level are collected by this trigger.
  • Category
    Select the category to be used. Category is a way to group triggers to ease the administration in case of many triggers. You may create new categories by placing the cursor in the field and typing a new category.
  • Hostname
    Specify the name of the host (string matching) sending alarms to be treated by this trigger.
  • Source
    Specify the source (string matching) for alarms to be treated by this trigger.
  • Subsystem ID
    Specify the subsystem ID (string matching) for alarms to be treated by this trigger.
  • Subsystem string
    Specify the subsystem string (string matching) for alarms to be treated by this trigger.
  • User Tag 1
    User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
  • User Tag 2
    User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
  • Message assigned to
    Select this option and select the Nimsoft user the alarm is assigned to.
  • Message string
    Specify a text string (string matching) found in alarms to be treated by this trigger.
  • Message Counter
    Specify the message counter as a value either less than, equal to or greater than the value specified.
  • Domain
    Specify the name of the Domain (string matching) the host sending alarms to be treated by this trigger belongs to.
  • Hub name
    Specify the name of the Hub (string matching) the host sending alarms to be treated by this trigger belongs to.
  • Robot name
    Specify the robot (string matching) sending alarms to be treated by this trigger.
  • Probe name
    Specify the probe (string matching) sending alarms to be treated by this trigger.
  • Origin
    Specify the origin (string matching) sending alarms to be treated by this trigger.
    QoS data from probes are tagged with a name to identify the origin of the data.
    If specifying an origin name in the controller probe, this name will be used to identify the origin of the data.
    If not, the Hub name will be used.
    Note however, that the
    Origin
    field under
    Advanced Settings
    in the Hub GUI lets you specify an origin name of your own choice to be used, rather than the Hub name.
The Scripts Tab
Scripts can be used by the Auto Operator when processing alarm messages matching the criteria defined for the Auto Operator profile.
If this tab is not enabled you must go to the distsrv probe configuration on the primary hub, select the 'Forwarding' tab, and set up a new record. The hub where you are trying to set up auto-operator must be selected as the Server field, and the Type set to Licenses. Once this has been applied and saved on the primary hub distsrv, the user must wait approximately five minutes, then restart the nas on the remote hub. The scripts tab should now be available.
Use scripts when processing alarm messages matching the criteria defined for the Auto Operator profile. Scripts can also be run by the Scheduler and by the pre-processing filters.
Use the Script Editor to create and edit these scripts, using the Lua scripting language. The scripts can also be grouped in folders, created by right-clicking in the list, selecting
New > Folder
.
1942511.png
Right-clicking in the list displays the following options:
  • New
    Opens the Script properties dialog, allowing you to create a new script, or a new folder where you can group scripts.
  • Edit
    Opens the properties dialog for the selected script, allowing you to edit the script properties.
  • Delete
    Deletes the selected script.
    You are asked to confirm the deletion.
  • Rename
    Allows you to give the selected script another name. The current script name is highlighted; just type the new name.
  • Run
    Executes the selected script. The execute result will appear on the screen. Click the
    OK
    button to exit the pop-up.
  • Run as Profile
    Allows you run the selected script as a profile. A dialog pops up, letting you select the profile which you want the script to run as.
  • Refresh
    Refreshes the list to reflect the most current content.
  • Cut
    Allows you move the selected script to another location (for example from the root level to a group, from a group to the root level, or from one group to another group).
    The script will be copied to the clipboard. Use the
    Paste
    command to paste the script to the new location.
  • Copy
    Makes a copy of the selected script. The selected script will still be present. The script will be copied to the clipboard. Use the
    Paste
    command to paste a copy of the script in the list. The name of the copy will be "Copy of <script name>.
  • Paste
    Allows you to paste the contents of the clipboard to the current location.
  • View activity
    Opens the activity log for the selected script.
    You can select a period, such as last hour, last week, last month etc., or you can specify a time range (start day and end day).
    The activity log shows information like: When the script was run, the time used, the status etc. Clicking the
    Preferences
    button opens the
    Activity Log Preferences
    dialog, enabling you to select additional items to be logged in the Activity log. Select the
    Enable Activity Log
    option (by default not selected) to enable the options on the dialog. Otherwise the options are deactivated (grayed out).
that you can move a script file by dragging the file onto a folder, or copy from a remote nas by dragging the script from one UI to the other.
The Pre-Processing Rules Tab
A pre-processing rule consists of a filter and a set of rules determining how the nas will handle alarm messages matching the filter (exclude, set invisible, custom etc).
This is useful if you want to filter out specific alarm messages to be treated a specific way, or want specific alarm messages to be excluded and not managed by the nas.
1942517.png
Icons used in the pre-processing rules list:
  • 1942518.png  Means that the pre-processing rule is not activated. To activate it, right-click the rule and select
    Activate
    , or simply click the check box.
  • 1942519.png  Means that the pre-processing rule is activated. To deactivate it, right-click the rule and select
    Deactivate
    , or simply de-select the check box.
  • 1942520.png  Means that alarm messages matching the filter set for this pre-processing profile will be excluded and not managed by the nas.
  • 1942521.png  Means that alarm messages matching the filter set for this pre-processing profile will be set to invisible. They will still be listed under the Status tab, provided that the option
    Show Invisible Alarms
    is selected. However, they will not be visible in the Alarm sub console in Infrastructure Manager and Enterprise Console, unless the ACL the user is associated with allows the user to see the invisible alarms there.
Right-clicking in the list gives you a set of options: Create a new rule, edit, copy, delete or rename a rule. In addition you can activate/deactivate a rule.
The properties dialog for a rule is as shown below:
sliding_window.PNG
: Filtering criteria fields can be inverted (set to
NOT Expression)
by clicking the small button above each of the fields. The buttons gets activated as soon as something is written in the fields.
The fields are:
  • Filter type
    This option describes how the nas will handle alarm messages matching the rules set in this dialog.
    Valid options are
    Exclude,
    Invisible
    and
    Custom
    .
    • Exclude
      Exclude alarm messages will not be managed by the nas and are deleted.
    • Invisible
      Alarm messages set
      invisible
      will be managed by the nas and will be listed under the Status tab, provided that the option
      Show Invisible Alarms
      (on the Status tab) is selected. However, they will not be visible in the Alarm sub console in the Infrastructure Manager and Enterprise Console, unless the ACL the UIM user is associated with allows the user to see the invisible alarms there.
    • Custom
      Enables the Custom script field at the bottom of the dialog (otherwise it is not available).
    • Transaction
      Alarms matching the criteria for this filter are not added to the transaction logs. This is useful if the transaction logs are filled up with messages such as heartbeat.
  • Category
    Select the category to be used. Category is a way to group triggers to ease the administration in case of many rules. You may create new categories by placing the cursor in the field and typing a new category.
  • Severity Level
    Select the severity level(s) for the alarms you want to be treated by this filter. Only alarms with the specified severity level are treated.
  • Hostname
    Specify the hostname (string matching) sending alarms to be treated by this filter.
  • Source
    Specify the source (string matching) for alarms to be treated by this filter.
  • NMS Domain
    Specify the name of the Domain (string matching) the host sending alarms to be treated by this filter belongs to.
  • Subsystem ID
    Specify the subsystem ID (string matching) for alarms to be treated by this filter.
  • Suppression key
    A unique ID with which the probe tags the alarms. This is done to avoid that the Alarm Console receives too many instances of the same alarm. A counter indicates the number of times the alarm is sent from the probe.
  • NMS Hub name
    Specify the name of the Hub (string matching) the host sending alarms to be treated by this filter belongs to.
  • User Tag 1
    User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
  • User Tag 2
    User-defined tag in the Controller probe. To be used as a grouping / locating mechanism.
  • NMS Robot name
    Specify the robot (string matching) sending alarms to be treated by this filter.
  • Time of origin older than
    Only alarms with origin older than the number of days specified here will be treated select one of the pre-defined values or type another value on the format
    n days
    .
    Time of origin tells when the alarm was sent from the Probe.
  • Sliding Window
    (for 9.10)
    Select or enter an appropriate value for the sliding window time. The value in the sliding windows helps as follows:
    When an alarm comes, nas checks whether this alarm is in the exclude filter. If the alarm satisfies the exclude rule, the following processing happens:
    • nas gets the value of the sliding window from the filter. 
    • nas gets the last received time for the alarm from the embedded database.
    • nas adds these two values and verifies whether the added value is higher than the current time. If it is higher, it ignores that alarm; otherwise, it sends the alarm.
    The following are the scenarios for the sliding window and severity:
    • If you do not select any severity level, the exclude rule allows only one alarm per sliding window to pass.
    • If you select all severity levels, the exclude rule allows only one alarm per sliding window to pass.
    • If you select some severity levels, this filter works when the selected severity level is reached. 
      For example, consider a scenario where you select the critical severity with the sliding window value as 2 minutes. Now, if five major alarms come, the count goes up to 5. Then, if a critical alarm comes within 2 minutes of the last major alarm, the critical alarm is ignored. Furthermore, if another major alarms comes again, the count goes up to 6.
  • NMS Probe name
    Specify the probe (string matching) sending alarms to be treated by this filter.
  • Message string
    Specify a text string (string matching) found in alarms to be treated by this filter.
  • NMS Origin
    Specify the origin (string matching) sending alarms to be treated by this trigger.
    QoS data from probes are tagged with a name to identify the origin of the data.
    If specifying an origin name in the controller probe, this name will be used to identify the origin of the data.
    If not, the Hub name will be used.
    Note however, that the
    Origin
    field under
    Advanced Settings
    in the Hub GUI lets you specify an origin name of your own choice to be used, rather than the Hub name.
  • Custom Script
    This field is only enabled if the Filter type is set to custom.
    Select a Lua script to pre-process the alarm messages. The menu lists all scripts available. You may create/edit these scripts yourself, using the Lua programming language (see the tab). Note that only a subset of the Lua methods are available to the pre-processing script. The following classes and methods are not available: exit, sleep, nimbus, pds, trigger, action, database, alarm and note. The trigger.state method through the state method is however available.
  • Operating Period tab
    Specifies the periods when the filter should be valid.
The Scheduler Tab
This tab enables you to define
scheduler
profiles. These are used to administer the running properties for the Auto-operator profiles and the Pre-processing Rules. The scheduler profiles can activate or deactivate Auto-operator profiles and/or pre-processing rules for defined time periods.
The scheduler can also execute scripts, independent of Auto-operator profiles.
The Scheduler works in co-operation with the
operating periods
specified for the Auto-operator profiles and the Pre-processing Rules. When a scheduler is selected to
activate
a profile, it is possible to select the scheduler to override the operating period defined for the profile.
Right-clicking in the list gives you the following options:
  • New
    Opens the Schedule properties dialog, allowing you to create a new schedule.
  • Copy
    Copies the selected schedule with a new name and displays it in the list. The new profile will be named "New Calendar", but have the same properties as the schedule you copied. Use the Rename option to give the schedule a descriptive name.
  • Edit
    Opens the properties dialog for the selected schedule, allowing you to edit the schedule properties.
  • Delete
    Deletes the selected schedule.
    You are asked to confirm the deletion.
  • Rename
    Allows you to rename the selected schedule. The current schedule name is highlighted; just type the new name.
  • Activate
    Activates the selected schedule.
  • Deactivate
    Deactivates the selected schedule.
  • View activity
    Opens the activity log for the selected schedule.
    You can select a period, such as last hour, last week, last month etc., or you can specify a time range (start day and end day).
    The activity log shows information like: When the schedule was active, the time used, the activity (activating, deactivating or running scripts).
    1942506.png
    1942495.png  Clicking the
    Preferences
    button opens the
    Activity Log Preferences
    dialog, enabling you to select additional items to be logged in the Activity log. Select the
    Enable Activity Log
    option (by default not selected) to enable the options on the dialog. Otherwise the options are deactivated (grayed out).
    1942508.png
Creating or Editing a Schedule
The Schedule dialog allows you to enter scheduling information for profiles. This screen contains three sections. The top section allows you to select the mode and operation. Depending on the options selected, the lower two sections (Mode: and Operation:) change to reflect the Mode or Operation selected at the top of the screen. This example displays the Mode: By Time and Operation: Deactivate Profile options.
1942529.png
The fields are:
  • Mode
    Three different modes can be used to specify the time settings for the scheduler. The scheduler will activate or deactivate Auto-Operator profiles and Pre-processing rules treated by this schedule or run the script specified, depending on operation selected.
    • By Time
      Use the drop-down menus to specify a
      start date
      and
      start
      time
      , and also
      end time
      and an
      end date
      .You can also use the calendar to set the start date and end date. Click on a date to set the start date, and then use <shift> + click to mark the end date.
    • By Recurring Event
      Select the date range for the recurring event and the pattern of the recurrence. Use the mode By Recurrent Event, you first specify the time period the selected operation should be performed, with a start day and time, and optionally an end day and time.
      2006600.png.jpg
      You must also specify a pattern, defining how often the selected operation should be performed within the time period specified.
      Click the
      Forecast
      button to list the future occurrences of the selected operation.
      If the operation selected is Activate or Deactivate and the mode is Recurrent you can select how long the Auto-Operator profiles and Pre-processing rules treated by this schedule should be activated / deactivated by entering a value in the
      Duration
      field.
    • By Calendar
      Specify a point in time when the Auto-Operator profiles and Pre-processing rules treated by this schedule should be activated, deactivated, or the specified script executed.
  • Operation
    Three different operations are available for the schedule:
    • Activate Profile
      Activates the Auto-Operator profiles and Pre-processing rules treated by this schedule at the time specifications set. Use the time settings to define how long the Auto-Operator profiles and Pre-processing rules treated by this schedule should be active.
      You can also chose to ignore the operating period for activating a profile. Select the
      Ignore Operating Period
      option in the lower portion of the screen. The Operating Period specified for the Auto-Operator profiles and Pre-processing rules treated by this schedule will be ignored.
    • Deactivate Profile
      Deactivates the Auto-Operator profiles and Pre-processing rules treated by this schedule at the time specifications set. Use the time settings to define how long the Auto-Operator profiles and Pre-processing rules treated by this schedule should be deactivated.
    • Execute Script
      Executes the script specified in the time period indicated.
      If the time specification mode
      By Time
      is chosen, you may select how often to execute the script. These options are:
      • Run once
      • Run on interval every
      • Run on Auto Operator interval.
      This option does not apply and is deactivated for the
      By Recurring Event
      and
      By Calendar
      modes.
Pattern Matching in Auto-Operator
In nas versions 3.x or later, changes were implemented to our pattern-matching to regular-expression conversion library to avoid improper matching.
This impacts the nas where a ‘loose’ pattern has been used.
Consider the string ‘
robot1
’ as the robot field in the matching criteria in a preprocessing filter, Auto-Operator profile or a trigger definition.
*robot1
resulted in match on myrobot1 and myrobot100. This was recognized as a bug after the release of nas 2.75 and was in all prior releases.
All fields will be treated as possible patterns
unless
starting and ending with a ‘/’.
If no special characters like *.?()[] appear as the first character in the target-string, the expression will be prefixed with a ^ (signifying the start of string). And likewise for the last character, if the target-string ends with a *, then a $ (dollar: signifying rest of string) is added.
All fields starting and ending with a ‘/’ (slash) will be passed on and treated as a true regular expression.
Also note that ‘\’ means escape in the pattern-matching/regexp world. If for example using the text string
Average (4 samples) disk free on C:
\
is now 93%, which is below the error threshold (95%
) as matching criteria, you should substitute the ‘\’ with e.g. a ‘*’ in the text string.
Hence, ‘robot1’ is internally converted and compiled to the regular expression ‘^robot1$’. This will only match ‘robot1’. 
The user must actively append an ‘*’ (asterix), to make the expression match a string containing robot1 as a substring.
The field may also be comma-separated (
NOTE: Except for the message field!
) with a mixture of regexp and patterns e.g. robot1, robot2*, /.robot./.
So, the above match criteria will match:
robot1
the first criteria
robot2
the second criteria
robot222
the second criteria
myrobottest
the third criteria
Also note:
abc,def
will be interpreted as two patterns
abc def
will be interpreted as two patterns
abc|def
will be interpreted as one pattern
To match a string (for example, an alarm message), use the following syntax:
/message.to.match /
Note that the message string is enclosed in a set of slashes, and that periods take the place of white space. The following example matches any alarm message that contains the string 'failed to connect to hub':
/failed.to.connect.to.hub/
Setting an Operating Period
Valid operating periods may be set for
Profiles
and
Pre-processing rules.
The operating periods define when the profiles or pre-processing rules are active. The screen below shows the operating period dialog for a rule, however the functionality is the same when setting an operating period for a profile.
Click the boxes to set the time range for each day. One box represents one hour. In the screen below, the time range for Monday is set from 02.00 until 06.00.
1942541.png
To select multiple boxes, select the first time box and then hold the shift key and select the last time box.
To select more than an hour, double-click inside a box to open a small dialog that allows you to specify the start and/or end-time within the selected hour in the format hh:mm.
1942542.png
Click the
OK
button to activate the operating period.
Right-click in the operating period dialog to select one of the following options:
  • Clear the selected day.
  • Clear the whole operating period definition.
  • Select one of the predefined operating periods.
  • Save As to save your operating period definition.
    Specify a name for the operating period, or you can overwrite one of the existing operating periods by selecting them from the list.
    1942543.png
The Computer State Monitor Tab
The
Computer State Monitor
tab is enabled only when the NiS Bridge is activated from the
Setup >
NiS Bridge
tab.
For more information about the Computer State Monitor Tab, see the topic The nas Setup Tab.