Man Page: bsnmp-jails(8)

bsnmp-jails(8)            BSD System Manager's Manual           bsnmp-jails(8)

NAME
     bsnmp-jails - an SNMP module provides statistics regarding FreeBSD jails
     running on the system.

DESCRIPTION
     bsnmp-jails is a module for bsnmpd(1) which monitors network and other
     statistics for FreeBSD jails running on the system.  These statistics are
     gathered by the module.

MIBS
     The counters will be available as a table under the following MIB:

            .1.3.6.1.4.1.12325.1.1111

     Or if the appropriate MIB.txt files have been installed:

            enterprises.fokus.begemot.jails

     The following SNMP MIBs are available for use (where X is the counter
     index):

     jails.jailCount
                 The number of jails running on the system.

     jails.jailTable.jailEntry.jailIndex.X
                 The index of the jail in the table.

     jails.jailTable.jailEntry.jailHost.X
                 The hostname of the jail.

     jails.jailTable.jailEntry.jailInOctets.X
                 The number of octets received by the jail over the network.

     jails.jailTable.jailEntry.jailInPackets.X
                 The number of packets received by the jail over the network.

     jails.jailTable.jailEntry.jailOutOctets.X
                 The number of octets sent by the jail over the network.

     jails.jailTable.jailEntry.jailOutPackets.X
                 The number of packets sent by the jail over the network.

     jails.jailTable.jailEntry.jailProcesses.X
                 The number of processes running in the jail.

     jails.jailTable.jailEntry.jailThreads.X
                 The number of threads running in the jail.

     jails.jailTable.jailEntry.jailCpuTime.X
                 The amount of CPU time (in SNMP time ticks) the jail has
                 used.

     jails.jailTable.jailEntry.jailDiskSpace.X
                 Amount of disk space taken by this jail. Zero means unknown.

     jails.jailTable.jailEntry.jailDiskFiles.X
                 Number of files (inodes) in this jail. Zero means unknown.

     jails.jailNetworkFilter
                 A tcpdump style filter for the network traffic. Only matched
                 traffic is counted in the jail statistics.

     jails.jailRefreshInterval
                 The interval (in SNMP time ticks) between refreshing the jail
                 process statistics and checking which jails are running.

     jails.jailMeasureInterval
                 The interval (in SNMP time ticks) between measuring the
                 amount of files and disk space used by the jail.

OPTIONS
     To activate the bsnmp-jails module you must load the module in
     /etc/snmpd.config

     You can use the jailNetworkFilter SNMP MIB to configure which traffic to
     count in the jail network statistics.

EXAMPLES
     This example configures the module, and excludes traffic to/from the
     10.0.0.0/8 network from the network monitoring.

     The following would be added to /etc/snmpd.config:

           begemotSnmpdModulePath."jails" = "/usr/local/lib/snmp_jails.so"
           %jails
           jailNetworkFilter = "not net 10.0.0.0/8"
           jailMeasureInterval = 360000

SEE ALSO
     bsnmpd(1,) tcpdump(1)

AUTHOR
     Stef Walter <stef@thewalter.net>

bsnmp-jails                    January 21, 2009                    bsnmp-jails
   [ back | home ]