| Options |
Description |
| -address
address |
Defines
the network address of the peer entity. |
| -port
port |
Defines
the UDP port which is used by the peer entity to receive messages |
| -version
number |
Sselects
the version used by a session. |
| -read
community |
v1
and v2c generator or responder sessions; It defines the read community
string which is used when invoking retrieval operations. |
| -write
community |
v1
and v2c generator or responder sessions; It defines the write community
string which is used when invoking set operations. Default = "private". |
| -notify
community |
v1
and v2c listener or notifier sessions; It defines the community string
which is used when invoking trap or inform operations. Default =
"public". |
| -user
name |
v3
sessions; It is used to define the v3 user name. The default user name
is the value of the global tnm(user) variable, which defaults to the login
name of the underlying operating system. |
| -authPassWord
password |
v3
sessions; It is used to specify the authentication password of the user.
The password is automatically converted into a key by applying the password2key
algorithm of RFC 2274.
The key is also automatically localized once the engineID of the SNMP peer
entity is known. Note that the application should take care to keep the
passwords safe from unauthorized access. |
| -privPassWord
password |
v3
sessions. It is used to specify the password of the user. The password
is automatically converted into a key by applying the password2key algorithm
of RFC 2274. The key
is also automatically localized once the engineID of the SNMP peer entity
is known. Note that the application should take care to keep the passwords
safe from unauthorized access. |
| -readSecurity
level |
v3
sessions. It allows to specify the security level for read operations.
Legal values:
noAuth/noPriv
md5/noPriv
md5/des
sha/noPriv
sha/des
Note, not all values are fully
supported in the current implementation. |
| -writeSecurity
level |
v3
sessions. It allows to specify the security level for SNMP write operations.
Legal values
-
noAuth/noPriv
-
md5/noPriv
-
md5/des
-
sha/noPriv
-
sha/des
Note, not all values are fully
supported in the current implementation. |
| -notifySecurity
level |
v3
sessions. It allows to specify the security level for notifications. Legal
values
-
noAuth/noPriv
-
md5/noPriv
-
md5/des
-
sha/noPriv
-
sha/des
Note, not all values are fully
supported in the current implementation. |
| -context
context |
The
-context option is specific to SNMPv3 sessions. It allows to select between
multiple contexts. The default context is the empty string "". |
| -engineID
id |
v3
sessions. It is used to get or set the engineID for messages. The default
is "". Note, the engineID value might change during protocol operations
when doing auto-discovery. |
| -timeout
time |
The
-timeout option defines the time the session will wait for a response.
The default is 5 seconds. This option only applies for unreliable transports
like UDP.Z |
| -retries
number |
The
-retries option defines how many times a request is retransmitted during
the timeout interval. The default = 3 reitres. This option only applies
for unreliable transports like UDP. |
| -delay
delay |
The
-delay option can be used to define a delay in milliseconds between two
messages send by the protocol engine. This can be used to avoid network
congestion problems. The default is 0 milliseconds. This option only applies
for transports without congestion control like UDP. |
| -window
size |
The
-window option allows to define a window which limits the number of active
asynchronous requests. This can be used to prevent fast scripts to flood
an agent or an intermediate system with asynchronous messages. The Tnm
extension queues requests internally so that no more than size synchronous
requests are on the wire. Setting the size to 0 turns the windowing mechanism
off. This option only applies for transports without congestion control
like UDP. |
| -alias
name |
The
-alias option substitutes this option with the configuration options contained
in the alias identified by name. You can define configuration option aliases
with the snmp alias command. It is possible to refer to other -alias options
within an -alias option. See the description of the snmp alias command
below for an example. |
| -tags
tagList |
The
-tags option is used to tag SNMP sessions. Tags are a convenient way to
group SNMP sessions that perform a single task or which belong a specific
network element. Tags are also convenient to relate SNMP sessions to network
map objects and/or management functions. |