lix_fortinet.fortios.fortios_report_theme (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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: Report themes configuration
    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>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

report_theme:
    default: null
    description:
    - Report themes configuration
    suboptions:
      bullet_list_style:
        description:
        - Bullet list style.
        type: str
      column_count:
        choices:
        - '1'
        - '2'
        - '3'
        description:
        - Report page column count.
        type: str
      default_html_style:
        description:
        - Default HTML report style.
        type: str
      default_pdf_style:
        description:
        - Default PDF report style.
        type: str
      graph_chart_style:
        description:
        - Graph chart style.
        type: str
      heading1_style:
        description:
        - Report heading style.
        type: str
      heading2_style:
        description:
        - Report heading style.
        type: str
      heading3_style:
        description:
        - Report heading style.
        type: str
      heading4_style:
        description:
        - Report heading style.
        type: str
      hline_style:
        description:
        - Horizontal line style.
        type: str
      image_style:
        description:
        - Image style.
        type: str
      name:
        description:
        - Report theme name.
        required: true
        type: str
      normal_text_style:
        description:
        - Normal text style.
        type: str
      numbered_list_style:
        description:
        - Numbered list style.
        type: str
      page_footer_style:
        description:
        - Report page footer style.
        type: str
      page_header_style:
        description:
        - Report page header style.
        type: str
      page_orient:
        choices:
        - portrait
        - landscape
        description:
        - Report page orientation.
        type: str
      page_style:
        description:
        - Report page style.
        type: str
      report_subtitle_style:
        description:
        - Report subtitle style.
        type: str
      report_title_style:
        description:
        - Report title style.
        type: str
      table_chart_caption_style:
        description:
        - Table chart caption style.
        type: str
      table_chart_even_row_style:
        description:
        - Table chart even row style.
        type: str
      table_chart_head_style:
        description:
        - Table chart head row style.
        type: str
      table_chart_odd_row_style:
        description:
        - Table chart odd row style.
        type: str
      table_chart_style:
        description:
        - Table chart style.
        type: str
      toc_heading1_style:
        description:
        - Table of contents heading style.
        type: str
      toc_heading2_style:
        description:
        - Table of contents heading style.
        type: str
      toc_heading3_style:
        description:
        - Table of contents heading style.
        type: str
      toc_heading4_style:
        description:
        - Table of contents heading style.
        type: str
      toc_title_style:
        description:
        - Table of contents title style.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str