From 8b2268cdfc54854feccafd335be71d06e7880d9f Mon Sep 17 00:00:00 2001
From: Gardouille <gardouille@gmail.com>
Date: Tue, 20 Jan 2015 08:55:41 +0100
Subject: [PATCH] * Add .gitignore for swp and puppet module's pkg files. *
 Publish the 0.1.0 version to puppet forge labs:
 https://forge.puppetlabs.com/gardouille/ipmi/readme

---
 .gitignore                     |  2 ++
 CHANGELOG.md                   |  3 ++-
 README.md                      | 17 ++++++++++++++++-
 manifests/ressource/channel.pp | 18 ++++++++++++++++++
 4 files changed, 38 insertions(+), 2 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..6ee20c2
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+pkg/
+*.swp
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 444e007..fd61e11 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,7 @@
 
 ### 0.1.0 - 2015/01/19
 
-
+Inital release.
 
 ##### Changes
 * Install package ipmitool
@@ -11,3 +11,4 @@
 * Load one needed module (for Debian) one time
 * Update README.md file.
 * Add a defined type to manage IPMI's user and channel.
+* Add .gitignore for swp and puppet module's pkg files.
diff --git a/README.md b/README.md
index 505e1cd..f7e9ba3 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,22 @@ the fancy stuff with your module here.
 
 ### Defined types
 
-* Not yet implemented
+* `ipmi::ressource::channel`: Manage IPMI's channel configuration (only lan right now).
+
+```
+ipmi::ressource::channel { '1':
+  ipaddr  => '192.168.100.1',
+  netmask => '255.255.255.0',
+}
+```
+
+* `ipmi::ressource::user`: Manage IPMI's user (can't create a new one):
+
+```
+ipmi::ressource::user { 'admin':
+  password => 'my_new_password',
+}
+```
 
 ### Parameters
 
diff --git a/manifests/ressource/channel.pp b/manifests/ressource/channel.pp
index 079a4cb..d1351c3 100644
--- a/manifests/ressource/channel.pp
+++ b/manifests/ressource/channel.pp
@@ -5,6 +5,24 @@
 # === Parameters
 #
 # [*channel_id*]
+#   _default_: +$title+, the title/name of the ressource
+#
+#   Is the channel identifier.
+#
+# [*ipaddr*]
+#   _default_: +0.0.0.0+
+#
+#   The ip address to allow remote access from lan.
+#
+# [*netmask*]
+#   _default_: +0.0.0.0+
+#
+#   The netmask associated to the previous ip address.
+#
+# [*remote_access*]
+#   _default_: +on+
+#
+#   Allow remote access from lan (+on+) or disable it (+off+).
 #
 define ipmi::ressource::channel ( $channel_id = $title, $ipaddr = '0.0.0.0', $netmask = '0.0.0.0', $remote_access = 'on' ) {