summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorwanghong <w.wanghong@huawei.com>2014-12-23 12:14:32 +0800
committerwanghong <w.wanghong@huawei.com>2014-12-24 14:31:12 +0800
commite5d71221adb17d05d14a1a692aed39dfc217151f (patch)
tree2daab64eaf5156dc925fbf4f490882e3c957ed17 /doc/source/command-objects
parenta24d6e7c6f06ccaecefa0a2c6cd2c105f3cd8be5 (diff)
downloadpython-openstackclient-e5d71221adb17d05d14a1a692aed39dfc217151f.tar.gz
add doc for group command
Change-Id: Iaaa0aeb42f9f940af63863f5d09011b5f7529281
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/group.rst192
1 files changed, 192 insertions, 0 deletions
diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst
new file mode 100644
index 00000000..85a0c5cd
--- /dev/null
+++ b/doc/source/command-objects/group.rst
@@ -0,0 +1,192 @@
+=====
+group
+=====
+
+Identity v3
+
+group add user
+--------------
+
+Add user to group
+
+.. program:: group add user
+.. code:: bash
+
+ os group add user
+ <group>
+ <user>
+
+.. option:: <group>
+
+ Group that user will be added to (name or ID)
+
+.. option:: <user>
+
+ User to add to group (name or ID)
+
+group contains user
+-------------------
+
+Check user in group
+
+.. program:: group contains user
+.. code:: bash
+
+ os group contains user
+ <group>
+ <user>
+
+.. option:: <group>
+
+ Group to check if user belongs to (name or ID)
+
+.. option:: <user>
+
+ User to check (name or ID)
+
+group create
+------------
+
+Create new group
+
+.. program:: group create
+.. code:: bash
+
+ os group create
+ [--domain <domain>]
+ [--description <description>]
+ [--or-show]
+ <group-name>
+
+.. option:: --domain <domain>
+
+ References the domain ID or name which owns the group
+
+.. option:: --description <description>
+
+ New group description
+
+.. option:: --or-show
+
+ Return existing group
+
+ If the group already exists, return the existing group data and do not fail.
+
+.. option:: <group-name>
+
+ New group name
+
+group delete
+------------
+
+Delete group
+
+.. program:: group delete
+.. code:: bash
+
+ os group delete
+ [--domain <domain>]
+ <group> [<group> ...]
+
+.. option:: --domain <domain>
+
+ Domain where group resides (name or ID)
+
+.. option:: <group>
+
+ Group(s) to delete (name or ID)
+
+group list
+----------
+
+List groups
+
+.. program:: group list
+.. code:: bash
+
+ os group list
+ [--domain <domain>]
+ [--user <user>]
+ [--long]
+
+.. option:: --domain <domain>
+
+ Filter group list by <domain> (name or ID)
+
+.. option:: --user <user>
+
+ List group memberships for <user> (name or ID)
+
+.. option:: --long
+
+ List additional fields in output (defaults to false)
+
+group remove user
+-----------------
+
+Remove user from group
+
+.. program:: group remove user
+.. code:: bash
+
+ os group remove user
+ <group>
+ <user>
+
+.. option:: <group>
+
+ Group that user will be removed from (name or ID)
+
+.. option:: <user>
+
+ User to remove from group (name or ID)
+
+group set
+---------
+
+Set group properties
+
+.. program:: group set
+.. code:: bash
+
+ os group set
+ [--name <name>]
+ [--domain <domain>]
+ [--description <description>]
+ <group>
+
+.. option:: --name <name>
+
+ New group name
+
+.. option:: --domain <domain>
+
+ New domain that will now own the group (name or ID)
+
+.. option:: --description <description>
+
+ New group description
+
+.. option:: <group>
+
+ Group to modify (name or ID)
+
+group show
+----------
+
+Show group details
+
+.. program:: group show
+.. code:: bash
+
+ os group show
+ [--domain <domain>]
+ <group>
+
+.. option:: --domain <domain>
+
+ Domain where group resides (name or ID)
+
+.. option:: <group>
+
+ Group to display (name or ID)