summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/netgroup.py
diff options
context:
space:
mode:
authorRob Crittenden <rcritten@redhat.com>2010-06-02 14:08:50 -0400
committerRob Crittenden <rcritten@redhat.com>2010-06-22 13:58:04 -0400
commit901ccc1393a7e494f7b1b64eaeb2f7809056aafa (patch)
treeb9523a814ed72e08ac286134bb45cf07e6e053f4 /ipalib/plugins/netgroup.py
parent8c6c93125f344ca117cc24b2e96c55b1d9ae31bd (diff)
downloadfreeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.gz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.tar.xz
freeipa-901ccc1393a7e494f7b1b64eaeb2f7809056aafa.zip
First pass at per-command documentation
Diffstat (limited to 'ipalib/plugins/netgroup.py')
-rw-r--r--ipalib/plugins/netgroup.py20
1 files changed, 20 insertions, 0 deletions
diff --git a/ipalib/plugins/netgroup.py b/ipalib/plugins/netgroup.py
index 6fd0670b0..ad97c7226 100644
--- a/ipalib/plugins/netgroup.py
+++ b/ipalib/plugins/netgroup.py
@@ -19,6 +19,26 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Netgroups
+
+A netgroup is a group used for permission checking. It can contain both
+user and host values.
+
+EXAMPLES:
+
+ Create a new netgroup:
+ ipa netgroup-add --desc='NFS admins' admins
+
+ Add a member to the group:
+ ipa netgroup-add-member --users=tuser1,tuser2 admins
+
+ Remove a member from the group:
+ ipa netgroup-remove-member --users=tuser2 admins
+
+ Display a netgroup:
+ ipa netgroup-show admins
+
+ Remove a netgroup:
+ ipa netgroup-del admins
"""
from ipalib import api, errors