Skip to content

Latest commit

 

History

History
295 lines (251 loc) · 12.9 KB

fortios_wireless_controller_wag_profile.rst

File metadata and controls

295 lines (251 loc) · 12.9 KB
Raw
source:fortios_wireless_controller_wag_profile.py
orphan:

fortios_wireless_controller_wag_profile -- Configure wireless access gateway (WAG) profiles used for tunnels on AP 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 wireless_controller feature and wag_profile 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_wireless_controller_wag_profile v6.2.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
  • wireless_controller_wag_profile - Configure wireless access gateway (WAG) profiles used for tunnels on AP. type: dict more...
    Supported Version Ranges
    wireless_controller_wag_profile v6.2.0 -> latest
    • comment - Comment. type: str more...
      Supported Version Ranges
      comment v6.2.0 -> latest
    • dhcp_ip_addr - IP address of the monitoring DHCP request packet sent through the tunnel. type: str more...
      Supported Version Ranges
      dhcp_ip_addr v6.2.0 -> latest
    • name - Tunnel profile name. type: str required: true more...
      Supported Version Ranges
      name v6.2.0 -> latest
    • ping_interval - Interval between two tunnel monitoring echo packets (1 - 65535 sec). type: int more...
      Supported Version Ranges
      ping_interval v6.2.0 -> latest
    • ping_number - Number of the tunnel monitoring echo packets (1 - 65535). type: int more...
      Supported Version Ranges
      ping_number v6.2.0 -> latest
    • return_packet_timeout - Window of time for the return packets from the tunnel"s remote end (1 - 65535 sec). type: int more...
      Supported Version Ranges
      return_packet_timeout v6.2.0 -> latest
    • tunnel_type - Tunnel type. type: str choices: l2tpv3, gre more...
      Supported Version Ranges
      tunnel_type v6.2.0 -> latest
      [l2tpv3] v6.0.0 -> latest
      [gre] v6.0.0 -> latest
    • wag_ip - IP Address of the wireless access gateway. type: str more...
      Supported Version Ranges
      wag_ip v6.2.0 -> latest
    • wag_port - UDP port of the wireless access gateway. type: int more...
      Supported Version Ranges
      wag_port v6.2.0 -> latest

Notes

Note

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

Examples

- name: Configure wireless access gateway (WAG) profiles used for tunnels on AP.
  fortinet.fortios.fortios_wireless_controller_wag_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      wireless_controller_wag_profile:
          comment: "Comment."
          dhcp_ip_addr: "<your_own_value>"
          name: "default_name_5"
          ping_interval: "1"
          ping_number: "5"
          return_packet_timeout: "160"
          tunnel_type: "l2tpv3"
          wag_ip: "<your_own_value>"
          wag_port: "1701"

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.