.. _Managing Domains:

Managing Domains
----------------

.. _vinfra domain create:

vinfra domain create
~~~~~~~~~~~~~~~~~~~~

Create a new domain:

:: 

   usage: vinfra domain create [--description <description>] [--enable | --disable] <name>

``--description <description>``
   Domain description

``--enable``
   Enable domain

``--disable``
   Disable domain

``<name>``
   Domain name

Example:

::

   # vinfra domain create mydomain
   +----------------+----------------------------------+
   | Field          | Value                            |
   +----------------+----------------------------------+
   | description    |                                  |
   | enabled        | True                             |
   | id             | ed408d00561c4a398f933c29e87cadab |
   | name           | domain1                          |
   | projects_count | 0                                |
   +----------------+----------------------------------+

This command creates and enables the domain ``mydomain``.

.. _vinfra domain list:

vinfra domain list
~~~~~~~~~~~~~~~~~~

List all available domains:

:: 

   usage: vinfra domain list

Example:

::

   # vinfra domain list
   +----------------------------------+----------+---------+--------------------+
   | id                               | name     | enabled | description        |
   +----------------------------------+----------+---------+--------------------+
   | default                          | Default  | True    | The default domain |
   | 24986479ee3246048d3ef2a065ea99f5 | mydomain | True    |                    |
   +----------------------------------+----------+---------+--------------------+

This command lists domains used in the compute cluster.

.. _vinfra domain show:

vinfra domain show
~~~~~~~~~~~~~~~~~~

Display information about a domain:

:: 

   usage: vinfra domain show <domain>

``<domain>``
   Domain ID or name

Example:

::

   # vinfra domain show mydomain
   +----------------+----------------------------------+
   | Field          | Value                            |
   +----------------+----------------------------------+
   | description    |                                  |
   | enabled        | True                             |
   | id             | 24986479ee3246048d3ef2a065ea99f5 |
   | name           | mydomain                         |
   | projects_count | 0                                |
   +----------------+----------------------------------+

This command shows the details of the domain ``mydomain``.

.. _vinfra domain set:

vinfra domain set
~~~~~~~~~~~~~~~~~

Modify an existing domain:

:: 

   usage: vinfra domain set [--description <description>] [--enable | --disable]
                            [--name <name>] <domain>

``--description <description>``
   Domain description

``--enable``
   Enable domain

``--disable``
   Disable domain

``--name <name>``
   Domain name

``<domain>``
   Domain ID or name   

Example:

::

   # vinfra domain set mydomain --description "A custom domain"
   +----------------+----------------------------------+
   | Field          | Value                            |
   +----------------+----------------------------------+
   | description    | A custom domain                  |
   | enabled        | True                             |
   | id             | 24986479ee3246048d3ef2a065ea99f5 |
   | name           | mydomain                         |
   | projects_count | 0                                |
   +----------------+----------------------------------+

This command adds the description for the domain ``mydomain``.

.. _vinfra domain delete:

vinfra domain delete
~~~~~~~~~~~~~~~~~~~~

Delete a domain:

:: 

   usage: vinfra domain delete <domain>

``<domain>``
   Domain ID or name

Example:

::

   # vinfra domain delete mydomain
   Operation successful

This command deletes the domain ``mydomain``.