Skip to content

MrMMorris/cookbook-snmp

 
 

Repository files navigation

SNMP Build Status

DESCRIPTION

Installs and configures snmpd.

The SNMP multiplex (smuxpeer) line will be set for Dell OpenManage, if Dell manufactured hardware is detected by Ohai.

REQUIREMENTS

This cookbook provides an SNMP Extend example to collect DNS RNDC statistics. The SNMP Extend script is written in Perl and depends on the CPAN module "version", and Getopt::Declare.

There is a loose dependency recommending the "perl" cookbook. If you have no need for the SNMP Extend example included, you may remove the "depends perl" line from metadata.rb. Then run 'knife cookbook metadata snmp' before uploading to the Chef server.

RECIPES

  • snmp::default

    • Installs and configures SNMP
  • snmp::snmptrapd

    • Configures snmptrapd
  • snmp::extendbind

    • Example recipe to deploy a Perl based extend script to collect stats from a BIND 9 server.

ATTRIBUTES

Notable overridable attributes are as follows. It is recommended to override these following attributes to best suit your own environment.

  • snmp[:community]

    • SNMP Community String, default is "public".
  • snmp[:trapcommunity]

    • SNMP Community Trap String, default is "public".
  • snmp[:trapsinks]

    • Array of trapsink hosts, and optionall Community Trap strings. This is an empty array by default.
  • snmp[:syscontact]

    • String to set a name, and e-mail address for systems. Default is "Root root@localhost"
  • snmp[:syslocationPhysical]

    • String to set the location for physical systems. Default is "Server Room".
  • snmp[:syslocationVirtual]

    • String to set the location for Virtual Machines. Default is "Virtual Server".
  • snmp[:full_systemview]

    • Boolean to include the full systemview. This defaults to "false" as many distributions ship this way to speed up snmpwalk. However, if you're running SNMP Network Management System, you'll want to override this as "true" on your systems.
  • snmp[:include_all_disks]

    • Boolean to include disk usage checks for all filesystems. Default is "false"
  • snmp[:all_disk_min]

    • Number of bytes that should be free on each disk when :include_all_disks is 'true.' Can also be expressed as a string specifying a minimum percent e.g. "10%". Default is 100 (100kB) which is the normal snmpd default.
  • snmp[:disks]

    • Specify individual disks to monitor or, if monitoring all disks, specify different minimums. If set, the template expects this to be an array of hashes specifying the mount point of the disk to monitor and the minimum threshold in the form of {:mount => '/', :min => 100000}. As with :all_disk_min, :min can also be expressed as a percent. Default is an empty array.
  • snmp['snmpd']['mibdirs']

    • MIB directories. "/usr/share/snmp/mibs" is the default
  • snmp['snmpd']['mibs']

    • MIBs to load. The default is not to set any and is therefore dependant on the daemon default.
  • snmp['snmpd']['snmpd_run']

    • snmpd control (default of "yes" means start daemon)
  • snmp]['snmpd']['snmpd_opts']

    • snmpd options
  • snmp['process_monitoring']['proc']

    • Array of processes to monitor. This is an empty array by default.
  • snmp['process_monitoring']['procfix']

    • Array of procfix lines to configure. This is an empty array by default.
    • These are run when a monitored process is in an error state.
  • snmp['snmpd']['trapd_run']

    • snmptrapd control (default of "no" means do not start daemon) master agentx support must be enabled in snmpd before snmptrapd can be run. See snmpd.conf(5) for how to do this.
  • snmp['snmpd']['trapd_opts']

    • snmptrapd options
  • snmp['snmpd']['snmpd_compat']

    • Create symlink on Debian legacy location to official RFC path Default is "yes".

default['snmp']['disman_events']['enable'] = false default['snmp']['disman_events']['user'] = "disman_events" default['snmp']['disman_events']['password'] = "disman_password" default['snmp']['disman_events']['linkUpDownNotifications'] = "yes" default['snmp']['disman_events']['defaultMonitors'] = "yes" default['snmp']['disman_events']['monitors'] = Array.new

  • snmp['disman_events']['enable']

    • Boolean value for enabling DisMan Event MIB configuration Default is false.
  • snmp['disman_events']['user'] and snmp['disman_events']['password']

    • String values for SNMPv3 credentials to set for the DisMan Event MIB to work.
  • snmp['disman_events']['linkUpDownNotifications']

    • String value which must be "yes" or "no" to enable traps for link state change notifications. Default is "yes".
  • snmp['disman_events']['defaultMonitors']

    • String value which must be "yes" or "no" to enable traps for the DisMan Event MIB default checks. See the snmpd.conf manual for details. Default is "yes".
  • snmp['disman_events']['monitors']

    • Array of string values for additional 'monitor' config entries. Default is an empty array.

USAGE

Here is a full example featuring all the overridable attributes. You can apply these override attributes in a role, or node context.

  override_attributes "snmp" => {
    "community" => "secret",
    "full_systemview" => true,
    "disks" => [{:mount => "/", :min => "10%"}],
    "trapsinks" => [ "zenoss.example.com", "nagios.example.com" ],
    "syslocationPhysical" => "Server Room",
    "syslocationVirtual" => "Cloud - Virtual Pool",
    "syscontact" => "[email protected]"
  }

ACKNOWLEDGEMENTS

Thanks to Sami Haahtinen on Freenode/#chef for testing, and feedback pertinent to the Debian/Ubuntu platforms.

AUTHOR AND LICENSE

Author:: Eric G. Wolfe ([email protected])

Copyright 2010-2012

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Chef cookbook for SNMP configuration

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Perl 58.9%
  • Ruby 40.6%
  • Shell 0.5%