aboutsummaryrefslogtreecommitdiff
path: root/manifests/shared_network.pp
diff options
context:
space:
mode:
Diffstat (limited to 'manifests/shared_network.pp')
-rw-r--r--manifests/shared_network.pp20
1 files changed, 15 insertions, 5 deletions
diff --git a/manifests/shared_network.pp b/manifests/shared_network.pp
index 38f14fb..766f432 100644
--- a/manifests/shared_network.pp
+++ b/manifests/shared_network.pp
@@ -1,12 +1,22 @@
-# == 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,