On this page
fortinet.fortios.fortios_system_mobile_tunnel – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 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_mobile_tunnel
.
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 mobile_tunnel 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.
|
||
state
string / required
|
|
Indicates whether to create or remove the object.
|
||
system_mobile_tunnel
dictionary
|
Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
|
|||
hash_algorithm
string
|
|
Hash Algorithm (Keyed MD5).
|
||
home_address
string
|
Home IP address (Format: xxx.xxx.xxx.xxx).
|
|||
home_agent
string
|
IPv4 address of the NEMO HA (Format: xxx.xxx.xxx.xxx).
|
|||
lifetime
integer
|
NMMO HA registration request lifetime (180 - 65535 sec).
|
|||
n_mhae_key
string
|
NEMO authentication key.
|
|||
n_mhae_key_type
string
|
|
NEMO authentication key type (ascii or base64).
|
||
n_mhae_spi
integer
|
NEMO authentication SPI .
|
|||
name
string / required
|
Tunnel name.
|
|||
network
list / elements=string
|
NEMO network configuration.
|
|||
id
integer / required
|
Network entry ID.
|
|||
interface
string
|
Select the associated interface name from available options. Source system.interface.name.
|
|||
prefix
string
|
Class IP and Netmask with correction (Format:xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx or xxx.xxx.xxx.xxx/x).
|
|||
reg_interval
integer
|
NMMO HA registration interval (5 - 300).
|
|||
reg_retry
integer
|
Maximum number of NMMO HA registration retries (1 to 30).
|
|||
renew_interval
integer
|
Time before lifetime expiraton to send NMMO HA re-registration (5 - 60).
|
|||
roaming_interface
string
|
Select the associated interface name from available options. Source system.interface.name.
|
|||
status
string
|
|
Enable/disable this mobile tunnel.
|
||
tunnel_mode
string
|
|
NEMO tunnnel mode (GRE tunnel).
|
||
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 Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
fortios_system_mobile_tunnel:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_mobile_tunnel:
hash_algorithm: "hmac-md5"
home_address: "<your_own_value>"
home_agent: "<your_own_value>"
lifetime: "6"
n_mhae_key: "<your_own_value>"
n_mhae_key_type: "ascii"
n_mhae_spi: "9"
name: "default_name_10"
network:
-
id: "12"
interface: "<your_own_value> (source system.interface.name)"
prefix: "<your_own_value>"
reg_interval: "15"
reg_retry: "16"
renew_interval: "17"
roaming_interface: "<your_own_value> (source system.interface.name)"
status: "disable"
tunnel_mode: "gre"
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_mobile_tunnel_module.html