fortinet.fortios.fortios_system_ike – Configure IKE global attributes in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
To use it in a playbook, specify: fortinet.fortios.fortios_system_ike.
New in version 2.10: of fortinet.fortios
Synopsis
- 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
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| system_ike
dictionary
|
Configure IKE global attributes.
|
|||
| dh_group_1
dictionary
|
Diffie-Hellman group 1 (MODP-768).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_14
dictionary
|
Diffie-Hellman group 14 (MODP-2048).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_15
dictionary
|
Diffie-Hellman group 15 (MODP-3072).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_16
dictionary
|
Diffie-Hellman group 16 (MODP-4096).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_17
dictionary
|
Diffie-Hellman group 17 (MODP-6144).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_18
dictionary
|
Diffie-Hellman group 18 (MODP-8192).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_19
dictionary
|
Diffie-Hellman group 19 (EC-P256).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_2
dictionary
|
Diffie-Hellman group 2 (MODP-1024).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_20
dictionary
|
Diffie-Hellman group 20 (EC-P384).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_21
dictionary
|
Diffie-Hellman group 21 (EC-P521).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_27
dictionary
|
Diffie-Hellman group 27 (EC-P224BP).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_28
dictionary
|
Diffie-Hellman group 28 (EC-P256BP).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_29
dictionary
|
Diffie-Hellman group 29 (EC-P384BP).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_30
dictionary
|
Diffie-Hellman group 30 (EC-P512BP).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_31
dictionary
|
Diffie-Hellman group 31 (EC-X25519).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_32
dictionary
|
Diffie-Hellman group 32 (EC-X448).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_group_5
dictionary
|
Diffie-Hellman group 5 (MODP-1536).
|
|||
| keypair_cache
string
|
|
Configure custom key pair cache size for this Diffie-Hellman group.
|
||
| keypair_count
integer
|
Number of key pairs to pre-generate for this Diffie-Hellman group (per-worker).
|
|||
| mode
string
|
|
Use software (CPU) or hardware (CPX) to perform calculations for this Diffie-Hellman group.
|
||
| dh_keypair_cache
string
|
|
Enable/disable Diffie-Hellman key pair cache.
|
||
| dh_keypair_count
integer
|
Number of key pairs to pre-generate for each Diffie-Hellman group (per-worker).
|
|||
| dh_keypair_throttle
string
|
|
Enable/disable Diffie-Hellman key pair cache CPU throttling.
|
||
| dh_mode
string
|
|
Use software (CPU) or hardware (CPX) to perform Diffie-Hellman calculations.
|
||
| dh_multiprocess
string
|
|
Enable/disable multiprocess Diffie-Hellman daemon for IKE.
|
||
| dh_worker_count
integer
|
Number of Diffie-Hellman workers to start.
|
|||
| embryonic_limit
integer
|
Maximum number of IPsec tunnels to negotiate simultaneously.
|
|||
| vdom
string
|
Default:
"root"
|
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.
|
||
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 IKE global attributes.
fortios_system_ike:
vdom: "{{ vdom }}"
system_ike:
dh_group_1:
keypair_cache: "global"
keypair_count: "5"
mode: "software"
dh_group_14:
keypair_cache: "global"
keypair_count: "9"
mode: "software"
dh_group_15:
keypair_cache: "global"
keypair_count: "13"
mode: "software"
dh_group_16:
keypair_cache: "global"
keypair_count: "17"
mode: "software"
dh_group_17:
keypair_cache: "global"
keypair_count: "21"
mode: "software"
dh_group_18:
keypair_cache: "global"
keypair_count: "25"
mode: "software"
dh_group_19:
keypair_cache: "global"
keypair_count: "29"
mode: "software"
dh_group_2:
keypair_cache: "global"
keypair_count: "33"
mode: "software"
dh_group_20:
keypair_cache: "global"
keypair_count: "37"
mode: "software"
dh_group_21:
keypair_cache: "global"
keypair_count: "41"
mode: "software"
dh_group_27:
keypair_cache: "global"
keypair_count: "45"
mode: "software"
dh_group_28:
keypair_cache: "global"
keypair_count: "49"
mode: "software"
dh_group_29:
keypair_cache: "global"
keypair_count: "53"
mode: "software"
dh_group_30:
keypair_cache: "global"
keypair_count: "57"
mode: "software"
dh_group_31:
keypair_cache: "global"
keypair_count: "61"
mode: "software"
dh_group_32:
keypair_cache: "global"
keypair_count: "65"
mode: "software"
dh_group_5:
keypair_cache: "global"
keypair_count: "69"
mode: "software"
dh_keypair_cache: "enable"
dh_keypair_count: "72"
dh_keypair_throttle: "enable"
dh_mode: "software"
dh_multiprocess: "enable"
dh_worker_count: "76"
embryonic_limit: "77"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_ike_module.html