Skip to content

Latest commit

 

History

History
729 lines (688 loc) · 32 KB

fortios_switch_controller_global.rst

File metadata and controls

729 lines (688 loc) · 32 KB
Raw
source

fortios_switch_controller_global.py

orphan

fortios_switch_controller_global -- Configure FortiSwitch 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 switch_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
  • switch_controller_global - Configure FortiSwitch 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>switch_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">allow_multiple_interfaces</span> - Enable/disable multiple FortiLink interfaces for redundant connections between a managed FortiSwitch and FortiGate. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>allow_multiple_interfaces</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.1 -> v6.4.1 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.2.7</code></td> </table> </div> </li> <li> <span class="li-head">bounce_quarantined_link</span> - Enable/disable bouncing (administratively bring the link down, up) of a switch port where a quarantined device was seen last. Helps to re-initiate the DHCP process for a device. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>bounce_quarantined_link</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">custom_command</span> - List of custom commands to be pushed to all FortiSwitches in the VDOM. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: custom_command:command_entry</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>custom_command</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">command_entry</span> - List of FortiSwitch commands. <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="1">Supported Version Ranges</td> </tr> <tr> <td>command_entry</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">command_name</span> - Name of custom command to push to all FortiSwitches in VDOM. Source switch-controller.custom-command.command-name. <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="1">Supported Version Ranges</td> </tr> <tr> <td>command_name</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">default_virtual_switch_vlan</span> - Default VLAN for ports when added to the virtual-switch. Source system.interface.name. <span class="li-normal">type: str</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>default_virtual_switch_vlan</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">dhcp_option82_circuit_id</span> - List the parameters to be included to inform about client identification. <span class="li-normal">type: list</span> <span class="li-normal">choices: intfname, vlan, hostname, mode, description</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>dhcp_option82_circuit_id</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[intfname]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[vlan]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[hostname]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[mode]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[description]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dhcp_option82_format</span> - DHCP option-82 format string. <span class="li-normal">type: str</span> <span class="li-normal">choices: ascii, legacy</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>dhcp_option82_format</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[ascii]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[legacy]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dhcp_option82_remote_id</span> - List the parameters to be included to inform about client identification. <span class="li-normal">type: list</span> <span class="li-normal">choices: mac, hostname, ip</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>dhcp_option82_remote_id</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[mac]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[hostname]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[ip]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dhcp_server_access_list</span> - Enable/disable DHCP snooping server access list. <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>dhcp_server_access_list</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dhcp_snoop_client_db_exp</span> - Expiry time for DHCP snooping server database entries (300 - 259200 sec). <span class="li-normal">type: int</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>dhcp_snoop_client_db_exp</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">dhcp_snoop_client_req</span> - Client DHCP packet broadcast mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: drop-untrusted, forward-untrusted</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>dhcp_snoop_client_req</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[drop-untrusted]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[forward-untrusted]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">dhcp_snoop_db_per_port_learn_limit</span> - Per Interface dhcp-server entries learn limit (0 - 1024). <span class="li-normal">type: int</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>dhcp_snoop_db_per_port_learn_limit</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">disable_discovery</span> - Prevent this FortiSwitch from discovering. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: disable_discovery:name</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>disable_discovery</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">name</span> - Managed device ID. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">fips_enforce</span> - Enable/disable enforcement of FIPS on managed FortiSwitch devices. <span class="li-normal">type: str</span> <span class="li-normal">choices: disable, enable</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>fips_enforce</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3 </code></td> </tr> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">firmware_provision_on_authorization</span> - Enable/disable automatic provisioning of latest firmware on authorization. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>firmware_provision_on_authorization</td> <td><code class="docutils literal notranslate">v7.0.4 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.0.4 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.0.4 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">https_image_push</span> - Enable/disable image push to FortiSwitch using HTTPS. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>https_image_push</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">log_mac_limit_violations</span> - Enable/disable logs for Learning Limit Violations. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>log_mac_limit_violations</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">mac_aging_interval</span> - Time after which an inactive MAC is aged out (10 - 1000000 sec). <span class="li-normal">type: int</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>mac_aging_interval</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">mac_event_logging</span> - Enable/disable MAC address event logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>mac_event_logging</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">mac_retention_period</span> - Time in hours after which an inactive MAC is removed from client DB (0 = aged out based on mac-aging-interval). <span class="li-normal">type: int</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>mac_retention_period</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">mac_violation_timer</span> - Set timeout for Learning Limit Violations (0 = disabled). <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>mac_violation_timer</td> <td><code class="docutils literal notranslate">v6.0.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">quarantine_mode</span> - Quarantine mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: by-vlan, by-redirect</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>quarantine_mode</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[by-vlan]</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3</code></td> <tr> <td>[by-redirect]</td> <td><code class="docutils literal notranslate">v6.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">sn_dns_resolution</span> - Enable/disable DNS resolution of the FortiSwitch unit"s IP address with switch name. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label50' href="javascript:ContentClick('label51', 'label50');" onmouseover="ContentPreview('label51');" onmouseout="ContentUnpreview('label51');" title="click to collapse or expand..."> more... </a> <div id="label51" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>sn_dns_resolution</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">update_user_device</span> - Control which sources update the device user list. <span class="li-normal">type: list</span> <span class="li-normal">choices: mac-cache, lldp, dhcp-snooping, l2-db, l3-db</span> <a id='label52' href="javascript:ContentClick('label53', 'label52');" onmouseover="ContentPreview('label53');" onmouseout="ContentUnpreview('label53');" title="click to collapse or expand..."> more... </a> <div id="label53" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="2">Supported Version Ranges</td> </tr> <tr> <td>update_user_device</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.4 -> 7.4.3 </code></td> </tr> <tr> <td>[mac-cache]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[lldp]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[dhcp-snooping]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[l2-db]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> <tr> <td>[l3-db]</td> <td><code class="docutils literal notranslate">v6.4.0 -> v6.4.0</code></td> </table> </div> </li> <li> <span class="li-head">vlan_all_mode</span> - VLAN configuration mode, user-defined-vlans or all-possible-vlans. <span class="li-normal">type: str</span> <span class="li-normal">choices: all, defined</span> <a id='label54' href="javascript:ContentClick('label55', 'label54');" onmouseover="ContentPreview('label55');" onmouseout="ContentUnpreview('label55');" title="click to collapse or expand..."> more... </a> <div id="label55" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vlan_all_mode</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[all]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[defined]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">vlan_identity</span> - Identity of the VLAN. Commonly used for RADIUS Tunnel-Private-Group-Id. <span class="li-normal">type: str</span> <span class="li-normal">choices: description, name</span> <a id='label56' href="javascript:ContentClick('label57', 'label56');" onmouseover="ContentPreview('label57');" onmouseout="ContentUnpreview('label57');" title="click to collapse or expand..."> more... </a> <div id="label57" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vlan_identity</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3 </code></td> </tr> <tr> <td>[description]</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3</code></td> <tr> <td>[name]</td> <td><code class="docutils literal notranslate">v7.4.1 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">vlan_optimization</span> - FortiLink VLAN optimization. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</span> <a id='label58' href="javascript:ContentClick('label59', 'label58');" onmouseover="ContentPreview('label59');" onmouseout="ContentUnpreview('label59');" title="click to collapse or expand..."> more... </a> <div id="label59" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>vlan_optimization</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v6.2.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v6.2.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 FortiSwitch global settings.
  fortinet.fortios.fortios_switch_controller_global:
      vdom: "{{ vdom }}"
      switch_controller_global:
          allow_multiple_interfaces: "enable"
          bounce_quarantined_link: "disable"
          custom_command:
              -
                  command_entry: "<your_own_value>"
                  command_name: "<your_own_value> (source switch-controller.custom-command.command-name)"
          default_virtual_switch_vlan: "<your_own_value> (source system.interface.name)"
          dhcp_option82_circuit_id: "intfname"
          dhcp_option82_format: "ascii"
          dhcp_option82_remote_id: "mac"
          dhcp_server_access_list: "enable"
          dhcp_snoop_client_db_exp: "86400"
          dhcp_snoop_client_req: "drop-untrusted"
          dhcp_snoop_db_per_port_learn_limit: "64"
          disable_discovery:
              -
                  name: "default_name_17"
          fips_enforce: "disable"
          firmware_provision_on_authorization: "enable"
          https_image_push: "enable"
          log_mac_limit_violations: "enable"
          mac_aging_interval: "300"
          mac_event_logging: "enable"
          mac_retention_period: "24"
          mac_violation_timer: "0"
          quarantine_mode: "by-vlan"
          sn_dns_resolution: "enable"
          update_user_device: "mac-cache"
          vlan_all_mode: "all"
          vlan_identity: "description"
          vlan_optimization: "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.