Skip to content

Latest commit

 

History

History
441 lines (401 loc) · 19.8 KB

fortios_switch_controller_vlan.rst

File metadata and controls

441 lines (401 loc) · 19.8 KB
Raw
source

fortios_switch_controller_vlan.py

orphan

fortios_switch_controller_vlan -- Configure VLANs for switch controller 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 switch_controller feature and vlan 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 -> v6.0.11 , v6.2.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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • switch_controller_vlan - Configure VLANs for switch controller. 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="2">Supported Version Ranges</td> </tr> <tr> <td>switch_controller_vlan</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth</span> - Authentication. <span class="li-normal">type: str</span> <span class="li-normal">choices: radius, usergroup</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="2">Supported Version Ranges</td> </tr> <tr> <td>auth</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> <tr> <td>[radius]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[usergroup]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">color</span> - Color of icon on the GUI. <span class="li-normal">type: int</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="2">Supported Version Ranges</td> </tr> <tr> <td>color</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">comments</span> - Comment. <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="2">Supported Version Ranges</td> </tr> <tr> <td>comments</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Switch VLAN name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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="2">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">portal_message_override_group</span> - Specify captive portal replacement message override group. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>portal_message_override_group</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">portal_message_overrides</span> - Individual message overrides. <span class="li-normal">type: dict</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="2">Supported Version Ranges</td> </tr> <tr> <td>portal_message_overrides</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">auth_disclaimer_page</span> - Override auth-disclaimer-page message with message from portal-message-overrides group. <span class="li-normal">type: str</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>auth_disclaimer_page</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auth_login_failed_page</span> - Override auth-login-failed-page message with message from portal-message-overrides group. <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="2">Supported Version Ranges</td> </tr> <tr> <td>auth_login_failed_page</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auth_login_page</span> - Override auth-login-page message with message from portal-message-overrides group. <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="2">Supported Version Ranges</td> </tr> <tr> <td>auth_login_page</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">auth_reject_page</span> - Override auth-reject-page message with message from portal-message-overrides group. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>auth_reject_page</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">radius_server</span> - Authentication radius server. Source user.radius.name. <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="2">Supported Version Ranges</td> </tr> <tr> <td>radius_server</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">security</span> - Security. <span class="li-normal">type: str</span> <span class="li-normal">choices: open, captive-portal, 8021x</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="2">Supported Version Ranges</td> </tr> <tr> <td>security</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> <tr> <td>[open]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[captive-portal]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> <tr> <td>[8021x]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11</code></td> </table> </div> </li> <li> <span class="li-head">selected_usergroups</span> - Selected user group. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: selected_usergroups:name</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="2">Supported Version Ranges</td> </tr> <tr> <td>selected_usergroups</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">name</span> - User group name. Source user.group.name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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="2">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">usergroup</span> - Authentication usergroup. Source user.group.name. <span class="li-normal">type: str</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="2">Supported Version Ranges</td> </tr> <tr> <td>usergroup</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">vdom</span> - Virtual domain, <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="2">Supported Version Ranges</td> </tr> <tr> <td>vdom</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">vlanid</span> - VLAN ID. <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="2">Supported Version Ranges</td> </tr> <tr> <td>vlanid</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.0.11 </code></td> <td><code class="docutils literal notranslate">v6.2.3 -> v6.2.3 </code></td> </tr> </table> </div> </li> </ul> </ul>

    Notes

    Note

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

    Examples

    - name: Configure VLANs for switch controller.
  fortinet.fortios.fortios_switch_controller_vlan:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_vlan:
          auth: "radius"
          color: "16"
          comments: "<your_own_value>"
          name: "default_name_6"
          portal_message_override_group: "<your_own_value>"
          portal_message_overrides:
              auth_disclaimer_page: "<your_own_value>"
              auth_login_failed_page: "<your_own_value>"
              auth_login_page: "<your_own_value>"
              auth_reject_page: "<your_own_value>"
          radius_server: "<your_own_value> (source user.radius.name)"
          security: "open"
          selected_usergroups:
              -
                  name: "default_name_16 (source user.group.name)"
          usergroup: "<your_own_value> (source user.group.name)"
          vdom: "<your_own_value>"
          vlanid: "2047"

    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.