Configure a Payload Filter for an Action (SNMP Trap Incidents)

The Payload Filter Editor enables you to create expressions that further refine the filters used to select the incidents that cause the configured action to run. Make sure to design any complex Payload Filters offline as a Boolean expression first. This method can help to minimize errors when entering your expressions using the Payload Filter editor.

To create a Payload Filter expression:

  1. Select the Actions tab.
  2. Do one of the following:

    1. To create a new configuration, click the New icon.
    2. To edit an existing configuration, select a row, click the  Open icon, and continue.
  3. Select the Payload Filter tab.
  4. Define your Payload Filter (see table). Also see Guidelines for Creating a Payload Filter.

    1. Plan out the logic needed for your Filter String.
    2. Use the buttons on the bottom half of the Additional Filters Editor to establish the logic structure.

      For example, to establish the following structure, click AND, then AND, and then OR:

      (( ) AND ( ))

    3. Now place your cursor in a location within the displayed Filter String, and use the top half of the filter editor to define the parameters of the highlighted filter requirement.

      For example, select a set of parentheses and use the Insert button to specify the filter requirement within those parentheses:

  5. Click  Save and Close.
  6. Click  Save and Close to save your changes and return to the previous form.
Payload Filter Editor Settings
Attribute Description
Attribute

The attribute name on which NNMi searches. Filterable attributes include the following:

  • ciaName
  • ciaValue

Note When you use ciaName and ciaValue in a Payload Filter, you must enter the ciaName and ciaValue as a pair. For example: (ciaName =.1.3.6.1.4.1.9.9.13.1.2.1.7 ) AND ( (ciaValue = 4) OR ( ciaValue = 5) ) is not supported.

Operator

Valid operators are described below.

Value

The value for which you want NNMi to search.

Note the following:

  • The values you enter are case sensitive.
  • NNMi displays a variable number of value fields depending on the Operator selected. For example, the between Operator causes two value fields to be displayed.
  • The between, in and not in operators require that each value be entered on a separate line.
Additional Filters Editor Buttons
Button Description
Append Appends the current expression (Attribute, Operator, and Value) to the selected expression already included in the Filter String.
Insert Inserts the current expression (Attribute, Operator, and Value) in front of the cursor location within the Filter String.
Replace Replaces the selected expression with the expression displayed in the Attribute, Operator, and Value fields.
AND

Appends, inserts, or replaces the AND Boolean Operator in the selected cursor location.

Note View the expression displayed under Filter String to see the logic of the expression as it is created.

OR

Appends, Inserts, or replaces the OR Boolean Operator in the current cursor location.

Note View the expression displayed under Filter String to see the logic of the expression as it is created.

NOT

Can be used in any part of the Filter String to specify that NNMi should exclude interfaces with values that pass the expression that immediately follows the NOT.

For example, when evaluating the following expression, NNMi includes interfaces with (interface description) ifDesc containing VLAN, and excludes any Interfaces that have VLAN10 for the (interface name) ifName value:

(ifDesc like VLAN AND NOT (ifName=VLAN10))

Note View the expression displayed under Filter String to see the logic of the expression as it is created .

EXISTS

Used for filters that include Capabilities or Custom Attribute names and values in the Filer String.

Indicates that you want NNMi to consider interfaces that have Capabilities or Custom Attributes when evaluating the Filter String.

Tip When creating complex Filter Strings that include customAttrName and customAttrValue pairs as one component of an "or" statement, to prevent NNMi from excluding Nodes that have zero Custom Attributes, use EXISTS or NOT EXISTS criteria for the customAttrName and customAttrValue pair definitions.

Otherwise Nodes that do not have any Custom Attributes are automatically excluded even if they have values that pass other aspects of your filter.

For example, when evaluating the following Filter String, NNMi includes interfaces with (interface description) ifDesc containing VLAN, as well as any Interfaces Custom Attribute Role value is LAN Connection to Oracle Server:

(ifDesc like VLAN OR EXISTS((customAttrName=Role AND customAttrValue=LAN Connection to Oracle Server)))

Note View the expression displayed under Filter String to see the logic of the expression as it is created.

NOT EXISTS

Used for filters that include Capabilities or Custom Attribute names and values in the Filer String. Indicates that you want NNMi to consider interfaces that do not have any Capabilities or Custom Attributes when evaluating the Filter String, but exclude the interfaces that match the expression that follows the NOT EXISTS.

Tip When creating complex Filter Strings that include customAttrName and customAttrValue pairs as one component of an "or" statement, to prevent NNMi from excluding Nodes that have zero Custom Attributes, use EXISTS or NOT EXISTS criteria for the customAttrName and customAttrValue pair definitions.

Otherwise Nodes that do not have any Custom Attributes are automatically excluded even if they have values that pass other aspects of your filter.

For example, when evaluating the following expression, NNMi includes interfaces with (interface description) ifDesc containing VLAN, and excludes any Interfaces that have the Custom Attribute Role and that Role value is LAN Connection to Oracle Server:

(ifDesc like VLAN OR NOT EXISTS((customAttrName=Role AND customAttrValue=LAN Connection to Oracle Server)))

Note View the expression displayed under Filter String to see the logic of the expression as it is created.

Delete

Deletes the selected expression.

Note If the Boolean Operator is selected, the Additional Filters Editor deletes all expressions associated with the Boolean Operator.