.. Document meta



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

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.edpm_os_net_config_mappings_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.edpm_os_net_config_mappings module -- Configure os-net-config mappings for nodes or node groups
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

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

New in osp.edpm 2.8

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

.. Deprecated


Synopsis
--------

.. Description

- This module creates os-net-config mapping for nodes or node groups based on the input data provided. MAC addresses or DMI table strings can be used to identify specific nodes or node groups. See manual page for DMIDECODE(8) for a list of DMI table strings that can be used.


.. Aliases


.. Requirements






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

      .. _ansible_collections.osp.edpm.edpm_os_net_config_mappings_module__parameter-net_config_data_lookup:

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

      **net_config_data_lookup**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Per node and/or per node group configuration map


      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Map os-net-config nicX abstraction using MAC address
      edpm_os_net_config_mappings:
        net_config_data_lookup:
          overcloud-controller-0:
            nic1: "00:c8:7c:e6:f0:2e"
          overcloud-compute-13:
            nic1: "00:18:7d:99:0c:b6"
    - name: Interface name to os-net-config nicX abstraction using system-uuid
      edpm_os_net_config_mappings:
        net_config_data_lookup:
          overcloud-controller-0:
            dmiString: 'system-uuid'
            id: 'A8C85861-1B16-4803-8689-AFC62984F8F6'
            nic1: em3
            nic2: em1
            nic3: em2
            nic4: em4
    - name: Interface name to os-net-config nicX abstraction for node groups using system-product-name
      edpm_os_net_config_mappings:
        net_config_data_lookup:
          nodegroup-dell-poweredge-r630:
            dmiString: "system-product-name"
            id: "PowerEdge R630"
            nic1: em3
            nic2: em1
            nic3: em2
          nodegroup-cisco-ucsb-b200-m4:
            dmiString: "system-product-name"
            id: "UCSB-B200-M4"
            nic1: enp7s0
            nic2: enp6s0



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

      .. _ansible_collections.osp.edpm.edpm_os_net_config_mappings_module__return-mapping:

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

      **mapping**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-mapping" 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 with os-net-config mapping data that can be written to the os-net-config mapping file.


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

      :ansible-option-returned-bold:`Returned:` when mapping match present in net\_config\_data\_lookup


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Harald Jensås



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