summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/group.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/group.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/group.rst')
-rw-r--r--doc/source/command-objects/group.rst249
1 files changed, 0 insertions, 249 deletions
diff --git a/doc/source/command-objects/group.rst b/doc/source/command-objects/group.rst
deleted file mode 100644
index ac938efd..00000000
--- a/doc/source/command-objects/group.rst
+++ /dev/null
@@ -1,249 +0,0 @@
-=====
-group
-=====
-
-Identity v3
-
-group add user
---------------
-
-Add user to group
-
-.. program:: group add user
-.. code:: bash
-
- openstack group add user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user> [<user> ...]
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group to contain <user> (name or ID)
-
-.. describe:: <user>
-
- User(s) to add to <group> (name or ID)
- (repeat option to add multiple users)
-
-group contains user
--------------------
-
-Check user membership in group
-
-.. program:: group contains user
-.. code:: bash
-
- openstack group contains user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user>
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group to check (name or ID)
-
-.. describe:: <user>
-
- User to check (name or ID)
-
-group create
-------------
-
-Create new group
-
-.. program:: group create
-.. code:: bash
-
- openstack group create
- [--domain <domain>]
- [--description <description>]
- [--or-show]
- <group-name>
-
-.. option:: --domain <domain>
-
- Domain to contain new group (name or ID)
-
-.. 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.
-
-.. describe:: <group-name>
-
- New group name
-
-group delete
-------------
-
-Delete group
-
-.. program:: group delete
-.. code:: bash
-
- openstack group delete
- [--domain <domain>]
- <group> [<group> ...]
-
-.. option:: --domain <domain>
-
- Domain containing group(s) (name or ID)
-
-.. describe:: <group>
-
- Group(s) to delete (name or ID)
-
-group list
-----------
-
-List groups
-
-.. program:: group list
-.. code:: bash
-
- openstack group list
- [--domain <domain>]
- [--user <user> [--user-domain <user-domain>]]
- [--long]
-
-.. option:: --domain <domain>
-
- Filter group list by <domain> (name or ID)
-
-.. option:: --user <user>
-
- Filter group list by <user> (name or ID)
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. option:: --long
-
- List additional fields in output
-
-group remove user
------------------
-
-Remove user from group
-
-.. program:: group remove user
-.. code:: bash
-
- openstack group remove user
- [--group-domain <group-domain>]
- [--user-domain <user-domain>]
- <group>
- <user> [<user> ...]
-
-.. option:: --group-domain <group-domain>
-
- Domain the group belongs to (name or ID). This can be
- used in case collisions between group names exist.
-
- .. versionadded:: 3
-
-.. option:: --user-domain <user-domain>
-
- Domain the user belongs to (name or ID). This can be
- used in case collisions between user names exist.
-
- .. versionadded:: 3
-
-.. describe:: <group>
-
- Group containing <user> (name or ID)
-
-.. describe:: <user>
-
- User(s) to remove from <group> (name or ID)
- (repeat option to remove multiple users)
-
-group set
----------
-
-Set group properties
-
-.. program:: group set
-.. code:: bash
-
- openstack group set
- [--domain <domain>]
- [--name <name>]
- [--description <description>]
- <group>
-
-.. option:: --domain <domain>
-
- Domain containing <group> (name or ID)
-
-.. option:: --name <name>
-
- New group name
-
-.. option:: --description <description>
-
- New group description
-
-.. describe:: <group>
-
- Group to modify (name or ID)
-
-group show
-----------
-
-Display group details
-
-.. program:: group show
-.. code:: bash
-
- openstack group show
- [--domain <domain>]
- <group>
-
-.. option:: --domain <domain>
-
- Domain containing <group> (name or ID)
-
-.. describe:: <group>
-
- Group to display (name or ID)