SNMP4J Command-Line Tool, version
...
3.
...
4.0
Type
Code Block |
---|
java -SNMP4J-CLT.jar help <command> |
for help on a specific command.
Type
Code Block |
---|
java -jar SNMP4J-CLT.jar example <command> |
for examples on a specific command.
Type
Code Block |
---|
java -jar SNMP4J-CLT.jar version |
to see the program version.
Type
Code Block |
---|
java -jar SNMP4J-CLT.jar -L "<license>" "<key>" defaults list |
to register your license (you then do not need to enter it for subsequent commands).
Most commands take agent address and OID list arguments. A list of the
available options for each command is listed after the command description.
The description of all options follows the command list.
Standard parameter formats are:
<OID>:
- An object identifier is either a dotted notation like '1.3.6.1.2.2.1.0
...
- '.
...
- An object name
...
- with dotted numeric suffix like 'IF-MIB:ifDescr.0' or 'sysName' (requires MIB information).
- An columnar OBJECT-TYPE name with formatted index, e.g. vacmAccessContextMatch."v3group"."".3.'authPriv(3)' (requires MIB information).
<address>: *<address>*: \ [upd:|tcp:\]<host>\[/<port>\]
Wiki Markup
Host is either an IP address or hostname and port is the SNMP port
of the target SNMP entity.
No Format |
---|
create-snapshot: create-snapshot <file> <address> <OID> defaults: Creates a snapshot <file> by walking the subtree specified by <OID> at the agent at <address>. defaultsdefaults <action> list reset save dump-snapshot: dump-snapshot <file> example: defaults <action> example <command> get: Manageget the<address> default options stored in the SNMP4J-CLT config file in your home directory. <sub-command> is one of 'list', 'reset', and 'save'. list: List default options to stdout and exit. The default options are stored in the SNMP4J-CLT config file in your home directory. reset: Reset (delete) all option defaults and exit. save: Save specified options as defaults and exit. dump-snapshot: dump-snapshot <file> Dumps the contents of the snapshot <file> to STDOUT. example: example <command> Display the help for a command including usage example (if available). get: get <address> <OID> [OID..] Get one or more object values from the SNMP agent at <address> with the specified instance <OID>. getbulk: [-Cr <repeaters>] [-Cn <non-repeaters>] getbulk <address> <OID> [OID..] Send a SNMP GETBULK message to <address>. The options -Cr and -Cn are GETBULK specific - defaults are 10 and 0 respectively. getnext: getnext <address> <OID> [OID..] Get one or more object values from the SNMP agent at <address> with an instance OID lexicographic following the specifed <OID> in the accessible MIB view. help: help [command]|all Display this message and then exits the application. If command is specified then specific help on that command is displayed. By specifying 'all' as [command] a description for each command is displayed. inform: inform <address> <OID>={<type>}<value> [..] Send an INFORM request with one or more object values to the SNMP agent at <address> with the specified instance <OID>, <type> and <value>s. Type is one of i,u,s,x,d which selects how <value> is being parsed and which SNMP (SMI) type is being send to the agent. The <value> for an <OID> is specified by using the following form: <OID>={<type>}<value> where <type> is one of the following single characters enclosed by '{' and '}': i Integer32 u UnsingedInteger32, Gauge32 s OCTET STRING x OCTET STRING specified as hex string with bytes separated by ':'. d OCTET STRING specified as decimal string with bytes separated by dots ('.'). n Null o OBJECT IDENTIFIER t TimeTicks a IpAddress b OCTET STRING specified as binary string with bytes separated by spaces. license: license Print the license agreement for SNMP4J-CLT on the console. listen: listen <address> Listen for incoming traps, notifications, and inform requests a dumps their content to STDOUT. mib: mib <action> <mib> Add MIB files to a MIB repository or remove MIB modules from it. The MIB repository directory has to be specified by the mandatory options -M or -Msmi. add: <mib-file> Compiles and then adds the MIB module(s) contained in 'mib-file' to the MIB repository specified by -M or -Msmi. del: <mib-module-name> Removes the MIB module with name 'mib-module-name' from the MIB repository specified by -M or -Msmi. oid: oid [find|find-by-descr] <regex> Search the MIB repository specified by the -M option for SMI definitions with an object name/description that matches the specified regular expression. find: oid find <regex> Search the MIB repository for object names that match <regex> find-by-descr: oid find-by-descr <regex> Search the MIB repository for descriptions that match <regex> set: set <address> <OID>={<type>}<value> [..] Set one or more object values in the SNMP agent at <address> with the specified instance <OID>, <type> and <value>s. Type is one of i,u,s,x,d which selects how <value> is being parsed and which SNMP (SMI) type is being send to the agent. The <value> for an <OID> is specified by using the following form: <OID>={<type>}<value> where <type> is one of the following single characters enclosed by '{' and '}': i Integer32 u UnsingedInteger32, Gauge32 s OCTET STRING x OCTET STRING specified as hex string with bytes separated by ':'. d OCTET STRING specified as decimal string with bytes separated by '.'. n Null o OBJECT IDENTIFIER t TimeTicks a IpAddress b OCTET STRING specified as binary string with bytes separated by spaces. smi: smi <OID> [..] Dump the SMI definition of the MIB object specified by the OID parameter(s). table: table <address> <OID> [OID..] Receives tabular data from the column OIDs specified as parameters. The retrieved rows will be dumped to the console (STDOUT) ordered by their index values. trap: [-To <notificationID>] trap <address> <OID>={<type>}<value> [..] Send a TRAP/NOTIFICATION to the SNMP agent at <address> with the specified instance <OID>s and <value>s.The <value> for an <OID> is specified by using the following form: <OID>={<type>}<value> where <type> is one of the following single characters enclosed by '{' and '}': i Integer32 u UnsingedInteger32, Gauge32 s OCTET STRING x OCTET STRING specified as hex string with bytes separated by ':'. d OCTET STRING specified as decimal string with bytes separated by '.'. n Null o OBJECT IDENTIFIER t TimeTicks a IpAddress b OCTET STRING specified as binary string with bytes separated by spaces. v1trap: [-Te eid] [-Ts sid] [-Tg gid] [-Ta addr] v1trap <address> <OID>={<type>}<value> [..] Sends a TRAP/NOTIFICATION to the SNMP agent at <address> with the specified instance <OID>s and <value>s.The <value> for an <OID> is specified by using the following form: <OID>={<type>}<value> where <type> is one of the following single characters enclosed by '{' and '}': i Integer32 u UnsingedInteger32, Gauge32 s OCTET STRING x OCTET STRING specified as hex string with bytes separated by ':'. d OCTET STRING specified as decimal string with bytes separated by '.'. n Null o OBJECT IDENTIFIER t TimeTicks a IpAddress b OCTET STRING specified as binary string with bytes separated by spaces. version: version Display version information and then exits. walk: walk <address> <OID> The walk operation mode uses GETNEXT or GETBULK PDUs to retrieve a MIB subtree with the specified root OID. OPTIONS: -A authPassphrase Set the authentication pass phrase for <OID> [..] getbulk: [-Cr <repeaters>] [-Cn <non-repeaters>] getbulk <address> <OID> [..] getnext: getnext <address> <OID> [..] help: help [command]|all inform: inform <address> <OID>={<type>}<value> [..] license: license listen: listen <address> mib: mib <action> [<mib>] add <mib-file> del <mib-module-name> list oid: oid [find|find-by-descr] <regex> find oid find <regex> find-by-descr oid find-by-descr <regex> set: set <address> <OID>={<type>}<value> [..] smi: smi <OID> [..] table: table <address> <OID> [..] trap: [-To <notificationID>] trap <address> <OID>={<type>}<value> [..] usmDHKey: usmKey auth|priv|authPriv <address> <oldpwd> <newpwd> [<user>] auth usmDHKey auth <address> [<user>] priv usmDHKey priv <address> [<user>] authPriv usmDHKey authPriv <address> [<user>] usmDHKickstartInit: usmDHKickstartInit -privateKeysFile <dhKickstartPrivKeys.properties> <address> [<user> ..] usmDHKickstartRun: usmDHKickstartRun -privateKeysFile <dhKickstartPrivKeys.properties> <address> [<user> ..] usmKey: usmKey auth|priv|authPriv <address> <old> <new> [<user>] auth usmKey auth <address> <old> <new> [<user>] priv usmKey priv <address> <old> <new> [<user>] authPriv usmKey authPriv <address> <oldpwd> <newpwd> [<user>] usmUser: usmUser create|delete <address> <user> [<cloneFromUser> [<cloneFromEngineID>]] create [-CE <usmUserEngineID>] [-createAndWait] usmUser create <address> <user> [<cloneFromUser> [<cloneFromEngineID>]] delete [-CE <usmUserEngineID>] usmUser delete <address> <user> v1trap: -Te eid -Ts sid -Tg gid -Ta addr v1trap <address> <OID>={<type>}<value> [..] version: version walk: walk <address> <OID> xml: xml <output-dir> OPTIONS: -A authPassphrase Set the authentication pass phrase for authenticated SNMPv3 messages. -CB Display brief column headers. Common prefixes will be dropped. -CE usmUserTableEngineID Set usmUserTableEngineID to be used as part of the index of the usmUserTable. Default is to use the authoritative engine ID (set via -e or probed) as the usmUserTableEngineID. -CH Do not display column headers. -Cb bufferSize The number of table rows to buffer before computing column sizes. -Cc columnWidth Print table columns with specified character width. -Cf columnSeparator Separate table columns with the specified separator string. The table is printed in compact form. By default columns are separated by spaces and aligned. -Ch Display only column headers. -Ci Prepend the index for each printed row. -Cil lowerBoundIndex Set the lower bound index for TABLE operations. -Ciu upperBoundIndex Set the upper bound index for TABLE operations. -Cl Left justify all cells when printing a table. -Cn non-repeaters Set the non-repeaters field for GETBULK PDUs. It specifies the number of supplied variables that should not be iterated over. The default is 0. -Cr max-repetitions Set the max-repetitions field for GETBULK PDUs. This specifies the maximum number of iterations over the repeating variables. The default is 10. -Cw Specify the line width when printing tables -Djavax.net.ssl.keyStore keyStoreFile The key store file with SSL keys for the TLS protocol. -Djavax.net.ssl.keyStorePassword keyStorePassword The password for the key store file with SSL keys for TLS. -Djavax.net.ssl.trustStore keyStoreFile The trust store file with trusted (public) SSL keys for the TLS protocol. -Djavax.net.ssl.trustStorePassword keyStorePassword The password for the trust store file. -Dn Do not use any default option values stored in config. -E contextEngineID Set the context engine ID used for the SNMPv3 scoped PDU. The authoritative engine ID will be used for the context engine ID, if the latter is not specified. -L license key Specify license and associated key. The license info will be saved in the SNMP4J-CLT config file in your home directory. Enter each license part enclosed in quotes, for example by '-L "b6 80 4d 68 3a 8 c0 f4" "O?fWO-3s"' -M mibRepositoryPath Set the path to the MIB repository to be used to resolve object names (OIDs) and parse/format object values ('repository' is the default). The repository directory must contain compiled MIB modules files only. -Oesc escapeCharacter Escape character used in non-printable OCTET-STRING values to print them as strings (instead of hex-strings). Default is '_' and 'x' disables escaping and enables hex-string output. -Ors maxSizeRespPDU The maximum size of the response PDU in bytes. -OtCSV For each SNMP row received exactly one row of comma separated values will printed to the console where the first column contains the row index. -Otd Activates dense table operation mode which improves table retrieval performance on regular (dense) tables. This option must not be used with sparse tables. -OttCSV Same as -OtCSV except that each row's first column will report the current time (millis after 1.1.1970) when the request has been sent. -Ta agentAddress Set the agent address field of a V1TRAP PDU. The default value is '0.0.0.0'. -Te enterpriseOID Set the enterprise OID field of a V1TRAP PDU. -Tg genericID Set the generic ID for SNMPv1 TRAPs (V1TRAP). The default is 0 (coldStart). -To trapOID Sets the trapOID (1.3.6.1.6.3.1.1.4.1.0) of an INFORM or TRAP PDU. The default is 1.3.6.1.6.3.1.1.5.1. -Ts specificID Set the specific ID for V1TRAP PDU. The default is 0. -Tu upTime Set the sysUpTime field of an INFORM, TRAP, or V1TRAP PDU. -Y privacyPassphrase Set the privacy pass phrase for authenticatedencrypted SNMPv3 messages. -CB Display brief column headersmessages. Common prefixes will -a authProtocol Set the authentication protocol used to be dropped. -CH authenticate SNMPv3 messages. Valid values are MD5 Do not display column headers. -Cb bufferSize The number of table rows to buffer beforeand computing SHA, SHA224, SHA256, SHA384, and SHA512. -b bindAddress Set local interface and port to use for columnoutgoing sizes. -Cc columnWidth Print table columns with specified character width. -Cf columnSeparator SNMP messages. SeparateBy tabledefault columnsthis with the specified separatoris 0.0.0.0/0 (host string.chosen Theport tableon isall printedlocal in compact form. By IPv4 addresses). -bc engineBootCount Set the engine boot count to the specified value default columns are separated by spaces and greater or equal to zero. Default alignedis zero. -Chc community Set the community for SNMPv1/v2c messages. Display only-createAndWait column headers. -Ci Use the createAndWait(5) RowStatus to create new Prepend the index for each printed row. -Cil lowerBoundIndex Set the lower boundrows indexinstead for TABLE operations. -Ciu upperBoundIndexof createAndGo(4) which might not be Set the upper bound index for TABLE operations. -Cl supported on certain devices. -d Left justify alldebugLevel cells when printing a table. Set -Cnthe global debug non-repeaterslevel for Log4J logging Set the non-repeaters field for GETBULK PDUs. It output. Valid values are OFF, ERROR, WARN, INFO, specifies the number of supplied variables that and DEBUG. -dhp usmDHParameters should notThe beoctet iteratedstring over.(provided Theas defaultcolon isseparated 0. -Cr max-repetitions Set the max-repetitions field for GETBULK PDUs. hexadecimal string) containing the BER encoded This specifies the maximum number of iterations ASN.1 sequence of prime (p) and base (g) as defined over the repeating variables. The default is 10. -Cw by RFC2786 usmDHParamters OBJECT-TYPE. The default Specify the line width when printing tables -Dn value is (without line breaks): Do not use any default option values stored in 10:69:02:61:00:ff:ff:ff:ff:ff:ff:ff:ff:c9:0f: config. -E contextEngineID Set the context engine ID used for the SNMPv3 da:a2:21:68:c2:34:c4:c6:62:8b:80:dc:1c:d1:29: scoped PDU. The authoritative engine ID will be 02:4e:08:8a:67:cc:74:02:0b:be:a6:3b:13:9b:22: 51:4a:08:79:8e:34:04:dd:ef:95:19:b3:cd:3a:43: used for the context engine ID, if the latter is 1b:30:2b:0a:6d:f2:5f:14:37:4f:e1:35:6d:6d:51: not specified. -L license key Specify license and associated key. The license c2:45:e4:85:b5:76:62:5e:7e:c6:f4:4c:42:e9:a6: 3a:36:20:ff:ff:ff:ff:ff:ff:ff:ff:02:01:02:02: info will be saved in the SNMP4J-CLT config file in 01:10 -dhx diffieHellmanPropertyPrefix The property prefix used with the your home directory. Enter each license part privateKeysFile for the usmDHKickstartInit and enclosed in quotes, for example by '-L "b6 80 4d 68 usmDHKickstartRun commands. By default 3a 8 c0 f4" "O?fWO-3s"' -M mibRepositoryPath Set the path to the MIB repository to be used to 'org.snmp4j.' is used. -dtls-version dtlsVersion Specifies the DTLS version to use. Possible resolve object names (OIDs) and parse/format object values are DTLSv1.0 and DTLSv1.2 (default). -e engineID values ('repository' isSet the default).authoritative Theengine ID of the command repository directory must contain compiledresponder MIBused for SNMPv3 request messages. If not modules files only. -Msmi mibRepositoryPath Set the path tosupplied, the MIBengine repositoryID towill be useddiscovered. to -f 1|2|3|4 Set the OID output format, where 1 = numeric, 2 = resolve object names (OIDs) and parse/format object last name and numeric index, 3 values ('repository' is the default). The MIB = last name and formatted index without repository directory must contain SMI MIB filesquoting, and 4 = last name (v1/v2). The file namesand formatted index including hex-formatting of the MIB files have to non-printable strings. The default is match4. their MIB module name-h or there has towindowSize be a Set the window height in rows. If the value is properties file named 'module-index.properties' greater than zero, every windowSize rows the user which maps to the module file by is prompted to continue output. Default is zero. -ilo '<modulename>.path=<path>' entries. -Ors maxSizeRespPDU The maximum size of the response PDUDo innot bytes. check for lexicographic ordering -OtCSVerrors For each SNMP row received exactly one row of comma while walking a subtree. Using this option may separated values will printed to the console where cause endless looping if an agent does not the first column contains the row index. -Otd implement lexicographic ordering correctly! -l localEngineID Set the local Activatesengine denseID tableof operationthe modecommand whichgenerator improves tableand the retrievalnotification performancereceiver onused regularfor (dense)SNMPv3 tablesrequest messages. This option mustcan not be used withto sparseavoid engine ID clashes through duplicate tables.IDs leading to -OttCSV Same as -OtCSV except that each row's firstusmStatsNotInTimeWindows column reports. -m mibModuleName Load the specified MIB module from the MIB will report the current time (millis after repository specified by the -M option. The 1.1.1970) when the request has been sent. -Ta agentAddress Set the agentmibModuleName addresscan fieldbe ofa aregular V1TRAP PDU. The expression, e.g. use default value is '0.0.0.0'. -Te enterpriseOID SNMPv2-.*' to load all MIB modules in the Set the enterprise OID field of a V1TRAP PDU. -Tg genericID Setrepository thethat genericstart ID for SNMPv1 TRAPs (V1TRAP). The with 'SNMPv2-'. -n contextName Set the target context name for SNMPv3 default is 0 (coldStart). messages. -To trapOID Sets the trapOID (1.3.6.1.6.3.1.1.4.1.0) of an Default is the empty string. -p INFORM or TRAPDump PDU.sent Theand defaultreceived ispackets as hex string. -r retries Set the number of retries used 1.3.6.1.6.3.1.1.5.1.for requests. A zero -Ts specificID Set the specific ID for V1TRAP PDU. The default is value will send out a request exactly once. Default 0. -Tu upTime is 1. -rsl low|basic|secure Set the sysUpTimesecurity fieldlevel ofstrategy an INFORM, TRAP, or for auto-responses V1TRAPto PDU. REPORT PDUs The default -Yis 'low' privacyPassphrase Set the privacy pass phrase for encrypted SNMPv3 for better error handling. Use 'secure' for messagesmax. security -a authProtocol Set the authentication protocol used to (i.e. never send noAuthNoPriv). The basic level is authenticate SNMPv3 messages. Valid values are MD5 conforming to RFC 3412 and 3414 allowing and SHA. -bc engineBootCount Set the engine boot count to the specified'noAuthNoPriv' valuefor engine ID discovery and wrong greater or equal to zero. Default isusername zeroreports. -cs community Set the community for SNMPv1/v2c messages. -dSuppress any output on debugLevelstderr (silent mode). -t Set the globaltimeout debug level for Log4J logging Set the timeout in milliseconds between retries. output. Valid values are OFF, ERROR, WARN, INFO, Default is 1000 milliseconds. -tls-cert-fingerprint certFingerprint The fingerprint of the trusted and DEBUG. -e engineID Set the authoritative enginecertificate IDpresented ofby the commandremote SNMP engine as responder used for SNMPv3hex request messagesstring. If notthe fingerprint does not match, supplied, the engine IDconnection will not be discovered.established. Use this option -h windowSize Set the window height in rows. If the value is with the "tls:" or "dtls:" transport domain. -tls-local-id certAlias The local certificate alias identity which selects greater than zero, every windowSize rows the user a certificate chain from the local key store. Only is prompted to continue output. Default is zero. -l localEngineID Set the localselected enginecertificate IDchain ofwill thebe commandpresented generator to and the notification receiver used for SNMPv3 remote SNMP engine. Use this option with the request messages. This option can be used to avoid "tls:" or "dtls:" transport domain. -tls-peer-id subjectDN The subject DN (e.g., "EMAILADDRESS=email@host.com, engine ID clashes through duplicate IDs leading to C=US, CN=My Name") of the trusted certificate usmStatsNotInTimeWindows reports. -m mibModuleName Load the specified MIB modulepresented fromby the MIBremote SNMP engine ID. Use this repository specified by the -M option. Thewith the "tls:" or "dtls:" transport domain. -tls-trust-ca issuerDN The issuer DN (e.g., "Company Name CA") of a mibModuleName can be a regular expression, e.g. use trusted certification authority (CA) presented by 'SNMPv2-.*' to load all MIB modules in the the remote SNMP engine ID for TLS and DTLS. -tls-version tlsVersion The TLS repositoryversion thatto startuse with the 'SNMPv2-'.tls:' transport -n contextName Set the target context name for SNMPv3 messagesprotocol. Currently only 'TLSv1', 'TLSv1.1', and Default is the empty string. -r retries 'TLSv1.2' are supported with Java 7 or later. Set the number of retries used for requests. A zero 'TLSv1' is the default which is supported with Java value will send out a request exactly once. Default 6 too. -u securityName Set the security name isfor 1. authenticated v3 -s Suppress any output on stderr (silent mode)messages. -tv timeout1|2c|3 Set the SNMP timeoutprotocol inversion millisecondsto betweenbe retriesused. Default Default is 1000 milliseconds3. -uw securityNameconsoleWidth SetSpecifies the width securityof namethe forconsole authenticatedoutput, v3default is messages80 characters. -vy 1|2c|3 privacyProtocol Set the SNMPprivacy protocol version to be used. to Defaultencrypt isSNMPv3 3. -wmessages. Valid values are DES, AES consoleWidth Specifies the width of the console output, default (AES128), AES192, AES256, AES192p, AES256p, and is 80 characters. -y privacyProtocol Set the privacy protocol to be used to encrypt3DES(DESEDE). The AES protocols that end with 'p' SNMPv3 messages. Valid values are DES, AES(for proprietary) are using a non-standardized key (AES128), AES192, AES256, and 3DES(DESEDE). extension algorithm from 3DES. Up |