
.. Document meta

:orphan:

.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.11.0

.. Anchors

.. _ansible_collections.vbotka.freebsd.iocage_module:

.. Anchors: short name for ansible.builtin

.. Title

vbotka.freebsd.iocage module -- FreeBSD iocage jail handling
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. Collection note

.. note::
    This module is part of the `vbotka.freebsd collection <https://galaxy.ansible.com/ui/repo/published/vbotka/freebsd/>`_ (version 0.2.7).

    It is not included in ``ansible-core``.
    To check whether it is installed, run :code:`ansible-galaxy collection list`.

    To install it, use: :code:`ansible-galaxy collection install vbotka.freebsd`.
    You need further requirements to be able to use this module,
    see :ref:`Requirements <ansible_collections.vbotka.freebsd.iocage_module_requirements>` for details.

    To use it in a playbook, specify: :code:`vbotka.freebsd.iocage`.

.. version_added


.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- The \ :ref:`vbotka.freebsd.iocage <ansible_collections.vbotka.freebsd.iocage_module>`\  module is wrapper to \ :strong:`iocage`\  command.


.. Aliases


.. Requirements

.. _ansible_collections.vbotka.freebsd.iocage_module_requirements:

Requirements
------------
The below requirements are needed on the host that executes this module.

- lang/python \>= 3.6
- sysutils/iocage






.. Options

Parameters
----------

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-args"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-args:

      .. rst-class:: ansible-option-title

      **args**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-args" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Additional arguments of \ :ref:`vbotka.freebsd.iocage <ansible_collections.vbotka.freebsd.iocage_module>`\  applied to the \ :ansopt:`vbotka.freebsd.iocage#module:state`\ . They will be applied to the sub-command \ :strong:`create`\  if the \ :ansopt:`vbotka.freebsd.iocage#module:state`\  is \ :ansval:`basejail, thickjail, template, present`\ .  If the same Ansible task also fetches a release as apart of the creation the arguments will not be applied to the sub-command \ :strong:`fetch`\ . Use separate task \ :strong:`state=fetched`\  and set \ :ansopt:`vbotka.freebsd.iocage#module:args`\  there if needed.


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`""`

      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-bupdate"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-bupdate:

      .. rst-class:: ansible-option-title

      **bupdate**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-bupdate" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Update the fetch to the latest patch level when \ :strong:`state=fetched`\ . Fetch and install binary updates when \ :ansopt:`vbotka.freebsd.iocage#module:name`\  is defined. This will start the jail.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-clone_from"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-clone_from:

      .. rst-class:: ansible-option-title

      **clone_from**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-clone_from" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Clone the jail \ :ansopt:`vbotka.freebsd.iocage#module:clone\_from`\  to \ :ansopt:`vbotka.freebsd.iocage#module:name`\ . Use \ :ansopt:`vbotka.freebsd.iocage#module:properties`\  to configure the clone.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-cmd"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-cmd:

      .. rst-class:: ansible-option-title

      **cmd**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-cmd" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Execute the command \ :ansopt:`vbotka.freebsd.iocage#module:cmd`\  inside the specified jail \ :ansopt:`vbotka.freebsd.iocage#module:name`\ .


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-components"></div>
        <div class="ansibleOptionAnchor" id="parameter-files"></div>
        <div class="ansibleOptionAnchor" id="parameter-component"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-component:
      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-components:
      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-files:

      .. rst-class:: ansible-option-title

      **components**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-components" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-aliases:`aliases: files, component`

        :ansible-option-type:`list` / :ansible-option-elements:`elements=path`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Uses a local file directory for the root directory instead of HTTP to downloads and/or updates releases.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-name"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-name:

      .. rst-class:: ansible-option-title

      **name**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      \ :ansopt:`vbotka.freebsd.iocage#module:name`\  of the jail.

      States \ :ansval:`started, stopped, restarted`\  accept \ :ansval:`ALL`\  to start, stop, or restart all jails.

      States \ :ansval:`present, cloned, template, basejail, thickjail`\  will return \ :ansretval:`vbotka.freebsd.iocage#module:uuid`\  and \ :ansretval:`vbotka.freebsd.iocage#module:uuid\_short`\  if \ :ansopt:`vbotka.freebsd.iocage#module:name`\  is \ :ansval:`None`\  or empty.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-pkglist"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-pkglist:

      .. rst-class:: ansible-option-title

      **pkglist**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-pkglist" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`path`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Path to a JSON file containing packages to install. Only applicable when creating a jail.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-plugin"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-plugin:

      .. rst-class:: ansible-option-title

      **plugin**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-plugin" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Specify which plugin to fetch or update.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-properties"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-properties:

      .. rst-class:: ansible-option-title

      **properties**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-properties" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      \ :ansopt:`vbotka.freebsd.iocage#module:properties`\  of the jail. The jail will restart if any of the properties \ :strong:`ip4\_addr, ip6\_addr, template, interfaces, vnet, host\_hostname`\  changes.


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-release"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-release:

      .. rst-class:: ansible-option-title

      **release**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-release" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Specify which RELEASE to fetch, update, or create a jail from. \ :ansopt:`vbotka.freebsd.iocage#module:release`\  defaults to the release of the remote host if \ :ansopt:`vbotka.freebsd.iocage#module:state`\  is one of \ :ansval:`basejail, thickjail, template, fetched, present`\ . \ :ansopt:`vbotka.freebsd.iocage#module:release`\  also defaults to the release of the remote host if \ :ansval:`bupdate=True`\ .


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-state"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-state:

      .. rst-class:: ansible-option-title

      **state**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      \ :ansopt:`vbotka.freebsd.iocage#module:state`\  of the desired result.

      State \ :ansval:`absent`\  by default force the destruction \ :literal:`iocage destroy --force name`\ .


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`"absent"`
      - :ansible-option-choices-entry:`"basejail"`
      - :ansible-option-choices-entry:`"cloned"`
      - :ansible-option-choices-entry:`"exec"`
      - :ansible-option-choices-entry-default:`"facts"` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`"fetched"`
      - :ansible-option-choices-entry:`"get"`
      - :ansible-option-choices-entry:`"pkg"`
      - :ansible-option-choices-entry:`"present"`
      - :ansible-option-choices-entry:`"restarted"`
      - :ansible-option-choices-entry:`"set"`
      - :ansible-option-choices-entry:`"started"`
      - :ansible-option-choices-entry:`"stopped"`
      - :ansible-option-choices-entry:`"template"`
      - :ansible-option-choices-entry:`"thickjail"`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-user"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__parameter-user:

      .. rst-class:: ansible-option-title

      **user**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      \ :ansopt:`vbotka.freebsd.iocage#module:user`\  who runs the command \ :ansopt:`vbotka.freebsd.iocage#module:cmd`\ .


      .. rst-class:: ansible-option-line

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"root"`

      .. raw:: html

        </div>


.. Attributes


.. Notes

Notes
-----

.. note::
   - Supports \ :literal:`check\_mode`\ .
   - There is no mandatory option.
   - The module always creates facts \ :strong:`iocage\_releases`\ , \ :strong:`iocage\_templates`\ , and \ :strong:`iocage\_jails`\ 
   - Returns \ :strong:`module\_args`\  when debugging is set \ :ansenvvarref:`ANSIBLE\_DEBUG=true`\ 

.. Seealso

See Also
--------

.. seealso::

   `iocage - A FreeBSD Jail Manager <https://iocage.readthedocs.io/en/latest/>`_
       iocage 1.2 documentation
   `iocage - jail manager using ZFS and VNET <https://www.freebsd.org/cgi/man.cgi?query=iocage>`_
       FreeBSD System Manager's Manual

