fortios_system_mobile_tunnel – Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet’s FortiOS and FortiGate — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# 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
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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.5

## Requirements

The below requirements are needed on the host that executes this module.

- fortiosapi>=0.9.8

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
host string |  | FortiOS or FortiGate IP address.
https boolean | Choices: no yes ← | Indicates if the requests towards FortiGate must use HTTPS protocol.
password string | Default: "" | FortiOS or FortiGate password.
ssl_verify boolean | Choices: no yes ← | Ensures FortiGate certificate must be verified by a proper CA.
state string / required | Choices: present absent | Indicates whether to create or remove the object.
system_mobile_tunnel dictionary | Default: null | Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
| hash_algorithm string | Choices: hmac-md5 | 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 | Choices: ascii base64 | NEMO authentication key type (ascii or base64).
| n_mhae_spi integer |  | NEMO authentication SPI .
| name string / required |  | Tunnel name.
| network list |  | 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 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 | Choices: disable enable | Enable/disable this mobile tunnel.
| tunnel_mode string | Choices: gre | NEMO tunnel mode (GRE tunnel).
username string |  | FortiOS or FortiGate username.
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

- Requires fortiosapi library developed by Fortinet
- Run as a local_action in your playbook

## Examples

    - hosts: localhost
      vars:
       host: "192.168.122.40"
       username: "admin"
       password: ""
       vdom: "root"
       ssl_verify: "False"
      tasks:
      - name: Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177.
        fortios_system_mobile_tunnel:
          host:  "{{ host }}"
          username: "{{ username }}"
          password: "{{ password }}"
          vdom:  "{{ vdom }}"
          https: "False"
          state: "present"
          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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.