- source
fortios_videofilter_profile.py
- orphan
2.10
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify videofilter feature and profile 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.9.0
v7.0.0 |
v7.0.1 |
|
fortios_videofilter_profile | yes | yes |
- 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
- videofilter_profile - Configure VideoFilter profile. 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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>videofilter_profile</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">comment</span> - Comment. <span class="li-normal">type: str</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>comment</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">dailymotion</span> - Enable/disable Dailymotion video source. <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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>dailymotion</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">fortiguard_category</span> - Configure FortiGuard categories. <span class="li-normal">type: dict</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>fortiguard_category</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">filters</span> - Configure VideoFilter FortiGuard category. <span class="li-normal">type: list</span> <span style="font-family:'Courier New'" class="li-required">member_path: fortiguard_category/filters:id</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>filters</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">action</span> - VideoFilter action. <span class="li-normal">type: str</span> <span class="li-normal">choices: bypass, monitor, block, allow</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>action</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[bypass]</td> <td>yes</td> <td>no</td> </tr> <tr> <td>[monitor]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[block]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[allow]</td> <td>n/a</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">category_id</span> - Category ID. <span class="li-normal">type: int</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>category_id</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">id</span> - ID. <span class="li-normal">type: int</span> <span class="li-required">required: true</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>id</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">log</span> - Enable/disable logging. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>log</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul> <li> <span class="li-head">name</span> - Name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">replacemsg_group</span> - Replacement message group. Source system.replacemsg-group.name. <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><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>replacemsg_group</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">vimeo</span> - Enable/disable Vimeo video source. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>vimeo</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">vimeo_restrict</span> - Set Vimeo-restrict ("7" = don"t show mature content, "134" = don"t show unrated and mature content). A value of cookie "content_rating". <span class="li-normal">type: str</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>vimeo_restrict</td> <td>yes</td> <td>no</td> </tr> </table> </div> </li> <li> <span class="li-head">youtube</span> - Enable/disable YouTube video source. <span class="li-normal">type: str</span> <span class="li-normal">choices: enable, disable</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>youtube</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[enable]</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[disable]</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">youtube_channel_filter</span> - Set YouTube channel filter. Source videofilter.youtube-channel-filter.id. <span class="li-normal">type: int</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>youtube_channel_filter</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">youtube_restrict</span> - Set YouTube-restrict mode. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, strict, moderate</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><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> </tr> <tr> <td>youtube_restrict</td> <td>yes</td> <td>no</td> </tr> <tr> <td>[none]</td> <td>yes</td> <td>n/a</td> </tr> <tr> <td>[strict]</td> <td>yes</td> <td>n/a</td> </tr> <tr> <td>[moderate]</td> <td>yes</td> <td>n/a</td> </tr> </table> </div> </li> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure VideoFilter profile. fortios_videofilter_profile: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" videofilter_profile: comment: "Comment." dailymotion: "enable" fortiguard_category: filters: - action: "bypass" category_id: "8" id: "9" log: "enable" name: "default_name_11" replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)" vimeo: "enable" vimeo_restrict: "<your_own_value>" youtube: "enable" youtube_channel_filter: "16 (source videofilter.youtube-channel-filter.id)" youtube_restrict: "none"
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.