- source
fortios_pfcp_message_filter.py
- orphan
fortios_pfcp_message_filter -- Message filter for PFCP messages in Fortinet's FortiOS and FortiGate.
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify pfcp feature and message_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
The below requirements are needed on the host that executes this module.
- ansible>=2.15
Using member operation to add an element to an existing object.
Supported Version Ranges: v7.0.1 -> v7.0.8 , v7.2.0 -> v7.2.4 , v7.4.3 -> 7.4.3
- 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
- pfcp_message_filter - Message filter for PFCP messages. 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="3">Supported Version Ranges</td> </tr> <tr> <td>pfcp_message_filter</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">association_release</span> - Allow or deny PFCP association release request (9) and PFCP association release response (10). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>association_release</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">association_setup</span> - Allow or deny PFCP association setup request (5) and PFCP association setup response (6). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>association_setup</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">association_update</span> - Allow or deny PFCP association update request (7) and PFCP association update response (8). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>association_update</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">heartbeat</span> - Allow or deny PFCP heartbeat request (1) and PFCP heartbeat response (2). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>heartbeat</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">name</span> - Message filter name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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="3">Supported Version Ranges</td> </tr> <tr> <td>name</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">node_report</span> - Allow or deny PFCP node report request (12) and PFCP node report response (13). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>node_report</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">pfd_management</span> - Allow or deny PFCP PFD management request (3) and PFCP PFD management response (4). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>pfd_management</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">session_deletion</span> - Allow or deny PFCP session deletion request (54) and PFCP session deletion response (55). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>session_deletion</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">session_establish</span> - Allow or deny PFCP session establishment request (50) and PFCP session establishment response (51). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>session_establish</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">session_modification</span> - Allow or deny PFCP session modification request (52) and PFCP session modification response (53). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>session_modification</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">session_report</span> - Allow or deny PFCP session report request (56) and PFCP session report response (57). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>session_report</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">session_set_deletion</span> - Allow or deny PFCP session set deletion request (14) and PFCP session set deletion response (15). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>session_set_deletion</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">unknown_message</span> - Allow or deny unknown messages. <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>unknown_message</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> <li> <span class="li-head">unknown_message_allow_list</span> - Allow list of unknown messages. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: unknown_message_allow_list:id</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="3">Supported Version Ranges</td> </tr> <tr> <td>unknown_message_allow_list</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Message IDs (range from 1 to 255). see <a href='#notes'>Notes</a>. <span class="li-normal">type: int</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="3">Supported Version Ranges</td> </tr> <tr> <td>id</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">version_not_support</span> - Allow or deny PFCP version not supported response (11). <span class="li-normal">type: str</span> <span class="li-normal">choices: allow, deny</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="3">Supported Version Ranges</td> </tr> <tr> <td>version_not_support</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 -> v7.2.4 </code></td> <td><code class="docutils literal notranslate">v7.4.3 -> 7.4.3 </code></td> </tr> <tr> <td>[allow]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> <tr> <td>[deny]</td> <td><code class="docutils literal notranslate">v7.0.1 -> v7.0.8</code></td> </table> </div> </li> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Message filter for PFCP messages. fortinet.fortios.fortios_pfcp_message_filter: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" pfcp_message_filter: association_release: "allow" association_setup: "allow" association_update: "allow" heartbeat: "allow" name: "default_name_7" node_report: "allow" pfd_management: "allow" session_deletion: "allow" session_establish: "allow" session_modification: "allow" session_report: "allow" session_set_deletion: "allow" unknown_message: "allow" unknown_message_allow_list: - id: "17" version_not_support: "allow"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
- This module is not guaranteed to have a backwards compatible interface.
- 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.