usr.sbin/bsnmpd/modules/snmp_hast/snmp_hast.3

   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 .\" $FreeBSD$
  27 .\"
  28 .Dd May 9, 2013
  29 .Dt SNMP_HAST 3
  30 .Os
  31 .Sh NAME
  32 .Nm snmp_hast
  33 .Nd "HAST module for"
  34 .Xr bsnmpd 1
  35 .Sh LIBRARY
  36 .Pq begemotSnmpdModulePath."hast" = "/usr/lib/snmp_hast.so"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm snmp_hast
  40 module implements a private BEGEMOT-HAST-MIB, which allows
  41 management of HAST resources.
  42 .Pp
  43 The module uses
  44 .Xr hastd 8
  45 control socket to communicate with the daemon.
  46 .Va hastConfigFile
  47 variable can be used to specify the location of
  48 .Xr hast.conf 5
  49 file to find the address of the control connection.
  50 .Sh FILES
  51 .Bl -tag -width "XXXXXXXXX"
  52 .It Pa /usr/share/snmp/defs/hast_tree.def
  53 The description of the MIB tree implemented by
  54 .Nm .
  55 .It Pa /usr/share/snmp/mibs/BEGEMOT-HAST-MIB.txt
  56 The private BEGEMOT-HAST-MIB that is implemented by this module.
  57 .It Pa /etc/hast.conf
  58 The default
  59 .Xr hastd 8
  60 configuration file.
  61 .El
  62 .Sh SEE ALSO
  63 .Xr bsnmpd 1 ,
  64 .Xr gensnmptree 1 ,
  65 .Xr hastctl 8 ,
  66 .Xr hastd 8 ,
  67 .Xr snmpmod 3
  68 .Sh AUTHORS
  69 .An Mikolaj Golub Aq trociny@FreeBSD.org