From 928dbaa62bcc37092ddec36b1f715365576eae6d Mon Sep 17 00:00:00 2001
From: Raphaël Pinson <raphael.pinson@camptocamp.com>
Date: Fri, 12 Apr 2013 14:11:44 +0200
Subject: doc

---
 manifests/hosts.pp | 38 +++++++++++++++++++++++++++++++-------
 1 file changed, 31 insertions(+), 7 deletions(-)

(limited to 'manifests/hosts.pp')

diff --git a/manifests/hosts.pp b/manifests/hosts.pp
index 9e2b284..1767a90 100644
--- a/manifests/hosts.pp
+++ b/manifests/hosts.pp
@@ -2,13 +2,13 @@
 #
 # 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'],
@@ -33,6 +33,30 @@
 #        …,
 #      }
 #
+# 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,
-- 
cgit v1.2.3