usr.sbin/bsnmpd/modules/snmp_hostres/snmp_hostres.3

   1 .\"
   2 .\" Copyright (C) 2005-2006
   3 .\"     The FreeBSD Project.
   4 .\"     All rights reserved.
   5 .\"
   6 .\" Author: Harti Brandt <harti@FreeBSD.org>
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20 .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  21 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd January 3, 2006
  32 .Dt SNMP_HOSTRES 3
  33 .Os
  34 .Sh NAME
  35 .Nm snmp_hostres
  36 .Nd host resources module for
  37 .Xr bsnmpd 8
  38 .Sh LIBRARY
  39 .Pq begemotSnmpdModulePath."hostres" = "/usr/lib/snmp_hostres.so"
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 module implements the HOST-RESOURCES-MIB as standardized in RFC 2790.
  44 .Sh RESTRICTIONS
  45 Not all information in the MIB is meaningful in FreeBSD or is available.
  46 The following variables are not implemented or carry no information:
  47 .Bl -tag -width indent
  48 .It Va hrFSType
  49 There are several types of file systems for which no appropriate OID
  50 exists yet which are supported by
  51 .Fx .
  52 For smbfs, procfs and devfs ,
  53 .Va hrFSOther
  54 is returned.
  55 In all other cases,
  56 .Va hrFSUnknown .
  57 .It Va hrFSBootable
  58 It is questionable what bootable means here.
  59 Does it mean that the BIOS is available to start a boot on that file system
  60 or does it mean that there is something bootable?
  61 In either case this information is not available so this variable returns True
  62 for the root file system (which is not necessarily correct) and False for
  63 all others.
  64 .It Va hrFSLastFullBackupDate , hrFSLastPartialBackupDate
  65 This is not available and always returns an empty string.
  66 Theoretically, this could be retrieved from
  67 .Pa /etc/dumpdates ,
  68 which would
  69 hardly be correct given the different ways of doing backups.
  70 .It Va hrDiskStorageTable
  71 Floppy devices are currently not reported.
  72 Also the names of the disks are hard-coded in the module.
  73 .El
  74 .Sh FILES
  75 .Bl -tag -width indent
  76 .It Pa /usr/share/snmp/defs/hostres_tree.def
  77 The description of the MIB tree implemented by
  78 .Nm .
  79 .It Pa /usr/share/snmp/mibs/HOST-RESOURCES-TYPES.txt
  80 .It Pa /usr/share/snmp/mibs/HOST-RESOURCES-MIB.txt
  81 .It Pa /usr/share/snmp/mibs/BEGEMOT-HOSTRES-MIB.txt
  82 This is the MIB that is implemented by this module.
  83 .El
  84 .Sh SEE ALSO
  85 .Xr gensnmptree 1 ,
  86 .Xr snmpmod 3
  87 .Sh AUTHORS
  88 .An Victor Cruceru Aq soc-victor@FreeBSD.org