lix_fortinet.fortios.fortios_system_mobile_tunnel (102.2.120) — module

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

| "added in version" 2.0.0 of lix_fortinet.fortios"

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

preview | supported by community

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120


Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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: "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"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

system_mobile_tunnel:
    default: null
    description:
    - Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions
      for Mobile IPv4 RFC5177.
    suboptions:
      hash_algorithm:
        choices:
        - hmac-md5
        description:
        - Hash Algorithm (Keyed MD5).
        type: str
      home_address:
        description:
        - 'Home IP address (Format: xxx.xxx.xxx.xxx).'
        type: str
      home_agent:
        description:
        - 'IPv4 address of the NEMO HA (Format: xxx.xxx.xxx.xxx).'
        type: str
      lifetime:
        description:
        - NMMO HA registration request lifetime (180 - 65535 sec).
        type: int
      n_mhae_key:
        description:
        - NEMO authentication key.
        type: str
      n_mhae_key_type:
        choices:
        - ascii
        - base64
        description:
        - NEMO authentication key type (ASCII or base64).
        type: str
      n_mhae_spi:
        description:
        - NEMO authentication SPI .
        type: int
      name:
        description:
        - Tunnel name.
        required: true
        type: str
      network:
        description:
        - NEMO network configuration.
        elements: dict
        suboptions:
          id:
            description:
            - Network entry ID.
            type: int
          interface:
            description:
            - Select the associated interface name from available options. Source system.interface.name.
            type: str
          prefix:
            description:
            - Class IP and Netmask with correction (Format:xxx.xxx.xxx.xxx xxx.xxx.xxx.xxx
              or xxx.xxx.xxx.xxx/x).
            type: str
        type: list
      reg_interval:
        description:
        - NMMO HA registration interval (5 - 300).
        type: int
      reg_retry:
        description:
        - Maximum number of NMMO HA registration retries (1 to 30).
        type: int
      renew_interval:
        description:
        - Time before lifetime expiration to send NMMO HA re-registration (5 - 60).
        type: int
      roaming_interface:
        description:
        - Select the associated interface name from available options. Source system.interface.name.
        type: str
      status:
        choices:
        - disable
        - enable
        description:
        - Enable/disable this mobile tunnel.
        type: str
      tunnel_mode:
        choices:
        - gre
        description:
        - NEMO tunnel mode (GRE tunnel).
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str