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

Примечание

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

Эта коллекция, возможно, уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token string	Токенная аутентификация. Создается в графическом интерфейсе Fortigate.
enable_log boolean	Включить/Выключить логирование для задачи. Варианты: `false` ← (default) `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 / required	ID элемента отчета. Смотрите <a href=’#notes’>Примечания</a>.
img_src string	Имя файла изображения элемента отчета.
list list / elements=dictionary	Настройка элемента списка отчета.
content string	Содержимое записи списка.
id integer / required	ID записи списка. Смотрите <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 / required	ID. Смотрите <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	Значение верхнего.
type string	Тип элемента отчёта. Варианты: `"text"` `"image"` `"chart"` `"misc"`
cutoff_option string	Параметр отсечения — либо выполнение во время выполнения, либо настраиваемый. Варианты: `"run-time"` `"custom"`
cutoff_time string	Настраиваемое время отсечения для генерации отчёта (формат = чч:мм).
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 / required	Идентификатор элемента отчета. См. <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 / required	Идентификатор элемента отчета. См. <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), определённая ранее. Vdom — это виртуальная инстанция FortiGate, которая может быть настроена и использоваться как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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