.. highlight:: xml
.. index:: mkdir

.. _mkdir:

``mkdir``
---------

This task creates one or multiple directories on the device. If a directory path is specified, the task will create all parent directories that don't exist.

Note that the :ref:`copy` task creates all directories automatically so this task does not need to be explicitly invoked.

Use nested ``dir`` elements to create multiple unrelated directories. All directories will be created 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 to create.

       Could include a filesystem which is defined using ``filesystem:/`` syntax. If not provided, the filesystem will default to ``local:/``.
     - Yes   
     
``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 mkdir -dir="/dir1/dir2"
   
.. code-block:: xml    
   
   <dp:mkdir dir="/dir1/dir2/dir3"/>