Date: Fri, 29 Mar 2024 00:13:59 +0000 (UTC) Message-ID: <1399163073.137.1711671239917@2997b7dde346> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_136_1707109926.1711671239916" ------=_Part_136_1707109926.1711671239916 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Type
java -S= NMP4J-CLT.jar help <command>
for help on a specific command.
Type
java -j= ar SNMP4J-CLT.jar example <command>
for examples on a specific command.
Type
java -j= ar SNMP4J-CLT.jar version
to see the program version.
Type
java -j= ar SNMP4J-CLT.jar -L "<license>" "<key>" defaults list
to register your license (you then do not need to enter it for subse= quent 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>:
<address>: [upd:|tcp:]<host>[/<port>]=
Host is either an IP address or hostname and port is the SNMP port
of the target SNMP entity.
create-snapshot: create-snapshot <file> <address> <OID> defaults: defaults <action> list reset save dump-snapshot: dump-snapshot <file> example: example <command> get: get <address> <OID> [..] getbulk: [-Cr <repeaters>] [-Cn <non-repeaters>] getbulk <address= > <OID> [..] getnext: getnext <address> <OID> [..] help: help [command]|all inform: inform <address> <OID>=3D{<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>=3D{<type>}<value> [..] smi: smi <OID> [..] table: table <address> <OID> [..] trap: [-To <notificationID>] trap <address> <OID>=3D{<ty= pe>}<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&= gt; <address> [<user> ..] usmDHKickstartRun: usmDHKickstartRun -privateKeysFile <dhKickstartPrivKeys.properties&g= t; <address> [<user> ..] usmKey: usmKey auth|priv|authPriv <address> <old> <new> [<= user>] auth usmKey auth <address> <old> <new> [<user&g= t;] priv usmKey priv <address> <old> <new> [<user&g= t;] authPriv usmKey authPriv <address> <oldpwd> <newpwd&g= t; [<user>] usmUser: usmUser create|delete <address> <user> [<cloneFromUser&g= t; [<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>=3D{= <type>}<value> [..] version: version walk: walk <address> <OID> xml: xml <output-dir> OPTIONS: -A authPassphrase Set the authentication pass phrase for=20 authenticated SNMPv3 messages. -CB Display brief column headers. Common prefixes w= ill=20 be dropped. -CE usmUserTableEngineID Set usmUserTableEngineID to be used as part = of=20 the index of the usmUserTable. Default is to us= e=20 the authoritative engine ID (set via -e or prob= ed)=20 as the usmUserTableEngineID. -CH Do not display column headers. -Cb bufferSize The number of table rows to buffer before compu= ting column sizes. -Cc columnWidth Print table columns with specified character wi= dth. -Cf columnSeparator Separate table columns with the specified separ= ator string. The table is printed in compact form. B= y=20 default columns are separated by spaces and=20 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. I= t=20 specifies the number of supplied variables that= =20 should not be iterated over. The default is 0. -Cr max-repetitions Set the max-repetitions field for GETBULK PDUs.= =20 This specifies the maximum number of iterations= =20 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=20 the TLS protocol. -Djavax.net.ssl.keyStorePassword keyStorePassword The password for the = key=20 store file with SSL keys for TLS. -Djavax.net.ssl.trustStore keyStoreFile The trust store file with trust= ed=20 (public) SSL keys for the TLS protocol. -Djavax.net.ssl.trustStorePassword keyStorePassword The password for th= e=20 trust store file. -Dn Do not use any default option values stored in= =20 config. -E contextEngineID Set the context engine ID used for the SNMPv3= =20 scoped PDU. The authoritative engine ID will be= =20 used for the context engine ID, if the latter i= s=20 not specified. -L license key Specify license and associated key. The license= =20 info will be saved in the SNMP4J-CLT config fil= e in your home directory. Enter each license part=20 enclosed in quotes, for example by '-L "b6 80 4= d 68 3a 8 c0 f4" "O?fWO-3s"' -M mibRepositoryPath Set the path to the MIB repository to be used t= o=20 resolve object names (OIDs) and parse/format ob= ject values ('repository' is the default). The=20 repository directory must contain compiled MIB= =20 modules files only. -Oesc escapeCharacter Escape character used in non-printable OCTET-ST= RING values to print them as strings (instead of=20 hex-strings). Default is '_' and 'x' disables= =20 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 c= omma separated values will printed to the console wh= ere=20 the first column contains the row index. -Otd Activates dense table operation mode which impr= oves table retrieval performance on regular (dense)= =20 tables. This option must not be used with spars= e=20 tables. -OttCSV Same as -OtCSV except that each row's first col= umn=20 will report the current time (millis after=20 1.1.1970) when the request has been sent. -Ta agentAddress Set the agent address field of a V1TRAP PDU. Th= e=20 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). T= he=20 default is 0 (coldStart). -To trapOID Sets the trapOID (1.3.6.1.6.3.1.1.4.1.0) of an= =20 INFORM or TRAP PDU. The default is=20 1.3.6.1.6.3.1.1.5.1. -Ts specificID Set the specific ID for V1TRAP PDU. The default= is=20 0. -Tu upTime Set the sysUpTime field of an INFORM, TRAP, or= =20 V1TRAP PDU. -Y privacyPassphrase Set the privacy pass phrase for encrypted SNMPv= 3=20 messages. -a authProtocol Set the authentication protocol used to=20 authenticate SNMPv3 messages. Valid values are = MD5=20 and SHA, SHA224, SHA256, SHA384, and SHA512. -b bindAddress Set local interface and port to use for outgoin= g=20 SNMP messages. By default this is 0.0.0.0/0 (ho= st=20 chosen port on all local IPv4 addresses). -bc engineBootCount Set the engine boot count to the specified valu= e=20 greater or equal to zero. Default is zero. -c community Set the community for SNMPv1/v2c messages. -createAndWait Use the createAndWait(5) RowStatus to create ne= w=20 rows instead of createAndGo(4) which might not = be=20 supported on certain devices. -d debugLevel Set the global debug level for Log4J logging=20 output. Valid values are OFF, ERROR, WARN, INFO= ,=20 and DEBUG. -dhp usmDHParameters The octet string (provided as colon separated= =20 hexadecimal string) containing the BER encoded= =20 ASN.1 sequence of prime (p) and base (g) as def= ined by RFC2786 usmDHParamters OBJECT-TYPE. The defa= ult=20 value is (without line breaks): 10:69:02:61:00:ff:ff:ff:ff:ff:ff:ff:ff:c9:0f: da:a2:21:68:c2:34:c4:c6:62:8b:80:dc:1c:d1:29: 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: 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: 3a:36:20:ff:ff:ff:ff:ff:ff:ff:ff:02:01:02:02: 01:10 -dhx diffieHellmanPropertyPrefix The property prefix used with the=20 privateKeysFile for the usmDHKickstartInit and= =20 usmDHKickstartRun commands. By default=20 'org.snmp4j.' is used. -dtls-version dtlsVersion Specifies the DTLS version to use. Possible= =20 values are DTLSv1.0 and DTLSv1.2 (default). -e engineID Set the authoritative engine ID of the command= =20 responder used for SNMPv3 request messages. If = not=20 supplied, the engine ID will be discovered. -f 1|2|3|4 Set the OID output format, where 1 =3D numeric,= 2 =3D=20 last name and numeric index, 3 =3D last name an= d=20 formatted index without quoting, and 4 =3D last= name=20 and formatted index including hex-formatting of= =20 non-printable strings. The default is 4. -h windowSize Set the window height in rows. If the value is= =20 greater than zero, every windowSize rows the us= er=20 is prompted to continue output. Default is zero= . -ilo Do not check for lexicographic ordering errors= =20 while walking a subtree. Using this option may= =20 cause endless looping if an agent does not=20 implement lexicographic ordering correctly! -l localEngineID Set the local engine ID of the command generato= r=20 and the notification receiver used for SNMPv3= =20 request messages. This option can be used to av= oid=20 engine ID clashes through duplicate IDs leading= to=20 usmStatsNotInTimeWindows reports. -m mibModuleName Load the specified MIB module from the MIB=20 repository specified by the -M option. The=20 mibModuleName can be a regular expression, e.g.= use 'SNMPv2-.*' to load all MIB modules in the=20 repository that start with 'SNMPv2-'. -n contextName Set the target context name for SNMPv3 messages= .=20 Default is the empty string. -p Dump sent and received packets as hex string. -r retries Set the number of retries used for requests. A = zero value will send out a request exactly once. Def= ault is 1. -rsl low|basic|secure Set the security level strategy for auto-respon= ses=20 to REPORT PDUs The default is 'low' for better= =20 error handling. Use 'secure' for max. security= =20 (i.e. never send noAuthNoPriv). The basic level= is=20 conforming to RFC 3412 and 3414 allowing=20 'noAuthNoPriv' for engine ID discovery and wron= g=20 username reports. -s Suppress any output on stderr (silent mode). -t timeout Set the timeout in milliseconds between retries= .=20 Default is 1000 milliseconds. -tls-cert-fingerprint certFingerprint The fingerprint of the trusted=20 certificate presented by the remote SNMP engine= as=20 hex string. If the fingerprint does not match,= =20 connection will not be established. Use this op= tion with the "tls:" or "dtls:" transport domain. -tls-local-id certAlias The local certificate alias identity which sele= cts=20 a certificate chain from the local key store. O= nly=20 the selected certificate chain will be presente= d to the remote SNMP engine. Use this option with th= e=20 "tls:" or "dtls:" transport domain. -tls-peer-id subjectDN The subject DN (e.g., "EMAILADDRESS=3Demail@hos= t.com, C=3DUS, CN=3DMy Name") of the trusted certifica= te=20 presented by the remote SNMP engine ID. Use thi= s=20 option with the "tls:" or "dtls:" transport dom= ain. -tls-trust-ca issuerDN The issuer DN (e.g., "Company Name CA") of a=20 trusted certification authority (CA) presented = by=20 the remote SNMP engine ID for TLS and DTLS. -tls-version tlsVersion The TLS version to use with the 'tls:' transpor= t=20 protocol. Currently only 'TLSv1', 'TLSv1.1', an= d=20 'TLSv1.2' are supported with Java 7 or later.= =20 'TLSv1' is the default which is supported with = Java 6 too. -u securityName Set the security name for authenticated v3=20 messages. -v 1|2c|3 Set the SNMP protocol version to be used. Defau= lt=20 is 3. -w consoleWidth Specifies the width of the console output, defa= ult=20 is 80 characters. -y privacyProtocol Set the privacy protocol to be used to encrypt= =20 SNMPv3 messages. Valid values are DES, AES=20 (AES128), AES192, AES256, AES192p, AES256p, and= =20 3DES(DESEDE). The AES protocols that end with '= p'=20 (for proprietary) are using a non-standardized = key=20 extension algorithm from 3DES. Up