:tocdepth: 0








.. _/plugins/cleanup:

Cleanup Plugins
~~~~~~~~~~~~~~~



.. include:: cleanup-header.inc.rst

.. _/plugins/cleanup/common-keys:

Common Keys
-----------



The following keys are accepted by all plugins of the ``cleanup`` step.


name
    The name of the step phase.

    Environment variable: ``TMT_PLUGIN_CLEANUP_TMT_NAME``

    In plan metadata:

    .. code-block:: yaml

       name:

    On command-line:

    .. code-block:: shell

       --name ...
       export TMT_PLUGIN_CLEANUP_TMT_NAME=...



order
    Order in which the phase should be handled.

    Default: ``50``

    Environment variable: ``TMT_PLUGIN_CLEANUP_TMT_ORDER``

    In plan metadata:

    .. code-block:: yaml

       order:

    On command-line:

    .. code-block:: shell

       --order ...
       export TMT_PLUGIN_CLEANUP_TMT_ORDER=...



summary
    Concise summary describing purpose of the phase.

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_CLEANUP_TMT_SUMMARY``

    In plan metadata:

    .. code-block:: yaml

       summary:

    On command-line:

    .. code-block:: shell

       --summary ...
       export TMT_PLUGIN_CLEANUP_TMT_SUMMARY=...



when
    If specified, phase is run only if any rule matches plan context.

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_CLEANUP_TMT_WHEN``

    In plan metadata:

    .. code-block:: yaml

       when: RULE


    On command-line:

    .. code-block:: shell

       --when RULE
       export TMT_PLUGIN_CLEANUP_TMT_WHEN=RULE



.. _/plugins/cleanup/tmt:

tmt
---



.. warning::

    Please, be aware that the documentation below is a work in progress. We are
    working on fixing it, adding missing bits and generally making it better.
    Also, it was originally used for command line help only, therefore the
    formatting is often suboptimal.

Stop and remove all provisioned guests