:source: fortios_extension_controller_extender_vap.py

:orphan:

.. fortios_extension_controller_extender_vap:

fortios_extension_controller_extender_vap -- FortiExtender wifi vap configuration in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 2.0.0

.. contents::
   :local:
   :depth: 1


Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extension_controller feature and extender_vap 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.16


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

FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v7.4.4 -> v7.6.6


Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">access_token</span> - Token-based authentication. Generated from GUI of Fortigate. <span class="li-normal">type: str</span> <span class="li-required">required: false</span> </li>
    <li> <span class="li-head">enable_log</span> - Enable/Disable logging for task. <span class="li-normal">type: bool</span> <span class="li-required">required: false</span> <span class="li-normal">default: False</span> </li>
    <li> <span class="li-head">vdom</span> - 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. <span class="li-normal">type: str</span> <span class="li-normal">default: root</span> </li>
    <li> <span class="li-head">member_path</span> - Member attribute path to operate on. <span class="li-normal">type: str</span> </li>
    <li> <span class="li-head">member_state</span> - Add or delete a member under specified attribute path. <span class="li-normal">type: str</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">state</span> - Indicates whether to create or remove the object. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> <span class="li-normal">choices: present, absent</span> </li>
    <li> <span class="li-head">extension_controller_extender_vap</span> - FortiExtender wifi vap configuration. <span class="li-normal">type: dict</span>
 <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>extension_controller_extender_vap</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <ul class="ul-self">
        <li> <span class="li-head">allowaccess</span> - Control management access to the managed extender. Separate entries with a space. <span class="li-normal">type: list</span> <span class="li-normal">choices: ping, telnet, http, https, ssh, snmp</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>allowaccess</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[ping]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[telnet]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[http]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[https]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[ssh]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[snmp]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">auth_server_address</span> - Wi-Fi Authentication Server Address (IPv4 format). <span class="li-normal">type: str</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>auth_server_address</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">auth_server_port</span> - Wi-Fi Authentication Server Port. <span class="li-normal">type: int</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>auth_server_port</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">auth_server_secret</span> - Wi-Fi Authentication Server Secret. <span class="li-normal">type: str</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>auth_server_secret</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">broadcast_ssid</span> - Wi-Fi broadcast SSID enable / disable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>broadcast_ssid</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">bss_color_partial</span> - Wi-Fi 802.11AX bss color partial enable / disable, default = enable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>bss_color_partial</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">dtim</span> - Wi-Fi DTIM (1 - 255) default = 1. <span class="li-normal">type: int</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="1">Supported Version Ranges</td>
 </tr>
 <tr>
 <td>dtim</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">end_ip</span> - End ip address. <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>end_ip</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">ip_address</span> - Extender ip address. <span class="li-normal">type: str</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>ip_address</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">max_clients</span> - Wi-Fi max clients (0 - 512)) <span class="li-normal">type: int</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>max_clients</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">mu_mimo</span> - Wi-Fi multi-user MIMO enable / disable, default = enable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>mu_mimo</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">name</span> - Wi-Fi VAP name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>name</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">passphrase</span> - Wi-Fi passphrase. <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>passphrase</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">pmf</span> - Wi-Fi pmf enable/disable, default = disable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disabled, optional, required</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>pmf</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[disabled]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[optional]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[required]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">rts_threshold</span> - Wi-Fi RTS Threshold (256 - 2347)). <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>rts_threshold</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">sae_password</span> - Wi-Fi SAE Password. <span class="li-normal">type: str</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>sae_password</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">security</span> - Wi-Fi security. <span class="li-normal">type: str</span> <span class="li-normal">choices: OPEN, WPA2-Personal, WPA-WPA2-Personal, WPA3-SAE, WPA3-SAE-Transition, WPA2-Enterprise, WPA3-Enterprise-only, WPA3-Enterprise-transition, WPA3-Enterprise-192-bit</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>security</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[OPEN]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA2-Personal]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA-WPA2-Personal]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA3-SAE]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA3-SAE-Transition]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA2-Enterprise]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA3-Enterprise-only]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA3-Enterprise-transition]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[WPA3-Enterprise-192-bit]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">ssid</span> - Wi-Fi SSID. <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>ssid</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">start_ip</span> - Start ip address. <span class="li-normal">type: str</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>start_ip</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 </table>
 </div>
 </li>
        <li> <span class="li-head">target_wake_time</span> - Wi-Fi 802.11AX target wake time enable / disable, default = enable. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>target_wake_time</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[disable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[enable]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        <li> <span class="li-head">type</span> - Wi-Fi VAP type local-vap / lan-extension-vap. <span class="li-normal">type: str</span> <span class="li-normal">choices: local-vap, lan-ext-vap</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>type</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6 </code></td>
 </tr>
 <tr>
 <td>[local-vap]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 <tr>
 <td>[lan-ext-vap]</td>
 <td><code class="docutils literal notranslate">v7.4.4 -> 7.6.6</code></td>
 </table>
 </div>
 </li>
        </ul>
    </ul>


Notes
-----

.. note::

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

   - The module supports check_mode.



Examples
--------

.. code-block:: yaml+jinja
    
    - name: FortiExtender wifi vap configuration.
      fortinet.fortios.fortios_extension_controller_extender_vap:
          vdom: "{{ vdom }}"
          state: "present"
          access_token: "<your_own_value>"
          extension_controller_extender_vap:
              allowaccess: "ping"
              auth_server_address: "<your_own_value>"
              auth_server_port: "0"
              auth_server_secret: "<your_own_value>"
              broadcast_ssid: "disable"
              bss_color_partial: "disable"
              dtim: "1"
              end_ip: "<your_own_value>"
              ip_address: "<your_own_value>"
              max_clients: "0"
              mu_mimo: "disable"
              name: "default_name_14"
              passphrase: "<your_own_value>"
              pmf: "disabled"
              rts_threshold: "2347"
              sae_password: "<your_own_value>"
              security: "OPEN"
              ssid: "<your_own_value>"
              start_ip: "<your_own_value>"
              target_wake_time: "disable"
              type: "local-vap"


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:

.. raw:: html

    <ul>

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

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.