xref: /freebsd/usr.sbin/bsnmpd/modules/snmp_hast/snmp_hast.3 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
1.\"-
2.\" Copyright (c) 2013 Mikolaj Golub <trociny@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd May 31, 2014
27.Dt SNMP_HAST 3
28.Os
29.Sh NAME
30.Nm snmp_hast
31.Nd "HAST module for"
32.Xr bsnmpd 1
33.Sh LIBRARY
34.Pq begemotSnmpdModulePath."hast" = "/usr/lib/snmp_hast.so"
35.Sh DESCRIPTION
36The
37.Nm snmp_hast
38module implements a private BEGEMOT-HAST-MIB, which allows
39management of HAST resources.
40.Pp
41The module uses the
42.Xr hastd 8
43control socket to communicate with the daemon.
44The
45.Va hastConfigFile
46variable can be used to specify the location of the
47.Xr hast.conf 5
48file to find the address of the control connection.
49.Sh FILES
50.Bl -tag -width "XXXXXXXXX"
51.It Pa /usr/share/snmp/defs/hast_tree.def
52The description of the MIB tree implemented by
53.Nm .
54.It Pa /usr/share/snmp/mibs/BEGEMOT-HAST-MIB.txt
55The private BEGEMOT-HAST-MIB that is implemented by this module.
56.It Pa /etc/hast.conf
57The default
58.Xr hastd 8
59configuration file.
60.El
61.Sh SEE ALSO
62.Xr bsnmpd 1 ,
63.Xr gensnmptree 1 ,
64.Xr snmpmod 3 ,
65.Xr hastctl 8 ,
66.Xr hastd 8
67.Sh AUTHORS
68.An Mikolaj Golub Aq Mt trociny@FreeBSD.org
69