fortios_report_layout – Report layout configuration in Fortinet’s FortiOS and FortiGate

From Get docs
Ansible/docs/2.8/modules/fortios report layout module


fortios_report_layout – Report layout configuration in Fortinet’s FortiOS and FortiGate

New in version 2.8.


Synopsis

  • This module is able to configure a FortiGate or FortiOS 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.2

Requirements

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

  • fortiosapi>=0.9.8

Parameters

Parameter Choices/Defaults Comments

host

- / required

FortiOS or FortiGate ip address.

https

boolean

  • no
  • yes

Indicates if the requests towards FortiGate must use HTTPS protocol

password

-

Default:

""

FortiOS or FortiGate password.

report_layout

-

Default:

null

Report layout configuration.

body-item

-

Configure report body item.

chart

-

Report item chart name.

chart-options

-

  • include-no-data
  • hide-title
  • show-caption

Report chart options.

column

-

Report section column number.

content

-

Report item text content.

description

-

Description.

drill-down-items

-

Control how drill down charts are shown.

drill-down-types

-

Control whether keys from the parent being combined or not.

hide

-

  • enable
  • disable

Enable/disable hide item in report.

id

- / required

Report item ID.

img-src

-

Report item image file name.

list

-

Configure report list item.

content

-

List entry content.

id

- / required

List entry ID.

list-component

-

  • bullet
  • numbered

Report item list component.

misc-component

-

  • hline
  • page-break
  • column-break
  • section-start

Report item miscellaneous component.

parameters

-

Parameters.

id

- / required

ID.

name

-

Field name that match field of parameters defined in dataset.

value

-

Value to replace corresponding field of parameters defined in dataset.

style

-

Report item style.

table-caption-style

-

Table chart caption style.

table-column-widths

-

Report item table column widths.

table-even-row-style

-

Table chart even row style.

table-head-style

-

Table chart head style.

table-odd-row-style

-

Table chart odd row style.

text-component

-

  • text
  • heading1
  • heading2
  • heading3

Report item text component.

title

-

Report section title.

top-n

-

Value of top.

type

-

  • text
  • image
  • chart
  • misc

Report item type.

cutoff-option

-

  • run-time
  • custom

Cutoff-option is either run-time or custom.

cutoff-time

-

Custom cutoff time to generate report [hh:mm].

day

-

  • sunday
  • monday
  • tuesday
  • wednesday
  • thursday
  • friday
  • saturday

Schedule days of week to generate report.

description

-

Description.

email-recipients

-

Email recipients for generated reports.

email-send

-

  • enable
  • disable

Enable/disable sending emails after reports are generated.

format

-

  • pdf

Report format.

max-pdf-report

-

Maximum number of PDF reports to keep at one time (oldest report is overwritten).

name

- / required

Report layout name.

options

-

  • include-table-of-content
  • auto-numbering-heading
  • view-chart-as-heading
  • show-html-navbar-before-heading
  • dummy-option

Report layout options.

page

-

Configure report page.

column-break-before

-

  • heading1
  • heading2
  • heading3

Report page auto column break before heading.

footer

-

Configure report page footer.

footer-item

-

Configure report footer item.

content

-

Report item text content.

description

-

Description.

id

- / required

Report item ID.

img-src

-

Report item image file name.

style

-

Report item style.

type

-

  • text
  • image

Report item type.

style

-

Report footer style.

header

-

Configure report page header.

header-item

-

Configure report header item.

content

-

Report item text content.

description

-

Description.

id

- / required

Report item ID.

img-src

-

Report item image file name.

style

-

Report item style.

type

-

  • text
  • image

Report item type.

style

-

Report header style.

options

-

  • header-on-first-page
  • footer-on-first-page

Report page options.

page-break-before

-

  • heading1
  • heading2
  • heading3

Report page auto page break before heading.

paper

-

  • a4
  • letter

Report page paper.

schedule-type

-

  • demand
  • daily
  • weekly

Report schedule type.

state

-

  • present
  • absent

Indicates whether to create or remove the object

style-theme

-

Report style theme.

subtitle

-

Report subtitle.

time

-

Schedule time to generate report [hh:mm].

title

-

Report title.

username

- / required

FortiOS or FortiGate username.

vdom

-

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

  • Requires fortiosapi library developed by Fortinet
  • Run as a local_action in your playbook


Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Report layout configuration.
    fortios_report_layout:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      report_layout:
        state: "present"
        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




Status

Authors

  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_report_layout_module.html