diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2017-08-17 12:17:39 -0400 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-10-06 00:57:04 +0000 |
| commit | 0d94a76d956c0322e9c4607fb5ce824f7653f038 (patch) | |
| tree | 5044ef180d214ce9a161739c5a6d748970e94766 /doc/source/cli/command-objects/domain.rst | |
| parent | a87bd58fb4de5dc5f99193b88d2a3f8bd1338c52 (diff) | |
| download | python-openstackclient-0d94a76d956c0322e9c4607fb5ce824f7653f038.tar.gz | |
auto-generate docs for v3 identity resources
skipped shared v2/v3 identity resources.
Change-Id: I9e1fb5dee5506780fd79a0cbfbde059d0ccd1489
Diffstat (limited to 'doc/source/cli/command-objects/domain.rst')
| -rw-r--r-- | doc/source/cli/command-objects/domain.rst | 119 |
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 |