Skip to content

Latest commit

 

History

History
449 lines (405 loc) · 19.6 KB

fortios_system_mobile_tunnel.rst

File metadata and controls

449 lines (405 loc) · 19.6 KB
Raw
source:fortios_system_mobile_tunnel.py
orphan:

fortios_system_mobile_tunnel -- Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet's FortiOS and FortiGate.

.. versionadded:: 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_system_mobile_tunnel v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • 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 more...
    Supported Version Ranges
    system_mobile_tunnel v6.0.0 -> latest
    • hash_algorithm - Hash Algorithm (Keyed MD5). type: str choices: hmac-md5 more...
      Supported Version Ranges
      hash_algorithm v6.0.0 -> latest
      [hmac-md5] v6.0.0 -> latest
    • home_address - Home IP address (Format: xxx.xxx.xxx.xxx). type: str more...
      Supported Version Ranges
      home_address v6.0.0 -> latest
    • home_agent - IPv4 address of the NEMO HA (Format: xxx.xxx.xxx.xxx). type: str more...
      Supported Version Ranges
      home_agent v6.0.0 -> latest
    • lifetime - NMMO HA registration request lifetime (180 - 65535 sec). type: int more...
      Supported Version Ranges
      lifetime v6.0.0 -> latest
    • n_mhae_key - NEMO authentication key. type: str more...
      Supported Version Ranges
      n_mhae_key v6.0.0 -> latest
    • n_mhae_key_type - NEMO authentication key type (ASCII or base64). type: str choices: ascii, base64 more...
      Supported Version Ranges
      n_mhae_key_type v6.0.0 -> latest
      [ascii] v6.0.0 -> latest
      [base64] v6.0.0 -> latest
    • n_mhae_spi - NEMO authentication SPI . type: int more...
      Supported Version Ranges
      n_mhae_spi v6.0.0 -> latest
    • name - Tunnel name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • network - NEMO network configuration. type: list member_path: network:id more...
      Supported Version Ranges
      network v6.0.0 -> latest
      • id - Network entry ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • interface - Select the associated interface name from available options. Source system.interface.name. type: str more...
        Supported Version Ranges
        interface v6.0.0 -> latest
      • prefix - Class IP and Netmask with correction (Format:xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx or xxx.xxx.xxx.xxx/x). type: str more...
        Supported Version Ranges
        prefix v6.0.0 -> latest
    • reg_interval - NMMO HA registration interval (5 - 300). type: int more...
      Supported Version Ranges
      reg_interval v6.0.0 -> latest
    • reg_retry - Maximum number of NMMO HA registration retries (1 to 30). type: int more...
      Supported Version Ranges
      reg_retry v6.0.0 -> latest
    • renew_interval - Time before lifetime expiration to send NMMO HA re-registration (5 - 60). type: int more...
      Supported Version Ranges
      renew_interval v6.0.0 -> latest
    • roaming_interface - Select the associated interface name from available options. Source system.interface.name. type: str more...
      Supported Version Ranges
      roaming_interface v6.0.0 -> latest
    • status - Enable/disable this mobile tunnel. type: str choices: disable, enable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • tunnel_mode - NEMO tunnel mode (GRE tunnel). type: str choices: gre more...
      Supported Version Ranges
      tunnel_mode v6.0.0 -> latest
      [gre] v6.0.0 -> latest

Notes

Note

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

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: 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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.