Skip to content

Latest commit

 

History

History
325 lines (283 loc) · 14.3 KB

fortios_switch_controller_acl_ingress.rst

File metadata and controls

325 lines (283 loc) · 14.3 KB
Raw
source

fortios_switch_controller_acl_ingress.py

orphan

fortios_switch_controller_acl_ingress -- Configure ingress ACL policies to be applied on managed FortiSwitch ports 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_acl feature and ingress 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: v7.4.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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • switch_controller_acl_ingress - Configure ingress ACL policies to be applied on managed FortiSwitch ports. 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_acl_ingress</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">action</span> - ACL actions. <span class="li-normal">type: dict</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>action</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">count</span> - Enable/disable count. <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>count</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> <li> <span class="li-head">drop</span> - Enable/disable drop. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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>drop</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> <tr> <td>[enable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> <tr> <td>[disable]</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3</code></td> </table> </div> </li> </ul> <li> <span class="li-head">classifier</span> - ACL classifiers. <span class="li-normal">type: dict</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>classifier</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">dst_ip_prefix</span> - Destination IP address to be matched. <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>dst_ip_prefix</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">dst_mac</span> - Destination MAC address to be matched. <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>dst_mac</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">src_ip_prefix</span> - Source IP address to be matched. <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="1">Supported Version Ranges</td> </tr> <tr> <td>src_ip_prefix</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">src_mac</span> - Source MAC address to be matched. <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>src_mac</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">vlan</span> - VLAN ID to be matched. <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>vlan</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">description</span> - Description for the ACL policy. <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="1">Supported Version Ranges</td> </tr> <tr> <td>description</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - ACL ID. see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</span> <span class="li-required">required: true</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>id</td> <td><code class="docutils literal notranslate">v7.4.0 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> </ul>

    Notes

    Note

    • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
    • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

    Examples

    - name: Configure ingress ACL policies to be applied on managed FortiSwitch ports.
  fortinet.fortios.fortios_switch_controller_acl_ingress:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_acl_ingress:
          action:
              count: "enable"
              drop: "enable"
          classifier:
              dst_ip_prefix: "<your_own_value>"
              dst_mac: "<your_own_value>"
              src_ip_prefix: "<your_own_value>"
              src_mac: "<your_own_value>"
              vlan: "0"
          description: "<your_own_value>"
          id: "13"

    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.