Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_report_chart — настройка виджета диаграммы отчёта в 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_chart.

Новое в 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_chart

dictionary

Конфигурация виджета диаграммы отчета.

background

string

Фон диаграммы.

category

string

Категория.

Варианты:

  • "misc"
  • "traffic"
  • "event"
  • "virus"
  • "webfilter"
  • "attack"
  • "spam"
  • "dlp"
  • "app-ctrl"
  • "vulnerability"

category_series

dictionary

Ряд категорий круговой диаграммы.

databind

string

Выражение значения ряда категорий.

font_size

integer

Размер шрифта заголовка ряда категорий.

color_palette

string

Цветовая палитра (по умолчанию система выбирает цвет автоматически).

column

list / elements=dictionary

Определение столбца таблицы.

detail_unit

string

Единица измерения значения подробных данных столбца.

detail_value

string

Значение подробных данных столбца.

footer_unit

string

Единица измерения значения нижнего колонтитула столбца.

footer_value

string

Значение нижнего колонтитула столбца.

header_value

string

Отображаемое имя заголовка таблицы.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

mapping

list / elements=dictionary

Отображение подробных данных с заданным значением для определенного условия.

displayname

string

Отображаемое имя.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

op

string

Оператор сравнения.

Варианты:

  • "none"
  • "greater"
  • "greater-equal"
  • "less"
  • "less-equal"
  • "equal"
  • "between"

value1

string

Значение 1.

value2

string

Значение 2.

value_type

string

Тип значения.

Варианты:

  • "integer"
  • "string"

comments

string

Комментарий.

dataset

string

Привязать набор данных к диаграмме.

dimension

string

Размерность.

Варианты:

  • "2D"
  • "3D"

drill_down_charts

list / elements=dictionary

Диаграммы детализации.

chart_name

string

Имя диаграммы детализации.

id

integer / обязательный

Идентификатор диаграммы детализации. См. <a href=’#notes’>Примечания</a>.

status

string

Включить/отключить эту диаграмму детализации.

Варианты:

  • "enable"
  • "disable"

favorite

string

Избранное.

Варианты:

  • "no"
  • "yes"

graph_type

string

Тип графика.

Варианты:

  • "none"
  • "bar"
  • "pie"
  • "line"
  • "flow"

legend

string

Включить/отключить область легенды.

Варианты:

  • "enable"
  • "disable"

legend_font_size

integer

Размер шрифта области легенды.

name

string / обязательный

Имя виджета диаграммы

period

string

Период времени.

Варианты:

  • "last24h"
  • "last7d"

policy

integer

Используется политикой мониторинга.

style

string

Стиль.

Варианты:

  • "auto"
  • "manual"

title

string

Заголовок диаграммы.

title_font_size

integer

Размер шрифта заголовка диаграммы.

type

string

Тип диаграммы.

Варианты:

  • "graph"
  • "table"

value_series

dictionary

Ряд значений круговой диаграммы.

databind

string

Выражение значения ряда значений.

x_series

dictionary

Ряд X диаграммы.

caption

string

Подпись ряда X.

caption_font_size

integer

Размер шрифта подписи ряда X.

databind

string

Выражение значения ряда X.

font_size

integer

Размер шрифта метки ряда X.

is_category

string

Указывает, является ли ряд X категорией.

Варианты:

  • "yes"
  • "no"

label_angle

string

Угол наклона меток ряда X.

Варианты:

  • "45-degree"
  • "vertical"
  • "horizontal"

scale_direction

string

Увеличение или уменьшение масштаба.

Варианты:

  • "decrease"
  • "increase"

scale_format

string

Формат даты и времени.

Варианты:

  • "YYYY-MM-DD-HH-MM"
  • "YYYY-MM-DD HH"
  • "YYYY-MM-DD"
  • "YYYY-MM"
  • "YYYY"
  • "HH-MM"
  • "MM-DD"

scale_step

integer

Шаг шкалы.

scale_unit

string

Единица измерения шкалы.

Варианты:

  • "minute"
  • "hour"
  • "day"
  • "month"
  • "year"

unit

string

Единица измерения ряда X.

y_series

dictionary

Ряд Y диаграммы.

caption

string

Подпись ряда Y.

caption_font_size

integer

Размер шрифта подписи ряда Y.

databind

string

Выражение значения ряда Y.

extra_databind

string

Дополнительное значение ряда Y.

extra_y

string

Разрешить дополнительное значение ряда Y

Варианты:

  • "enable"
  • "disable"

extra_y_legend

string

Тип/имя легенды дополнительного ряда Y.

font_size

integer

Размер шрифта подписи серии Y.

group

string

Параметр группы серии Y.

label_angle

string

Угол наклона подписи серии Y.

Варианты:

  • "45-degree"
  • "vertical"
  • "horizontal"

unit

string

Единица измерения серии Y.

y_legend

string

Тип/имя легенды первой серии Y.

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает 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

Возвращается: всегда

Пример: "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_chart_module.html

Spec-Zone.ru

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