fortios_report_layout – Конфигурация макета отчетов в Fortinet’s FortiOS и FortiGate
Новая версия с 2.8.
Обзор
- Этот модуль позволяет настраивать FortiGate или FortiOS, позволяя пользователю задавать и изменять параметры и макет категории отчетов. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.2
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||||
|---|---|---|---|---|---|---|
| host - / обязательно | IP-адрес FortiOS или FortiGate. | |||||
| https boolean |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | ||||
| password - | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | ||||
| report_layout - | Значение по умолчанию: null | Настройка макета отчета. | ||||
| body-item - | Настройка элемента тела отчета. | |||||
| chart - | Имя диаграммы элемента отчета. | |||||
| chart-options - |
| Параметры диаграммы отчета. | ||||
| column - | Номер столбца раздела отчета. | |||||
| content - | Текстовое содержимое элемента отчета. | |||||
| description - | Описание. | |||||
| drill-down-items - | Управление отображением диаграмм с детализацией. | |||||
| drill-down-types - | Управление объединением ключей из родительского элемента. | |||||
| hide - |
| Включить/выключить скрытие элемента в отчете. | ||||
| id - / обязательно | Идентификатор элемента отчета. | |||||
| img-src - | Имя файла изображения элемента отчета. | |||||
| list - | Настройка элемента списка отчета. | |||||
| content - | Содержимое записи списка. | |||||
| id - / обязательно | Идентификатор записи списка. | |||||
| list-component - |
| Компонент списка элемента отчета. | ||||
| misc-component - |
| Разнообразный компонент элемента отчета. | ||||
| parameters - | Параметры. | |||||
| id - / обязательно | Идентификатор. | |||||
| name - | Имя поля, которое соответствует полю параметров, определенному в наборе данных. | |||||
| value - | Значение для замены соответствующего поля параметров, определенного в наборе данных. | |||||
| style - | Стиль элемента отчета. | |||||
| table-caption-style - | Стиль заголовка таблицы диаграммы. | |||||
| table-column-widths - | Ширина столбцов таблицы элемента отчета. | |||||
| table-even-row-style - | Стиль четных строк таблицы диаграммы. | |||||
| table-head-style - | Стиль заголовка таблицы диаграммы. | |||||
| table-odd-row-style - | Стиль нечетных строк таблицы диаграммы. | |||||
| text-component - |
| Компонент текста элемента отчета. | ||||
| title - | Заголовок раздела отчета. | |||||
| top-n - | Значение top. | |||||
| type - |
| Тип элемента отчета. | ||||
| cutoff-option - |
| Параметр cutoff может быть run-time или custom. | ||||
| cutoff-time - | Пользовательское время обрезки для генерации отчета [чч:мм]. | |||||
| day - |
| Дни недели для планирования генерации отчета. | ||||
| description - | Описание. | |||||
| email-recipients - | Получатели электронной почты для сгенерированных отчетов. | |||||
| email-send - |
| Включить/выключить отправку электронных писем после генерации отчетов. | ||||
| формат - |
| Формат отчета. | ||||
| max-pdf-report - | Максимальное количество PDF-отчетов, которые следует хранить одновременно (старейший отчет перезаписывается). | |||||
| название - / обязательно | Имя макета отчета. | |||||
| параметры - |
| Параметры макета отчета. | ||||
| страница - | Настройка страницы отчета. | |||||
| разрыв-колонки-перед - |
| Автоматический разрыв колонки на странице отчета перед заголовком. | ||||
| подвал - | Настройка подвала страницы отчета. | |||||
| элемент-подвала - | Настройка элемента подвала отчета. | |||||
| содержимое - | Текстовое содержимое элемента отчета. | |||||
| описание - | Описание. | |||||
| id - / обязательно | Идентификатор элемента отчета. | |||||
| img-src - | Имя файла изображения элемента отчета. | |||||
| стиль - | Стиль элемента отчета. | |||||
| тип - |
| Тип элемента отчета. | ||||
| стиль - | Стиль подвала отчета. | |||||
| заголовок - | Настройка заголовка страницы отчета. | |||||
| элемент-заголовка - | Настройка элемента заголовка отчета. | |||||
| содержимое - | Текстовое содержимое элемента отчета. | |||||
| описание - | Описание. | |||||
| id - / обязательно | Идентификатор элемента отчета. | |||||
| img-src - | Имя файла изображения элемента отчета. | |||||
| стиль - | Стиль элемента отчета. | |||||
| тип - |
| Тип элемента отчета. | ||||
| стиль - | Стиль заголовка отчета. | |||||
| параметры - |
| Параметры страницы отчета. | ||||
| разрыв-страниц-перед - |
| Автоматический разрыв страницы отчета перед заголовком. | ||||
| бумага - |
| Бумага для страницы отчета. | ||||
| тип-расписания - |
| Тип расписания отчета. | ||||
| состояние - |
| Указывает, нужно ли создать или удалить объект | ||||
| тема-стиля - | Тема стиля отчета. | |||||
| подзаголовок - | Подзаголовок отчета. | |||||
| время - | Время расписания для генерации отчета [чч:мм]. | |||||
| заголовок - | Заголовок отчета. | |||||
| имя_пользователя - / обязательно | Имя пользователя FortiOS или FortiGate. | |||||
| vdom - | По умолчанию: "корень" | Виртуальный домен из ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | ||||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Запуск как local_action в вашем playbook
Примеры
- 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>"
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Данный модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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