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.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)