Skip to content

Latest commit

 

History

History
5221 lines (5176 loc) · 165 KB

fortios_system_ike.rst

File metadata and controls

5221 lines (5176 loc) · 165 KB
source:fortios_system_ike.py
orphan:

fortios_system_ike -- Configure IKE global attributes in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

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

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

  • ansible>=2.9

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


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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
fortios_system_ike yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

  • 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
  • system_ike - Configure IKE global attributes. 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
    system_ike yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_1 - Diffie-Hellman group 1 (MODP-768). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_1 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_14 - Diffie-Hellman group 14 (MODP-2048). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_14 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_15 - Diffie-Hellman group 15 (MODP-3072). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_15 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_16 - Diffie-Hellman group 16 (MODP-4096). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_16 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_17 - Diffie-Hellman group 17 (MODP-6144). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_17 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_18 - Diffie-Hellman group 18 (MODP-8192). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_18 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_19 - Diffie-Hellman group 19 (EC-P256). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_19 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_2 - Diffie-Hellman group 2 (MODP-1024). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_2 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_20 - Diffie-Hellman group 20 (EC-P384). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_20 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_21 - Diffie-Hellman group 21 (EC-P521). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_21 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_27 - Diffie-Hellman group 27 (EC-P224BP). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_27 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_28 - Diffie-Hellman group 28 (EC-P256BP). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_28 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_29 - Diffie-Hellman group 29 (EC-P384BP). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_29 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_30 - Diffie-Hellman group 30 (EC-P512BP). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_30 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_31 - Diffie-Hellman group 31 (EC-X25519). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_31 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_32 - Diffie-Hellman group 32 (EC-X448). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_32 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_group_5 - Diffie-Hellman group 5 (MODP-1536). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_group_5 yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_cache - Configure custom key pair cache size for this Diffie-Hellman group. type: str choices: global, custom 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [custom] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • keypair_count - Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      • mode - Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group. type: str choices: software, hardware, global 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
        mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
        [global] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_keypair_cache - Enable/disable Diffie-Hellman key pair cache. type: str choices: enable, disable 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_keypair_cache yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_keypair_count - Number of key pairs to pre-generate for each Diffie-Hellman group (per-worker). 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_keypair_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_keypair_throttle - Enable/disable Diffie-Hellman key pair cache CPU throttling. type: str choices: enable, disable 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_keypair_throttle yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_mode - Use software (CPU) or hardware (CPX) to perform Diffie-Hellman calculations. type: str choices: software, hardware 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_mode yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [software] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [hardware] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_multiprocess - Enable/disable multiprocess Diffie-Hellman daemon for IKE. type: str choices: enable, disable 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_multiprocess yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [enable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
      [disable] yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • dh_worker_count - Number of Diffie-Hellman workers to start. 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      dh_worker_count yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes
    • embryonic_limit - Maximum number of IPsec tunnels to negotiate simultaneously. 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.0.12 v7.2.0 v7.2.1 v7.2.2 v7.2.4 v7.4.0
      embryonic_limit yes yes yes yes yes yes yes yes yes yes yes yes yes yes yes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- 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 IKE global attributes.
    fortios_system_ike:
      vdom:  "{{ vdom }}"
      system_ike:
        dh_group_1:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_14:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_15:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_16:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_17:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_18:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_19:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_2:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_20:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_21:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_27:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_28:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_29:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_30:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_31:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_32:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_group_5:
            keypair_cache: "global"
            keypair_count: "0"
            mode: "software"
        dh_keypair_cache: "enable"
        dh_keypair_count: "100"
        dh_keypair_throttle: "enable"
        dh_mode: "software"
        dh_multiprocess: "enable"
        dh_worker_count: "0"
        embryonic_limit: "10000"

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
  • This module is not guaranteed to have a backwards compatible interface.
  • 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.