~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

« back to all changes in this revision

Viewing changes to man/snmpd.8.def

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2004-09-13 12:06:21 UTC
  • Revision ID: james.westby@ubuntu.com-20040913120621-g952ntonlleihcvm
Tags: upstream-5.1.1
ImportĀ upstreamĀ versionĀ 5.1.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH SNMPD 8 "7 Feb 2002" VVERSIONINFO "Net-SNMP"
 
2
.UC 4
 
3
.SH NAME
 
4
snmpd - daemon to respond to SNMP request packets.
 
5
.SH SYNOPSIS
 
6
.B snmpd
 
7
[OPTIONS] [LISTENING ADDRESSES]
 
8
.SH DESCRIPTION
 
9
.B snmpd
 
10
is an SNMP agent which binds to a port and awaits requests from
 
11
SNMP management software.  Upon receiving a request, it processes the
 
12
request(s), collects the requested information and/or performs the
 
13
requested operation(s) and returns the information to the sender.
 
14
.SH OPTIONS
 
15
.TP 8
 
16
.B -a
 
17
Log the source addresses of incoming requests.
 
18
.TP
 
19
.B -A
 
20
Append to the log file rather than truncating it.
 
21
.TP
 
22
.B "-c" \fIFILE
 
23
Read 
 
24
.I FILE
 
25
as a configuration file
 
26
(or a comma-separated list of configuration files).
 
27
.TP
 
28
.B -C
 
29
Do not read any configuration files except the ones optionally specified by the 
 
30
.B -c 
 
31
option.
 
32
Note that this behaviour also covers the persistent configuration files.
 
33
This may result in dynamically-assigned values being reset following an
 
34
agent restart, unless the relevant persistent config files are
 
35
explicitly loaded using the
 
36
.B -c 
 
37
option.
 
38
.TP
 
39
.B -d
 
40
Dump (in hexadecimal) the sent and received SNMP packets.
 
41
.TP
 
42
.B -D\fI[TOKEN[,...]]
 
43
Turn on debugging output for the given
 
44
.IR "TOKEN" "(s)."
 
45
Without any tokens specified, it defaults to printing all the tokens
 
46
(which is equivalent to the keyword "ALL").
 
47
You might want to try
 
48
.IR ALL
 
49
for extremely verbose output.  Note: You can not put a space between
 
50
the -D flag and the listed TOKENs.
 
51
.TP
 
52
.B -f
 
53
Do not fork() from the calling shell.
 
54
.TP
 
55
.B -g \fIGID
 
56
Change to the numerical group ID
 
57
.I GID
 
58
after opening listening sockets.
 
59
.TP
 
60
.B -h, --help
 
61
Display a brief usage message and then exit.
 
62
.TP
 
63
.B -H
 
64
Display a list of configuration file directives understood by the
 
65
agent and then exit.
 
66
.TP
 
67
.B -I \fI[-]INITLIST
 
68
This option specifies which modules you do (or do not) want to be
 
69
initialized when the agent starts up.  If the comma-separated
 
70
.I INITLIST
 
71
is preceded
 
72
with a '-', it is the list of modules that you do
 
73
.I not
 
74
want to be started.  Otherwise,
 
75
.I INITLIST
 
76
is the list of modules to be started.
 
77
 
 
78
To get a list of compiled modules, run the agent with the arguments
 
79
.I "-Dmib_init -H"
 
80
(assumes you have debugging support compiled in).
 
81
.TP
 
82
.BR -l "" " " "[\fIFILE" "" "]"
 
83
Log all output from the agent (including stdout and stderr) to 
 
84
.IR FILE .
 
85
If no filename is given, log to a default file set at compile time
 
86
(normally /var/log/snmpd.log).
 
87
.br
 
88
This option is being deprecated, and '-Lf FILE' should be used instead.
 
89
.TP
 
90
.B -L[efos]
 
91
Specify where logging output should be directed (standard error or output,
 
92
to a file or via syslog).  See LOGGING OPTIONS in snmpcmd(5) for details.
 
93
.br
 
94
This option deprecates the
 
95
.B -l
 
96
.B -s
 
97
and
 
98
.B -S
 
99
options.
 
100
.TP
 
101
.B -p \fIFILE
 
102
Save the process ID of the daemon in
 
103
.IR FILE "."
 
104
.br
 
105
This option deprecates the
 
106
.B -P
 
107
option.
 
108
.TP
 
109
.B -P \fIFILE
 
110
Save the process ID of the daemon in
 
111
.IR FILE "."
 
112
This option is being deprecated, and '-p FILE' should be used instead.
 
113
.TP 
 
114
.B -q
 
115
Print simpler output for easier automated parsing.
 
116
.TP
 
117
.B -r
 
118
Do not require root access to run the daemon.  Specifically, do not exit
 
119
if files only accessible to root (such as /dev/kmem etc.) cannot be
 
120
opened.
 
121
.TP
 
122
.B -s
 
123
Use syslog for logging.
 
124
.br
 
125
This option is being deprecated, and '-Ls FACILITY' should be used instead.
 
126
.TP
 
127
.BR -S " d|0-7"
 
128
Specifies the syslog facility to use when logging to syslog.
 
129
.br
 
130
This option is being deprecated, and '-Ls FACILITY' should be used instead.
 
131
.TP
 
132
.B -u \fIUID
 
133
Change to the user ID
 
134
.I UID
 
135
(which can be given in numerical or textual form) after opening
 
136
listening sockets.
 
137
.TP
 
138
.B -v, --version
 
139
Print version information for the agent and then exit.
 
140
.TP
 
141
.B -V
 
142
Symbolically dump SNMP transactions.
 
