- source
fortios_report_theme.py
- orphan
2.0.0
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and theme 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: v6.0.0 -> v6.4.4
- 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
- report_theme - Report themes configuration 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>report_theme</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">bullet_list_style</span> - Bullet list style. <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 colspan="1">Supported Version Ranges</td> </tr> <tr> <td>bullet_list_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">column_count</span> - Report page column count. <span class="li-normal">type: str</span> <span class="li-normal">choices: 1, 2, 3</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>column_count</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[1]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[2]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[3]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">default_html_style</span> - Default HTML report style. <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="1">Supported Version Ranges</td> </tr> <tr> <td>default_html_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">default_pdf_style</span> - Default PDF report style. <span class="li-normal">type: str</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>default_pdf_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">graph_chart_style</span> - Graph chart style. <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>graph_chart_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">heading1_style</span> - Report heading style. <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>heading1_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">heading2_style</span> - Report heading style. <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>heading2_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">heading3_style</span> - Report heading style. <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>heading3_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">heading4_style</span> - Report heading style. <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="1">Supported Version Ranges</td> </tr> <tr> <td>heading4_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">hline_style</span> - Horizontal line style. <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>hline_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">image_style</span> - Image style. <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="1">Supported Version Ranges</td> </tr> <tr> <td>image_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Report theme name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>name</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">normal_text_style</span> - Normal text style. <span class="li-normal">type: str</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>normal_text_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">numbered_list_style</span> - Numbered list style. <span class="li-normal">type: str</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>numbered_list_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">page_footer_style</span> - Report page footer style. <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="1">Supported Version Ranges</td> </tr> <tr> <td>page_footer_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">page_header_style</span> - Report page header style. <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="1">Supported Version Ranges</td> </tr> <tr> <td>page_header_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">page_orient</span> - Report page orientation. <span class="li-normal">type: str</span> <span class="li-normal">choices: portrait, landscape</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>page_orient</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[portrait]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[landscape]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">page_style</span> - Report page style. <span class="li-normal">type: str</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>page_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">report_subtitle_style</span> - Report subtitle style. <span class="li-normal">type: str</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>report_subtitle_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">report_title_style</span> - Report title style. <span class="li-normal">type: str</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>report_title_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">table_chart_caption_style</span> - Table chart caption style. <span class="li-normal">type: str</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>table_chart_caption_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">table_chart_even_row_style</span> - Table chart even row style. <span class="li-normal">type: str</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>table_chart_even_row_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">table_chart_head_style</span> - Table chart head row style. <span class="li-normal">type: str</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>table_chart_head_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">table_chart_odd_row_style</span> - Table chart odd row style. <span class="li-normal">type: str</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>table_chart_odd_row_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">table_chart_style</span> - Table chart style. <span class="li-normal">type: str</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>table_chart_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">toc_heading1_style</span> - Table of contents heading style. <span class="li-normal">type: str</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="1">Supported Version Ranges</td> </tr> <tr> <td>toc_heading1_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">toc_heading2_style</span> - Table of contents heading style. <span class="li-normal">type: str</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>toc_heading2_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">toc_heading3_style</span> - Table of contents heading style. <span class="li-normal">type: str</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>toc_heading3_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">toc_heading4_style</span> - Table of contents heading style. <span class="li-normal">type: str</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>toc_heading4_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">toc_title_style</span> - Table of contents title style. <span class="li-normal">type: str</span> <a id='label60' href="javascript:ContentClick('label61', 'label60');" onmouseover="ContentPreview('label61');" onmouseout="ContentUnpreview('label61');" title="click to collapse or expand..."> more... </a> <div id="label61" style="display:none"> <table border="1"> <tr> <td></td> <td colspan="1">Supported Version Ranges</td> </tr> <tr> <td>toc_title_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> </ul> </ul>
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Report themes configuration fortinet.fortios.fortios_report_theme: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" report_theme: bullet_list_style: "<your_own_value>" column_count: "1" default_html_style: "<your_own_value>" default_pdf_style: "<your_own_value>" graph_chart_style: "<your_own_value>" heading1_style: "<your_own_value>" heading2_style: "<your_own_value>" heading3_style: "<your_own_value>" heading4_style: "<your_own_value>" hline_style: "<your_own_value>" image_style: "<your_own_value>" name: "default_name_14" normal_text_style: "<your_own_value>" numbered_list_style: "<your_own_value>" page_footer_style: "<your_own_value>" page_header_style: "<your_own_value>" page_orient: "portrait" page_style: "<your_own_value>" report_subtitle_style: "<your_own_value>" report_title_style: "<your_own_value>" table_chart_caption_style: "<your_own_value>" table_chart_even_row_style: "<your_own_value>" table_chart_head_style: "<your_own_value>" table_chart_odd_row_style: "<your_own_value>" table_chart_style: "<your_own_value>" toc_heading1_style: "<your_own_value>" toc_heading2_style: "<your_own_value>" toc_heading3_style: "<your_own_value>" toc_heading4_style: "<your_own_value>" toc_title_style: "<your_own_value>"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.