Skip to end of metadata
Go to start of metadata

SNMP4J Command-Line Tool, version 2.0

Type

for help on a specific command.
Type

for examples on a specific command.
Type

to see the program version.
Type

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>:

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

<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>

 Creates a snapshot <file> by walking the subtree specified by <OID> at the
    agent at <address>.

defaults:
    defaults <action>

 Manage the 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.
    list:
    List all MIB modules in 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.


usmKey:
    usmKey auth|priv|authPriv <address> <old> <new> [<user>]

 Change the key(s) of an USM user. This command requires the usage of a 
    SNMPv3 user, thus the options "-v 3" and "-u <user>" are mandatory.
    auth:
    usmKey auth <address> <old> <new> [<user>]

 Change the authentication key (passphrase) of the current (-u user) or the
    specified <user>.
    priv:
    usmKey priv <address> <old> <new> [<user>]

 Change the privacy key (passphrase) of the current (-u user) or the 
    specified <user>.
    authPriv:
    usmKey authPriv <address> <old> <new> [<user>]

 Change both, the authentication and the privacy key (passphrase) of the 
    current (-u user) or the specified <user>.


usmUser:
    usmUser create|delete <address> <user> [<cloneFromUser> [<cloneFromEngineID>]]

 Create and delete entries in the USM user table. This command requires the
    usage of a SNMPv3 user, thus the options "-v 3" and "-u <user>" are 
    mandatory.
    create:
    [-CE <usmUserEngineID>] [-createAndWait] usmUser create <address> <user> [<cloneFromUser> [<cloneFromEngineID>]]

 Create an USM <user> at the SNMP entity identified by <address>. If 
    <cloneFromUser> is not specified then the new user will be cloned from the 
    user specified with the -u option (which is mandatory for this command), 
    otherwise the <cloneFormUser> is used. The <cloneFromEngineID> can be 
    specified if the engine ID of the template user does not match the 
    <usmUserEngineID> and/or does not match theauthoritative engine ID of the 
    agent.
    delete:
    [-CE <usmUserEngineID>] usmUser delete <address> <user>

 Delete an USM user from the USM of a SNMPv3 entity.


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 
                            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.
    -Msmi 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 MIB 
                            repository directory must contain SMI MIB files 
                            (v1/v2). The file names of the MIB files have to 
                            match their MIB module name or there has to be a 
                            properties file named 'module-index.properties' 
                            which maps to the module file by 
                            '<modulename>.path=<path>' entries.
    -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 encrypted SNMPv3 
                            messages.
    -a    authProtocol      Set the authentication protocol used to 
                            authenticate SNMPv3 messages. Valid values are MD5 
                            and SHA.
    -bc   engineBootCount   Set the engine boot count to the specified value 
                            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 new 
                            rows instead of createAndGo(4) which might not be 
                            supported on certain devices.
    -d    debugLevel        Set the global debug level for Log4J logging 
                            output. Valid values are OFF, ERROR, WARN, INFO, 
                            and DEBUG.
    -e    engineID          Set the authoritative engine ID of the command 
                            responder used for SNMPv3 request messages. If not 
                            supplied, the engine ID will be discovered.
    -f    1|2|3|4           Set the OID output format, where 1 = numeric, 2 = 
                            last name and numeric index, 3 = last name and 
                            formatted index without quoting, and 4 = last name 
                            and formatted index including hex-formatting of 
                            non-printable strings. The default is 4.
    -h    windowSize        Set the window height in rows. If the value is 
                            greater than zero, every windowSize rows the user 
                            is prompted to continue output. Default is zero.
    -ilo                    Do not check for lexicographic ordering errors 
                            while walking a subtree. Using this option may 
                            cause endless looping if an agent does not 
                            implement lexicographic ordering correctly!
    -l    localEngineID     Set the local engine ID of the command generator 
                            and the notification receiver used for SNMPv3 
                            request messages. This option can be used to avoid 
                            engine ID clashes through duplicate IDs leading to 
                            usmStatsNotInTimeWindows reports.
    -m    mibModuleName     Load the specified MIB module from the MIB 
                            repository specified by the -M option. The 
                            mibModuleName can be a regular expression, e.g. use
                            'SNMPv2-.*' to load all MIB modules in the 
                            repository that start with 'SNMPv2-'.
    -n    contextName       Set the target context name for SNMPv3 messages. 
                            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. Default
                            is 1.
    -rsl  low|basic|secure  Set the security level strategy for auto-responses 
                            to REPORT PDUs The default is 'low' for better 
                            error handling. Use 'secure' for max. security 
                            (i.e. never send noAuthNoPriv). The basic level is 
                            conforming to RFC 3412 and 3414 allowing 
                            'noAuthNoPriv' for engine ID discovery and wrong 
                            username reports.
    -s                      Suppress any output on stderr (silent mode).
    -t    timeout           Set the timeout in milliseconds between retries. 
                            Default is 1000 milliseconds.
    -tls-local-id certAlias The local certificate alias identity which selects 
                            a certificate chain from the local key store. Only 
                            the selected certificate chain will be presented to
                            the remote SNMP engine. Use this option with the 
                            "tls:" transport domain.
    -tls-peer-id subjectDN  The subject DN (e.g., "EMAILADDRESS=email@host.com,
                            C=US, CN=My Name") of the trusted certificate 
                            presented by the remote SNMP engine ID. Use this 
                            option with the "tls:" transport domain.
    -tls-trust-ca issuerDN  The issuer DN (e.g., "Company Name CA") of a 
                            trusted certification authority (CA) presented by 
                            the remote SNMP engine ID.
    -tls-version tlsVersion The TLS version to use with the 'tls:' transport 
                            protocol. Currently only 'TLSv1', 'TLSv1.1', and 
                            'TLSv1.2' are supported with Java 7 or later. 
                            'TLSv1' is the default which is supported with Java
                            6 too.
    -u    securityName      Set the security name for authenticated v3 
                            messages.
    -v    1|2c|3            Set the SNMP protocol version to be used. Default 
                            is 3.
    -w    consoleWidth      Specifies the width of the console output, default 
                            is 80 characters.
    -y    privacyProtocol   Set the privacy protocol to be used to encrypt 
                            SNMPv3 messages. Valid values are DES, AES 
                            (AES128), AES192, AES256, AES192p, AES256p, and 
                            3DES(DESEDE). The AES protocols that end with 'p' 
                            (for proprietary) are using a non-standardized key 
                            extension algorithm from 3DES.
  • No labels