.. highlight:: xml
.. index:: Domains Tasks

.. _domain_tasks:

Tasks/Commands for Creating/Resetting/Restarting Domains
========================================================

All of the tasks explained in this section run against the domain provided by the :ref:`"domain" attribute or "dp.domain" property <connection_options>`.

.. index:: createDomain
.. _createDomain:

``createDomain``
----------------

The ``createDomain`` task creates a new domain. It can also delete the domain before creation if it exists. By default, the domain is created using the domain configuration file packaged with DPBuddy distribution. A custom configuration can be provided using the ``file`` attribute. This configuration could be created by exporting a domain object from your appliance (this has to be done from the "default" domain).

Note that deleting a domain that was previous quiesced and then creatig the domain will leave the new domain in an inconsistent state (operational state is "up" whereas the domain's state is "quiesced"). DPBuddy automatically detects this situation. It un-quiesces the new domain and then quiesced it again. This brings the domain into the correct "down" operational state.

Attributes/Options
^^^^^^^^^^^^^^^^^^

.. list-table::
   :widths: 20 80 8
   :header-rows: 1

   * - Name
     - Description
     - Required
   * - delete
     - If set to ``true``, delete the domain with the same name if exists.

       Defaults to ``false``.
     - No
   * - file
     - Domain configuration file created by exporting a domain object. You will need to provide this file if you want your  domain configuration to be different from the DataPower default configuration. The file can contain variables in ${} format.

       Defaults to the domain configuration bundled with DPBuddy.
     - No
   * - maxCheckpoints
     - Maximum number of checkpoints in the domain.

       Defaults to 3 (DataPower default).
     - No

Examples
^^^^^^^^

.. code-block:: bat

   dpbuddy createDomain -maxCheckpoints 5 -delete

.. code-block:: xml

   <dp:createDomain maxCheckpoints="5" delete="true"/>


.. _restartDomain:

``restartDomain``
-----------------

This task restarts the domain.

Example
^^^^^^^

.. code-block:: bat

   dpbuddy restartDomain -domain default

.. code-block:: xml

   <dp:restartDomain domain="default"/>

.. _resetDomain:

``resetDomain``
---------------

This task resets the configuration of the domain. It deletes all configuration objects in the domain. The task does not affect files.

Example
^^^^^^^

.. code-block:: xml

   dpbuddy resetDomain

.. code-block:: bat

   <dp:resetDomain/>