Muonics: MIB Smithy - Developer's Guide - Querying SNMP Session Parameters

Quering SNMP Session Parameters

The SNMP Session's cget subcommand is used to query configuration parameters for the given session. The parameters are generally the same as those provided by the config subcommand.

Syntax:

% snmpcmd cget parameter

..where snmpcmd is the name of session to be queried and parameter specifies configuration parameter whose value is desired.

Returns:

The current value of the specified parameter.

Session Parameters

Option	Description
`-authpass`	Returns the password that will be used when sending authenticated SNMPv3 messages. The value returned will either be an ASCII string or a colon-delimited hex string (e.g. `"0x01:02:ab:cd"`).
`-authproto`	Returns the Authentication Protocol used to send SNMPv3 authNoPriv and authPriv messages when an Authentication Password has been set. The value returned will either be `HMAC-SHA-96` or `HMAC-MD5-96`.
`-db`	Returns the name of the configured SMI Database.
`-hostname`	Returns the hostname for the host where the SDK is running.
`-localboots`	Returns value of the session's own snmpEngineBoots. This property is not currently used, but is reserved for future SNMPv3 inform support.
`-localengid`	Returns value of the session's own snmpEngineID. This property is not currently used, but is reserved for future SNMPv3 inform support.
`-localport`	Returns the port number to be used for receiving notifications if a notification handler is registered with the `bind` command.
`-localtime`	Returns value of the session's own snmpEngineTime. This property is not currently used, but is reserved for future SNMPv3 inform support.
`-logchannel`	Returns a two-element list indicating the file channels configured for logging of hex dumps of sent and received packets, respectively. Returns an empty string if logging is disabled.
`-privpass`	Returns the password that will be used when sending authenticated SNMPv3 messages. The value returned will either be an ASCII string or a colon-delimited hex string (e.g. `"0x01:02:ab:cd"`).
`-privproto`	Returns the Authentication Protocol used to send SNMPv3 authNoPriv and authPriv messages when an Authentication Password has been set. As of this writing, only `CBC-DES` is supported.
`-readcommunity`	Returns the configured community string used to transmit SNMPv1 and SNMPv2c GET, GET-NEXT and GET-BULK requests. The value returned will either be an ASCII string or a colon-delimited hex string (e.g. "0x01:02:ab:cd").
`-remoteaddress`	Returns the IP address of the configured agent to which SNMP requests are sent.
`-remoteport`	Returns the integer port number to which SNMP requests are sent.
`-retries`	Returns the number of followup attempts that will be made to complete the request if the first transmission yields no response.
`-timeout`	Returns the integer timeout (in milliseconds) waited between each transmission prior to resending or signalling a timeout to the calling script.
`-username`	Returns the SNMPv3 User Name used to send messages using the User-Based Security Model, regardless of security level. The value returned will either be an ASCII string or a colon-delimited hex string (e.g. `"0x01:02:ab:cd"`).
`-version`	Returns the configured SNMP version (SNMPv1, SNMPv2c or SNMPv3).
`-writecommunity`	Returns the configured community string used to transmit SNMPv1 and SNMPv2c SET requests. The value returned will either be an ASCII string or a colon-delimited hex string (e.g. `"0x01:02:ab:cd"`).

< Prev

Back to Table of Contents

Next >