fortinet.fortios.fortios_vpn_ipsec_manualkey_interface – Configure IPsec manual keys in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 1.1.8).
To install it use: ansible-galaxy collection install fortinet.fortios
.
To use it in a playbook, specify: fortinet.fortios.fortios_vpn_ipsec_manualkey_interface
.
New in version 2.8: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and manualkey_interface 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. | ||
state string added in 2.9 of fortinet.fortios |
| Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. | |
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. | |
vpn_ipsec_manualkey_interface dictionary | Configure IPsec manual keys. | ||
addr_type string |
| IP version to use for IP packets. | |
auth_alg string |
| Authentication algorithm. Must be the same for both ends of the tunnel. | |
auth_key string | Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens. | ||
enc_alg string |
| Encryption algorithm. Must be the same for both ends of the tunnel. | |
enc_key string | Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens. | ||
interface string | Name of the physical, aggregate, or VLAN interface. Source system.interface.name. | ||
ip_version string |
| IP version to use for VPN interface. | |
local_gw string | IPv4 address of the local gateway"s external interface. | ||
local_gw6 string | Local IPv6 address of VPN gateway. | ||
local_spi string | Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules. | ||
name string / required | IPsec tunnel name. | ||
npu_offload string |
| Enable/disable offloading IPsec VPN manual key sessions to NPUs. | |
remote_gw string | IPv4 address of the remote gateway"s external interface. | ||
remote_gw6 string | Remote IPv6 address of VPN gateway. | ||
remote_spi string | Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules. | ||
state string |
| Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object. |
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 IPsec manual keys. fortios_vpn_ipsec_manualkey_interface: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" vpn_ipsec_manualkey_interface: addr_type: "4" auth_alg: "null" auth_key: "<your_own_value>" enc_alg: "null" enc_key: "<your_own_value>" interface: "<your_own_value> (source system.interface.name)" ip_version: "4" local_gw: "<your_own_value>" local_gw6: "<your_own_value>" local_spi: "<your_own_value>" name: "default_name_13" npu_offload: "enable" remote_gw: "<your_own_value>" remote_gw6: "<your_own_value>" remote_spi: "<your_own_value>"
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/2.11/collections/fortinet/fortios/fortios_vpn_ipsec_manualkey_interface_module.html