Skip to content

Latest commit

 

History

History
592 lines (551 loc) · 25.6 KB

fortios_wireless_controller_global.rst

File metadata and controls

592 lines (551 loc) · 25.6 KB
Raw
source

fortios_wireless_controller_global.py

orphan

fortios_wireless_controller_global -- Configure wireless controller global settings in Fortinet's FortiOS and FortiGate.

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 global 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.15

Tips

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

FortiOS Version Compatibility

Supported Version Ranges: v6.0.0 -> 7.4.3

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_global - Configure wireless controller global settings. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td><td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>wireless_controller_global</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">acd_process_count</span> - Configure the number cw_acd daemons for multi-core CPU support . <span class="li-normal">type: int</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>acd_process_count</td> <td><code class="docutils literal notranslate">v7.2.4 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_log_server</span> - Enable/disable configuring FortiGate to redirect wireless event log messages or FortiAPs to send UTM log messages to a syslog server . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_log_server</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">ap_log_server_ip</span> - IP address that FortiGate or FortiAPs send log messages to. <span class="li-normal">type: str</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_log_server_ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">ap_log_server_port</span> - Port that FortiGate or FortiAPs send log messages to. <span class="li-normal">type: int</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ap_log_server_port</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">control_message_offload</span> - Configure CAPWAP control message data channel offload. <span class="li-normal">type: list</span> <span class="li-normal">choices: ebp-frame, aeroscout-tag, ap-list, sta-list, sta-cap-list, stats, aeroscout-mu, sta-health, spectral-analysis</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>control_message_offload</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[ebp-frame]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[aeroscout-tag]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[ap-list]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[sta-list]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[sta-cap-list]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[stats]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[aeroscout-mu]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[sta-health]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </tr> <tr> <td>[spectral-analysis]</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3</code></td> </tr> </table> </div> </li> <li> <span class="li-head">data_ethernet_II</span> - Configure the wireless controller to use Ethernet II or 802.3 frames with 802.3 data tunnel mode . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>data_ethernet_II</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dfs_lab_test</span> - Enable/disable DFS certificate lab test mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>dfs_lab_test</td> <td><code class="docutils literal notranslate">v7.0.12 -> v7.0.12 </code></td> <td><code class="docutils literal notranslate">v7.2.1 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.12 -> v7.0.12</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.12 -> v7.0.12</code></td> </table> </div> </li> <li> <span class="li-head">discovery_mc_addr</span> - Multicast IP address for AP discovery . <span class="li-normal">type: str</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>discovery_mc_addr</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">fiapp_eth_type</span> - Ethernet type for Fortinet Inter-Access Point Protocol (IAPP), or IEEE 802.11f, packets (0 - 65535). <span class="li-normal">type: int</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>fiapp_eth_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">image_download</span> - Enable/disable WTP image download at join time. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>image_download</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">ipsec_base_ip</span> - Base IP address for IPsec VPN tunnels between the access points and the wireless controller . <span class="li-normal">type: str</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>ipsec_base_ip</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">link_aggregation</span> - Enable/disable calculating the CAPWAP transmit hash to load balance sessions to link aggregation nodes . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>link_aggregation</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">location</span> - Description of the location of the wireless controller. <span class="li-normal">type: str</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>location</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">max_clients</span> - Maximum number of clients that can connect simultaneously . <span class="li-normal">type: int</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>max_clients</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">max_retransmit</span> - Maximum number of tunnel packet retransmissions (0 - 64). <span class="li-normal">type: int</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>max_retransmit</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">mesh_eth_type</span> - Mesh Ethernet identifier included in backhaul packets (0 - 65535). <span class="li-normal">type: int</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>mesh_eth_type</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">nac_interval</span> - Interval in seconds between two WiFi network access control (NAC) checks (10 - 600). <span class="li-normal">type: int</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>nac_interval</td> <td><code class="docutils literal notranslate">v7.0.2 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Name of the wireless controller. <span class="li-normal">type: str</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">rogue_scan_mac_adjacency</span> - Maximum numerical difference between an AP"s Ethernet and wireless MAC values to match for rogue detection (0 - 31). <span class="li-normal">type: int</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rogue_scan_mac_adjacency</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">rolling_wtp_upgrade</span> - Enable/disable rolling WTP upgrade . <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rolling_wtp_upgrade</td> <td><code class="docutils literal notranslate">v7.4.2 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.4.2 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.4.2 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">rolling_wtp_upgrade_threshold</span> - Minimum signal level/threshold in dBm required for the managed WTP to be included in rolling WTP upgrade (-95 to -20). <span class="li-normal">type: str</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>rolling_wtp_upgrade_threshold</td> <td><code class="docutils literal notranslate">v7.4.2 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">tunnel_mode</span> - Compatible/strict tunnel mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: compatible, strict</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>tunnel_mode</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3 </code></td> </tr> <tr> <td>[compatible]</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3</code></td> <tr> <td>[strict]</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">wpad_process_count</span> - Wpad daemon process count for multi-core CPU support. <span class="li-normal">type: int</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>wpad_process_count</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">wtp_share</span> - Enable/disable sharing of WTPs between VDOMs. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>wtp_share</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3</code></td> </table> </div> </li> </ul> </ul>

    Notes

    Note

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

    Examples

    - name: Configure wireless controller global settings.
  fortinet.fortios.fortios_wireless_controller_global:
      vdom: "{{ vdom }}"
      wireless_controller_global:
          acd_process_count: "0"
          ap_log_server: "enable"
          ap_log_server_ip: "<your_own_value>"
          ap_log_server_port: "0"
          control_message_offload: "ebp-frame"
          data_ethernet_II: "enable"
          dfs_lab_test: "enable"
          discovery_mc_addr: "<your_own_value>"
          fiapp_eth_type: "5252"
          image_download: "enable"
          ipsec_base_ip: "<your_own_value>"
          link_aggregation: "enable"
          location: "<your_own_value>"
          max_clients: "0"
          max_retransmit: "3"
          mesh_eth_type: "8755"
          nac_interval: "120"
          name: "default_name_20"
          rogue_scan_mac_adjacency: "7"
          rolling_wtp_upgrade: "enable"
          rolling_wtp_upgrade_threshold: "<your_own_value>"
          tunnel_mode: "compatible"
          wpad_process_count: "0"
          wtp_share: "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.