- source
fortios_report_style.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 style 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_style - Report style 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_style</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">align</span> - Alignment. <span class="li-normal">type: str</span> <span class="li-normal">choices: left, center, right, justify</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>align</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[left]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[center]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[right]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[justify]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">bg_color</span> - Background color. <span class="li-normal">type: str</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>bg_color</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">border_bottom</span> - Border bottom. <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>border_bottom</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">border_left</span> - Border left. <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>border_left</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">border_right</span> - Border right. <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>border_right</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">border_top</span> - Border top. <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>border_top</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_gap</span> - Column gap. <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>column_gap</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_span</span> - Column span. <span class="li-normal">type: str</span> <span class="li-normal">choices: none, all</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>column_span</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[none]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[all]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">fg_color</span> - Foreground color. <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>fg_color</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">font_family</span> - Font family. <span class="li-normal">type: str</span> <span class="li-normal">choices: Verdana, Arial, Helvetica, Courier, Times</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>font_family</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[Verdana]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[Arial]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[Helvetica]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[Courier]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[Times]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">font_size</span> - Font size. <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>font_size</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">font_style</span> - Font style. <span class="li-normal">type: str</span> <span class="li-normal">choices: normal, italic</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>font_style</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[normal]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[italic]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">font_weight</span> - Font weight. <span class="li-normal">type: str</span> <span class="li-normal">choices: normal, bold</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>font_weight</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[normal]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[bold]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">height</span> - Height. <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>height</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">line_height</span> - Text line height. <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>line_height</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">margin_bottom</span> - Margin bottom. <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>margin_bottom</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">margin_left</span> - Margin left. <span class="li-normal">type: str</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>margin_left</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">margin_right</span> - Margin right. <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>margin_right</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">margin_top</span> - Margin top. <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>margin_top</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 style name. <span class="li-normal">type: str</span> <span class="li-required">required: true</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>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">options</span> - Report style options. <span class="li-normal">type: list</span> <span class="li-normal">choices: font, text, color, align, size, margin, border, padding, column</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>options</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> <tr> <td>[font]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[text]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[color]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[align]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[size]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[margin]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[border]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[padding]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> <tr> <td>[column]</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4</code></td> </table> </div> </li> <li> <span class="li-head">padding_bottom</span> - Padding bottom. <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>padding_bottom</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">padding_left</span> - Padding left. <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>padding_left</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">padding_right</span> - Padding right. <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>padding_right</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">padding_top</span> - Padding top. <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>padding_top</td> <td><code class="docutils literal notranslate">v6.0.0 -> v6.4.4 </code></td> </tr> </table> </div> </li> <li> <span class="li-head">width</span> - Width. <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>width</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 style configuration. fortinet.fortios.fortios_report_style: vdom: "{{ vdom }}" state: "present" access_token: "<your_own_value>" report_style: align: "left" bg_color: "<your_own_value>" border_bottom: "<your_own_value>" border_left: "<your_own_value>" border_right: "<your_own_value>" border_top: "<your_own_value>" column_gap: "<your_own_value>" column_span: "none" fg_color: "<your_own_value>" font_family: "Verdana" font_size: "<your_own_value>" font_style: "normal" font_weight: "normal" height: "<your_own_value>" line_height: "<your_own_value>" margin_bottom: "<your_own_value>" margin_left: "<your_own_value>" margin_right: "<your_own_value>" margin_top: "<your_own_value>" name: "default_name_22" options: "font" padding_bottom: "<your_own_value>" padding_left: "<your_own_value>" padding_right: "<your_own_value>" padding_top: "<your_own_value>" width: "<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.