lix_fortinet.fortios.fortios_vpn_ipsec_fec (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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 Forward Error Correction (FEC) mapping profiles.
    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: "0"
        name: "default_name_12"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

vpn_ipsec_fec:
    default: null
    description:
    - Configure Forward Error Correction (FEC) mapping profiles.
    suboptions:
      mappings:
        description:
        - FEC redundancy mapping table.
        elements: dict
        suboptions:
          bandwidth_bi_threshold:
            description:
            - Apply FEC parameters when available bi-bandwidth is >= threshold (kbps,
              0 means no threshold).
            type: int
          bandwidth_down_threshold:
            description:
            - Apply FEC parameters when available down bandwidth is >= threshold (kbps,
              0 means no threshold).
            type: int
          bandwidth_up_threshold:
            description:
            - Apply FEC parameters when available up bandwidth is >= threshold (kbps,
              0 means no threshold).
            type: int
          base:
            description:
            - Number of base FEC packets (1 - 20).
            type: int
          latency_threshold:
            description:
            - Apply FEC parameters when latency is <= threshold (0 means no threshold).
            type: int
          packet_loss_threshold:
            description:
            - Apply FEC parameters when packet loss is >= threshold (0 - 100, 0 means
              no threshold).
            type: int
          redundant:
            description:
            - Number of redundant FEC packets (1 - 5).
            type: int
          seqno:
            description:
            - Sequence number (1 - 64).
            type: int
        type: list
      name:
        description:
        - Profile name.
        required: true
        type: str
    type: dict

Outputs

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