From 901ccc1393a7e494f7b1b64eaeb2f7809056aafa Mon Sep 17 00:00:00 2001
From: Rob Crittenden <rcritten@redhat.com>
Date: Wed, 2 Jun 2010 14:08:50 -0400
Subject: First pass at per-command documentation

---
 ipalib/plugins/hostgroup.py | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'ipalib/plugins/hostgroup.py')

diff --git a/ipalib/plugins/hostgroup.py b/ipalib/plugins/hostgroup.py
index f233e286..fe5bed76 100644
--- a/ipalib/plugins/hostgroup.py
+++ b/ipalib/plugins/hostgroup.py
@@ -19,6 +19,26 @@
 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 Groups of hosts.
+
+This is useful for Host-Based Access Control (HBAC) to group a series
+of hosts together for applying access control.
+
+EXAMPLES:
+
+ Create a new host group:
+   ipa hostgroup-add --desc='Baltimore hosts' baltimore
+
+ Add some hosts to the group:
+   ipa hostgroup-add-member --hosts=box1,box2,box3 baltimore
+
+ Remove a host from the group:
+   ipa hostgroup-remove-member --hosts=box2 baltimore
+
+ Display a host group:
+   ipa hostgroup-show baltimore
+
+ Removey a host group:
+   ipa hostgroup-del baltimore
 """
 
 from ipalib.plugins.baseldap import *
-- 
cgit