23ac29
###############################################################################
23ac29
#
23ac29
# snmpd.conf:
23ac29
#   An example configuration file for configuring the ucd-snmp snmpd agent.
23ac29
#
23ac29
###############################################################################
23ac29
#
23ac29
# This file is intended to only be as a starting point.  Many more
23ac29
# configuration directives exist than are mentioned in this file.  For 
23ac29
# full details, see the snmpd.conf(5) manual page.
23ac29
#
23ac29
# All lines beginning with a '#' are comments and are intended for you
23ac29
# to read.  All other lines are configuration commands for the agent.
23ac29
23ac29
###############################################################################
23ac29
# Access Control
23ac29
###############################################################################
23ac29
23ac29
# As shipped, the snmpd demon will only respond to queries on the
23ac29
# system mib group until this file is replaced or modified for
23ac29
# security purposes.  Examples are shown below about how to increase the
23ac29
# level of access.
23ac29
23ac29
# By far, the most common question I get about the agent is "why won't
23ac29
# it work?", when really it should be "how do I configure the agent to
23ac29
# allow me to access it?"
23ac29
#
23ac29
# By default, the agent responds to the "public" community for read
23ac29
# only access, if run out of the box without any configuration file in 
23ac29
# place.  The following examples show you other ways of configuring
23ac29
# the agent so that you can change the community names, and give
23ac29
# yourself write access to the mib tree as well.
23ac29
#
23ac29
# For more information, read the FAQ as well as the snmpd.conf(5)
23ac29
# manual page.
23ac29
23ac29
####
23ac29
# First, map the community name "public" into a "security name"
23ac29
23ac29
#       sec.name  source          community
23ac29
com2sec notConfigUser  default       public
23ac29
23ac29
####
23ac29
# Second, map the security name into a group name:
23ac29
23ac29
#       groupName      securityModel securityName
23ac29
group   notConfigGroup v1           notConfigUser
23ac29
group   notConfigGroup v2c           notConfigUser
23ac29
23ac29
####
23ac29
# Third, create a view for us to let the group have rights to:
23ac29
23ac29
# Make at least  snmpwalk -v 1 localhost -c public system fast again.
23ac29
#       name           incl/excl     subtree         mask(optional)
23ac29
view    systemview    included   .1.3.6.1.2.1.1
23ac29
view    systemview    included   .1.3.6.1.2.1.25.1.1
23ac29
23ac29
####
23ac29
# Finally, grant the group read-only access to the systemview view.
23ac29
23ac29
#       group          context sec.model sec.level prefix read   write  notif
23ac29
access  notConfigGroup ""      any       noauth    exact  systemview none none
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
# Here is a commented out example configuration that allows less
23ac29
# restrictive access.
23ac29
23ac29
# YOU SHOULD CHANGE THE "COMMUNITY" TOKEN BELOW TO A NEW KEYWORD ONLY
23ac29
# KNOWN AT YOUR SITE.  YOU *MUST* CHANGE THE NETWORK TOKEN BELOW TO
23ac29
# SOMETHING REFLECTING YOUR LOCAL NETWORK ADDRESS SPACE.
23ac29
23ac29
##       sec.name  source          community
23ac29
#com2sec local     localhost       COMMUNITY
23ac29
#com2sec mynetwork NETWORK/24      COMMUNITY
23ac29
23ac29
##     group.name sec.model  sec.name
23ac29
#group MyRWGroup  any        local
23ac29
#group MyROGroup  any        mynetwork
23ac29
#
23ac29
#group MyRWGroup  any        otherv3user
23ac29
#...
23ac29
23ac29
##           incl/excl subtree                          mask
23ac29
#view all    included  .1                               80
23ac29
23ac29
## -or just the mib2 tree-
23ac29
23ac29
#view mib2   included  .iso.org.dod.internet.mgmt.mib-2 fc
23ac29
23ac29
23ac29
##                context sec.model sec.level prefix read   write  notif
23ac29
#access MyROGroup ""      any       noauth    0      all    none   none
23ac29
#access MyRWGroup ""      any       noauth    0      all    all    all
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Sample configuration to make net-snmpd RFC 1213.
23ac29
# Unfortunately v1 and v2c don't allow any user based authentification, so
23ac29
# opening up the default config is not an option from a security point.
23ac29
#
23ac29
# WARNING: If you uncomment the following lines you allow write access to your
23ac29
# snmpd daemon from any source! To avoid this use different names for your
23ac29
# community or split out the write access to a different community and 
23ac29
# restrict it to your local network.
23ac29
# Also remember to comment the syslocation and syscontact parameters later as
23ac29
# otherwise they are still read only (see FAQ for net-snmp).
23ac29
#
23ac29
23ac29
# First, map the community name "public" into a "security name"
23ac29
#       sec.name        source          community
23ac29
#com2sec notConfigUser   default         public
23ac29
23ac29
# Second, map the security name into a group name:
23ac29
#       groupName       securityModel   securityName
23ac29
#group   notConfigGroup  v1              notConfigUser
23ac29
#group   notConfigGroup  v2c             notConfigUser
23ac29
23ac29
# Third, create a view for us to let the group have rights to:
23ac29
# Open up the whole tree for ro, make the RFC 1213 required ones rw.
23ac29
#       name            incl/excl       subtree mask(optional)
23ac29
#view    roview          included        .1
23ac29
#view    rwview          included        system.sysContact
23ac29
#view    rwview          included        system.sysName
23ac29
#view    rwview          included        system.sysLocation
23ac29
#view    rwview          included        interfaces.ifTable.ifEntry.ifAdminStatus
23ac29
#view    rwview          included        at.atTable.atEntry.atPhysAddress
23ac29
#view    rwview          included        at.atTable.atEntry.atNetAddress
23ac29
#view    rwview          included        ip.ipForwarding
23ac29
#view    rwview          included        ip.ipDefaultTTL
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteDest
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteIfIndex
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMetric1
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMetric2
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMetric3
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMetric4
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteType
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteAge
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMask
23ac29
#view    rwview          included        ip.ipRouteTable.ipRouteEntry.ipRouteMetric5
23ac29
#view    rwview          included        ip.ipNetToMediaTable.ipNetToMediaEntry.ipNetToMediaIfIndex
23ac29
#view    rwview          included        ip.ipNetToMediaTable.ipNetToMediaEntry.ipNetToMediaPhysAddress
23ac29
#view    rwview          included        ip.ipNetToMediaTable.ipNetToMediaEntry.ipNetToMediaNetAddress
23ac29
#view    rwview          included        ip.ipNetToMediaTable.ipNetToMediaEntry.ipNetToMediaType
23ac29
#view    rwview          included        tcp.tcpConnTable.tcpConnEntry.tcpConnState
23ac29
#view    rwview          included        egp.egpNeighTable.egpNeighEntry.egpNeighEventTrigger
23ac29
#view    rwview          included        snmp.snmpEnableAuthenTraps
23ac29
23ac29
# Finally, grant the group read-only access to the systemview view.
23ac29
#       group          context sec.model sec.level prefix read   write  notif
23ac29
#access  notConfigGroup ""      any       noauth    exact  roview rwview none
23ac29
23ac29
23ac29
23ac29
###############################################################################
23ac29
# System contact information
23ac29
#
23ac29
23ac29
# It is also possible to set the sysContact and sysLocation system
23ac29
# variables through the snmpd.conf file:
23ac29
23ac29
syslocation Unknown (edit /etc/snmp/snmpd.conf)
23ac29
syscontact Root <root@localhost> (configure /etc/snmp/snmp.local.conf)
23ac29
23ac29
# Example output of snmpwalk:
23ac29
#   % snmpwalk -v 1 localhost -c public system
23ac29
#   system.sysDescr.0 = "SunOS name sun4c"
23ac29
#   system.sysObjectID.0 = OID: enterprises.ucdavis.ucdSnmpAgent.sunos4
23ac29
#   system.sysUpTime.0 = Timeticks: (595637548) 68 days, 22:32:55
23ac29
#   system.sysContact.0 = "Me <me@somewhere.org>"
23ac29
#   system.sysName.0 = "name"
23ac29
#   system.sysLocation.0 = "Right here, right now."
23ac29
#   system.sysServices.0 = 72
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Logging
23ac29
#
23ac29
23ac29
# We do not want annoying "Connection from UDP: " messages in syslog.
23ac29
# If the following option is commented out, snmpd will print each incoming
23ac29
# connection, which can be useful for debugging.
23ac29
23ac29
dontLogTCPWrappersConnects yes
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Process checks.
23ac29
#
23ac29
#  The following are examples of how to use the agent to check for
23ac29
#  processes running on the host.  The syntax looks something like:
23ac29
#
23ac29
#  proc NAME [MAX=0] [MIN=0]
23ac29
#
23ac29
#  NAME:  the name of the process to check for.  It must match
23ac29
#         exactly (ie, http will not find httpd processes).
23ac29
#  MAX:   the maximum number allowed to be running.  Defaults to 0.
23ac29
#  MIN:   the minimum number to be running.  Defaults to 0.
23ac29
23ac29
#
23ac29
#  Examples (commented out by default):
23ac29
#
23ac29
23ac29
#  Make sure mountd is running
23ac29
#proc mountd
23ac29
23ac29
#  Make sure there are no more than 4 ntalkds running, but 0 is ok too.
23ac29
#proc ntalkd 4
23ac29
23ac29
#  Make sure at least one sendmail, but less than or equal to 10 are running.
23ac29
#proc sendmail 10 1
23ac29
23ac29
#  A snmpwalk of the process mib tree would look something like this:
23ac29
# 
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.2
23ac29
# enterprises.ucdavis.procTable.prEntry.prIndex.1 = 1
23ac29
# enterprises.ucdavis.procTable.prEntry.prIndex.2 = 2
23ac29
# enterprises.ucdavis.procTable.prEntry.prIndex.3 = 3
23ac29
# enterprises.ucdavis.procTable.prEntry.prNames.1 = "mountd"
23ac29
# enterprises.ucdavis.procTable.prEntry.prNames.2 = "ntalkd"
23ac29
# enterprises.ucdavis.procTable.prEntry.prNames.3 = "sendmail"
23ac29
# enterprises.ucdavis.procTable.prEntry.prMin.1 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prMin.2 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prMin.3 = 1
23ac29
# enterprises.ucdavis.procTable.prEntry.prMax.1 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prMax.2 = 4
23ac29
# enterprises.ucdavis.procTable.prEntry.prMax.3 = 10
23ac29
# enterprises.ucdavis.procTable.prEntry.prCount.1 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prCount.2 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prCount.3 = 1
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrorFlag.1 = 1
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrorFlag.2 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrorFlag.3 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrMessage.1 = "No mountd process running."
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrMessage.2 = ""
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrMessage.3 = ""
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrFix.1 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrFix.2 = 0
23ac29
# enterprises.ucdavis.procTable.prEntry.prErrFix.3 = 0
23ac29
#
23ac29
#  Note that the errorFlag for mountd is set to 1 because one is not
23ac29
#  running (in this case an rpc.mountd is, but thats not good enough),
23ac29
#  and the ErrMessage tells you what's wrong.  The configuration
23ac29
#  imposed in the snmpd.conf file is also shown.  
23ac29
# 
23ac29
#  Special Case:  When the min and max numbers are both 0, it assumes
23ac29
#  you want a max of infinity and a min of 1.
23ac29
#
23ac29
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Executables/scripts
23ac29
#
23ac29
23ac29
#
23ac29
#  You can also have programs run by the agent that return a single
23ac29
#  line of output and an exit code.  Here are two examples.
23ac29
#
23ac29
#  exec NAME PROGRAM [ARGS ...]
23ac29
#
23ac29
#  NAME:     A generic name. The name must be unique for each exec statement.
23ac29
#  PROGRAM:  The program to run.  Include the path!
23ac29
#  ARGS:     optional arguments to be passed to the program
23ac29
23ac29
# a simple hello world
23ac29
23ac29
#exec echotest /bin/echo hello world
23ac29
23ac29
# Run a shell script containing:
23ac29
#
23ac29
# #!/bin/sh
23ac29
# echo hello world
23ac29
# echo hi there
23ac29
# exit 35
23ac29
#
23ac29
# Note:  this has been specifically commented out to prevent
23ac29
# accidental security holes due to someone else on your system writing
23ac29
# a /tmp/shtest before you do.  Uncomment to use it.
23ac29
#
23ac29
#exec shelltest /bin/sh /tmp/shtest
23ac29
23ac29
# Then, 
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.8
23ac29
# enterprises.ucdavis.extTable.extEntry.extIndex.1 = 1
23ac29
# enterprises.ucdavis.extTable.extEntry.extIndex.2 = 2
23ac29
# enterprises.ucdavis.extTable.extEntry.extNames.1 = "echotest"
23ac29
# enterprises.ucdavis.extTable.extEntry.extNames.2 = "shelltest"
23ac29
# enterprises.ucdavis.extTable.extEntry.extCommand.1 = "/bin/echo hello world"
23ac29
# enterprises.ucdavis.extTable.extEntry.extCommand.2 = "/bin/sh /tmp/shtest"
23ac29
# enterprises.ucdavis.extTable.extEntry.extResult.1 = 0
23ac29
# enterprises.ucdavis.extTable.extEntry.extResult.2 = 35
23ac29
# enterprises.ucdavis.extTable.extEntry.extOutput.1 = "hello world."
23ac29
# enterprises.ucdavis.extTable.extEntry.extOutput.2 = "hello world."
23ac29
# enterprises.ucdavis.extTable.extEntry.extErrFix.1 = 0
23ac29
# enterprises.ucdavis.extTable.extEntry.extErrFix.2 = 0
23ac29
23ac29
# Note that the second line of the /tmp/shtest shell script is cut
23ac29
# off.  Also note that the exit status of 35 was returned.
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# disk checks
23ac29
#
23ac29
23ac29
# The agent can check the amount of available disk space, and make
23ac29
# sure it is above a set limit.  
23ac29
23ac29
# disk PATH [MIN=100000]
23ac29
#
23ac29
# PATH:  mount path to the disk in question.
23ac29
# MIN:   Disks with space below this value will have the Mib's errorFlag set.
23ac29
#        Default value = 100000.
23ac29
23ac29
# Check the / partition and make sure it contains at least 10 megs.
23ac29
23ac29
#disk / 10000
23ac29
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.9
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskIndex.1 = 0
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskPath.1 = "/" Hex: 2F 
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskDevice.1 = "/dev/dsk/c201d6s0"
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskMinimum.1 = 10000
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskTotal.1 = 837130
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskAvail.1 = 316325
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskUsed.1 = 437092
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskPercent.1 = 58
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskErrorFlag.1 = 0
23ac29
# enterprises.ucdavis.diskTable.dskEntry.diskErrorMsg.1 = ""
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# load average checks
23ac29
#
23ac29
23ac29
# load [1MAX=12.0] [5MAX=12.0] [15MAX=12.0]
23ac29
#
23ac29
# 1MAX:   If the 1 minute load average is above this limit at query
23ac29
#         time, the errorFlag will be set.
23ac29
# 5MAX:   Similar, but for 5 min average.
23ac29
# 15MAX:  Similar, but for 15 min average.
23ac29
23ac29
# Check for loads:
23ac29
#load 12 14 14
23ac29
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.10
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveIndex.1 = 1
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveIndex.2 = 2
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveIndex.3 = 3
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveNames.1 = "Load-1"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveNames.2 = "Load-5"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveNames.3 = "Load-15"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveLoad.1 = "0.49" Hex: 30 2E 34 39 
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveLoad.2 = "0.31" Hex: 30 2E 33 31 
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveLoad.3 = "0.26" Hex: 30 2E 32 36 
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveConfig.1 = "12.00"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveConfig.2 = "14.00"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveConfig.3 = "14.00"
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrorFlag.1 = 0
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrorFlag.2 = 0
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrorFlag.3 = 0
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrMessage.1 = ""
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrMessage.2 = ""
23ac29
# enterprises.ucdavis.loadTable.laEntry.loadaveErrMessage.3 = ""
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Extensible sections.
23ac29
# 
23ac29
23ac29
# This alleviates the multiple line output problem found in the
23ac29
# previous executable mib by placing each mib in its own mib table:
23ac29
23ac29
# Run a shell script containing:
23ac29
#
23ac29
# #!/bin/sh
23ac29
# echo hello world
23ac29
# echo hi there
23ac29
# exit 35
23ac29
#
23ac29
# Note:  this has been specifically commented out to prevent
23ac29
# accidental security holes due to someone else on your system writing
23ac29
# a /tmp/shtest before you do.  Uncomment to use it.
23ac29
#
23ac29
# exec .1.3.6.1.4.1.2021.50 shelltest /bin/sh /tmp/shtest
23ac29
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.50
23ac29
# enterprises.ucdavis.50.1.1 = 1
23ac29
# enterprises.ucdavis.50.2.1 = "shelltest"
23ac29
# enterprises.ucdavis.50.3.1 = "/bin/sh /tmp/shtest"
23ac29
# enterprises.ucdavis.50.100.1 = 35
23ac29
# enterprises.ucdavis.50.101.1 = "hello world."
23ac29
# enterprises.ucdavis.50.101.2 = "hi there."
23ac29
# enterprises.ucdavis.50.102.1 = 0
23ac29
23ac29
# Now the Output has grown to two lines, and we can see the 'hi
23ac29
# there.' output as the second line from our shell script.
23ac29
#
23ac29
# Note that you must alter the mib.txt file to be correct if you want
23ac29
# the .50.* outputs above to change to reasonable text descriptions.
23ac29
23ac29
# Other ideas:
23ac29
# 
23ac29
# exec .1.3.6.1.4.1.2021.51 ps /bin/ps 
23ac29
# exec .1.3.6.1.4.1.2021.52 top /usr/local/bin/top
23ac29
# exec .1.3.6.1.4.1.2021.53 mailq /usr/bin/mailq
23ac29
23ac29
# -----------------------------------------------------------------------------
23ac29
23ac29
23ac29
###############################################################################
23ac29
# Pass through control.
23ac29
# 
23ac29
23ac29
# Usage:
23ac29
#   pass MIBOID EXEC-COMMAND
23ac29
#
23ac29
# This will pass total control of the mib underneath the MIBOID
23ac29
# portion of the mib to the EXEC-COMMAND.  
23ac29
#
23ac29
# Note:  You'll have to change the path of the passtest script to your
23ac29
# source directory or install it in the given location.
23ac29
# 
23ac29
# Example:  (see the script for details)
23ac29
#           (commented out here since it requires that you place the
23ac29
#           script in the right location. (its not installed by default))
23ac29
23ac29
# pass .1.3.6.1.4.1.2021.255 /bin/sh /usr/local/local/passtest
23ac29
23ac29
# % snmpwalk -v 1 localhost -c public .1.3.6.1.4.1.2021.255
23ac29
# enterprises.ucdavis.255.1 = "life the universe and everything"
23ac29
# enterprises.ucdavis.255.2.1 = 42
23ac29
# enterprises.ucdavis.255.2.2 = OID: 42.42.42
23ac29
# enterprises.ucdavis.255.3 = Timeticks: (363136200) 42 days, 0:42:42
23ac29
# enterprises.ucdavis.255.4 = IpAddress: 127.0.0.1
23ac29
# enterprises.ucdavis.255.5 = 42
23ac29
# enterprises.ucdavis.255.6 = Gauge: 42
23ac29
#
23ac29
# % snmpget -v 1 localhost public .1.3.6.1.4.1.2021.255.5
23ac29
# enterprises.ucdavis.255.5 = 42
23ac29
#
23ac29
# % snmpset -v 1 localhost public .1.3.6.1.4.1.2021.255.1 s "New string"
23ac29
# enterprises.ucdavis.255.1 = "New string"
23ac29
#
23ac29
23ac29
# For specific usage information, see the man/snmpd.conf.5 manual page
23ac29
# as well as the local/passtest script used in the above example.
23ac29
23ac29
###############################################################################
23ac29
# Further Information
23ac29
#
23ac29
#  See the snmpd.conf manual page, and the output of "snmpd -H".