:source: fmgd_system_ike.py
:orphan:
.. _fmgd_system_ike:
fmgd_system_ike -- Configure IKE global attributes.
+++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- system_ike - Configure IKE global attributes. type: dict
- dh_group_1 (Alias name: dh-group-1) Dh group 1. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_14 (Alias name: dh-group-14) Dh group 14. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_15 (Alias name: dh-group-15) Dh group 15. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_16 (Alias name: dh-group-16) Dh group 16. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_17 (Alias name: dh-group-17) Dh group 17. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_18 (Alias name: dh-group-18) Dh group 18. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_19 (Alias name: dh-group-19) Dh group 19. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_2 (Alias name: dh-group-2) Dh group 2. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_20 (Alias name: dh-group-20) Dh group 20. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_21 (Alias name: dh-group-21) Dh group 21. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_27 (Alias name: dh-group-27) Dh group 27. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_28 (Alias name: dh-group-28) Dh group 28. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_29 (Alias name: dh-group-29) Dh group 29. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_30 (Alias name: dh-group-30) Dh group 30. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_31 (Alias name: dh-group-31) Dh group 31. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_32 (Alias name: dh-group-32) Dh group 32. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_group_5 (Alias name: dh-group-5) Dh group 5. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Diffie-hellman group id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_cache (Alias name: keypair-cache) Configure custom key pair cache size for this diffie-hellman group. type: str choices: [global, custom]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- keypair_count (Alias name: keypair-count) Number of key pairs to pre-generate for this diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- mode Use software (cpu) or hardware (cpx) to perform calculations for this diffie-hellman group. type: str choices: [software, hardware, global]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_keypair_cache (Alias name: dh-keypair-cache) Enable/disable diffie-hellman key pair cache. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_keypair_count (Alias name: dh-keypair-count) Number of key pairs to pre-generate for each diffie-hellman group (per-worker). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_keypair_throttle (Alias name: dh-keypair-throttle) Enable/disable diffie-hellman key pair cache cpu throttling. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_mode (Alias name: dh-mode) Use software (cpu) or hardware (cpx) to perform diffie-hellman calculations. type: str choices: [software, hardware]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_multiprocess (Alias name: dh-multiprocess) Enable/disable multiprocess diffie-hellman daemon for ike. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dh_worker_count (Alias name: dh-worker-count) Number of diffie-hellman workers to start. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- embryonic_limit (Alias name: embryonic-limit) Maximum number of ipsec tunnels to negotiate simultaneously. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure IKE global attributes.
fortinet.fmgdevice.fmgd_system_ike:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
system_ike:
# dh_group_1:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_14:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_15:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_16:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_17:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_18:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_19:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_2:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_20:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_21:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_27:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_28:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_29:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_30:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_31:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_32:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_group_5:
# id:
# keypair_cache:
# keypair_count:
# mode:
# dh_keypair_cache:
# dh_keypair_count:
# dh_keypair_throttle:
# dh_mode:
# dh_multiprocess:
# dh_worker_count:
# embryonic_limit:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)