* dhcp
* dhcp::server
+### dhcp
+
+The `dhcp` class is a wrapper around `dhcp::server`:
+
+ include ::dhcp
+
+### dhcp::server
+
## Definitions
* dhcp::hosts
#
# Creates a dhcp configuration for given hosts
#
-# Arguments
-# $template: dhcp host template - default: 'dhcp/host.conf.erb'
-# $global_options: an array of global options for the whole bunch of hosts.
-# you may override it per host, setting the host "options"
-# directly in the hash.
-# $subnet: targeted subnet
-# $hash_data: hash containing data - default form:
+# Parameters:
+# ['template'] - DHCP host template - default: 'dhcp/host.conf.erb'
+# ['global_options'] - An array of global options for the whole bunch of
+# hosts. You may override it per host, setting the
+# host "options" directly in the hash.
+# ['subnet'] - Targeted subnet
+# ['hash_data'] - Hash containing data - default form:
# {
# <host1> => {
# options => ['opt1', 'opt2'],
# …,
# }
#
+# Sample usage:
+# ::dhcp::hosts { 'workstations':
+# subnet => '192.168.1.0',
+# 'hash_data' => {
+# 'host1' => {
+# 'interfaces' => {
+# 'eth0' => '00:11:22:33:44:55',
+# 'wlan0' => '00:aa:bb:44:55:ff',
+# },
+# },
+# 'host2' => {
+# 'interfaces' => {
+# 'eth1' => '00:11:af:33:44:55',
+# },
+# 'fixed_address' => 'foo.example.com',
+# 'options' => ['opt1'],
+# },
+# },
+# }
+#
+# Requires:
+# - puppetlabs/stdlib
+# - ripienaar/concat
+#
define dhcp::hosts (
$hash_data,
$subnet,
+# Class: dhcp
+#
+# This class provides a simple way to install a DHCP server
+# It will install and configure the necessary packages.
+#
+# Parameters:
+# ['server'] - Whether to install the DHCP server
+# (default: true)
+# ['server_ddns_update'] - Set ddns_update on dhcp::server
+# ['server_authoritative'] - Set authoritative on dhcp::server
+# ['server_opts'] - Set opts for dhcp::server
+#
+# Actions:
+# - Deploys a DHCP server
+#
+# Sample usage:
+# include ::dhcp
+#
+# Requires:
+# - puppetlabs/stdlib
+# - ripienaar/concat
+#
class dhcp (
$server = true,
$server_ddns_update = undef,
-# = Class: dhcp::server
-# Simple OS wrapper. Include this to install a dhcp server on your host.
+# Class: dhcp::server
#
-# Requires:
-# module "common": git://github.com/camptocamp/puppet-common.git
+# Installs and configures a DHCP server.
#
-# facultative argument:
-# *$ddns_update* : ddns-update-style option (defaults to 'none')
-# *$authoritative* : a boolean setting whether the DHCP server is
-# authoritative (defaults to false)
-# *$opts* : an array of DHCPD valid options
+# Parameters:
+# ['ddns_update'] : ddns-update-style option (defaults to 'none')
+# ['authoritative'] : a boolean setting whether the DHCP server is
+# authoritative (defaults to false)
+# ['opts'] : an array of DHCPD valid options
#
-# Example:
-# node "dhcp.toto.ltd" {
-# class { 'dhcp::server':
-# opts => ['domain-name "toto.ltd"',
-# 'domain-name-servers 192.168.21.1'],
-# }
+# Sample usage:
+# node "dhcp.toto.ltd" {
+# class { 'dhcp::server':
+# opts => ['domain-name "toto.ltd"',
+# 'domain-name-servers 192.168.21.1'],
+# }
#
-# dhcp::subnet {"10.27.20.0":
-# ensure => present,
-# broadcast => "10.27.20.255",
-# other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
-# }
+# dhcp::subnet {"10.27.20.0":
+# ensure => present,
+# broadcast => "10.27.20.255",
+# other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
+# }
#
-# dhcp::host {"titi-eth0":
-# ensure => present,
-# mac => "0e:18:fa:fe:d9:00",
-# subnet => "10.27.20.0",
-# fixed_address => "10.27.10.52",
+# dhcp::host {"titi-eth0":
+# ensure => present,
+# mac => "0e:18:fa:fe:d9:00",
+# subnet => "10.27.20.0",
+# fixed_address => "10.27.10.52",
+# }
# }
-# }
+#
+# Requires:
+# - puppetlabs/stdlib
+# - ripienaar/concat
#
class dhcp::server (
$ddns_update = 'none',
-# == Definition: dhcp::shared-network
+# Definition: dhcp::shared-network
+#
# Creates a shared-network
#
-# Arguments:
-# *$subnets* : subnet list to be included in the shared-network
+# Parameters:
+# ['subnets'] - An array of subnets to be included in the shared-network.
+#
+# Sample usage:
+# ::dhcp::shared_network { 'office':
+# subnets => ['192.168.1.0', '192.168.2.0'],
+# }
+#
+# Requires:
+# - puppetlabs/stdlib
+# - ripienaar/concat
#
# Warnings:
-# - subnets must exists
-# - subnets must have $is_shared set to true (default is false)
+# - subnets must exists
+# - subnets must have $is_shared set to true (default is false)
#
define dhcp::shared_network(
$ensure = present,
-# = Definition: dhcp::subnet
-# Creates a subnet
-#
-# Arguments:
-# *$broadcast* : subnet broadcast (mandatory)
-# *$netmask* : subnet netmask (if not set, takes eth0 netmask)
-# *$routers* : subnet routers (array) (if not set, takes eth0 IP)
-# *$subnet_mask* : netmask sent to dhcp guests (if not set, takes
-# $netmask, or netmask_eth0)
-# *$domain_name* : subnet domain name (if not set, takes server domain)
-# *$other_opts* : any other DHCPD option, as an array
-# *$is_shared* : whether it's part of a shared network or not. Default: false
+# Definition: dhcp::subnet
#
-# Example:
+# Creates a subnet
#
-# node "dhcp.domain.ltd" {
-# $dhcpd_domain_name = 'domain.ltd'
-# $dhcpd_dns_servers = '10.27.21.1, 10.26.21.1'
-# include dhcp
+# Parameters:
+# ['broadcast'] : subnet broadcast (mandatory)
+# ['netmask'] : subnet netmask
+# (default: $::netmask_eth0)
+# ['routers'] : An array of subnet routers
+# (default: $::netmask)
+# ['subnet_mask'] : netmask sent to dhcp guests
+# (default: the value of $netmask)
+# ['domain_name'] : subnet domain name
+# (default: $::domain)
+# ['other_opts'] : An array of additional DHCPD options
+# ['is_shared'] : whether it's part of a shared network or not
+# (default: false)
#
+# Sample usage:
# dhcp::subnet {"10.27.20.0":
# ensure => present,
# broadcast => "10.27.20.255",
# other_opts => ['filename "pxelinux.0";', 'next-server 10.27.10.1;'],
# }
-# }
#
define dhcp::subnet(
$broadcast,
projects / puppet-dhcp.git / commitdiff