fmgd_report_layout – Report layout configuration.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • report_layout - Report layout configuration. type: dict
    • body_item (Alias name: body-item) Body item. type: list more...
      • chart Report item chart name. type: list more...
      • chart_options (Alias name: chart-options) Report chart options. type: list choices: [include-no-data, hide-title, show-caption] more...
      • content Report item text content. type: str more...
      • description Description. type: str more...
      • id Report item id. type: int more...
      • img_src (Alias name: img-src) Report item image file name. type: str more...
      • misc_component (Alias name: misc-component) Report item miscellaneous component. type: str choices: [hline, page-break, column-break, section-start] more...
      • parameters Parameters. type: list more...
        • id Id. type: int more...
        • name Field name that match field of parameters defined in dataset. type: str more...
        • value Value to replace corresponding field of parameters defined in dataset. type: str more...
      • style Report item style. type: list more...
      • text_component (Alias name: text-component) Report item text component. type: str choices: [text, heading1, heading2, heading3] more...
      • title Report section title. type: str more...
      • top_n (Alias name: top-n) Value of top. type: int more...
      • type Report item type. type: str choices: [text, image, chart, misc] more...
      • table_caption_style (Alias name: table-caption-style) Table chart caption style. type: list more...
      • list List. type: list more...
        • content List entry content. type: str more...
        • id List entry id. type: int more...
      • table_column_widths (Alias name: table-column-widths) Report item table column widths. type: str more...
      • table_odd_row_style (Alias name: table-odd-row-style) Table chart odd row style. type: list more...
      • table_even_row_style (Alias name: table-even-row-style) Table chart even row style. type: list more...
      • column Report section column number. type: int more...
      • drill_down_types (Alias name: drill-down-types) Control whether keys from the parent being combined or not. type: str more...
      • list_component (Alias name: list-component) Report item list component. type: str choices: [bullet, numbered] more...
      • hide Enable/disable hide item in report. type: str choices: [disable, enable] more...
      • drill_down_items (Alias name: drill-down-items) Control how drill down charts are shown. type: str more...
      • table_head_style (Alias name: table-head-style) Table chart head style. type: list more...
    • cutoff_option (Alias name: cutoff-option) Cutoff-option is either run-time or custom. type: str choices: [run-time, custom] more...
    • cutoff_time (Alias name: cutoff-time) Custom cutoff time to generate report (format = hh:mm). type: str more...
    • day Schedule days of week to generate report. type: str choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
    • description Description. type: str more...
    • email_recipients (Alias name: email-recipients) Email recipients for generated reports. type: str more...
    • email_send (Alias name: email-send) Enable/disable sending emails after reports are generated. type: str choices: [disable, enable] more...
    • format Report format. type: list choices: [html, pdf] more...
    • max_pdf_report (Alias name: max-pdf-report) Maximum number of pdf reports to keep at one time (oldest report is overwritten). type: int more...
    • name Report layout name. type: str more...
    • options Report layout options. type: list choices: [include-table-of-content, auto-numbering-heading, view-chart-as-heading, show-html-navbar-before-heading, dummy-option] more...
    • page Page. type: dict more...
      • column_break_before (Alias name: column-break-before) Report page auto column break before heading. type: list choices: [heading1, heading2, heading3] more...
      • footer Footer. type: dict more...
        • footer_item (Alias name: footer-item) Footer item. type: list more...
          • content Report item text content. type: str more...
          • description Description. type: str more...
          • id Report item id. type: int more...
          • img_src (Alias name: img-src) Report item image file name. type: str more...
          • style Report item style. type: list more...
          • type Report item type. type: str choices: [text, image] more...
        • style Report footer style. type: list more...
      • header Header. type: dict more...
        • header_item (Alias name: header-item) Header item. type: list more...
          • content Report item text content. type: str more...
          • description Description. type: str more...
          • id Report item id. type: int more...
          • img_src (Alias name: img-src) Report item image file name. type: str more...
          • style Report item style. type: list more...
          • type Report item type. type: str choices: [text, image] more...
        • style Report header style. type: list more...
      • options Report page options. type: list choices: [header-on-first-page, footer-on-first-page] more...
      • page_break_before (Alias name: page-break-before) Report page auto page break before heading. type: list choices: [heading1, heading2, heading3] more...
      • paper Report page paper. type: str choices: [a4, letter] more...
    • schedule_type (Alias name: schedule-type) Report schedule type. type: str choices: [daily, weekly, once, demand] more...
    • style_theme (Alias name: style-theme) Report style theme. type: str more...
    • subtitle Report subtitle. type: str more...
    • time Schedule time to generate report (format = hh:mm). type: str more...
    • title Report title. type: str more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Report layout configuration.
      fortinet.fmgdevice.fmgd_report_layout:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        report_layout:
          name: "your value" # Required variable, string
          # body_item:
          #   - chart: <list or string>
          #     chart_options:
          #       - "include-no-data"
          #       - "hide-title"
          #       - "show-caption"
          #     content: <string>
          #     description: <string>
          #     id: <integer>
          #     img_src: <string>
          #     misc_component: <value in [hline, page-break, column-break, ...]>
          #     parameters:
          #       - id: <integer>
          #         name: <string>
          #         value: <string>
          #     style: <list or string>
          #     text_component: <value in [text, heading1, heading2, ...]>
          #     title: <string>
          #     top_n: <integer>
          #     type: <value in [text, image, chart, ...]>
          #     table_caption_style: <list or string>
          #     list:
          #       - content: <string>
          #         id: <integer>
          #     table_column_widths: <string>
          #     table_odd_row_style: <list or string>
          #     table_even_row_style: <list or string>
          #     column: <integer>
          #     drill_down_types: <string>
          #     list_component: <value in [bullet, numbered]>
          #     hide: <value in [disable, enable]>
          #     drill_down_items: <string>
          #     table_head_style: <list or string>
          # cutoff_option: <value in [run-time, custom]>
          # cutoff_time: <string>
          # day: <value in [sunday, monday, tuesday, ...]>
          # description: <string>
          # email_recipients: <string>
          # email_send: <value in [disable, enable]>
          # format:
          #   - "html"
          #   - "pdf"
          # max_pdf_report: <integer>
          # options:
          #   - "include-table-of-content"
          #   - "auto-numbering-heading"
          #   - "view-chart-as-heading"
          #   - "show-html-navbar-before-heading"
          #   - "dummy-option"
          # page:
          #   column_break_before:
          #     - "heading1"
          #     - "heading2"
          #     - "heading3"
          #   footer:
          #     footer_item:
          #       - content: <string>
          #         description: <string>
          #         id: <integer>
          #         img_src: <string>
          #         style: <list or string>
          #         type: <value in [text, image]>
          #     style: <list or string>
          #   header:
          #     header_item:
          #       - content: <string>
          #         description: <string>
          #         id: <integer>
          #         img_src: <string>
          #         style: <list or string>
          #         type: <value in [text, image]>
          #     style: <list or string>
          #   options:
          #     - "header-on-first-page"
          #     - "footer-on-first-page"
          #   page_break_before:
          #     - "heading1"
          #     - "heading2"
          #     - "heading3"
          #   paper: <value in [a4, letter]>
          # schedule_type: <value in [daily, weekly, once, ...]>
          # style_theme: <string>
          # subtitle: <string>
          # time: <string>
          # title: <string>

Return Values

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)