|
Packit |
fcad23 |
.TH SNMP.CONF 5 "21 Apr 2010" VVERSIONINFO "Net-SNMP"
|
|
Packit |
fcad23 |
.SH NAME
|
|
Packit |
fcad23 |
snmp.conf - configuration files for the Net-SNMP applications
|
|
Packit |
fcad23 |
.SH DESCRIPTION
|
|
Packit |
fcad23 |
Applications built using the Net-SNMP libraries typically use one or
|
|
Packit |
fcad23 |
more configuration files to control various aspects of their operation.
|
|
Packit |
fcad23 |
These files (\fBsnmp.conf\fR and \fBsnmp.local.conf\fR) can be located
|
|
Packit |
fcad23 |
in one of several locations, as described in the \fIsnmp_config(5)\fR
|
|
Packit |
fcad23 |
manual page.
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
In particular, \fCSYSCONFDIR/snmp/snmp.conf\fR is a common file,
|
|
Packit |
fcad23 |
containing the settings shared by all users of the system.
|
|
Packit |
fcad23 |
\fC~/.snmp/snmp.conf\fR is a personal file, with the settings
|
|
Packit |
fcad23 |
specific to a particular user.
|
|
Packit |
fcad23 |
.SH HOST-SPECIFIC FILES
|
|
Packit |
fcad23 |
Host-specific files may also be loaded and will be searched for if a
|
|
Packit |
fcad23 |
transport name is specified that matches a \fIPATH/hosts/HOST.conf\fR
|
|
Packit |
fcad23 |
file. For example, if you wanted a particular host to use SNMPv2c by
|
|
Packit |
fcad23 |
default you could create a ~/.snmp/hosts/NAME.conf file and in it put:
|
|
Packit |
fcad23 |
.RS
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
defVersion 2c
|
|
Packit |
fcad23 |
.RE
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
Any connections set to connect to the hostname \fINAME\fR will use
|
|
Packit |
fcad23 |
SNMPv2c. Also see the \fItransport\fR token below for additional
|
|
Packit |
fcad23 |
host-specific examples.
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
Host-specific configuration files are loaded at the time the
|
|
Packit |
fcad23 |
connection is opened. Thus they're generally loaded after all other
|
|
Packit |
fcad23 |
configuration files and can be used to override settings from the
|
|
Packit |
fcad23 |
generic files.
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
To avoid loading any host-specific config files set
|
|
Packit |
fcad23 |
"dontLoadHostConfig true" in your snmp.conf file.
|
|
Packit |
fcad23 |
.SH COMMAND-LINE OPTIONS
|
|
Packit |
fcad23 |
All of the tokens described in this file can be used on the command
|
|
Packit |
fcad23 |
line of Net-SNMP applications as well by prefixing them with "\-\-".
|
|
Packit |
fcad23 |
EG, specifying \fI\-\-dontLoadHostConfig=true\fR on the command line will
|
|
Packit |
fcad23 |
turn of loading of the host specific configuration files.
|
|
Packit |
fcad23 |
.SH IMPORTANT NOTE
|
|
Packit |
fcad23 |
Several of these directives may contain sensitive information
|
|
Packit |
fcad23 |
(such as pass phrases). Configuration files that include such
|
|
Packit |
fcad23 |
settings should only be readable by the user concerned.
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
As well as application-specific configuration tokens, there are
|
|
Packit |
fcad23 |
several directives that relate to standard library behaviour,
|
|
Packit |
fcad23 |
relevant to most Net-SNMP applications. Many of these correspond
|
|
Packit |
fcad23 |
to standard command-line options, which are described in the
|
|
Packit |
fcad23 |
\fIsnmpcmd(1)\fR manual page.
|
|
Packit |
fcad23 |
.PP
|
|
Packit |
fcad23 |
These directives can be divided into several distinct groups.
|
|
Packit |
fcad23 |
.SH CLIENT BEHAVIOUR
|
|
Packit |
fcad23 |
.IP "defDomain application domain"
|
|
Packit |
fcad23 |
The transport domain that should be used for a certain application type unless
|
|
Packit |
fcad23 |
something else is specified.
|
|
Packit |
fcad23 |
.IP "defTarget application domain target"
|
|
Packit |
fcad23 |
The target that should be used for connections to a certain application if the
|
|
Packit |
fcad23 |
connection should be in a specific domain.
|
|
Packit |
fcad23 |
.IP "defaultPort PORT"
|
|
Packit |
fcad23 |
defines the default UDP port that client SNMP applications will
|
|
Packit |
fcad23 |
attempt to connect to. This can be overridden by explicitly
|
|
Packit |
fcad23 |
including a port number in the \fIAGENT\fR specification.
|
|
Packit |
fcad23 |
See the \fIsnmpcmd(1)\fR manual page for more details.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, the default value for this token is 161.
|
|
Packit |
fcad23 |
.IP "transport HOSTSPECIFIER"
|
|
Packit |
fcad23 |
This special token should go into a hostname-specific configuration
|
|
Packit |
fcad23 |
file in a \fIhosts\fR sub-directory. For example if the file
|
|
Packit |
fcad23 |
\fIhosts/foo.conf\fR exists in the search path it will be loaded if a
|
|
Packit |
fcad23 |
transport name of \fIfoo\fR was used. Within the foo.conf file you may
|
|
Packit |
fcad23 |
put both general snmp.conf settings as well as a special
|
|
Packit |
fcad23 |
\fItransport\fR string to specify the destination to connect to. For
|
|
Packit |
fcad23 |
example, putting:
|
|
Packit |
fcad23 |
.RS
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
transport tcp:foo.example.com:9876
|
|
Packit |
fcad23 |
.RE
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
in the \fIhosts/foo.conf\fR file will make applications referencing
|
|
Packit |
fcad23 |
the \fIfoo\fR hostname (e.g. \fIsnmpget\fR) to actually connect via
|
|
Packit |
fcad23 |
TCP to \fIfoo.exmaple.com\fR on port 9876.
|
|
Packit |
fcad23 |
.IP "defVersion (1|2c|3)"
|
|
Packit |
fcad23 |
defines the default version of SNMP to use.
|
|
Packit |
fcad23 |
This can be overridden using the \fB\-v\fR option.
|
|
Packit |
fcad23 |
.IP "defCommunity STRING"
|
|
Packit |
fcad23 |
defines the default community to use for SNMPv1 and SNMPv2c requests.
|
|
Packit |
fcad23 |
This can be overridden using the \fB\-c\fR option.
|
|
Packit |
fcad23 |
.\".IP "dumpPacket (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
.IP "alias NAME DEFINITION"
|
|
Packit |
fcad23 |
Creates an aliased tied to NAME for a given transport definition. The
|
|
Packit |
fcad23 |
alias can the be referred to using an alias: prefix. Eg, a line of
|
|
Packit |
fcad23 |
"alias here udp:127.0.0.1:6161" would allow you to use a destination
|
|
Packit |
fcad23 |
host of "alias:here" instead of "udp:127.0.0.1:6161". This becomes
|
|
Packit |
fcad23 |
more useful with complex transport addresses involving IPv6 addresses,
|
|
Packit |
fcad23 |
etc.
|
|
Packit |
fcad23 |
.IP "dumpPacket yes"
|
|
Packit |
fcad23 |
defines whether to display a hexadecimal dump of the raw SNMP requests
|
|
Packit |
fcad23 |
sent and received by the application.
|
|
Packit |
fcad23 |
This is equivalent to the \fB\-d\fR option.
|
|
Packit |
fcad23 |
.IP "doDebugging (1|0)"
|
|
Packit |
fcad23 |
turns on debugging for all applications run if set to 1.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" XXX - why not full boolean values?
|
|
Packit |
fcad23 |
.\" what is the purpose of this directive ??
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.IP "debugTokens TOKEN[,TOKEN...]"
|
|
Packit |
fcad23 |
defines the debugging tokens that should be turned on when
|
|
Packit |
fcad23 |
\fIdoDebugging\fR is set.
|
|
Packit |
fcad23 |
This is equivalent to the \fB\-D\fR option.
|
|
Packit |
fcad23 |
.IP "debugLogLevel (emerg|alert|crit|err|warning|notice|info|debug)"
|
|
Packit |
fcad23 |
Set the priority level for logging of debug output. Defaults to debug.
|
|
Packit |
fcad23 |
.\".IP "16bitIDs (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
.IP "16bitIDs yes"
|
|
Packit |
fcad23 |
restricts requestIDs, etc to 16-bit values.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
The SNMP specifications define these ID fields as 32-bit quantities,
|
|
Packit |
fcad23 |
and the Net-SNMP library typically initialises them to random values
|
|
Packit |
fcad23 |
for security.
|
|
Packit |
fcad23 |
However certain (broken) agents cannot handle ID values greater than
|
|
Packit |
fcad23 |
2^16 - this option allows interoperability with such agents.
|
|
Packit |
fcad23 |
.IP "clientaddr [<transport-specifier>:]<transport-address>"
|
|
Packit |
fcad23 |
specifies the source address to be used by command-line applications
|
|
Packit |
fcad23 |
when sending SNMP requests. See \fIsnmpcmd(1)\fR for more information
|
|
Packit |
fcad23 |
about the format of addresses.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
This value is also used by \fBsnmpd\fR when generating notifications.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" But not responses to an incoming request?
|
|
Packit |
fcad23 |
.\" What about snmptrapd?
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.IP "clientaddrUsesPort no"
|
|
Packit |
fcad23 |
specifies, if clientaddr option contains a port number. Set this option
|
|
Packit |
fcad23 |
to "yes", if clientaddr contains a port number and this port should
|
|
Packit |
fcad23 |
be used for sending outgoing SNMP requests.
|
|
Packit |
fcad23 |
.IP "clientRecvBuf INTEGER"
|
|
Packit |
fcad23 |
specifies the desired size of the buffer to be used when receiving
|
|
Packit |
fcad23 |
responses to SNMP requests.
|
|
Packit |
fcad23 |
If the OS hard limit is lower than the \fIclientRecvBuf\fR value,
|
|
Packit |
fcad23 |
then this will be used instead.
|
|
Packit |
fcad23 |
Some platforms may decide to increase the size of the buffer
|
|
Packit |
fcad23 |
actually used for internal housekeeping.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
This directive will be ignored if the platforms does not support
|
|
Packit |
fcad23 |
\fIsetsockopt()\fR.
|
|
Packit |
fcad23 |
.IP "clientSendBuf INTEGER"
|
|
Packit |
fcad23 |
is similar to \fIclientRecvBuf\fR, but applies to the size
|
|
Packit |
fcad23 |
of the buffer used when sending SNMP requests.
|
|
Packit |
fcad23 |
.IP "noRangeCheck yes"
|
|
Packit |
fcad23 |
disables the validation of varbind values against the MIB definition
|
|
Packit |
fcad23 |
for the relevant OID.
|
|
Packit |
fcad23 |
This is equivalent to the \fB\-Ir\fR option.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
This directive is primarily relevant to the \fBsnmpset\fR command,
|
|
Packit |
fcad23 |
but will also apply to any application that calls \fIsnmp_add_var()\fR
|
|
Packit |
fcad23 |
.\" what else ??
|
|
Packit |
fcad23 |
with a non-NULL value.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" XXX - including snmpd ??
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.IP "noTokenWarnings"
|
|
Packit |
fcad23 |
disables warnings about unknown config file tokens.
|
|
Packit |
fcad23 |
.IP "reverseEncodeBER (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
controls how the encoding of SNMP requests is handled.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
The default behaviour is to encode packets starting from the end of
|
|
Packit |
fcad23 |
the PDU and working backwards.
|
|
Packit |
fcad23 |
This directive can be used to disable this behaviour, and build
|
|
Packit |
fcad23 |
the encoded request in the (more obvious) forward direction.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
It should not normally be necessary to change this setting, as
|
|
Packit |
fcad23 |
the encoding is basically the same in either case - but working
|
|
Packit |
fcad23 |
backwards typically produces a slightly more efficient encoding,
|
|
Packit |
fcad23 |
and hence a smaller network datagram.
|
|
Packit |
fcad23 |
.IP "dontLoadHostConfig (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Specifies whether or not the host-specific configuration files are
|
|
Packit |
fcad23 |
loaded. Set to "true" to turn off the loading of the host specific
|
|
Packit |
fcad23 |
configuration files.
|
|
Packit |
fcad23 |
.IP "retries INTEGER"
|
|
Packit |
fcad23 |
Specifies the number of retries to be used in the requests.
|
|
Packit |
fcad23 |
.IP "timeout INTEGER"
|
|
Packit |
fcad23 |
Specifies the timeout in seconds between retries.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" XXX - It is probably about time to remove this choice!
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.SH SNMPv1/SNMPv2c SETTINGS
|
|
Packit |
fcad23 |
.IP "disableSNMPv1 (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
.IP "disableSNMPv2c (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Disables protocol versions at runtime. Incoming and outgoing packets for
|
|
Packit |
fcad23 |
the protocol will be dropped.
|
|
Packit |
fcad23 |
.SH SNMPv3 SETTINGS
|
|
Packit |
fcad23 |
.IP "disableSNMPv3 (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Disables protocol versions at runtime. Incoming and outgoing packets for
|
|
Packit |
fcad23 |
the protocol will be dropped.
|
|
Packit |
fcad23 |
.IP "defSecurityName STRING"
|
|
Packit |
fcad23 |
defines the default security name to use for SNMPv3 requests.
|
|
Packit |
fcad23 |
This can be overridden using the \fB\-u\fR option.
|
|
Packit |
fcad23 |
.IP "defSecurityLevel noAuthNoPriv|authNoPriv|authPriv"
|
|
Packit |
fcad23 |
defines the default security level to use for SNMPv3 requests.
|
|
Packit |
fcad23 |
This can be overridden using the \fB\-l\fR option.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, the default value for this token is \fInoAuthNoPriv\fR.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" XXX - Is this correct ?
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.RS
|
|
Packit |
fcad23 |
.IP "Note:
|
|
Packit |
fcad23 |
\fIauthPriv\fR is only available if the software has been compiled
|
|
Packit |
fcad23 |
to use the OpenSSL libraries.
|
|
Packit |
fcad23 |
.RE
|
|
Packit |
fcad23 |
.IP "defPassphrase STRING"
|
|
Packit |
fcad23 |
.IP "defAuthPassphrase STRING"
|
|
Packit |
fcad23 |
.IP "defPrivPassphrase STRING"
|
|
Packit |
fcad23 |
define the default authentication and privacy pass phrases to use
|
|
Packit |
fcad23 |
for SNMPv3 requests.
|
|
Packit |
fcad23 |
These can be overridden using the \fB\-A\fR and \fB\-X\fR options respectively.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
The
|
|
Packit |
fcad23 |
.B defPassphrase
|
|
Packit |
fcad23 |
value will be used for the authentication and/or privacy pass phrases
|
|
Packit |
fcad23 |
if either of the other directives are not specified.
|
|
Packit |
fcad23 |
.IP "defAuthType MD5|SHA|SHA-512|SHA-384|SHA-256|SHA-224"
|
|
Packit |
fcad23 |
.IP "defPrivType DES|AES"
|
|
Packit |
fcad23 |
define the default authentication and privacy protocols to use for
|
|
Packit |
fcad23 |
SNMPv3 requests.
|
|
Packit |
fcad23 |
These can be overridden using the \fB\-a\fR and \fB\-x\fR options respectively.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, SNMPv3 requests will default to MD5 authentication
|
|
Packit |
fcad23 |
and DES encryption.
|
|
Packit |
fcad23 |
.RS
|
|
Packit |
fcad23 |
.IP "Note:
|
|
Packit |
fcad23 |
If the software has not been compiled to use the OpenSSL libraries,
|
|
Packit |
fcad23 |
then only MD5 authentication is supported.
|
|
Packit |
fcad23 |
Neither SHA authentication nor any form of encryption will be available.
|
|
Packit |
fcad23 |
.RE
|
|
Packit |
fcad23 |
.IP "defContext STRING"
|
|
Packit |
fcad23 |
defines the default context to use for SNMPv3 requests.
|
|
Packit |
fcad23 |
This can be overridden using the \fB\-n\fR option.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, the default value for this token is the default context
|
|
Packit |
fcad23 |
(i.e. the empty string "").
|
|
Packit |
fcad23 |
.IP "defSecurityModel STRING"
|
|
Packit |
fcad23 |
defines the security model to use for SNMPv3 requests.
|
|
Packit |
fcad23 |
The default value is "usm" which is the only widely
|
|
Packit |
fcad23 |
used security model for SNMPv3.
|
|
Packit |
fcad23 |
.IP "defAuthMasterKey 0xHEXSTRING"
|
|
Packit |
fcad23 |
.IP "defPrivMasterKey 0xHEXSTRING"
|
|
Packit |
fcad23 |
.IP "defAuthLocalizedKey 0xHEXSTRING"
|
|
Packit |
fcad23 |
.IP "defPrivLocalizedKey 0xHEXSTRING"
|
|
Packit |
fcad23 |
define the (hexadecimal) keys to be used for SNMPv3 secure communications.
|
|
Packit |
fcad23 |
SNMPv3 keys are frequently derived from a passphrase, as discussed in
|
|
Packit |
fcad23 |
the \fIdefPassphrase\fR section above. However for improved security a
|
|
Packit |
fcad23 |
truely random key can be generated and used instead (which would
|
|
Packit |
fcad23 |
normally has better entropy than a password unless it is
|
|
Packit |
fcad23 |
amazingly long).
|
|
Packit |
fcad23 |
The directives are equivalent to the short-form
|
|
Packit |
fcad23 |
command line options \fB\-3m\fR, \fB\-3M\fR, \fB\-3k\fR, and \fB\-3K\fR.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
Localized keys are
|
|
Packit |
fcad23 |
master keys which have been converted to a unique key which is only
|
|
Packit |
fcad23 |
suitable for on particular SNMP engine (agent). The length of the key
|
|
Packit |
fcad23 |
needs to be appropriate for the authentication or encryption type
|
|
Packit |
fcad23 |
being used (auth keys: MD5=16 bytes, SHA1=20 bytes;
|
|
Packit |
fcad23 |
priv keys: DES=16 bytes (8
|
|
Packit |
fcad23 |
bytes of which is used as an IV and not a key), and AES=16 bytes).
|
|
Packit |
fcad23 |
.IP "sshtosnmpsocket PATH"
|
|
Packit |
fcad23 |
Sets the path of the \fBsshtosnmp\fR socket created by an application
|
|
Packit |
fcad23 |
(e.g. snmpd) listening for incoming ssh connections through the
|
|
Packit |
fcad23 |
\fBsshtosnmp\fR unix socket.
|
|
Packit |
fcad23 |
.IP "sshtosnmpsocketperms MODE [OWNER [GROUP]]"
|
|
Packit |
fcad23 |
Sets the mode, owner and group of the \fBsshtosnmp\fR socket created by
|
|
Packit |
fcad23 |
an application (e.g. \fBsnmpd\fR) listening for incoming ssh connections
|
|
Packit |
fcad23 |
through the \fBsshtosnmp\fR unix socket. The socket needs to be read/write
|
|
Packit |
fcad23 |
privileged for SSH users that are allowed to connect to the SNMP
|
|
Packit |
fcad23 |
service (VACM access still needs to be granted as well, most likely
|
|
Packit |
fcad23 |
through the TSM security model).
|
|
Packit |
fcad23 |
.IP "sshusername NAME"
|
|
Packit |
fcad23 |
Sets the SSH user name for logging into the remote system.
|
|
Packit |
fcad23 |
.IP "sshpubkey FILE"
|
|
Packit |
fcad23 |
Set the public key file to use when connecting to a remote system.
|
|
Packit |
fcad23 |
.IP "sshprivkey FILE"
|
|
Packit |
fcad23 |
Set the private key file to use when connecting to a remote system.
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.\" XXX - are these lengths still correct ?
|
|
Packit |
fcad23 |
.\"
|
|
Packit |
fcad23 |
.SH SERVER BEHAVIOUR
|
|
Packit |
fcad23 |
.IP "persistentDir DIRECTORY"
|
|
Packit |
fcad23 |
defines the directory where \fBsnmpd\fR and \fBsnmptrapd\fR store
|
|
Packit |
fcad23 |
persistent configuration settings.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, the persistent directory defaults to
|
|
Packit |
fcad23 |
PERSISTENT_DIRECTORY
|
|
Packit |
fcad23 |
.IP "noPersistentLoad yes"
|
|
Packit |
fcad23 |
.IP "noPersistentSave yes"
|
|
Packit |
fcad23 |
disable the loading and saving of persistent configuration information.
|
|
Packit |
fcad23 |
.RS
|
|
Packit |
fcad23 |
.IP "Note:"
|
|
Packit |
fcad23 |
This will break SNMPv3 operations (and other behaviour that relies
|
|
Packit |
fcad23 |
on changes persisting across application restart). Use With Care.
|
|
Packit |
fcad23 |
.RE
|
|
Packit |
fcad23 |
.IP "tempFilePattern PATTERN"
|
|
Packit |
fcad23 |
defines a filename template for creating temporary files,
|
|
Packit |
fcad23 |
for handling input to and output from external shell commands.
|
|
Packit |
fcad23 |
Used by the \fImkstemp()\fR and \fImktemp()\fR functions.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
If not specified, the default pattern is \fCNETSNMP_TEMP_FILE_PATTERN\fR.
|
|
Packit |
fcad23 |
.IP "serverRecvBuf INTEGER"
|
|
Packit |
fcad23 |
specifies the desired size of the buffer to be used when receiving
|
|
Packit |
fcad23 |
incoming SNMP requests.
|
|
Packit |
fcad23 |
If the OS hard limit is lower than the \fIserverRecvBuf\fR value,
|
|
Packit |
fcad23 |
then this will be used instead.
|
|
Packit |
fcad23 |
Some platforms may decide to increase the size of the buffer
|
|
Packit |
fcad23 |
actually used for internal housekeeping.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
This directive will be ignored if the platforms does not support
|
|
Packit |
fcad23 |
\fIsetsockopt()\fR.
|
|
Packit |
fcad23 |
.IP "serverSendBuf INTEGER"
|
|
Packit |
fcad23 |
is similar to \fIserverRecvBuf\fR, but applies to the size
|
|
Packit |
fcad23 |
of the buffer used when sending SNMP responses.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
.IP "sourceFilterType none|whitelist|blacklist"
|
|
Packit |
fcad23 |
specifies whether or not addresses added with \fIsourceFilterAddress\fR are
|
|
Packit |
fcad23 |
whitelisted or blacklisted. The default is none, indicating that incoming
|
|
Packit |
fcad23 |
packets will not be checked agains the filter list.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
.IP "sourceFilterAddress ADDRESS"
|
|
Packit |
fcad23 |
specifies an address to be added to the source address filter list.
|
|
Packit |
fcad23 |
\fIsourceFilterType\fR configuration determines whether or not addresses are
|
|
Packit |
fcad23 |
whitelisted or blacklisted.
|
|
Packit |
fcad23 |
.IP
|
|
Packit |
fcad23 |
.SH MIB HANDLING
|
|
Packit |
fcad23 |
.IP "mibdirs DIRLIST"
|
|
Packit |
fcad23 |
specifies a list of directories to search for MIB files.
|
|
Packit |
fcad23 |
This operates in the same way as the \fB\-M\fR option -
|
|
Packit |
fcad23 |
see \fIsnmpcmd(1)\fR for details.
|
|
Packit |
fcad23 |
Note that this value can be overridden by the
|
|
Packit |
fcad23 |
.B MIBDIRS
|
|
Packit |
fcad23 |
environment variable, and the \fB\-M\fR option.
|
|
Packit |
fcad23 |
.IP "mibs MIBLIST"
|
|
Packit |
fcad23 |
specifies a list of MIB modules (not files) that should be loaded.
|
|
Packit |
fcad23 |
This operates in the same way as the \fB\-m\fR option -
|
|
Packit |
fcad23 |
see \fIsnmpcmd(1)\fR for details.
|
|
Packit |
fcad23 |
Note that this list can be overridden by the
|
|
Packit |
fcad23 |
.B MIBS
|
|
Packit |
fcad23 |
environment variable, and the \fB\-m\fR option.
|
|
Packit |
fcad23 |
.IP "mibfile FILE"
|
|
Packit |
fcad23 |
specifies a (single) MIB file to load, in addition to the
|
|
Packit |
fcad23 |
list read from the \fImibs\fR token (or equivalent configuration).
|
|
Packit |
fcad23 |
Note that this value can be overridden by the
|
|
Packit |
fcad23 |
.B MIBFILES
|
|
Packit |
fcad23 |
environment variable.
|
|
Packit |
fcad23 |
.IP "showMibErrors (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
whether to display MIB parsing errors.
|
|
Packit |
fcad23 |
.IP "commentToEOL (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
whether MIB parsing should be strict about comment termination.
|
|
Packit |
fcad23 |
Many MIB writers assume that ASN.1 comments extend to the end of
|
|
Packit |
fcad23 |
the text line, rather than being terminated by the next "\-\-" token.
|
|
Packit |
fcad23 |
This token can be used to accept such (strictly incorrect) MIBs.
|
|
Packit |
fcad23 |
.br
|
|
Packit |
fcad23 |
Note that this directive was previous (mis-)named \fIstrictCommentTerm\fR,
|
|
Packit |
fcad23 |
but with the reverse behaviour from that implied by the name.
|
|
Packit |
fcad23 |
This earlier token is still accepted for backwards compatibility.
|
|
Packit |
fcad23 |
.IP "mibAllowUnderline (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
whether to allow underline characters in MIB object names and
|
|
Packit |
fcad23 |
enumeration values.
|
|
Packit |
fcad23 |
This token can be used to accept such (strictly incorrect) MIBs.
|
|
Packit |
fcad23 |
.IP "mibWarningLevel INTEGER"
|
|
Packit |
fcad23 |
the minimum warning level of the warnings printed by the MIB parser.
|
|
Packit |
fcad23 |
.SH OUTPUT CONFIGURATION
|
|
Packit |
fcad23 |
.IP "logTimestamp (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Whether the commands should log timestamps with their error/message
|
|
Packit |
fcad23 |
logging or not. Note that output will not look as pretty with
|
|
Packit |
fcad23 |
timestamps if the source code that is doing the logging does
|
|
Packit |
fcad23 |
incremental logging of messages that are not line buffered before
|
|
Packit |
fcad23 |
being passed to the logging routines. This option is only used when file logging is active.
|
|
Packit |
fcad23 |
.IP "printNumericEnums (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Oe .
|
|
Packit |
fcad23 |
.IP "printNumericOids (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-On .
|
|
Packit |
fcad23 |
.IP "dontBreakdownOids (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Ob .
|
|
Packit |
fcad23 |
.IP "escapeQuotes (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-OE .
|
|
Packit |
fcad23 |
.IP "quickPrinting (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Oq .
|
|
Packit |
fcad23 |
.IP "printValueOnly (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Ov .
|
|
Packit |
fcad23 |
.IP "dontPrintUnits (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-OU .
|
|
Packit |
fcad23 |
.IP "numericTimeticks (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Ot .
|
|
Packit |
fcad23 |
.IP "printHexText (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-OT .
|
|
Packit |
fcad23 |
.IP "hexOutputLength integer"
|
|
Packit |
fcad23 |
Specifies where to break up the output of hexadecimal strings.
|
|
Packit |
fcad23 |
Set to 0 to disable line breaks. Defaults to 16.
|
|
Packit |
fcad23 |
.IP "suffixPrinting (0|1|2)"
|
|
Packit |
fcad23 |
The value 1 is equivalent to
|
|
Packit |
fcad23 |
.B \-Os
|
|
Packit |
fcad23 |
and the value 2 is equivalent to
|
|
Packit |
fcad23 |
.BR \-OS .
|
|
Packit |
fcad23 |
.IP "oidOutputFormat (1|2|3|4|5|6)"
|
|
Packit |
fcad23 |
Maps \-O options as follow: \-Os=1, \-OS=2, \-Of=3, \-On=4, \-Ou=5.
|
|
Packit |
fcad23 |
The value 6 has no matching \-O option. It suppresses output.
|
|
Packit |
fcad23 |
.IP "extendedIndex (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-OX .
|
|
Packit |
fcad23 |
.IP "noDisplayHint (1|yes|true|0|no|false)"
|
|
Packit |
fcad23 |
Disables the use of DISPLAY-HINT information when parsing indices and
|
|
Packit |
fcad23 |
values to set. Equivalent to
|
|
Packit |
fcad23 |
.BR \-Ih .
|
|
Packit |
fcad23 |
.IP "outputPrecision PRECISION"
|
|
Packit |
fcad23 |
Uses the PRECISION string to allow modification of the value output
|
|
Packit |
fcad23 |
format. See snmpcmd(1) for details.
|
|
Packit |
fcad23 |
Equivalent to
|
|
Packit |
fcad23 |
.BR \-Op
|
|
Packit |
fcad23 |
(which takes precedence over the config file).
|
|
Packit |
fcad23 |
.SH FILES
|
|
Packit |
fcad23 |
.IP "System-wide configuration files:"
|
|
Packit |
fcad23 |
SYSCONFDIR/snmp/snmp.conf
|
|
Packit |
fcad23 |
.br
|
|
Packit |
fcad23 |
SYSCONFDIR/snmp/snmp.local.conf
|
|
Packit |
fcad23 |
.IP "User-specific configuration settings:"
|
|
Packit |
fcad23 |
$HOME/.snmp/snmp.conf
|
|
Packit |
fcad23 |
.br
|
|
Packit |
fcad23 |
$HOME/.snmp/snmp.local.conf
|
|
Packit |
fcad23 |
.IP "Destination host specific files:
|
|
Packit |
fcad23 |
SYSCONFDIR/snmp/hosts/HOSTNAME.conf
|
|
Packit |
fcad23 |
.br
|
|
Packit |
fcad23 |
$HOME/.snmp/hosts/HOSTNAME.conf
|
|
Packit |
fcad23 |
|
|
Packit |
fcad23 |
.SH "SEE ALSO"
|
|
Packit |
fcad23 |
snmp_config(5), netsnmp_config_api(3), snmpcmd(1).
|
|
Packit |
fcad23 |
.\" Local Variables:
|
|
Packit |
fcad23 |
.\" mode: nroff
|
|
Packit |
fcad23 |
.\" End:
|