143
.TP
 
144
.B -x \fIADDRESS
 
145
Listens for AgentX connections on the specified address
 
146
rather than the default '/var/agentx/master'.
 
147
The address can either be a Unix domain socket path,
 
148
or the address of a network interface.  The format is the same as the
 
149
format of listening addresses described below.
 
150
.TP
 
151
.B -X
 
152
Run as an AgentX subagent rather than as an SNMP master agent.
 
153
 
 
154
.SH LISTENING ADDRESSES
 
155
By default,
 
156
.B snmpd
 
157
listens for incoming SNMP requests only on UDP port 161.  However, it
 
158
is possible to modify this behaviour by specifying one or more
 
159
listening addresses as arguments to
 
160
.BR snmpd .
 
161
A listening address takes the form:
 
162
.IP
 
163
[<transport-specifier>:]<transport-address>
 
164
.PP
 
165
At its simplest, a listening address may consist only of a port
 
166
number, in which case
 
167
.B snmpd
 
168
listens on that UDP port on all IPv4 interfaces.  Otherwise, the
 
169
<transport-address> part of the specification is parsed according to
 
170
the following table:
 
171
.RS 4
 
172
.TP 28
 
173
.BR "<transport-specifier>"
 
174
.BR "<transport-address> format"
 
175
.IP "udp" 28
 
176
hostname[:port]
 
177
.I or
 
178
IPv4-address[:port]
 
179
.IP "tcp" 28
 
180
hostname[:port]
 
181
.I or
 
182
IPv4-address[:port]
 
183
.IP "unix" 28
 
184
pathname
 
185
.IP "ipx" 28
 
186
[network]:node[/port]
 
187
.TP 28 
 
188
.IR "" "aal5pvc " or " pvc"
 
189
[interface.][VPI.]VCI
 
190
.TP 28
 
191
.IR "" "udp6 " or " udpv6 " or " udpipv6"
 
192
hostname[:port]
 
193
.I or
 
194
IPv6-address[:port]
 
195
.TP 28
 
196
.IR "" "tcp6 " or " tcpv6 " or " tcpipv6"
 
197
hostname[:port]
 
198
.I or
 
199
IPv6-address[:port]
 
200
.RE
 
201
.PP
 
202
Note that <transport-specifier> strings are case-insensitive so that,
 
203
for example, "tcp" and "TCP" are equivalent.  Here are some examples,
 
204
along with their interpretation:
 
205
.TP 24
 
206
.IR "127.0.0.1:161"
 
207
listen on UDP port 161, but only on the loopback interface.  This
 
208
prevents
 
209
.B snmpd
 
210
being queried remotely (which is a bit pointless).  The ":161" is
 
211
redundant here since that is the default SNMP port in any case.
 
212
.TP 24
 
213
.IR "TCP:1161"
 
214
listen on TCP port 1161 on all IPv4 interfaces.
 
215
.TP 24
 
216
.IR "ipx:/40000"
 
217
listen on IPX port 40000 on all IPX interfaces.
 
218
.TP 24
 
219
.IR "unix:/tmp/local-agent"
 
220
listen on the Unix domain socket 
 
221
.IR /tmp/local-agent .
 
222
.TP 24
 
223
.IR "/tmp/local-agent"
 
224
identical to the previous specification, since the Unix domain is the
 
225
default transport iff the first character of the <transport-address>
 
226
is a '/'.
 
227
.TP 24
 
228
.IR "PVC:161"
 
229
listen on the AAL5 permanent virtual circuit with VPI=0 and VCI=161
 
230
(decimal) on the first ATM adapter in the machine.
 
231
.TP 24
 
232
.IR "udp6:10161"
 
233
listen on port 10161 on all IPv6 interfaces.
 
234
.PP
 
235
Note that not all the transport domains listed above will always be
 
236
available; for instance, hosts with no IPv6 support will not be able
 
237
to use udp6 transport addresses, and attempts to do so will result in
 
238
the error "Error opening specified endpoint".  Likewise, since AAL5
 
239
PVC support is only currently available on Linux, it will fail with
 
240
the same error on other platforms.
 
241
 
 
242
.RE
 
243
.SH CONFIGURATION FILES
 
244
.PP
 
245
.B snmpd
 
246
checks for the existence of and parses the following files:
 
247
.TP 6
 
248
.B SYSCONFDIR/snmp/snmp.conf
 
249
Common configuration for the agent and applications. See
 
250
.I snmp.conf(5)
 
251
for details.
 
252
.TP
 
253
.B SYSCONFDIR/snmp/snmpd.conf
 
254
.TP
 
255
.B SYSCONFDIR/snmp/snmpd.local.conf
 
256
Agent-specific configuration.  See
 
257
.I snmpd.conf(5)
 
258
for details.  These files are optional and may be used to configure
 
259
access control, trap generation, subagent protocols and much else
 
260
besides.
 
261
.IP
 
262
In addition to these two configuration files in SYSCONFDIR/snmp, the
 
263
agent will read any files with the names
 
264
.I snmpd.conf
 
265
and
 
266
.I snmpd.local.conf
 
267
in a colon separated path specified in the
 
268
SNMPCONFPATH environment variable.
 
269
.TP
 
270
.B DATADIR/snmp/mibs/
 
271
The agent will also load all files in this directory as MIBs.  It will
 
272
not, however, load any file that begins with a '.' or descend into
 
273
subdirectories.
 
274
.SH SEE ALSO
 
275
(in recommended reading order)
 
276
.PP
 
277
snmp.conf(5),
 
278
snmpd.conf(5)
 
279
.\" Local Variables:
 
280
.\"  mode: nroff
 
281
.\" End: