New in version 2.8.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host
-
/ required
|
FortiOS or FortiGate ip address.
|
||
https
boolean
|
|
Indicates if the requests towards FortiGate must use HTTPS protocol
|
|
password
-
|
Default: ""
|
FortiOS or FortiGate password.
|
|
username
-
/ required
|
FortiOS or FortiGate username.
|
||
vdom
-
|
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
-
|
Default: null
|
Configure IPsec manual keys.
|
|
addr-type
-
|
|
IP version to use for IP packets.
|
|
auth-alg
-
|
|
Authentication algorithm. Must be the same for both ends of the tunnel.
|
|
auth-key
-
|
Hexadecimal authentication key in 16-digit (8-byte) segments separated by hyphens.
|
||
enc-alg
-
|
|
Encryption algorithm. Must be the same for both ends of the tunnel.
|
|
enc-key
-
|
Hexadecimal encryption key in 16-digit (8-byte) segments separated by hyphens.
|
||
interface
-
|
Name of the physical, aggregate, or VLAN interface. Source system.interface.name.
|
||
ip-version
-
|
|
IP version to use for VPN interface.
|
|
local-gw
-
|
IPv4 address of the local gateway's external interface.
|
||
local-gw6
-
|
Local IPv6 address of VPN gateway.
|
||
local-spi
-
|
Local SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules.
|
||
name
-
/ required
|
IPsec tunnel name.
|
||
npu-offload
-
|
|
Enable/disable offloading IPsec VPN manual key sessions to NPUs.
|
|
remote-gw
-
|
IPv4 address of the remote gateway's external interface.
|
||
remote-gw6
-
|
Remote IPv6 address of VPN gateway.
|
||
remote-spi
-
|
Remote SPI, a hexadecimal 8-digit (4-byte) tag. Discerns between two traffic streams with different encryption rules.
|
||
state
-
|
|
Indicates whether to create or remove the object
|
Note
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure IPsec manual keys.
fortios_vpn_ipsec_manualkey_interface:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
vpn_ipsec_manualkey_interface:
state: "present"
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>"
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
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.