Wiki source code of CLT create-snapshot

Last modified by Frank Fock on 2024/05/25 13:05

Show last authors
1 === create-snapshot ===
2
3 {{code language="none"}}
4 create-snapshot <file> <address> <OID>
5
6 Creates a snapshot <file> by walking the subtree specified by <OID> at the
7 agent at <address>.
8
9 Options:
10 -A authPassphrase Set the authentication pass phrase for
11 authenticated SNMPv3 messages.
12 -CB Display brief column headers. Common prefixes will
13 be dropped.
14 -CH Do not display column headers.
15 -Cb bufferSize The number of table rows to buffer before computing
16 column sizes.
17 -Cc columnWidth Print table columns with specified character width.
18 -Cf columnSeparator Separate table columns with the specified separator
19 string. The table is printed in compact form. By
20 default columns are separated by spaces and
21 aligned.
22 -Ch Display only column headers.
23 -Ci Prepend the index for each printed row.
24 -Cil lowerBoundIndex Set the lower bound index for TABLE operations.
25 -Ciu upperBoundIndex Set the upper bound index for TABLE operations.
26 -Cl Left justify all cells when printing a table.
27 -Cn non-repeaters Set the non-repeaters field for GETBULK PDUs. It
28 specifies the number of supplied variables that
29 should not be iterated over. The default is 0.
30 -Cr max-repetitions Set the max-repetitions field for GETBULK PDUs.
31 This specifies the maximum number of iterations
32 over the repeating variables. The default is 10.
33 -Cw Specify the line width when printing tables
34 -Dn Do not use any default option values stored in
35 config.
36 -E contextEngineID Set the context engine ID used for the SNMPv3
37 scoped PDU. The authoritative engine ID will be
38 used for the context engine ID, if the latter is
39 not specified.
40 -L license key Specify license and associated key. The license
41 info will be saved in the SNMP4J-CLT config file in
42 your home directory. Enter each license part
43 enclosed in quotes, for example by '-L "b6 80 4d 68
44 3a 8 c0 f4" "O?fWO-3s"'
45 -M mibRepositoryPath Set the path to the MIB repository to be used to
46 resolve object names (OIDs) and parse/format object
47 values ('repository' is the default). The
48 repository directory must contain compiled MIB
49 modules files only.
50 -Msmi mibRepositoryPath Set the path to the MIB repository to be used to
51 resolve object names (OIDs) and parse/format object
52 values ('repository' is the default). The MIB
53 repository directory must contain SMI MIB files
54 (v1/v2). The file names of the MIB files have to
55 match their MIB module name or there has to be a
56 properties file named 'module-index.properties'
57 which maps to the module file by
58 '<modulename>.path=<path>' entries.
59 -Ors maxSizeRespPDU The maximum size of the response PDU in bytes.
60 -OtCSV For each SNMP row received exactly one row of comma
61 separated values will printed to the console where
62 the first column contains the row index.
63 -Otd Activates dense table operation mode which improves
64 table retrieval performance on regular (dense)
65 tables. This option must not be used with sparse
66 tables.
67 -OttCSV Same as -OtCSV except that each row's first column
68 will report the current time (millis after
69 1.1.1970) when the request has been sent.
70 -Y privacyPassphrase Set the privacy pass phrase for encrypted SNMPv3
71 messages.
72 -a authProtocol Set the authentication protocol used to
73 authenticate SNMPv3 messages. Valid values are MD5
74 and SHA.
75 -bc engineBootCount Set the engine boot count to the specified value
76 greater or equal to zero. Default is zero.
77 -c community Set the community for SNMPv1/v2c messages.
78 -d debugLevel Set the global debug level for Log4J logging
79 output. Valid values are OFF, ERROR, WARN, INFO,
80 and DEBUG.
81 -e engineID Set the authoritative engine ID of the command
82 responder used for SNMPv3 request messages. If not
83 supplied, the engine ID will be discovered.
84 -h windowSize Set the window height in rows. If the value is
85 greater than zero, every windowSize rows the user
86 is prompted to continue output. Default is zero.
87 -l localEngineID Set the local engine ID of the command generator
88 and the notification receiver used for SNMPv3
89 request messages. This option can be used to avoid
90 engine ID clashes through duplicate IDs leading to
91 usmStatsNotInTimeWindows reports.
92 -m mibModuleName Load the specified MIB module from the MIB
93 repository specified by the -M option. The
94 mibModuleName can be a regular expression, e.g. use
95 'SNMPv2-.*' to load all MIB modules in the
96 repository that start with 'SNMPv2-'.
97 -n contextName Set the target context name for SNMPv3 messages.
98 Default is the empty string.
99 -r retries Set the number of retries used for requests. A zero
100 value will send out a request exactly once. Default
101 is 1.
102 -s Suppress any output on stderr (silent mode).
103 -t timeout Set the timeout in milliseconds between retries.
104 Default is 1000 milliseconds.
105 -u securityName Set the security name for authenticated v3
106 messages.
107 -v 1|2c|3 Set the SNMP protocol version to be used. Default
108 is 3.
109 -w consoleWidth Specifies the width of the console output, default
110 is 80 characters.
111 -y privacyProtocol Set the privacy protocol to be used to encrypt
112 SNMPv3 messages. Valid values are DES, AES
113 (AES128), AES192, AES256, and 3DES(DESEDE).
114
115 Examples:
116 SNMP4J-CLT -v 2c -c public create-snapshot /tmp/mibdump.sf 127.0.0.1/161 1.3.6
117 {{/code}}