fortinet.fortios.fortios_system_mobile_tunnel module – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.3.8).

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. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: fortinet.fortios.fortios_system_mobile_tunnel.

New in fortinet.fortios 2.0.0

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.15

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

member_path

string

Member attribute path to operate on.

Delimited by a slash character if there are more than one attribute.

Parameter marked with member_path is legitimate for doing member operation.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • "present"

  • "absent"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"

  • "absent"

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).

Choices:

  • "hmac-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).

Choices:

  • "ascii"

  • "base64"

n_mhae_spi

integer

NEMO authentication SPI .

name

string / required

Tunnel name.

network

list / elements=dictionary

NEMO network configuration.

id

integer / required

Network entry ID. see <a href=’#notes’>Notes</a>.

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 expiration 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.

Choices:

  • "disable"

  • "enable"

tunnel_mode

string

NEMO tunnel mode (GRE tunnel).

Choices:

  • "gre"

vdom

string

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.

Default: "root"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

  • The module supports check_mode.

Examples

- name: Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
  fortinet.fortios.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: "65535"
          n_mhae_key: "<your_own_value>"
          n_mhae_key_type: "ascii"
          n_mhae_spi: "256"
          name: "default_name_10"
          network:
              -
                  id: "12"
                  interface: "<your_own_value> (source system.interface.name)"
                  prefix: "<your_own_value>"
          reg_interval: "5"
          reg_retry: "3"
          renew_interval: "60"
          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

Description

build

string

Build number of the fortigate image

Returned: always

Sample: "1547"

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: "PUT"

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: "200"

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: "id"

name

string

Name of the table used to fulfill the request

Returned: always

Sample: "urlfilter"

path

string

Path of the table used to fulfill the request

Returned: always

Sample: "webfilter"

revision

string

Internal revision number

Returned: always

Sample: "17.0.2.10658"

serial

string

Serial number of the unit

Returned: always

Sample: "FGVMEVYYQT3AB5352"

status

string

Indication of the operation’s result

Returned: always

Sample: "success"

vdom

string

Virtual domain used

Returned: always

Sample: "root"

version

string

Version of the FortiGate

Returned: always

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)