Page History

SNMP4J Command-Line Tool, version

...

3.4.0

...

Type

Code Block
java -SNMP4J-CLT.jar help <command>

...

Standard parameter formats are:

<OID>:

1. An object identifier is either a dotted notation like '1.3.6.1.2.2.1.0

...

1. '.

...

1. An object name

...

1. with dotted numeric suffix like 'IF-MIB:ifDescr.0' or 'sysName' (requires MIB information).
2. An columnar OBJECT-TYPE name with formatted index, e.g. vacmAccessContextMatch."v3group"."".3.'authPriv(3)' (requires MIB information).

<address>: Wiki Markup*<address>*: \ [upd:|tcp:\]<host>\[/<port>\]
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 defaults <action> list reset save dump-snapshot: agent at <address>.dump-snapshot <file> defaultsexample: defaults <action> example <command> get: Manageget the<address> default options stored in the SNMP4J-CLT config file in your home directory. <action> 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> [..] 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> [..] 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> [..] 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> [..] 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 authenticated SNMPv3 messages. -CB INFORM or Display brief column headers. Common prefixes willTRAP PDU. The default is be dropped1.3.6.1.6.3.1.1.5.1. -CHTs specificID Set the specific ID for V1TRAP PDU. The default is Do not display column headers. -Cb bufferSize The number of table rows to buffer before computing0. -Tu upTime Set the sysUpTime field of an INFORM, TRAP, or column sizes. -Cc columnWidth Print table columns with specified character width. -Cf columnSeparatorV1TRAP PDU. Separate table columns-Y with the specified separator privacyPassphrase Set the privacy pass phrase for encrypted SNMPv3 string. The table is printed in compact form. By messages. -a authProtocol Set the authentication protocol used to default columns are separated by spaces and authenticate SNMPv3 messages. Valid values are MD5 aligned. -Ch and SHA, SHA224, DisplaySHA256, onlySHA384, columnand headersSHA512. -Cib bindAddress Set local interface and port to use for outgoing Prepend the index for each printed row. -Cil lowerBoundIndex Set the lower bound index for TABLE operations. -CiuSNMP messages. upperBoundIndexBy default this Set the upper bound index for TABLE operations. is 0.0.0.0/0 (host -Cl chosen Leftport justifyon all cellslocal when printing a tableIPv4 addresses). -Cnbc non-repeaters engineBootCount Set the non-repeaters field for GETBULK PDUs. Itengine boot count to the specified value specifiesgreater theor numberequal ofto suppliedzero. variablesDefault thatis zero. -c community should not be iteratedSet over.the Thecommunity defaultfor isSNMPv1/v2c 0messages. -CrcreateAndWait max-repetitions Set the max-repetitions fieldUse for GETBULK PDUs. the createAndWait(5) RowStatus to create new This specifies the maximumrows numberinstead of iterations createAndGo(4) which might not be over the repeating variables. Thesupported defaulton iscertain 10devices. -Cwd debugLevel Set the global debug level Specify the line width when printing tables for Log4J logging -Dn Do notoutput. useValid anyvalues defaultare optionOFF, valuesERROR, storedWARN, inINFO, and configDEBUG. -Edhp usmDHParameters contextEngineID The octet Setstring the(provided contextas enginecolon IDseparated used for the SNMPv3 hexadecimal string) containing the scopedBER PDU.encoded The authoritative engine ID will be ASN.1 sequence of prime (p) and used for the context engine ID, if the latter is base (g) as defined by RFC2786 usmDHParamters OBJECT-TYPE. The notdefault specified. -L license key Specify license and associated key. The license value is (without line breaks): info will be saved in the SNMP4J-CLT config file in 10:69:02:61:00:ff:ff:ff:ff:ff:ff:ff:ff:c9:0f: your home directory. Enter each license part da:a2:21:68:c2:34:c4:c6:62:8b:80:dc:1c:d1:29: enclosed in quotes, for example by '-L "b6 80 4d 68 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: 3a 8 c0 f4" "O?fWO-3s"' -M mibRepositoryPath Set the path to the MIB repository to be used to 1b:30:2b:0a:6d:f2:5f:14:37:4f:e1:35:6d:6d:51: c2:45:e4:85:b5:76:62:5e:7e:c6:f4:4c:42:e9:a6: resolve object names (OIDs) and parse/format object 3a:36:20:ff:ff:ff:ff:ff:ff:ff:ff:02:01:02:02: values ('repository' is the default). The 01:10 -dhx diffieHellmanPropertyPrefix The property prefix used with the repository directory must contain compiled MIB privateKeysFile for the usmDHKickstartInit and modules files only. -Msmi mibRepositoryPath Set the path to the MIB repository to be used to usmDHKickstartRun commands. By default resolve object names (OIDs) and parse/format object 'org.snmp4j.' is used. -dtls-version dtlsVersion Specifies the DTLS version to use. Possible values ('repository' is the default). The MIB values are DTLSv1.0 and DTLSv1.2 (default). -e engineID repository directory must contain SMI MIB files Set the authoritative engine ID of the command (v1/v2). The file names of the MIB files have toresponder used for SNMPv3 request messages. If not match their MIB module name or there hassupplied, tothe beengine aID will be discovered. -f 1|2|3|4 Set the OID output format, where 1 properties= filenumeric, named 'module-index.properties'2 = whichlast mapsname toand thenumeric moduleindex, file3 by= last name and '<modulename>.path=<path>' entries. formatted index -Orswithout quoting, maxSizeRespPDUand 4 = last Thename maximum size of the response PDU in bytes. -OtCSV and Forformatted eachindex SNMPincluding rowhex-formatting receivedof exactly one row of comma non-printable strings. The default separatedis values4. will printed to the-h console where windowSize Set the window height in rows. If the value is the first column contains the row index. -Otd greater than zero, every windowSize rows the user Activates dense table operation mode which improves is prompted to continue output. Default is zero. table retrieval performance-ilo on regular (dense) Do not check for lexicographic ordering errors tables. This option must not be used with sparse while walking a subtree. Using this option may tables. -OttCSV Same ascause -OtCSVendless exceptlooping thatif eachan row'sagent firstdoes columnnot willimplement reportlexicographic theordering currentcorrectly! time (millis after -l localEngineID Set the local engine ID of the command generator 1.1.1970) when the request has been sent. -Ta agentAddress Setand the agentnotification addressreceiver fieldused of a V1TRAP PDU. The for SNMPv3 default value is '0.0.0.0'. -Te enterpriseOID request messages. This option can be used to avoid Set the enterprise OID field of a V1TRAP PDU. -Tg genericID Set the genericengine ID forclashes SNMPv1 TRAPs (V1TRAP). The through duplicate IDs leading to default is 0usmStatsNotInTimeWindows (coldStart)reports. -Tom trapOID mibModuleName Load the specified MIB module Setsfrom the trapOID (1.3.6.1.6.3.1.1.4.1.0) of an MIB repository specified by INFORMthe or TRAP PDU-M option. The default is mibModuleName can be 1.3.6.1.6.3.1.1.5.1. a regular expression, e.g. use -Ts specificID Set the specific ID for V1TRAP PDU. The default is 'SNMPv2-.*' to load all MIB modules in the 0. -Tu upTime repository that start with 'SNMPv2-'. -n Set the sysUpTime fieldcontextName of an INFORM, TRAP, or Set the target context name for SNMPv3 messages. V1TRAP PDU. -Y privacyPassphraseDefault Setis the privacyempty passstring. phrase for encrypted SNMPv3-p Dump sent and received packets as hex messagesstring. -ar retries authProtocol Set the authenticationnumber of protocolretries used to for requests. A zero value authenticatewill SNMPv3send messages.out Valida valuesrequest areexactly MD5once. Default andis SHA1. -bcrsl engineBootCount Set the engine boot count tolow|basic|secure Set the specifiedsecurity valuelevel strategy for auto-responses greater or equal to zero.REPORT DefaultPDUs isThe zero. default is 'low' for -cbetter community Set the community for SNMPv1/v2c messages. -d debugLevel error handling. SetUse the'secure' globalfor debugmax. levelsecurity for Log4J logging (i.e. never send outputnoAuthNoPriv). The Validbasic valueslevel areis OFF, ERROR, WARN, INFO, conforming to RFC 3412 and 3414 allowing DEBUG. -e engineID Set the authoritative engine ID of the command 'noAuthNoPriv' for engine ID discovery and wrong responder used for SNMPv3 request messages. If not username reports. -s supplied,Suppress theany engineoutput IDon willstderr be(silent discoveredmode). -ht timeout windowSize Set the window height in rows. If the value is timeout in milliseconds between retries. Default is 1000 milliseconds. greater than zero, every windowSize rows -tls-cert-fingerprint certFingerprint The fingerprint of the usertrusted iscertificate presented promptedby tothe continueremote output.SNMP Defaultengine isas zero. -ilo hex Dostring. notIf checkthe forfingerprint lexicographicdoes orderingnot errorsmatch, connection whilewill walkingnot abe subtreeestablished. UsingUse this option may causewith endless looping if an agent does not the "tls:" or "dtls:" transport domain. -tls-local-id certAlias The local certificate alias identity which selects implement lexicographic ordering correctly! -l localEngineID a certificate chain Setfrom the local engine ID of the command generator key store. Only the selected certificate chain will be presented andto the notification receiver used for SNMPv3 the remote SNMP engine. Use this option requestwith messages.the This option can be used to avoid "tls:" or "dtls:" transport domain. engine ID clashes through duplicate IDs leading to -tls-peer-id subjectDN The subject DN (e.g., "EMAILADDRESS=email@host.com, usmStatsNotInTimeWindows reports. -m mibModuleNameC=US, CN=My Name") of the trusted certificate Load the specified MIB module from the MIB presented by the remote SNMP engine ID. Use this repository specified by the -M option. The option with the "tls:" or "dtls:" transport domain. mibModuleName can be a regular expression, -tls-trust-ca issuerDN The issuer DN (e.g. use , "Company Name CA") of a 'SNMPv2-.*' to loadtrusted allcertification MIBauthority modules(CA) inpresented theby repositorythe thatremote startSNMP with 'SNMPv2-'. -nengine ID for TLS and DTLS. contextName-tls-version tlsVersion The TLS version to use Setwith the target context name for SNMPv3 messages.'tls:' transport Defaultprotocol. isCurrently the empty string. -ponly 'TLSv1', 'TLSv1.1', and Dump sent and received packets as hex 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 issecurity 1. name for authenticated v3 -s Suppress any output on stderr (silent mode)messages. -tv timeout1|2c|3 Set thethe 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