Table of Contents
- Setup - The basics of getting started with arpwatch
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- Release Notes
Install and configure arpwatch
Beginning with arpwatch
include ::arpwatch is enough to get you up and running.
All interaction with the arpwatch module is done through the main arpwatch class. You can simply set the options in
::arpwatch to have full functionality of the module.
- arpwatch: Main class, installs and configures arpwatch
- arpwatch::params: Determines and sets the defaults used by the main arpwatch class
The following parameters are available in the
Specifies a file for arpwatch's configuration. Valid options: string containing an absolute path. Default value: '/etc/sysconfig/arpwatch'
Specifies a file to act as a ERB template for the config file. Valid options: string containing a path (absolute, or relative to the module path). Example value: 'arpwatch/conf.rhel.erb'
Specifies the email address to send arpwatch alerts to. Valid options: string. Default value: '-' (suppresses all email output from arpwatch)
Specifies the interface to monitor for arp changes. Valid options: string containing an interface name. Default: eth0
Specify additional options to pass to arpwatch at start. Valid options: string of command line options. Default: OS dependant
Tells Puppet whether the arpwatch package should be installed, and what version. Valid options: 'present', 'latest', or a specific version number. Default value: 'present'
Tells Puppet what arpwatch package to manage. Valid options: string. Default value: 'arpwatch'
Tells Puppet whether to enable the arpwatch service at boot. Valid options: true or false. Default value: true
Tells Puppet whether the arpwatch service should be running. Valid options: 'running' or 'stopped'. Default value: 'running'
Tells Puppet what arpwatch service to manage. Valid options: string. Default value: 'arpwatch'
Specifies which user account arpwatch should run under. Valid options: string. Default value: 'arpwatch' ('pcap' under RHEL5)
Specifies the source email address for arpwatch emails. Only works under RedHat family distributions. Valid options: string. Default value: 'arpwatch@$fqdn'
This module currently supports RedHat and Debian distributions. It has only been thoroughly tested under RedHat. Pull requests are welcome to add support for other platforms.
Pull requests are welcome. Please make sure to properly document any additions or changes made to the module.
v0.2.0 - Add support for Debian
v0.1.2 - Add spec tests and dependencies
v0.1.0 - Initial release of arpwatch module