Administer > Configure Incidents > Configure Trap Logging > Valid Parameters for Trap Logging Messages

Valid Parameters for Trap Logging Messages

When configuring Trap Logging messages, consider using SNMP Trap Incident information as part of the message. NNMi provides the following parameter values. Use these parameters as variables when formatting an incident message.

Tip See the Using the Incident Form for more information about the parameter values.

Note NNMi stores varbind values as custom incident attributes (CIAs).

See Configure Trap Logging for more information about configuring messages.

Parameter strings are available for the following:

Note See the following tables to view the valid parameters for Trap Logging messages: Parameter Strings for all Incidents (Attributes from an Incident form), Parameter Strings for Node Source Objects (Attributes from a Node form), and Parameter Strings for all Incidents (Attributes not Visible from any form).

  • Parameter strings for all incidents (Incident form attributes) (ClosedClick here for a list of choices.)

    Parameter Strings for all Incidents (Incident form attributes)
    Parameter String Description
    $category, $cat

    Value of the Category attribute in the Trap Logging Configuration.

    If no Trap Logging configuration is specified, NNMi uses the value Configuration.
    $family, $fam

    Value from the Family attribute in the Trap Logging Configuration.

    If no Trap Logging configuration is specified, NNMi uses the value Node
    $lifecycleState, $lcs

    By default, this value is Registered.
    $name Value of the Name attribute from the Trap Logging Configuration.
    $nature, $nat

    By default, this value is Symptom.
    $origin, $ori

    By default, this value is SNMP Trap.
    $originOccurrenceTime, $oot

    Value from the Origin Occurrence Time attribute in the associated SNMP Trap Incident Configuration.

    When trap arrived at the trap server
    $priority, $pri

    By default, this value is None.
    $sev, $severity

    Value of the Severity attribute of the Trap Logging Configuration.

    If no Trap Logging configuration is specified, NNMi uses the value Normal.
  • Parameter Strings for Node Source Objects (Node form attributes) (ClosedClick here for a list of choices.)
    Parameter Strings for Node Source Objects (Node form attributes)
    Parameter String Description
    $managementAddress, $mga The fully-qualified DNS name of the source address of the trap.
    $sourceNodeLongName, $sln The fully-qualified DNS name of the source address of the trap.
    $sourceNodeName, $snn The HostName of the trap source.
  • Parameter Strings for all incidents (Additional information that is not visible in any form) (ClosedClick here for a list of choices.)
    Parameter Strings for all Incidents (Attributes not visible in any form)
    Parameter String Description
    $count, $cnt Value representing the number of varbinds that appear in the SNMP Trap.
    $oid Value of the unique Object Identifier (OID) for the SNMP trap.
    $originOccurrenceTimeMs, $oms

    Time the trap was received in number of milliseconds (measured since January 1, 1970, 00:00:00 GMT - Greenwich Mean Time).
  • Information established in varbinds (ClosedClick here for a list of choices.)

     

    Parameter Strings for varbinds
    Parameter String Description
    $<position _number>

    Value of the position number for a varbind . For example, to indicate you want to use the varbind in position 1, enter: $1

    If you know the varbind position number, use this parameter.
    $<varbind_name> Value of the name that is used for the varbind.
    $<varbind_oid> Value of the object identifier for a specified varbind. For example, $.1.3.6.1.6.3.1.1.5.1. Use this parameter when you are not certain of a varbind position number.
    $* Used to indicate you want all of the varbind values, to be passed to the action configuration.
  • Functions to generate values (ClosedClick here for a list of choices.)

    The function described in the following table replaces the specified numeric value with the associated text value stored in the varbind.

    Note: The associated MIB must have been loaded using the nnmloadmib.ovpl command.

    Functions to Generate Values Within the Incident Message
    Function Description
    $oidtext($<position_number>)

    A <position_number> argument specifies the numeric value of the position number for a specific varbind . For example, $oidtext($2).

    Note The position number you enter must represent a varbind that contains an Object Identifier (OID) value.

    NNMi returns the textual value of the OID for the varbind specified.

    Note the following:

    • If the MIB is not loaded, NNMi returns the numeric OID value.
    • If the OID has a MIB instance, the number representing the MIB instance is appended to the textual OID value.
    $oidtext($<varbind_oid>)

    The <varbind_oid> argument specifies the Object Identifier (OID) for a specific varbind. For example, $oidtext($.1.3.6.1.6.3.1.1.5.1.)

    Tip Use this argument to the $oidtext() function when you are not certain of a varbind position number.

    NNMi replaces the numeric value with the textual value of the OID you specify.

    Note the following:

    • If the MIB is not loaded, NNMi returns the numeric OID value.
    • If the OID has a MIB instance, the number representing the MIB instance is appended to the textual OID value.
    $text($<position_number>)

    The <position_number> argument specifies the numeric value of the varbind position number. For example, to indicate you want to use the varbind in position 1, enter: $1.

    NNMi replaces the numeric value with the text value stored in the varbind.

    Note If a text value is not available, NNMi returns the numeric value.
    $text($<varbind_oid>)

    The <varbind_oid> argument specifies the object identifier for a specific varbind. For example, $.1.3.6.1.6.3.1.1.5.1.

    Use this argument to the $text function when you are not certain of a varbind position number.

    NNMi replaces the numeric value with the text value stored in the varbind.

    Note If a text value is not available, NNMi returns the numeric value.

 

Send Help Center feedback