xref: /openbsd-src/libexec/snmpd/snmpd_metrics/snmpd_metrics.8 (revision 6d0d199e534fdc92c78a2cd4b02c7d941e3ff0eb)
1.\"	$OpenBSD: snmpd_metrics.8,v 1.4 2022/10/23 06:12:06 jmc Exp $
2.\"
3.\" Copyright (c) 2022 Martijn van Duren <martijn@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: October 23 2022 $
18.Dt SNMPD_METRICS 8
19.Os
20.Sh NAME
21.Nm snmpd_metrics
22.Nd export snmpd MIB data
23.Sh SYNOPSIS
24.Nm
25.Op Fl dv
26.Op Fl C Ar option
27.Op Fl c Ar context
28.Op Fl s Ar path
29.Sh DESCRIPTION
30.Nm
31exports the following
32.Pq partial
33MIBs via an AgentX compatible
34.Pq snmp
35daemon:
36HOST-RESOURCES-MIB, IF-MIB, OPENBSD-PF-MIB, OPENBSD-SENSORS-MIB,
37OPENBSD-CARP-MIB, OPENBSD-MEM-MIB, IP-MIB, IP-FORWARD-MIB,
38UCD-DISKIO-MIB, and BRIDGE-MIB.
39.Pp
40The options are as follows:
41.Bl -tag -width Ds
42.It Fl C Ar option
43Enable MIB-specific options.
44Currently only
45.Ic filter-routes
46is supported.
47If set ask the kernel to filter route update messages on the routing socket.
48Routing table information will not be available, but CPU use will be
49reduced during bulk updates.
50.It Fl c Ar context
51The SNMPv3 context and can usually be omitted.
52.It Fl d
53Do not daemonize and log to
54.Em stderr .
55.It Fl s Ar path
56Connect to the AgentX master via
57.Ar path .
58It defaults to
59.Pa /var/agentx/master .
60.It Fl v
61Produce more verbose output.
62.El
63.Sh SEE ALSO
64.Xr snmp 1 ,
65.Xr snmpd 8
66.Sh STANDARDS
67.Rs
68.%A P. Grillo
69.%A WeSync.com
70.%D March 2000
71.%R RFC 2790
72.%T Host Resources MIB
73.Re
74.Pp
75.Rs
76.%A K. McCloghrie
77.%A Cisco Systems
78.%A F. Kastenholz
79.%A Argon Networks
80.%D June 2000
81.%R RFC 2863
82.%T The Interfaces Group MIB
83.Re
84.Pp
85.Rs
86.%A S. Routhier, Ed.
87.%D April 2006
88.%R RFC 4293
89.%T Management Information Base for the Internet Protocol (IP)
90.Re
91.Pp
92.Rs
93.%A B. Haberman
94.%A Johns Hopkins University
95.%D April 2006
96.%R RFC 4292
97.%T IP Forwarding Table MIB
98.Re
99.Pp
100.Rs
101.%A K. Norseth, Ed.
102.%A L-3 Communications
103.%A E. Bell, Ed.
104.%A 3Com Europe Limited
105.%D September 2005
106.%R RFC 4188
107.%T Definitions of Managed Objects for Bridges
108.Re
109.Sh AUTHORS
110.An Martijn van Duren Aq Mt martijn@openbsd.org
111.An Joel Knight Aq Mt joel@openbsd.org
112.An Reyk Floeter Aq Mt reyk@openbsd.org
113