Skip to content

Latest commit

 

History

History
240 lines (199 loc) · 11 KB

fortios_dpdk_cpus.rst

File metadata and controls

240 lines (199 loc) · 11 KB
Raw
source:fortios_dpdk_cpus.py
orphan:

fortios_dpdk_cpus -- Configure CPUs enabled to run engines in each DPDK stage in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dpdk feature and cpus category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.15

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

Supported Version Ranges: v7.0.0 -> v7.0.12 , v7.2.1 -> v7.2.2 , v7.4.0 -> 7.4.3

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • dpdk_cpus - Configure CPUs enabled to run engines in each DPDK stage. type: dict more...
    Supported Version Ranges
    dpdk_cpus v7.0.0 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • ips_cpus - CPUs enabled to run DPDK IPS engines. type: str more...
      Supported Version Ranges
      ips_cpus v7.0.0 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • isolated_cpus - CPUs isolated to run only the DPDK engines with the exception of processes that have affinity explicitly set by either a user configuration or by their implementation. type: str more...
      Supported Version Ranges
      isolated_cpus v7.0.2 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • rx_cpus - CPUs enabled to run DPDK RX engines. type: str more...
      Supported Version Ranges
      rx_cpus v7.0.0 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • tx_cpus - CPUs enabled to run DPDK TX engines. type: str more...
      Supported Version Ranges
      tx_cpus v7.0.0 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • vnp_cpus - CPUs enabled to run DPDK VNP engines. type: str more...
      Supported Version Ranges
      vnp_cpus v7.0.0 -> v7.0.12 v7.2.1 -> v7.2.2 v7.4.0 -> 7.4.3
    • vnpsp_cpus - CPUs enabled to run DPDK VNP slow path. type: str more...
      Supported Version Ranges
      vnpsp_cpus v7.4.2 -> 7.4.3

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure CPUs enabled to run engines in each DPDK stage.
  fortinet.fortios.fortios_dpdk_cpus:
      vdom: "{{ vdom }}"
      dpdk_cpus:
          ips_cpus: "<your_own_value>"
          isolated_cpus: "<your_own_value>"
          rx_cpus: "<your_own_value>"
          tx_cpus: "<your_own_value>"
          vnp_cpus: "<your_own_value>"
          vnpsp_cpus: "<your_own_value>"

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.