fortios_dpdk_global.rst

source:	fortios_dpdk_global.py
orphan:

fortios_dpdk_global -- Configure global DPDK options in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dpdk feature and global 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.9

FortiOS Version Compatibility

	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
fortios_dpdk_global	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

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_global - Configure global DPDK options. type: dict more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  dpdk_global	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• elasticbuffer - Enable/disable elasticbuffer support for all DPDK ports. type: str choices: disable, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  elasticbuffer	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• hugepage_percentage - Percentage of main memory allocated to hugepages, which are available for DPDK operation. type: int more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  hugepage_percentage	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• interface - Physical interfaces that enable DPDK. type: list more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  interface	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• interface_name - Physical interface name. Source system.interface.name. type: str more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  interface_name	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• ipsec_offload - Enable/disable DPDK IPsec phase 2 offloading. type: str choices: disable, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  ipsec_offload	no	no	no	no	no	no	yes	yes	yes	yes	yes
  [disable]	n/a	n/a	n/a	n/a	n/a	n/a	yes	yes	yes	yes	yes
  [enable]	n/a	n/a	n/a	n/a	n/a	n/a	yes	yes	yes	yes	yes

• mbufpool_percentage - Percentage of main memory allocated to DPDK packet buffer. type: int more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  mbufpool_percentage	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• multiqueue - Enable/disable multi-queue RX/TX support for all DPDK ports. type: str choices: disable, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  multiqueue	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• per_session_accounting - Enable/disable per-session accounting. type: str choices: disable, traffic-log-only, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  per_session_accounting	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [traffic-log-only]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• sleep_on_idle - Enable/disable sleep-on-idle support for all FDH engines. type: str choices: disable, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  sleep_on_idle	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

• status - Enable/disable DPDK operation for the entire system. type: str choices: disable, enable more...

  	v7.0.0	v7.0.1	v7.0.2	v7.0.3	v7.0.4	v7.0.5	v7.0.6	v7.0.7	v7.0.8	v7.2.1	v7.2.2
  status	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes	yes

Notes

Note

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

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure global DPDK options.
    fortios_dpdk_global:
      vdom:  "{{ vdom }}"
      dpdk_global:
        elasticbuffer: "disable"
        hugepage_percentage: "30"
        interface:
         -
            interface_name: "<your_own_value> (source system.interface.name)"
        ipsec_offload: "disable"
        mbufpool_percentage: "25"
        multiqueue: "disable"
        per_session_accounting: "disable"
        sleep_on_idle: "disable"
        status: "disable"

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.