Configuration Checkpoints
=========================

.. _checkpoint:
.. index:: checkpoint

``checkpoint``
--------------

The ``checkpoint`` task creates a configuration checkpoint with the given name. It is equivalent to using the "Administration/Configuration/Configuration Checkpoints" screen in the UI. If the checkpoint with the provided name already exists, it is automatically deleted (this is different from UI behavior). Note that DataPower can accommodate only a limited number of checkpoints in a domain; you can use the "removeOld" option to prune the old checkpoints.

If the checkpoint's name contains dots, they will be replaced with underscores. This makes it easier to accommodate version numbers in the checkpoint name.

Use ``dpbuddy status -class DomainCheckpointStatus`` to list existing checkpoints in a domain.

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

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

   * - Name
     - Description
     - Required
   * - name
     - Name of the checkpoint.
     - Yes
   * - removeOld
     - Number of old checkpoints to delete, based on the checkpoint creation date. "-1" deletes all checkpoints.
       Defaults to 0.
     - No
   * - timestamp
     - If set to ``true``, append timestamp to the checkpoint name. Use with caution as this could quickly create a large number of checkpoints.  The timestamp has the format "yyyyMMdd_HHmmss".

       Defaults to ``false``.
     - No

Examples
^^^^^^^^

.. code-block:: bat

   dpbuddy checkpoint -name release-1.0.1  -save -removeOld 2

.. code-block:: xml

   <dp:checkpoint name="release-1.0.1" save="true"/>


.. index:: rollback

.. _rollback:

``rollback``
------------
This command reverts the domain configuration to the specified or latest checkpoint. Note that the content of the local file system will also be restored using the files that reside on the ``local:/`` at the time of the checkpoint. The command restarts the domain after the completion of the rollback process; this is necessary for the restored configuration to go into effect as per the DataPower `documentation <https://www.ibm.com/docs/en/datapower-gateway/10.6.x?topic=checkpoints-rolling-back-configuration-checkpoint#taskconfigurationcheckpoint_rollingback__postreq__1>`_.

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

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

   * - Name
     - Description
     - Required
   * - name
     - Name of the checkpoint to which to rollback.

       Defaults to the latest checkpoint in the domain. If the domain does not have any checkpoints, an exception will be raised.
     - No

Examples
^^^^^^^^

.. code-block:: bat

   dpbuddy rollback -save

.. code-block:: xml

   <dp:rollback save="true"/>


.. index:: delCheckpoint

.. _delCheckpoint:

``delCheckpoint``
-----------------

This task deletes configuration checkpoints. Since DataPower can accommodate only a limited number of checkpoints, it may be necessary to delete old checkpoints from time to time.

The default number of checkpoints for a domain is 3. You can increase this limit from the domain configuration screen in the UI.

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

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

   * - Name
     - Description
     - Required
   * - name
     - Name of the checkpoint to remove.
     - Yes, unless ``namePattern`` was provided.
   * - namePattern
     - Regular expression pattern defining checkpoints to remove. Use ``.*`` to delete all checkpoints.
     - Yes, unless ``name`` was provided.
   * - matchRequired
     - If set to ``true``, fail if no checkpoints matched the pattern specified in ``namePattern``.

       Defaults to ``true``.
     - No

Examples
^^^^^^^^

.. code-block:: bat


   dpbuddy delCheckpoint -namePattern ".*1_0_1" -matchRequired false

.. code-block:: xml

   <dp:delCheckpoint namePattern=".*1_0_1"/>