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