Spec-Zone.ru › Ansible 2.11

fortinet.fortios.fortios_report_layout – Настройка макета отчетов в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в playbook, укажите: fortinet.fortios.fortios_report_layout.

Введено в версии 2.8: модуля fortinet.fortios

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять категории макета и функций отчетов. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0.

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерирован из GUI Fortigate.
report_layout
словарь
Настройка макета отчета.
body_item
список / элементы=строка
Настройка элемента тела отчета.
chart
строка
Имя диаграммы элемента отчета.
chart_options
строка
    Варианты:
  • include-no-data
  • hide-title
  • show-caption
Параметры диаграммы отчета.
column
целое число
Номер колонки раздела отчета.
content
строка
Текстовое содержимое элемента отчета.
description
строка
Описание.
drill_down_items
строка
Управление отображением диаграмм с детализацией.
drill_down_types
строка
Управление объединением ключей родительского элемента.
hide
строка
    Варианты:
  • enable
  • disable
Включить/выключить скрытие элемента в отчете.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
list
список / элементы=строка
Настройка элемента списка отчета.
content
строка
Содержимое записи списка.
id
целое число / обязательно
Идентификатор записи списка.
list_component
строка
    Варианты:
  • bullet
  • numbered
Компонент списка элемента отчета.
misc_component
строка
    Варианты:
  • hline
  • page-break
  • column-break
  • section-start
Разнообразный компонент элемента отчета.
parameters
список / элементы=строка
Параметры.
id
целое число / обязательно
Идентификатор.
name
строка
Имя поля, соответствующее полю параметров, определенных в наборе данных.
value
строка
Значение для замены соответствующего поля параметров, определенных в наборе данных.
style
строка
Стиль элемента отчета.
table_caption_style
строка
Стиль заголовка таблицы диаграммы.
table_column_widths
строка
Ширина колонок таблицы элемента отчета.
table_even_row_style
строка
Стиль четных строк таблицы диаграммы.
table_head_style
строка
Стиль заголовка таблицы диаграммы.
table_odd_row_style
строка
Стиль нечетных строк таблицы диаграммы.
text_component
строка
    Варианты:
  • текст
  • заголовок1
  • заголовок2
  • заголовок3
Компонент текста элемента отчета.
title
строка
Заголовок раздела отчета.
top_n
целое число
Значение верхнего предела.
type
строка
    Варианты:
  • текст
  • изображение
  • диаграмма
  • разное
Тип элемента отчета.
cutoff_option
строка
    Варианты:
  • run-time
  • custom
Параметр cutoff — либо run-time, либо custom.
cutoff_time
строка
Пользовательское время окончания для генерации отчета [чч:мм].
day
строка
    Варианты:
  • воскресенье
  • понедельник
  • вторник
  • среда
  • четверг
  • пятница
  • суббота
Дни недели для планирования генерации отчета.
description
строка
Описание.
email_recipients
строка
Получатели электронной почты для сгенерированных отчетов.
email_send
строка
    Варианты:
  • enable
  • disable
Включить/выключить отправку электронных писем после генерации отчетов.
format
строка
    Варианты:
  • pdf
Формат отчета.
max_pdf_report
целое число
Максимальное количество PDF-отчетов для хранения одновременно (старейший отчет перезаписывается).
name
строка / обязательно
Имя макета отчета.
options
строка
    Варианты:
  • include-table-of-content
  • auto-numbering-heading
  • view-chart-as-heading
  • show-html-navbar-before-heading
  • dummy-option
Параметры макета отчета.
page
словарь
Настройка страницы отчета.
column_break_before
строка
    Варианты:
  • заголовок1
  • заголовок2
  • заголовок3
Автоматическое разбиение колонок страницы отчета перед заголовком.
footer
словарь
Настройка подвала страницы отчета.
footer_item
список / элементы=строка
Настройка элемента подвала отчета.
content
строка
Текстовое содержимое элемента отчета.
description
строка
Описание.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
style
строка
Стиль элемента отчета.
type
строка
    Варианты:
  • текст
  • изображение
Тип элемента отчета.
style
строка
Стиль подвала отчета.
header
словарь
Настройка заголовка страницы отчета.
header_item
список / элементы=строка
Настройка элемента заголовка отчета.
content
строка
Текстовое содержимое элемента отчета.
description
строка
Описание.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
style
строка
Стиль элемента отчета.
type
строка
    Варианты:
  • текст
  • изображение
Тип элемента отчета.
style
строка
Стиль заголовка отчета.
options
строка
    Варианты:
  • header-on-first-page
  • footer-on-first-page
Параметры страницы отчета.
page_break_before
строка
    Варианты:
  • heading1
  • heading2
  • heading3
Автоматический разрыв страницы отчета перед заголовком.
paper
строка
    Варианты:
  • a4
  • letter
Бумага страницы отчета.
schedule_type
строка
    Варианты:
  • по запросу
  • ежедневно
  • еженедельно
Тип планирования отчета.
state
строка
    Варианты:
  • текущий
  • отсутствует
Устаревшее
Начиная с Ansible 2.9, рекомендуем использовать параметр "state" на верхнем уровне.
Указывает, следует ли создать или удалить объект.
style_theme
строка
Тема стиля отчета.
subtitle
строка
Подзаголовок отчета.
time
строка
Время планирования создания отчета [чч:мм].
title
строка
Название отчета.
state
строка
добавлен в 2.9 fortios
    Варианты:
  • текущий
  • отсутствует
Указывает, следует ли создать или удалить объект. Этот атрибут уже был на предыдущих версиях на более глубоком уровне. Он был перемещен на внешний уровень.
vdom
строка
По умолчанию:
"корневой"
Виртуальный домен, среди тех, которые были определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельную единицу.

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- 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>"

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое значение Описание
build
строка
всегда
Номер сборки изображения fortigate

Пример:
1547
http_method
строка
всегда
Последний метод, использованный для размещения содержимого в FortiGate

Пример:
PUT
http_status
строка
всегда
Последний результат, предоставленный FortiGate после последней операции

Пример:
200
mkey
строка
успех
Главный ключ (id), использованный в последнем вызове FortiGate

Пример:
id
name
строка
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
path
строка
всегда
Путь таблицы, используемой для выполнения запроса

Пример:
webfilter
revision
строка
всегда
Внутренний номер пересмотра

Пример:
17.0.2.10658
serial
строка
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
строка
всегда
Указание результата операции

Пример:
успех
vdom
строка
всегда
Используемый виртуальный домен

Пример:
корневой
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Авторы

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_report_layout_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API