fortinet.fortios.fortios_system_ike (2.3.6) — module

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

| "added in version" 2.0.0 of fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure IKE global attributes.
  fortinet.fortios.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"

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

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

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

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

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