Skip to content

Latest commit

 

History

History
309 lines (265 loc) · 13.6 KB

fortios_vpn_ipsec_fec.rst

File metadata and controls

309 lines (265 loc) · 13.6 KB
Raw
source:fortios_vpn_ipsec_fec.py
orphan:

fortios_vpn_ipsec_fec -- Configure Forward Error Correction (FEC) mapping profiles 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 vpn_ipsec feature and fec 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.14

Tips

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

FortiOS Version Compatibility


Supported Version Ranges
fortios_vpn_ipsec_fec v7.0.2 -> latest

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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • vpn_ipsec_fec - Configure Forward Error Correction (FEC) mapping profiles. type: dict more...
    Supported Version Ranges
    vpn_ipsec_fec v7.0.2 -> latest
    • mappings - FEC redundancy mapping table. type: list member_path: mappings:seqno more...
      Supported Version Ranges
      mappings v7.0.2 -> latest
      • bandwidth_bi_threshold - Apply FEC parameters when available bi-bandwidth is >= threshold (kbps, 0 means no threshold). type: int more...
        Supported Version Ranges
        bandwidth_bi_threshold v7.0.2 -> latest
      • bandwidth_down_threshold - Apply FEC parameters when available down bandwidth is >= threshold (kbps, 0 means no threshold). type: int more...
        Supported Version Ranges
        bandwidth_down_threshold v7.0.2 -> latest
      • bandwidth_up_threshold - Apply FEC parameters when available up bandwidth is >= threshold (kbps, 0 means no threshold). type: int more...
        Supported Version Ranges
        bandwidth_up_threshold v7.0.2 -> latest
      • base - Number of base FEC packets (1 - 20). type: int more...
        Supported Version Ranges
        base v7.0.2 -> latest
      • latency_threshold - Apply FEC parameters when latency is <= threshold (0 means no threshold). type: int more...
        Supported Version Ranges
        latency_threshold v7.0.2 -> latest
      • packet_loss_threshold - Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means no threshold). type: int more...
        Supported Version Ranges
        packet_loss_threshold v7.0.2 -> latest
      • redundant - Number of redundant FEC packets (1 - 5). type: int more...
        Supported Version Ranges
        redundant v7.0.2 -> latest
      • seqno - Sequence number (1 - 64). see Notes. type: int required: true more...
        Supported Version Ranges
        seqno v7.0.2 -> latest
    • name - Profile name. type: str required: true more...
      Supported Version Ranges
      name v7.0.2 -> latest

Notes

Note

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

Examples

- name: Configure Forward Error Correction (FEC) mapping profiles.
  fortinet.fortios.fortios_vpn_ipsec_fec:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      vpn_ipsec_fec:
          mappings:
              -
                  bandwidth_bi_threshold: "0"
                  bandwidth_down_threshold: "0"
                  bandwidth_up_threshold: "0"
                  base: "0"
                  latency_threshold: "0"
                  packet_loss_threshold: "0"
                  redundant: "0"
                  seqno: "<you_own_value>"
          name: "default_name_12"

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.