.. highlight:: xml
.. index:: rmdir

.. _rmdir:

``rmdir``
---------

This task deletes directories on the device. This task is slightly faster than the :ref:`delete` task since it does not need to make a query to determine what to delete. 

Use nested ``dir`` elements to delete multiple unrelated directories. All directories will be deleted as part of a single SOMA request to the device.

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

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

   * - Name
     - Description
     - Required 
   * - dir
     - A directory or a path on the device.

       Could include a filesystem which is defined using 'filesystem:/' syntax. If not provided, the filesystem will default to ``local:/``.
     - Yes
   * - failOnError
     - Fail if the directory doesn't exist.

       Defaults to ``true``.
     - No

``dir`` Nested Element
^^^^^^^^^^^^^^^^^^^^^^

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

   * - Name
     - Description
     - Required 
   * - path     
     - A directory or a path.

       Could include a filesystem which is defined using ``filesystem:/`` syntax. If not provided, the filesystem will default to ``local:/``.
     - Yes
     
Examples
^^^^^^^^

.. code-block:: bat

   dpbuddy rmdir -dir="/dir1/dir2" -failOnError false

.. code-block:: xml    

   <dp:rmdir dir="/dir1/dir2" failOnError="false"/>