summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2014-12-30 17:06:07 +0000
committerGerrit Code Review <review@openstack.org>2014-12-30 17:06:07 +0000
commitbe8cac9cea15e4935247df5e41a3cfdc7a58e204 (patch)
treec49b508467fd75a82f8875e0acf7c8b66b08e434 /doc/source/command-objects
parent3cb8b0ca6fb3985ca97a4820dfa8e44d31bd5281 (diff)
parentd240b709b9f2638382daa8b18227b9baf021596d (diff)
downloadpython-openstackclient-be8cac9cea15e4935247df5e41a3cfdc7a58e204.tar.gz
Merge "add doc for domain command"
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/domain.rst115
1 files changed, 115 insertions, 0 deletions
diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst
new file mode 100644
index 00000000..057296ac
--- /dev/null
+++ b/doc/source/command-objects/domain.rst
@@ -0,0 +1,115 @@
+======
+domain
+======
+
+Identity v3
+
+domain create
+-------------
+
+Create new domain
+
+.. program:: domain create
+.. code:: bash
+
+ os 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.
+
+.. option:: <domain-name>
+
+ New domain name
+
+domain delete
+-------------
+
+Delete domain
+
+.. program:: domain delete
+.. code:: bash
+
+ os domain delete
+ <domain>
+
+.. option:: <domain>
+
+ Domain to delete (name or ID)
+
+domain list
+-----------
+
+List domains
+
+.. program:: domain list
+.. code:: bash
+
+ os domain list
+
+domain set
+----------
+
+Set domain properties
+
+.. program:: domain set
+.. code:: bash
+
+ os 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
+
+.. option:: <domain>
+
+ Domain to modify (name or ID)
+
+domain show
+-----------
+
+Show domain details
+
+.. program:: domain show
+.. code:: bash
+
+ os domain show
+ <domain>
+
+.. option:: <domain>
+
+ Domain to display (name or ID)