.. Document meta



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

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.edpm_derive_pci_passthrough_devicespec module -- Derive list of pci device\_spec for sriov nic-partition
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

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

New in osp.edpm 1.0

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

.. Deprecated


Synopsis
--------

.. Description

- This module generates the pci device\_spec addr list for nova configmap, when sriov nic partitioning is configured in EDPM nodes. See openstack user guide for details of PCI passthrough formats.


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

      .. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_module__parameter-sriov_device_spec_map:

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

      **sriov_device_spec_map**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

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

      List of SR-IOV device\_spec


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_module__parameter-sriov_device_spec_out_file:

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

      **sriov_device_spec_out_file**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

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

      ConfigMap file to be used in nic-partitioned deployment


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_module__parameter-sriov_phydev_map:

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

      **sriov_phydev_map**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Comma seperated SR-IOV \<-\> phydev mappings


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

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

      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Create pci device_spec from defaults
      edpm_derive_pci_passthrough_devicespec:
        sriov_device_spec_map:
          - "address" : "0000:06:00.2"
            "truested" : "true"
        sriov_device_spec_out_file: 20-sriov-nova.conf
        sriov_phydev_map: 'sriov1:ens2f0np0,sriov2:ens2f1np1'



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

      .. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_module__return-device_spec:

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

      **device_spec**

      .. raw:: html

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

      Dict of device\_spec


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

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


      .. raw:: html

        </div>


  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_derive_pci_passthrough_devicespec_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>



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