Модуль fortinet.fortios.fortios_report_chart — Настройка виджета диаграммы отчетов в 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_chart.
Новая версия в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры отчетов и категорий диаграмм. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate. |
enable_log логическое значение | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту элемента для обработки. Разделяется символом слеша, если атрибутов несколько. Параметр, помеченный member_path, допустим для выполнения операции над элементом. |
member_state строка | Добавление или удаление элемента по указанному пути атрибута. При указании member_state опция state игнорируется. Варианты:
|
report_chart словарь | Настройка виджета диаграммы отчета. |
|
background строка |
Фон диаграммы. |
|
category строка |
Категория. Варианты:
|
|
category_series словарь |
Серия категорий круговой диаграммы. |
|
databind строка |
Выражение значения серии категорий. |
|
font_size целое число |
Размер шрифта заголовка категории-серии. |
|
color_palette строка |
Цветовая палитра (система автоматически подбирает цвет по умолчанию). |
|
column список / элементы=словарь |
Определение столбца таблицы. |
|
detail_unit строка |
Единица детализации столбца. |
|
detail_value строка |
Детальное значение столбца. |
|
строка |
Единица подвала столбца. |
|
строка |
Значение подвала столбца. |
|
header_value строка |
Имя отображения заголовка таблицы. |
|
id целое число / обязательно |
Идентификатор. см. <a href=’#notes’>Примечания</a>. |
|
mapping список / элементы=словарь |
Отображение детали в определенном значении отображения для определенного условия. |
|
displayname строка |
Имя отображения. |
|
id целое число / обязательно |
Идентификатор, см. <a href=’#notes’>Примечания</a>. |
|
op строка |
Оператор сравнения. Варианты:
|
|
value1 строка |
Значение 1. |
|
value2 string |
Значение 2. |
|
value_type string |
Тип значения. Варианты:
|
|
comments string |
Комментарий. |
|
dataset string |
Привязка набора данных к диаграмме. |
|
dimension string |
Измерение. Варианты:
|
|
drill_down_charts list / elements=dictionary |
Вложенные диаграммы. |
|
chart_name string |
Имя вложенной диаграммы. |
|
id integer / required |
ID вложенной диаграммы. см. <a href=’#notes’>Примечания</a>. |
|
status string |
Включить/выключить эту вложенную диаграмму. Варианты:
|
|
favorite string |
Избранное. Варианты:
|
|
graph_type string |
Тип графика. Варианты:
|
|
legend string |
Включить/Выключить область легенды. Варианты:
|
|
legend_font_size integer |
Размер шрифта области легенды. |
|
name string / required |
Имя виджета диаграммы |
|
period string |
Временной период. Варианты:
|
|
policy integer |
Используется политикой мониторинга. |
|
style string |
Стиль. Варианты:
|
|
title string |
Заголовок диаграммы. |
|
title_font_size integer |
Размер шрифта заголовка диаграммы. |
|
type string |
Тип диаграммы. Варианты:
|
|
value_series dictionary |
Ряд значений круговой диаграммы. |
|
databind string |
Выражение значения ряда значений. |
|
x_series dictionary |
X-ряд диаграммы. |
|
caption string |
Подпись X-ряда. |
|
caption_font_size целое число |
Размер шрифта заголовка X-ряда. |
|
databind строка |
Выражение значения для X-ряда. |
|
font_size целое число |
Размер шрифта метки X-ряда. |
|
is_category строка |
Представляет ли X-ряд категорию. Варианты:
|
|
label_angle строка |
Угол метки X-ряда. Варианты:
|
|
scale_direction строка |
Направление масштабирования. Варианты:
|
|
scale_format строка |
Формат даты/времени. Варианты:
|
|
scale_step целое число |
Шаг масштабирования. |
|
scale_unit строка |
Единица масштабирования. Варианты:
|
|
unit строка |
Единица X-ряда. |
|
y_series словарь |
Y-ряд графика. |
|
caption строка |
Заголовок Y-ряда. |
|
caption_font_size целое число |
Размер шрифта заголовка Y-ряда. |
|
databind строка |
Выражение значения для Y-ряда. |
|
extra_databind строка |
Дополнительное значение Y-ряда. |
|
extra_y строка |
Разрешить другое значение Y-ряда Варианты:
|
|
extra_y_legend строка |
Тип/имя легенды дополнительного Y-ряда. |
|
font_size целое число |
Размер шрифта метки Y-ряда. |
|
group строка |
Группа Y-ряда. |
|
label_angle строка |
Угол метки Y-ряда. Варианты:
|
|
unit строка |
Единица Y-ряда. |
|
y_legend строка |
Тип/имя легенды первого Y-ряда. |
state строка / обязательно | Указывает на создание или удаление объекта. Варианты:
|
vdom string | Виртуальный домен, среди ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Default: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает check_mode.
Примеры
- name: Report chart widget configuration.
fortinet.fortios.fortios_report_chart:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
report_chart:
background: "<your_own_value>"
category: "misc"
category_series:
databind: "<your_own_value>"
font_size: "10"
color_palette: "<your_own_value>"
column:
-
detail_unit: "<your_own_value>"
detail_value: "<your_own_value>"
footer_unit: "<your_own_value>"
footer_value: "<your_own_value>"
header_value: "<your_own_value>"
id: "15"
mapping:
-
displayname: "<your_own_value>"
id: "18"
op: "none"
value_type: "integer"
value1: "<your_own_value>"
value2: "<your_own_value>"
comments: "<your_own_value>"
dataset: "<your_own_value>"
dimension: "2D"
drill_down_charts:
-
chart_name: "<your_own_value>"
id: "28"
status: "enable"
favorite: "no"
graph_type: "none"
legend: "enable"
legend_font_size: "2147483647"
name: "default_name_34"
period: "last24h"
policy: "2147483647"
style: "auto"
title: "<your_own_value>"
title_font_size: "2147483647"
type: "graph"
value_series:
databind: "<your_own_value>"
x_series:
caption: "<your_own_value>"
caption_font_size: "10"
databind: "<your_own_value>"
font_size: "10"
is_category: "yes"
label_angle: "45-degree"
scale_direction: "decrease"
scale_format: "YYYY-MM-DD-HH-MM"
scale_step: "32767"
scale_unit: "minute"
unit: "<your_own_value>"
y_series:
caption: "<your_own_value>"
caption_font_size: "10"
databind: "<your_own_value>"
extra_databind: "<your_own_value>"
extra_y: "enable"
extra_y_legend: "<your_own_value>"
font_size: "10"
group: "<your_own_value>"
label_angle: "45-degree"
unit: "<your_own_value>"
y_legend: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при последней применённой операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный в последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер ревизии Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Указание результата операции Возвращается: всегда Пример: |
vdom string | Использованный виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_chart_module.html