.. Examples

Examples
--------

.. code-block:: yaml+jinja

    
    - name: Create Ansible facts iocage_*. This is the default state.
      vbotka.freebsd.iocage:
        state: facts

    - name: Display lists of bases, plugins, templates, and jails
      debug:
        msg: |-
          {{ iocage_releases }}
          {{ iocage_plugins.keys()|list }}
          {{ iocage_templates.keys()|list }}
          {{ iocage_jails.keys()|list }}

    - name: Fetch the remote host's version of base
      vbotka.freebsd.iocage:
        state: fetched

    - name: Fetch base 13.0-RELEASE
      vbotka.freebsd.iocage:
        state: fetched
        release: 13.0-RELEASE

    - name: Fetch only components base.txz and doc.txz of the base 13.0-RELEASE
      vbotka.freebsd.iocage:
        state: fetched
        release: 13.0-RELEASE
        components: 'base.txz,doc.txz'

    - name: Fetch plugin Tarsnap. Keep jails on failure.
      vbotka.freebsd.iocage:
        state: fetched
        plugin: Tarsnap
        args: -k

    - name: Update or fetch components base.txz and doc.txz of the remote host's release.
            Fetch plugin Tarsnap. Keep jails on failure.
      vbotka.freebsd.iocage:
        state: fetched
        bupdate: true
        components: 'base.txz,doc.txz'
        plugin: Tarsnap
        args: -k

    - name: Update the jail. This will start the jail.
      vbotka.freebsd.iocage:
        state: present
        bupdate: true
        name: foo

    - name: Start jail
      vbotka.freebsd.iocage:
        state: started
        name: foo

    - name: Start all jails
      vbotka.freebsd.iocage:
        state: started
        name: ALL

    - name: Start all jails with boot=on
      vbotka.freebsd.iocage:
        state: started
        args: '--rc'

    - name: Stop jail
      vbotka.freebsd.iocage:
        state: stopped
        name: foo

    - name: Stop all jails
      vbotka.freebsd.iocage:
        state: stopped
        name: ALL

    - name: Stop all jails with boot=on
      vbotka.freebsd.iocage:
        state: stopped
        args: '--rc'

    - name: Restart jail
      vbotka.freebsd.iocage:
        state: restarted
        name: foo

    - name: Restart all jails
      vbotka.freebsd.iocage:
        state: restarted
        name: ALL

    - name: Set IP address of the jail
      vbotka.freebsd.iocage:
        state: set
        name: foo
        properties:
          vnet: 'on'
          defaultrouter: 10.1.0.10
          ip4_addr: 'vnet0|10.1.0.199/24'

    - name: Create jail without cloning, install packages, and set properties.
            Use release of the remote host.
      vbotka.freebsd.iocage:
        state: present
        name: foo
        pkglist: /path/to/pkglist.json
        properties:
          ip4_addr: 'vnet0|10.1.0.199/24'
          boot: true
          allow_sysvipc: true
          defaultrouter: '10.1.0.1'

    - name: Create template, install packages, and set properties.
            Use release of the remote host.
      vbotka.freebsd.iocage:
        state: template
        name: tplfoo
        pkglist: /path/to/pkglist.json
        properties:
          ip4_addr: 'lo1|10.1.0.5'
          boot: true
          allow_sysvipc: true
          defaultrouter: '10.1.0.1'

    - name: Create a cloned jail. Creates basejail if needed.
      vbotka.freebsd.iocage:
        state: present
        name: foo
        clone_from: tplfoo
        pkglist: /path/to/pkglist.json
        properties:
          ip4_addr: 'lo1|10.1.0.5'
          boot: true
          allow_sysvipc: true
          defaultrouter: '10.1.0.1'

    - name: Create a cloned jail. Name is automatically generated.
      vbotka.freebsd.iocage:
        state: present
        clone_from: tplfoo
      register: result
    - name: Set variable contains the name of the created jail.
      set_fact:
        jname: "{{ result.uuid_short }}"

    - name: Execute command in running jail
      vbotka.freebsd.iocage:
        state: exec
        name: foo
        cmd: service sshd start

    - name: Execute pkg command in running jail
      vbotka.freebsd.iocage:
        state: pkg
        name: foo
        cmd: info

    - name: Destroy jail
      vbotka.freebsd.iocage:
        state: absent
        name: foo




