python-openstackclient/doc/source/cli/command-objects/domain.rst

======
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)
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00			`======`
			`domain`
			`======`

			`Identity v3`

			`domain create`
			`-------------`

			`Create new domain`

			`.. program:: domain create`
			`.. code:: bash`

change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack domain create`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00			`[--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.`

Command docs: domain Change the implementation of --enable\|--disable on domain create and set commands to our usual style. Change-Id: I10f2b96281a114fa3cf3b001394844770b2a8632 2014-12-31 09:54:21 -06:00			`.. describe:: <domain-name>`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`New domain name`

			`domain delete`
			`-------------`

Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906 2016-07-12 12:44:55 +08:00			`Delete domain(s)`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`.. program:: domain delete`
			`.. code:: bash`

change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack domain delete`
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906 2016-07-12 12:44:55 +08:00			`<domain> [<domain> ...]`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
Command docs: domain Change the implementation of --enable\|--disable on domain create and set commands to our usual style. Change-Id: I10f2b96281a114fa3cf3b001394844770b2a8632 2014-12-31 09:54:21 -06:00			`.. describe:: <domain>`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
Support bulk deletion for delete commands in identityv3 Support bulk deletion for delete commands in the list below identity/v3/consumer identity/v3/credential identity/v3/domain identity/v3/ec2creds identity/v3/endpoint identity/v3/federation_protocol identity/v3/identity_provider identity/v3/mapping identity/v3/policy identity/v3/region identity/v3/service_provider identity/v3/service The unit test in identityv3 need to be refactored, so I add some functional tests instead. I will add all unit tests at one time after the refactor completed. Change-Id: I82367570f59817b47c87b6c7bfeae95ccfe5c50e Closes-Bug: #1592906 2016-07-12 12:44:55 +08:00			`Domain(s) to delete (name or ID)`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`domain list`
			`-----------`

			`List domains`

			`.. program:: domain list`
			`.. code:: bash`

change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack domain list`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`domain set`
			`----------`

			`Set domain properties`

			`.. program:: domain set`
			`.. code:: bash`

change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack domain set`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00			`[--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`

Command docs: domain Change the implementation of --enable\|--disable on domain create and set commands to our usual style. Change-Id: I10f2b96281a114fa3cf3b001394844770b2a8632 2014-12-31 09:54:21 -06:00			`.. describe:: <domain>`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`Domain to modify (name or ID)`

			`domain show`
			`-----------`

Fine tune some of the helps commands try and add some consistency with the show and delete commands. replace 'show x' with 'display x' change 'delete a y' with just 'delete y' Change-Id: I47dfa8ee23ac5c41b355796415eb515155832f65 2015-01-09 19:13:03 -05:00			`Display domain details`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`.. program:: domain show`
			`.. code:: bash`

change os in command example to openstack In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: Ic7686257725e1aa8e4e0d65a712eff1c079927a8 2016-12-20 09:03:29 +08:00			`openstack domain show`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00			`<domain>`

Command docs: domain Change the implementation of --enable\|--disable on domain create and set commands to our usual style. Change-Id: I10f2b96281a114fa3cf3b001394844770b2a8632 2014-12-31 09:54:21 -06:00			`.. describe:: <domain>`
add doc for domain command Change-Id: I8b5575a5f27362fa375746b955e1f17a5a8b29a6 2014-12-23 11:08:24 +08:00
			`Domain to display (name or ID)`