fortinet.fortios.fortios_report_layout – Report layout configuration in Fortinet’s FortiOS and FortiGate.¶

Note

This plugin is part of the fortinet.fortios collection (version 1.1.9).

To install it use: ansible-galaxy collection install fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_report_layout.

New in version 2.8: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and layout category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

Parameters ¶

Parameter					Choices/Defaults	Comments
access_token string						Token-based authentication. Generated from GUI of Fortigate.
report_layout dictionary						Report layout configuration.
	body_item list / elements=string					Configure report body item.
		chart string				Report item chart name.
		chart_options string			Choices: include-no-data hide-title show-caption	Report chart options.
		column integer				Report section column number.
		content string				Report item text content.
		description string				Description.
		drill_down_items string				Control how drill down charts are shown.
		drill_down_types string				Control whether keys from the parent being combined or not.
		hide string			Choices: enable disable	Enable/disable hide item in report.
		id integer / required				Report item ID.
		img_src string				Report item image file name.
		list list / elements=string				Configure report list item.
			content string			List entry content.
			id integer / required			List entry ID.
		list_component string			Choices: bullet numbered	Report item list component.
		misc_component string			Choices: hline page-break column-break section-start	Report item miscellaneous component.
		parameters list / elements=string				Parameters.
			id integer / required			ID.
			name string			Field name that match field of parameters defined in dataset.
			value string			Value to replace corresponding field of parameters defined in dataset.
		style string				Report item style.
		table_caption_style string				Table chart caption style.
		table_column_widths string				Report item table column widths.
		table_even_row_style string				Table chart even row style.
		table_head_style string				Table chart head style.
		table_odd_row_style string				Table chart odd row style.
		text_component string			Choices: text heading1 heading2 heading3	Report item text component.
		title string				Report section title.
		top_n integer				Value of top.
		type string			Choices: text image chart misc	Report item type.
	cutoff_option string				Choices: run-time custom	Cutoff-option is either run-time or custom.
	cutoff_time string					Custom cutoff time to generate report [hh:mm].
	day string				Choices: sunday monday tuesday wednesday thursday friday saturday	Schedule days of week to generate report.
	description string					Description.
	email_recipients string					Email recipients for generated reports.
	email_send string				Choices: enable disable	Enable/disable sending emails after reports are generated.
	format string				Choices: pdf	Report format.
	max_pdf_report integer					Maximum number of PDF reports to keep at one time (oldest report is overwritten).
	name string / required					Report layout name.
	options string				Choices: include-table-of-content auto-numbering-heading view-chart-as-heading show-html-navbar-before-heading dummy-option	Report layout options.
	page dictionary					Configure report page.
		column_break_before string			Choices: heading1 heading2 heading3	Report page auto column break before heading.
		footer dictionary				Configure report page footer.
			footer_item list / elements=string			Configure report footer item.
				content string		Report item text content.
				description string		Description.
				id integer / required		Report item ID.
				img_src string		Report item image file name.
				style string		Report item style.
				type string	Choices: text image	Report item type.
			style string			Report footer style.
		header dictionary				Configure report page header.
			header_item list / elements=string			Configure report header item.
				content string		Report item text content.
				description string		Description.
				id integer / required		Report item ID.
				img_src string		Report item image file name.
				style string		Report item style.
				type string	Choices: text image	Report item type.
			style string			Report header style.
		options string			Choices: header-on-first-page footer-on-first-page	Report page options.
		page_break_before string			Choices: heading1 heading2 heading3	Report page auto page break before heading.
		paper string			Choices: a4 letter	Report page paper.
	schedule_type string				Choices: demand daily weekly	Report schedule type.
	state string				Choices: present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	style_theme string					Report style theme.
	subtitle string					Report subtitle.
	time string					Schedule time to generate report [hh:mm].
	title string					Report title.
state string added in 2.9 of fortinet.fortios					Choices: present absent	Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level.
vdom string					Default: "root"	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.

Notes ¶

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples ¶

- 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 layout configuration.
    fortios_report_layout:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      report_layout:
        body_item:
         -
            chart: "<your_own_value>"
            chart_options: "include-no-data"
            column: "6"
            content: "<your_own_value>"
            description: "<your_own_value>"
            drill_down_items: "<your_own_value>"
            drill_down_types: "<your_own_value>"
            hide: "enable"
            id:  "12"
            img_src: "<your_own_value>"
            list:
             -
                content: "<your_own_value>"
                id:  "16"
            list_component: "bullet"
            misc_component: "hline"
            parameters:
             -
                id:  "20"
                name: "default_name_21"
                value: "<your_own_value>"
            style: "<your_own_value>"
            table_caption_style: "<your_own_value>"
            table_column_widths: "<your_own_value>"
            table_even_row_style: "<your_own_value>"
            table_head_style: "<your_own_value>"
            table_odd_row_style: "<your_own_value>"
            text_component: "text"
            title: "<your_own_value>"
            top_n: "31"
            type: "text"
        cutoff_option: "run-time"
        cutoff_time: "<your_own_value>"
        day: "sunday"
        description: "<your_own_value>"
        email_recipients: "<your_own_value>"
        email_send: "enable"
        format: "pdf"
        max_pdf_report: "40"
        name: "default_name_41"
        options: "include-table-of-content"
        page:
            column_break_before: "heading1"
            footer:
                footer_item:
                 -
                    content: "<your_own_value>"
                    description: "<your_own_value>"
                    id:  "49"
                    img_src: "<your_own_value>"
                    style: "<your_own_value>"
                    type: "text"
                style: "<your_own_value>"
            header:
                header_item:
                 -
                    content: "<your_own_value>"
                    description: "<your_own_value>"
                    id:  "58"
                    img_src: "<your_own_value>"
                    style: "<your_own_value>"
                    type: "text"
                style: "<your_own_value>"
            options: "header-on-first-page"
            page_break_before: "heading1"
            paper: "a4"
        schedule_type: "demand"
        style_theme: "<your_own_value>"
        subtitle: "<your_own_value>"
        time: "<your_own_value>"
        title: "<your_own_value>"

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

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

Authors¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

fortinet.fortios.fortios_report_layout – Report layout configuration in Fortinet’s FortiOS and FortiGate.¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