nnmincidentcfg.ovpl — create incident configurations from SNMP MIBs
nnmincidentcfg.ovpl [
[ [-loadTraps mib_module_name
[-authorLabel author_label -authorKey author_key]] |
-deleteAuthor author_key |
-deleteCategory category_key |
-deleteFamily family_key |
-disableAllTraps <true|false>
[-u username]
[-p password]
]
nnmincidentcfg.ovpl is used
to create incident configurations for SNMP traps defined in a
TRAP-TYPE or NOTIFICATION-TYPE macro in an SNMP MIB file.
To load a MIB into NNMi for defining MIB Expressions or to display
numeric SNMP Object Identifiers as text,
use the nnmloadmib.ovpl command.
The created incident will have the following values, which can then be manually updated with the NNMi user interface:
1. Name will be set to the name of the trap/notification in the MIB file.
2. Oid will be set to the oid of the trap/notification in the MIB file.
3. Enable will be set to "true."
4. Category will be set to "Status."
5. Family will be set to "Node."
6. Severity will be set to "Normal."
7. Message Format will be set to the name of the incident configuration.
8. Description will be set to the trap/notification description in the MIB file.
The created incident can be accessed using the Incident Configuration view. This can be further customized as required.
nnmincidentcfg.ovpl
supports a special annotation called
#SUMMARY. The value for the #SUMMARY
annotation will be used as Message Format value in the
created incident configuration entry.
This annotation is applied to the MIB file
just after the trap description as a MIB comment. The following
shows an example of this:
MyTrap TRAP-TYPE
ENTERPRISE hp
VARIABLES {
serverName, trapTime, volumeName, volumeNum
}
DESCRIPTION "The disk volume is out of space. Please consult
your sysop, and/or the proper manual."
--#SUMMARY "Volume $1 on system $2 is out of space."
nnmincidentcfg.ovpl supports the following options:
-loadTraps <mib_module_name>
Specify the MIB module name that has the trap definitions.
nnmincidentcfg.ovpl
parses trap/notification definitions (TRAP-TYPE or
NOTIFICATION-TYPE macros) found in the MIB module,
and creates incident configurations for each entry.
-authorLabel <author_label>
Specifies the label of the author for the target incident configurations. This is an optional parameter. If author label is specified, then author key must also be specified.
-authorKey <author_key>
Specifies the key of the author for the target incident configurations.
This is an optional parameter. If author key is specified, then author label must also be specified.
It is recommended that java packaging notation with your company's domain be used,
such as com.example.nnm.author.
-deleteAuthor <author_key>
It may be desirable to delete an Author that is no longer being used by the incident configuration. This option may be used to delete an Author by specifying the Author key value as long as no configurations reference the Author object.
-deleteCategory <category_key>
It may be desirable to delete a Category that is no longer being used by the incident configuration. This option may be used to delete a Category by specifying the Category key value as long as no incidents or incident configurations reference the Category object.
-deleteFamily <family_key>
It may be desirable to delete a Family that is no longer being used by the incident configuration. This option may be used to delete a Family by specifying the Family key value as long as no incidents or incident configurations reference the Family object
-disableAllTraps <true|false>
If true all traps should be loaded as disabled in
the incident configuration. The default value is false, meaning
the incident configuration is enabled by default.
-u <username>
Supply the NNMi administrator username to run the script. This script requires
the NNMi administrator username unless you use an nnm.properties file.
See the nnm.properties.4 reference page for more information.
-p <password>
Supply the NNMi administrator password to run the script. This script requires
the NNMi administrator password unless you use an nnm.properties file.
See the nnm.properties.4 reference page for more information.
nnmincidentcfg.ovpl -loadTraps "CISCO-VTP-MIB" -authorLabel "Cisco" -authorKey com.example.cisco.nnm.author
nnmincidentcfg.ovpl -loadTraps "mpls"
RFC 2578 Structure of Management Information Version 2 (SMIv2)
RFCs 1155, 1212, 1215: SNMP Version 1 Structure of Management Information
RFCs 1902, 1903, 1904: SNMP Version 2 Structure of Management Information
nnmloadmib.ovpl(1M),
nnm.properties(4).