.. Document meta



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

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.edpm_os_net_config_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.edpm_os_net_config module -- Execute os-net-config tool.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

.. rst-class:: ansible-version-added

New in osp.edpm 1.0

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

.. Deprecated


Synopsis
--------

.. Description

- Configure host network interfaces using a JSON config file format.


.. Aliases


.. Requirements

.. _ansible_collections.osp.edpm.edpm_os_net_config_module_requirements:

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

- os-net-config






.. 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-cleanup"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-cleanup:

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

      **cleanup**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Cleanup unconfigured interfaces.


      .. 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-config_file"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-config_file:

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

      **config_file**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Path to the configuration file.


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"/etc/os-net-config/config.yaml"`

      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-debug:

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

      **debug**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Print debug output.


      .. 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-detailed_exit_codes"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-detailed_exit_codes:

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

      **detailed_exit_codes**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

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

      If enabled an exit code of '2' means that files were modified.


      .. 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-safe_defaults"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-safe_defaults:

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

      **safe_defaults**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

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

      If enabled, safe defaults (DHCP for all interfaces) will be applied in case of failing while applying the provided net config.


      .. 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-use_nmstate"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__parameter-use_nmstate:

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

      **use_nmstate**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

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

      If enabled, use nmstate and network manager for network configuration.


      .. 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>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Create network configs with defaults
      edpm_os_net_config:



.. Facts


.. 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-rc"></div>

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__return-rc:

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

      **rc**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Integer for the return code


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__return-stderr:

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

      **stderr**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-stderr" 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">

      The command standard error


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_os_net_config_module__return-stdout:

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

      **stdout**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-stdout" 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">

      The command standard output


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

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


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- OpenStack EDPM Contributors



.. Extra links

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

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/openstack-k8s-operators/edpm-ansible/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/openstack-k8s-operators/edpm-ansible"
    external: true


.. Parsing errors