xref: /freebsd/usr.sbin/bsnmpd/modules/snmp_hostres/snmp_hostres.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd January 3, 2006
30.Dt SNMP_HOSTRES 3
31.Os
32.Sh NAME
33.Nm snmp_hostres
34.Nd host resources module for
35.Xr bsnmpd 8
36.Sh LIBRARY
37.Pq begemotSnmpdModulePath."hostres" = "/usr/lib/snmp_hostres.so"
38.Sh DESCRIPTION
39The
40.Nm
41module implements the HOST-RESOURCES-MIB as standardized in RFC 2790.
42.Sh RESTRICTIONS
43Not all information in the MIB is meaningful in FreeBSD or is available.
44The following variables are not implemented or carry no information:
45.Bl -tag -width indent
46.It Va hrFSType
47There are several types of file systems for which no appropriate OID
48exists yet which are supported by
49.Fx .
50For smbfs, procfs and devfs ,
51.Va hrFSOther
52is returned.
53In all other cases,
54.Va hrFSUnknown .
55.It Va hrFSBootable
56It is questionable what bootable means here.
57Does it mean that the BIOS is available to start a boot on that file system
58or does it mean that there is something bootable?
59In either case this information is not available so this variable returns True
60for the root file system (which is not necessarily correct) and False for
61all others.
62.It Va hrFSLastFullBackupDate , hrFSLastPartialBackupDate
63This is not available and always returns an empty string.
64Theoretically, this could be retrieved from
65.Pa /etc/dumpdates ,
66which would
67hardly be correct given the different ways of doing backups.
68.It Va hrDiskStorageTable
69Floppy devices are currently not reported.
70Also the names of the disks are hard-coded in the module.
71.El
72.Sh FILES
73.Bl -tag -width indent
74.It Pa /usr/share/snmp/defs/hostres_tree.def
75The description of the MIB tree implemented by
76.Nm .
77.It Pa /usr/share/snmp/mibs/HOST-RESOURCES-TYPES.txt
78.It Pa /usr/share/snmp/mibs/HOST-RESOURCES-MIB.txt
79.It Pa /usr/share/snmp/mibs/BEGEMOT-HOSTRES-MIB.txt
80This is the MIB that is implemented by this module.
81.El
82.Sh SEE ALSO
83.Xr gensnmptree 1 ,
84.Xr snmpmod 3
85.Sh AUTHORS
86.An Victor Cruceru Aq Mt soc-victor@FreeBSD.org
87