.. Facts

Returned Facts
--------------
Facts returned by this module are added/updated in the ``hostvars`` host facts and can be referenced by name just like any other host fact. They do not need to be registered in order to use them.

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Key
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-ansible_facts/iocage_jails"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-ansible_facts/iocage_jails:

      .. rst-class:: ansible-option-title

      **iocage_jails**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_facts/iocage_jails" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Dictionary of all jails.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{}`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-ansible_facts/iocage_plugins"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-ansible_facts/iocage_plugins:

      .. rst-class:: ansible-option-title

      **iocage_plugins**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_facts/iocage_plugins" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Dictionary of all plugins.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{}`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-ansible_facts/iocage_releases"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-ansible_facts/iocage_releases:

      .. rst-class:: ansible-option-title

      **iocage_releases**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_facts/iocage_releases" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of all bases.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["13.3-RELEASE", "13.4-RELEASE"]`


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-ansible_facts/iocage_templates"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-ansible_facts/iocage_templates:

      .. rst-class:: ansible-option-title

      **iocage_templates**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-ansible_facts/iocage_templates" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Dictionary of all templates.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{}`


      .. raw:: html

        </div>



.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Key
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-module_args"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-module_args:

      .. rst-class:: ansible-option-title

      **module_args**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-module_args" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Information on how the module was invoked.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` debug


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-uuid"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-uuid:

      .. rst-class:: ansible-option-title

      **uuid**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-uuid" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Automatically generated unique ID of a jail.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` States \ :emphasis:`present, cloned, template, basejail, thickjail`\  if \ :emphasis:`name`\  is \ :literal:`None`\  or empty.


      .. raw:: html

        </div>


  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-uuid_short"></div>

      .. _ansible_collections.vbotka.freebsd.iocage_module__return-uuid_short:

      .. rst-class:: ansible-option-title

      **uuid_short**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-uuid_short" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      First 8 characters of \ :emphasis:`uuid`\ . Set as a name of the jail.


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` States \ :emphasis:`present, cloned, template, basejail, thickjail`\  if \ :emphasis:`name`\  is \ :literal:`None`\  or empty.


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Johannes Meixner (@xmj)
- Vladimir Botka (@vbotka)
- dgeo (@dgeo)
- Berend de Boer (@berenddeboer)
- Dr Josef Karthauser (@Infiniverse)
- Kevin P. Fleming (@kpfleming)
- Ross Williams (@overhacked)
- david8001 (@david8001)
- luto (@luto)
- Keve Müller (@kevemueller)
- Mårten Lindblad (@martenlindblad)



.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/vbotka/ansible-collection-freebsd/issues/"
    external: true
  - title: "Homepage"
    url: "https://github.com/vbotka/ansible-collection-freebsd/wiki/"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/vbotka/ansible-collection-freebsd/"
    external: true


.. Parsing errors

