aboutsummaryrefslogtreecommitdiff
path: root/manifests/subnet.pp
diff options
context:
space:
mode:
Diffstat (limited to 'manifests/subnet.pp')
-rw-r--r--manifests/subnet.pp34
1 files changed, 16 insertions, 18 deletions
diff --git a/manifests/subnet.pp b/manifests/subnet.pp
index b9826da..b70a233 100644
--- a/manifests/subnet.pp
+++ b/manifests/subnet.pp
@@ -1,29 +1,27 @@
-# = 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,