summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/domain.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/cli/command-objects/domain.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/cli/command-objects/domain.rst')
-rw-r--r--doc/source/cli/command-objects/domain.rst115
1 files changed, 115 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/domain.rst b/doc/source/cli/command-objects/domain.rst
new file mode 100644
index 00000000..70a3e733
--- /dev/null
+++ b/doc/source/cli/command-objects/domain.rst
@@ -0,0 +1,115 @@
+======
+domain
+======
+
+Identity v3
+
+domain create
+-------------
+
+Create new domain
+
+.. program:: domain create
+.. code:: bash
+
+ openstack domain create
+ [--description <description>]
+ [--enable | --disable]
+ [--or-show]
+ <domain-name>
+
+.. 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)