fortios_system_mobile_tunnel – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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. type: str default: root
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_mobile_tunnel - Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177. type: dict
- hash_algorithm - Hash Algorithm (Keyed MD5). type: str choices: hmac-md5
- home_address - Home IP address (Format: xxx.xxx.xxx.xxx). type: str
- home_agent - IPv4 address of the NEMO HA (Format: xxx.xxx.xxx.xxx). type: str
- lifetime - NMMO HA registration request lifetime (180 - 65535 sec). type: int
- n_mhae_key - NEMO authentication key. type: str
- n_mhae_key_type - NEMO authentication key type (ascii or base64). type: str choices: ascii, base64
- n_mhae_spi - NEMO authentication SPI . type: int
- name - Tunnel name. type: str required: True
- network - NEMO network configuration. type: list
- id - Network entry ID. type: int required: True
- interface - Select the associated interface name from available options. Source system.interface.name. type: str
- prefix - Class IP and Netmask with correction (Format:xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx or xxx.xxx.xxx.xxx/x). type: str
- reg_interval - NMMO HA registration interval (5 - 300). type: int
- reg_retry - Maximum number of NMMO HA registration retries (1 to 30). type: int
- renew_interval - Time before lifetime expiraton to send NMMO HA re-registration (5 - 60). type: int
- roaming_interface - Select the associated interface name from available options. Source system.interface.name. type: str
- status - Enable/disable this mobile tunnel. type: str choices: disable, enable
- tunnel_mode - NEMO tunnnel mode (GRE tunnel). type: str choices: gre
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3