summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/domain.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli/command-objects/domain.rst')
-rw-r--r--doc/source/cli/command-objects/domain.rst119
1 files changed, 13 insertions, 106 deletions
diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst
index 70a3e733..81a19349 100644
--- a/doc/source/cli/command-objects/domain.rst
+++ b/doc/source/cli/command-objects/domain.rst
@@ -2,114 +2,21 @@
domain
======
-Identity v3
+A **domain** is a collection of **users**, **groups**, and **projects**. Each
+**group** and **project** is owned by exactly one **domain**. Applies to
+Identity v3.
-domain create
--------------
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: domain create
-Create new domain
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: domain delete
-.. program:: domain create
-.. code:: bash
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: domain list
- openstack domain create
- [--description <description>]
- [--enable | --disable]
- [--or-show]
- <domain-name>
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: domain set
-.. option:: --description <description>
-
- New domain description
-
-.. option:: --enable
-
- Enable domain (default)
-
-.. option:: --disable
-
- Disable domain
-
-.. option:: --or-show
-
- Return existing domain
-
- If the domain already exists, return the existing domain data and do not fail.
-
-.. describe:: <domain-name>
-
- New domain name
-
-domain delete
--------------
-
-Delete domain(s)
-
-.. program:: domain delete
-.. code:: bash
-
- openstack domain delete
- <domain> [<domain> ...]
-
-.. describe:: <domain>
-
- Domain(s) to delete (name or ID)
-
-domain list
------------
-
-List domains
-
-.. program:: domain list
-.. code:: bash
-
- openstack domain list
-
-domain set
-----------
-
-Set domain properties
-
-.. program:: domain set
-.. code:: bash
-
- openstack domain set
- [--name <name>]
- [--description <description>]
- [--enable | --disable]
- <domain>
-
-.. option:: --name <name>
-
- New domain name
-
-.. option:: --description <description>
-
- New domain description
-
-.. option:: --enable
-
- Enable domain
-
-.. option:: --disable
-
- Disable domain
-
-.. describe:: <domain>
-
- Domain to modify (name or ID)
-
-domain show
------------
-
-Display domain details
-
-.. program:: domain show
-.. code:: bash
-
- openstack domain show
- <domain>
-
-.. describe:: <domain>
-
- Domain to display (name or ID)
+.. autoprogram-cliff:: openstack.identity.v3
+ :command: domain show