Skip to content

Latest commit

 

History

History
340 lines (296 loc) · 15.2 KB

fortios_wireless_controller_inter_controller.rst

File metadata and controls

340 lines (296 loc) · 15.2 KB
Raw
source:fortios_wireless_controller_inter_controller.py
orphan:

fortios_wireless_controller_inter_controller -- Configure inter wireless controller operation 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 inter_controller 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_inter_controller 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
  • wireless_controller_inter_controller - Configure inter wireless controller operation. type: dict more...
    Supported Version Ranges
    wireless_controller_inter_controller v6.0.0 -> latest
    • fast_failover_max - Maximum number of retransmissions for fast failover HA messages between peer wireless controllers (3 - 64). type: int more...
      Supported Version Ranges
      fast_failover_max v6.0.0 -> latest
    • fast_failover_wait - Minimum wait time before an AP transitions from secondary controller to primary controller (10 - 86400 sec). type: int more...
      Supported Version Ranges
      fast_failover_wait v6.0.0 -> latest
    • inter_controller_key - Secret key for inter-controller communications. type: str more...
      Supported Version Ranges
      inter_controller_key v6.0.0 -> latest
    • inter_controller_mode - Configure inter-controller mode (disable, l2-roaming, 1+1). type: str choices: disable, l2-roaming, 1+1 more...
      Supported Version Ranges
      inter_controller_mode v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [l2-roaming] v6.0.0 -> latest
      [1+1] v6.0.0 -> latest
    • inter_controller_peer - Fast failover peer wireless controller list. type: list member_path: inter_controller_peer:id more...
      Supported Version Ranges
      inter_controller_peer v6.0.0 -> latest
      • id - ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • peer_ip - Peer wireless controller"s IP address. type: str more...
        Supported Version Ranges
        peer_ip v6.0.0 -> latest
      • peer_port - Port used by the wireless controller"s for inter-controller communications (1024 - 49150). type: int more...
        Supported Version Ranges
        peer_port v6.0.0 -> latest
      • peer_priority - Peer wireless controller"s priority (primary or secondary). type: str choices: primary, secondary more...
        Supported Version Ranges
        peer_priority v6.0.0 -> latest
        [primary] v6.0.0 -> latest
        [secondary] v6.0.0 -> latest
    • inter_controller_pri - Configure inter-controller"s priority (primary or secondary). type: str choices: primary, secondary more...
      Supported Version Ranges
      inter_controller_pri v6.0.0 -> latest
      [primary] v6.0.0 -> latest
      [secondary] v6.0.0 -> latest
    • l3_roaming - Enable/disable layer 3 roaming . type: str choices: enable, disable more...
      Supported Version Ranges
      l3_roaming v7.2.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure inter wireless controller operation.
  fortinet.fortios.fortios_wireless_controller_inter_controller:
      vdom: "{{ vdom }}"
      wireless_controller_inter_controller:
          fast_failover_max: "10"
          fast_failover_wait: "10"
          inter_controller_key: "<your_own_value>"
          inter_controller_mode: "disable"
          inter_controller_peer:
              -
                  id: "8"
                  peer_ip: "<your_own_value>"
                  peer_port: "5246"
                  peer_priority: "primary"
          inter_controller_pri: "primary"
          l3_roaming: "enable"

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.