Модуль fortinet.fortios.fortios_report_layout — настройка макета отчёта в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем требуются дополнительные зависимости. Подробнее см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_report_layout.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Создается в графическом интерфейсе Fortigate.
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с указанным member_path можно использовать для операций с элементами.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
report_layout dictionary	Конфигурация макета отчета.
body_item list / elements=dictionary	Настройка элемента основного содержимого отчета.
chart string	Название диаграммы элемента отчета.
chart_options list / elements=string	Параметры диаграммы в отчете. Варианты: `"include-no-data"` `"hide-title"` `"show-caption"`
column integer	Номер столбца раздела отчета.
content string	Текстовое содержимое элемента отчета.
description string	Описание.
drill_down_items string	Управление отображением диаграмм детализации.
drill_down_types string	Управление объединением ключей родительского элемента.
hide string	Включить или отключить скрытие элемента в отчете. Варианты: `"enable"` `"disable"`
id integer / обязательный	Идентификатор элемента отчета. См. <a href=’#notes’>Примечания</a>.
img_src string	Имя файла изображения элемента отчета.
list list / elements=dictionary	Настройка элемента списка в отчете.
content string	Содержимое записи списка.
id integer / обязательный	Идентификатор записи списка. См. <a href=’#notes’>Примечания</a>.
list_component string	Компонент списка элемента отчета. Варианты: `"bullet"` `"numbered"`
misc_component string	Дополнительный компонент элемента отчета. Варианты: `"hline"` `"page-break"` `"column-break"` `"section-start"`
parameters list / elements=dictionary	Параметры.
id integer / обязательный	Идентификатор. См. <a href=’#notes’>Примечания</a>.
name string	Имя поля, соответствующего полю параметров, определенному в наборе данных.
value string	Значение для замены соответствующего поля параметров, определенного в наборе данных.
style string	Стиль элемента отчета.
table_caption_style string	Стиль заголовка таблицы диаграммы.
table_column_widths string	Ширина столбцов таблицы элемента отчета.
table_even_row_style string	Стиль четных строк таблицы диаграммы.
table_head_style string	Стиль заголовка таблицы диаграммы.
table_odd_row_style string	Стиль нечетных строк таблицы диаграммы.
text_component string	Текстовый компонент элемента отчета. Варианты: `"text"` `"heading1"` `"heading2"` `"heading3"`
title string	Заголовок раздела отчета.
top_n integer	Значение параметра top.
type string	Тип элемента отчета. Варианты: `"text"` `"image"` `"chart"` `"misc"`
cutoff_option string	Параметр времени отсечения может быть задан как время выполнения или пользовательское значение. Варианты: `"run-time"` `"custom"`
cutoff_time string	Пользовательское время отсечения для создания отчета (формат = hh:mm).
day string	Дни недели, в которые следует планировать создание отчета. Варианты: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
description string	Описание.
email_recipients string	Получатели электронной почты для созданных отчетов.
email_send string	Включить или отключить отправку писем после создания отчетов. Варианты: `"enable"` `"disable"`
format list / elements=string	Формат отчета. Варианты: `"pdf"`
max_pdf_report integer	Максимальное количество PDF-отчетов, хранящихся одновременно (самый старый отчет перезаписывается).
name string / обязательный	Имя макета отчета.
options list / elements=string	Параметры макета отчета. Варианты: `"include-table-of-content"` `"auto-numbering-heading"` `"view-chart-as-heading"` `"show-html-navbar-before-heading"` `"dummy-option"`
page dictionary	Настройка страницы отчета.
column_break_before list / elements=string	Автоматический перенос столбца на новую страницу отчета перед заголовком. Варианты: `"heading1"` `"heading2"` `"heading3"`
footer dictionary	Настройка нижнего колонтитула страницы отчета.
footer_item list / elements=dictionary	Настройка элемента нижнего колонтитула отчета.
content string	Текстовое содержимое элемента отчета.
description string	Описание.
id integer / обязательный	Идентификатор элемента отчета. См. <a href=’#notes’>Примечания</a>.
img_src string	Имя файла изображения элемента отчета.
style string	Стиль элемента отчета.
type string	Тип элемента отчета. Варианты: `"text"` `"image"`
style string	Стиль нижнего колонтитула отчета.
header dictionary	Настройка верхнего колонтитула страницы отчета.
header_item list / elements=dictionary	Настройка элемента верхнего колонтитула отчета.
content string	Текстовое содержимое элемента отчета.
description string	Описание.
id integer / обязательный	Идентификатор элемента отчета. См. <a href=’#notes’>Примечания</a>.
img_src string	Имя файла изображения элемента отчета.
style string	Стиль элемента отчета.

type string	Тип элемента отчёта. Варианты: `"text"` `"image"`
style string	Стиль заголовка отчёта.
options list / elements=string	Параметры страницы отчёта. Варианты: `"header-on-first-page"` `"footer-on-first-page"`
page_break_before list / elements=string	Автоматический разрыв страницы отчёта перед заголовком. Варианты: `"heading1"` `"heading2"` `"heading3"`
paper string	Формат бумаги страницы отчёта. Варианты: `"a4"` `"letter"`
schedule_type string	Тип расписания отчёта. Варианты: `"demand"` `"daily"` `"weekly"`
style_theme string	Тема оформления отчёта.
subtitle string	Подзаголовок отчёта.
time string	Время создания отчёта по расписанию (формат = чч:мм).
title string	Заголовок отчёта.
state string / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
vdom string	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревшая fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi
Модуль поддерживает check_mode.

Примеры

- name: Report layout configuration.
  fortinet.fortios.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: "2147483647"
                  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: "0"
                  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: "31"
          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 string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат выполнения операции Возвращается: всегда Пример: `"success"`
vdom string	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_report_layout_module.html