nnmsnmpbulk.ovpl — Queries a node for information using an SNMPv2c GetBulk request.
nnmsnmpbulk.ovpl -u user_name -p passwd
[options]
node object-id
[,object-id]...
options:version]
[-c community]
[-port port(default:161)]
[-t timeout(default:5000)]
[-r retries(default:1)]
[-T]
[-n non-repeaters]
[-m max-repetitions]
[-pp Proxy Port]
[-pa Proxy Address]
[-a Authentication Protocol]
[-A Authentication Pass phrase]
[-x Privacy Protocol]
[-X Privacy Passphrase]
[-N Context Name]
[-oen OID and Output Encoding]
[-oex OIDs that are not encoded]
[-v3u SNMPv3 user name]
[-jndiHost hostname]
[-jndiPort port Default is 1099]
The nnmsnmpbulk.ovpl script uses the SNMPv2c/v3 GetBulk request to retrieve
information from an SNMP agent. The SNMP GetBulk request minimizes the number of protocol exchanges required
to retrieve a large amount of information. This increases performance, as the nnmsnmpbulk.ovpl
script uses fewer SNMP requests to retrieve management information from the remote node.
If the node is an SNMPv1-only agent, the nnmsnmpbulk.ovpl
script automatically downgrades the GetBulk request to an SNMPv1-supported GetNext request.
node can be a system with an IP address that supports SNMP. You can supply
IP nodes to the nnmsnmpbulk.ovpl script using either a node's IP address or its
hostname.
Supply command arguments for one or more OIDs in dotted decimal format or as a
mnemonic name. Before attempting to supply a mnemonic name, load the MIB that defines the OID by using the
nnmloadmib.ovpl script.
Only users who belong to System, Administrator or Web Service Client roles can run the nnmsnmpbulk.ovpl
script. Users who are in Level1, Level2 or Guest roles cannot run the nnmsnmpbulk.ovpl script.
-d
Dumps all SNMP packets to standard output in a hexadecimal and decoded ASN.1 format.
-v
version
Requests a specific version of SNMP be used to communicate with the remote node.
Valid choices for version are 1, 2,
2c, or 3.
If you do not specify the version, the nnmsnmpbulk.ovpl script uses
2c as the default for nodes not in the topology.
-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.
-port
port
Specifies the port to use to communicate with the remote node.
-t
timeout
Specifies a timeout period, in milliseconds, for communication with the remote node.
-r
retries
Specifies the number of retries to use for communication with the remote node.
-T
Prints the OID in dotted decimal format and the MIB variable value with no textual conventions applied.
-n
non-repeaters specifies the number of variables for which a single
lexicographic successor is to be returned. This value represents the number of non-repeating varbinds
(values) you want the nnmsnmpbulk.ovpl script to retrieve.
-m
Max-Repetitions specifies the number of lexicographic successors to be returned for the remaining variables. This value represents the number of rows to retrieve for a repeating varbind (value). The repeating varbind is present in each table row.
-pp
Proxy Port
Specifies the Proxy Port to use in communication with the node
-pa
Proxy Address
Specifies the Proxy IP Address to use to communicate with the node.
-a
Authentication Protocol
SNMPv3 Authentication Protocol (MD5|SHA)
-A
Authentication Passphrase
SNMPv3 Authentication Passphrase
-x
Privacy Protocol
SNMPv3 Privacy Protocol (DES|3DES|AES|AES192|AES256)
-X
Privacy Passphrase
SNMPv3 Privacy Passphrase
-N
context
SNMPv3 Context Name (for example, vlan1)
-oen
<OID>:<encoding>
OID and Output Encoding (e.g. 1.3.6.1.2.1.1.4:UTF-8)
-oex
<OID1,OID2,...>
OIDs that are not encoded
-v3u
SNMPv3 user name
SNMPv3 security name (for example, testV3user)
-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.
-jndiHost<jndiHost>
The hostname of the server running the jboss application server. If you do not specify a hostname, the
nnmcommload.ovpl script uses localhost
as the default value.
-jndiPort<jndiPort>
The jboss application server port. If you do not specify this port, the nnmcommload.ovpl script
uses 1099 as the default value.
If the nnmsnmpbulk.ovpl script does not receive a response, it uses a linear
backoff algorithm based on the timeout and retries arguments to
resend the SNMP request. For example, if the timeout argument is 2000
(two seconds) and the retries argument is 3, the initial
request would time out after two seconds, the first retry would time out after four seconds, the second retry
would time out after six seconds, and the last retry would time out after eight seconds. The
nnmsnmpbulk.ovpl script requires additional time to resolve the configuration.
The following command retrieves all information under the system MIB OID from node testnode:
nnmsnmpbulk.ovpl –c community
testnode
.1.3.6.1.2.1.1.0
The environment variable below represents a universal path that is established according to your shell and platform requirements:
Windows: %NNM_BIN%\nnmsnmpbulk.ovpl
UNIX: $NNM_BIN/nnmsnmpbulk.ovpl
nnmloadmib.ovpl(1M), nnmsnmpnotify.ovpl(1M), nnmsnmpset.ovpl(1M), nnmsnmpwalk.ovpl(1M).
RFC 1155, 1157, 1212: SNMP Version 1.
RFC 1901 - 1908, 2576, 2578, 3416 - 3418: SNMP Version 2.
RFC 3411 - 3415: SNMP Version 3.
$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, the nnmsnmpbulk.ovpl script functions as if all
internationalization variables are set to C.