Skip to content

Latest commit

 

History

History
303 lines (259 loc) · 12.8 KB

fortios_vpn_l2tp.rst

File metadata and controls

303 lines (259 loc) · 12.8 KB
Raw
source:fortios_vpn_l2tp.py
orphan:

fortios_vpn_l2tp -- Configure L2TP 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 vpn feature and l2tp 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_vpn_l2tp 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
  • vpn_l2tp - Configure L2TP. type: dict more...
    Supported Version Ranges
    vpn_l2tp v6.0.0 -> latest
    • compress - Enable/disable data compression. type: str choices: enable, disable more...
      Supported Version Ranges
      compress v6.2.0 -> v6.2.0 v6.2.5 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • eip - End IP. type: str more...
      Supported Version Ranges
      eip v6.0.0 -> latest
    • enforce_ipsec - Enable/disable IPsec enforcement. type: str choices: enable, disable more...
      Supported Version Ranges
      enforce_ipsec v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • hello_interval - L2TP hello message interval in seconds (0 - 3600 sec). type: int more...
      Supported Version Ranges
      hello_interval v7.0.1 -> latest
    • lcp_echo_interval - Time in seconds between PPPoE Link Control Protocol (LCP) echo requests. type: int more...
      Supported Version Ranges
      lcp_echo_interval v6.4.0 -> v6.4.0 v6.4.4 -> latest
    • lcp_max_echo_fails - Maximum number of missed LCP echo messages before disconnect. type: int more...
      Supported Version Ranges
      lcp_max_echo_fails v6.4.0 -> v6.4.0 v6.4.4 -> latest
    • sip - Start IP. type: str more...
      Supported Version Ranges
      sip v6.0.0 -> latest
    • status - Enable/disable FortiGate as a L2TP gateway. type: str choices: enable, disable more...
      Supported Version Ranges
      status v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • usrgrp - User group. Source user.group.name. type: str more...
      Supported Version Ranges
      usrgrp v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure L2TP.
  fortinet.fortios.fortios_vpn_l2tp:
      vdom: "{{ vdom }}"
      vpn_l2tp:
          compress: "enable"
          eip: "<your_own_value>"
          enforce_ipsec: "enable"
          hello_interval: "60"
          lcp_echo_interval: "5"
          lcp_max_echo_fails: "3"
          sip: "<your_own_value>"
          status: "enable"
          usrgrp: "<your_own_value> (source user.group.name)"

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.