nnmsnmpnotify.ovpl

SYNOPSIS

nnmsnmpnotify.ovpl [-v version] [-c community] [-p port(default:162)] [-A] [-t timeout] [-r retries] [-d] [-T] [-a agent_addr] [-e enterprise] node trap-oid variable type value [variable type value]...

DESCRIPTION

If you frequently run NNMi command line tools, create an nnm.properties file containing your username and password. Doing so permits you to run many NNMi command line tools and scripts without entering a username and password. Place the nnm.properties file in a .nnm subdirectory within your home directory. For example, you might place the nnm.properties file you create in the drive:\Documents and Settings\username\.nnm\ (Windows) or ~/.nnm (UNIX) directory.

The nnmsnmpnotify.ovpl script sends an SNMP notification request to notify another system of an event on the local system. You can use options with the nnmsnmpnotify.ovpl script to acknowledge (SNMPv2 Inform) or unacknowledge (SNMPv1 or SNMPv2 Trap) the notification. You cannot send acknowledged notifications to systems that support only SNMP Version 1.

By default, the notification is unacknowledged. The nnmsnmpnotify.ovpl script sends an SNMP Version 1 or SNMP Version 2 Trap depending on the protocol version you specify. When you use the default version of the nnmsnmpnotify.ovpl script, it terminates immediately after sending the SNMP Trap request. There is no confirmation that the notification reached the destination system.

Use the -A option to send an acknowledged notification. The nnmsnmpnotify.ovpl script sends an SNMP Version 2 Inform request to the destination system. It waits for the corresponding acknowledgment, and retransmits an SNMP Version 2 Inform request if necessary. If an SNMP Version 2 Inform request retransmission occurs, the nnmsnmpnotify.ovpl script uses the timeout and retry values you specify on the command line. If the nnmsnmpnotify.ovpl script displays an acknowledgment within the time period and retry attempts you specify, you know the notification reached the destination system. If the nnmsnmpnotify.ovpl script does not display an acknowledgment within the time period and retry attempts you specify, the notification did not reach the destination system.

node can be an IP-addressable system that supports SNMP. You can identify IP nodes by Internet address or hostname. You can supply node in Internet address form or hostname form. If you supply an empty string ("") to the nnmsnmpnotify.ovpl script instead of a node, the script uses localhost as the destination.

Specify the trap type as an object identifier in the trap_oid command-line argument. You must identify all notifications using the object identifier form. You can supply notifications defined in the SNMPv2 MIB or in a vendor-specific SNMPv1 MIB directly to the nnmsnmpnotify.ovpl script. However, you must convert traps defined in a vendor-specific SNMPv1 MIB to the object identifier form before supplying them to the nnmsnmpnotify.ovpl script. For an SNMP Version 1 trap, if you supply an empty string ("") instead of a trap_oid, the Generic trap type value is set to 6 and the Specific trap type value is set to 0. For an SNMP Version 2 trap, if you supply an empty string ("") instead of a trap_oid the trap_oid variable binding is not set.

When providing trap object identifiers to the nnmsnmpnotify.ovpl script, follow these guidelines:

Use the corresponding object identifiers defined in RFC 1907 to generate a trap for any of the six generic SNMP traps: coldStart, warmStart, linkDown, linkUp, authenticationFailure, and egpNeighborLoss. For example, use the 1.3.6.1.6.3.1.1.5.1 trap OID to generate a coldStart trap. .
To generate a trap that is not SNMP-generic but is defined in SNMPv2 form, use the NOTIFICATION-TYPE identifier from the SNMPv2-compatible MIB.
To generate a trap that is not SNMP-generic but is defined in SNMPv1 form, determine the trap enterprise and specific numbers from the SNMPv1-compatible MIB. From these trap enterprise and specific numbers, construct an object identifier in the enterprise.0.specific field form. For example, consider a vendor-specific MIB for a device test. The MIB defines a trap with enterprise 1.3.6.1.4.1.11.2.17.1 and specific trap field 4. The resulting trap object identifier would be 1.3.6.1.4.1.11.2.17.1.0.4.

The nnmsnmpnotify.ovpl script passes data to the remote node as a triple of variable,type,value. Supply one or more triples to the nnmsnmpnotify.ovpl script as command-line arguments.

Each variable is an object instance identifier in either dotted decimal format or mnemonic string format. For example, you can use either the .1.3.6.1.4.1.11.2.17.2.1.0 or the openViewSourceId.0 format.

Each type must be one of the following types:

INTEGER

INTEGER32

IPADDRESS

COUNTER

COUNTER32

COUNTER64 (for SNMPv2c or v3 capable remote nodes)

GAUGE

GAUGE32

OBJECTIDENTIFIER

OCTETSTRING

OCTETSTRINGASCII

OCTETSTRINGHEX

OCTETSTRINGOCTAL

OPAQUE

OPAQUEASCII

OPAQUEHEX

OPAQUEOCTAL

TIMETICKS

UNSIGNED32

For a complete description of each type, refer to RFC 1155 and RFC 1902.

The value parameter must be valid for the type specified. When using a type that requires a hexadecimal or octal value, you must fully define each byte of the value. For example, if you specify fff (or 17377), it is missing a byte, and will not work. Use 0fff (or 017377) instead. You must specify a value on the command line. value must not be larger than 512 bytes.

Parameters

-v version

Requests the nnmsnmpnotify.ovpl script to use a specific version of SNMP to communicate with the remote node. Valid choices for version are 1, 2c, or 3.

-c community

Specifies the community string to use for authentication on the remote node.

Note: If the community string contains characters the shell interferes with, use one or more escape symbols or quotation marks as required.

-p port

Specifies the port to use to communicate with the remote node.

-t timeout

Specifies a timeout period, in tenths of seconds, to wait for an acknowledgment when using an SNMP Version 2 Inform request. This option is only valid when used with the -A option.

-r retries

Specifies the number of retransmissions to attempt when no acknowledgment is received when using an SNMP Version 2 Inform request. This option is only valid when used with the -A option.

-d

Dump ASN.1 packet trace

-T

Prints the OID in dotted decimal format.

-a agent_add

Overrides the local host as the source of the notification with the given agent address. agent_addr must be an IP address or hostname.

-e enterprise

Overrides the default enterprise object identifier for the notification with the given enterprise value.

EXAMPLES

The following command sends an SNMP link down Inform request to the node v2c_node:

nnmsnmpnotify.ovpl -A -v2c v2c_node .1.3.6.1.6.3.1.1.5.3

The following command sends an SNMP link down trap request to the node v1_node with the agent address set to agent:

nnmsnmpnotify.ovpl -a agent v1_node .1.3.6.1.6.3.1.1.5.3

AUTHOR

nnmsnmpnotify.ovpl was developed by Hewlett Packard Enterprise.

FILES

The environment variable below represents a universal path that is established according to your shell and platform requirements:

Windows: %NNM_BIN%\nnmsnmpnotify.ovpl

UNIX: $NNM_BIN/nnmsnmpnotify.ovpl

EXTERNAL INFLUENCES

Environmental Variables

$LANG determines the language in which messages appear. If $LANG is not specified or is set to an empty string, a default of C is used instead of $LANG. If any internationalization variable contains an invalid setting, nnmsnmpnotify.ovpl behaves as if all internationalization variables are set to C.

International Code Set Support

Supports single-byte and multiple-byte character code sets.

NOTE: SNMP MIB values of the type octetstringascii are restricted to NVT-ASCII.

Name