Spec-Zone.ru › Ansible 2.9

fortios_report_chart – Настройка виджета диаграммы отчетов в FortiOS и FortiGate Fortinet

Новая версия с 2.8.

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры отчетов и категории диаграмм. Примеры включают все параметры и значения, которые нужно скорректировать в источниках данных перед использованием. Тестировалось с FOS v6.0.5

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое значение
    Варианты:
  • no
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
Значение по умолчанию:
""
Пароль FortiOS или FortiGate.
report_chart
словарь
Значение по умолчанию:
null
Конфигурация виджета диаграммы отчета.
background
строка
Фон диаграммы.
category
строка
    Варианты:
  • misc
  • traffic
  • event
  • virus
  • webfilter
  • attack
  • spam
  • dlp
  • app-ctrl
  • vulnerability
Категория.
category_series
словарь
Категория серии круговой диаграммы.
databind
строка
Выражение значения категории серии.
font_size
целое число
Размер шрифта заголовка категории-серии.
color_palette
строка
Цветовая палитра (система автоматически подберет цвет по умолчанию).
column
список
Определение столбца таблицы.
detail_unit
строка
Единица измерения детали столбца.
detail_value
строка
Значение детали столбца.
footer_unit
строка
Единица измерения подвала столбца.
footer_value
строка
Значение подвала столбца.
header_value
строка
Имя отображаемого заголовка таблицы.
id
целое число / обязательно
Идентификатор.
mapping
список
Отображение детали в определённом значении отображения при определённом условии.
displayname
строка
Имя для отображения.
id
целое число / обязательно
id
op
строка
    Варианты:
  • none
  • greater
  • greater-equal
  • less
  • less-equal
  • equal
  • between
Оператор сравнения.
value1
строка
Значение 1.
value2
строка
Значение 2.
value_type
строка
    Варианты:
  • целое число
  • строка
Тип значения.
comments
строка
Комментарий.
dataset
строка
Привязка набора данных к диаграмме.
dimension
строка
    Варианты:
  • 2D
  • 3D
Измерение.
drill_down_charts
список
Вложенные диаграммы.
chart_name
строка
Имя диаграммы вложенного отображения.
id
целое число / обязательно
Идентификатор диаграммы вложенного отображения.
status
строка
    Варианты:
  • enable
  • disable
Включить/выключить эту вложенную диаграмму.
favorite
строка
    Варианты:
  • no
  • yes
Избранное.
graph_type
строка
    Варианты:
  • none
  • bar
  • pie
  • line
  • flow
Тип графика.
legend
строка
    Варианты:
  • enable
  • disable
Включить/выключить область легенды.
legend_font_size
целое число
Размер шрифта области легенды.
name
строка / обязательно
Имя виджета диаграммы
period
строка
    Варианты:
  • last24h
  • last7d
Период времени.
policy
целое число
Используется политикой мониторинга.
state
строка
    Варианты:
  • present
  • absent
Устаревшее
Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' на верхнем уровне.
Указывает, создать или удалить объект.
style
строка
    Варианты:
  • auto
  • manual
Стиль.
title
строка
Заголовок диаграммы.
Размер шрифта заголовка
целое число
Размер шрифта заголовка диаграммы.
Тип
строка
    Варианты:
  • график
  • таблица
Тип диаграммы.
Серия значений
словарь
Серия значений круговой диаграммы.
databind
строка
Выражение значения для ряда значений.
Серия значений X
словарь
Серия значений X диаграммы.
Заголовок
строка
Заголовок серии X.
Размер шрифта заголовка
целое число
Размер шрифта заголовка серии X.
databind
строка
Выражение значения для серии X.
Размер шрифта
целое число
Размер шрифта меток серии X.
Является категорией
строка
    Варианты:
  • да
  • нет
Представляет ли серия X категорию.
Угол метки
строка
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки серии X.
Направление шкалы
строка
    Варианты:
  • уменьшение
  • увеличение
Направление увеличения/уменьшения шкалы.
Формат шкалы
строка
    Варианты:
  • ГГГГ-ММ-ДД-ЧЧ-ММ
  • ГГГГ-ММ-ДД ЧЧ
  • ГГГГ-ММ-ДД
  • ГГГГ-ММ
  • ГГГГ
  • ЧЧ-ММ
  • ММ-ДД
Формат даты/времени.
Шаг шкалы
целое число
Шаг шкалы.
Единица шкалы
строка
    Варианты:
  • минута
  • час
  • день
  • месяц
  • год
Единица измерения шкалы.
Единица
строка
Единица измерения серии X.
Серия значений Y
словарь
Серия значений Y диаграммы.
Заголовок
строка
Заголовок серии Y.
Размер шрифта заголовка
целое число
Размер шрифта заголовка серии Y.
databind
строка
Выражение значения для серии Y.
extra_databind
строка
Дополнительное значение для серии Y.
extra_y
строка
    Варианты:
  • включено
  • выключено
Разрешить дополнительное значение Y.
extra_y_legend
строка
Тип/имя легенды для дополнительной серии Y.
Размер шрифта
целое число
Размер шрифта меток серии Y.
Группа
строка
Параметр группы для серии Y.
Угол метки
строка
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки серии Y.
Единица
строка
Единица измерения серии Y.
y_legend
строка
Тип/имя легенды первой серии Y.
ssl_verify
булево
добавлено в 2.9
    Варианты:
  • нет
  • да ←
Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
состояние
строка
добавлено в 2.9
    Варианты:
  • присутствует
  • отсутствует
Указывает, создавать или удалять объект. Этот атрибут уже присутствовал в предыдущих версиях на более глубоком уровне. Он был перенесен на этот внешний уровень.
имя пользователя
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
По умолчанию:
"root"
Виртуальная область, определённая ранее. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Требуется библиотека fortiosapi, разработанная Fortinet
  • Выполняется как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Report chart widget configuration.
    fortios_report_chart:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      report_chart:
        background: "<your_own_value>"
        category: "misc"
        category_series:
            databind: "<your_own_value>"
            font_size: "7"
        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: "33"
        name: "default_name_34"
        period: "last24h"
        policy: "36"
        style: "auto"
        title: "<your_own_value>"
        title_font_size: "39"
        type: "graph"
        value_series:
            databind: "<your_own_value>"
        x_series:
            caption: "<your_own_value>"
            caption_font_size: "45"
            databind: "<your_own_value>"
            font_size: "47"
            is_category: "yes"
            label_angle: "45-degree"
            scale_direction: "decrease"
            scale_format: "YYYY-MM-DD-HH-MM"
            scale_step: "52"
            scale_unit: "minute"
            unit: "<your_own_value>"
        y_series:
            caption: "<your_own_value>"
            caption_font_size: "57"
            databind: "<your_own_value>"
            extra_databind: "<your_own_value>"
            extra_y: "enable"
            extra_y_legend: "<your_own_value>"
            font_size: "62"
            group: "<your_own_value>"
            label_angle: "45-degree"
            unit: "<your_own_value>"
            y_legend: "<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
строка
всегда
Указание результата операции

Пример:
success
vdom
строка
всегда
Используемый виртуальный домен

Пример:
root
version
строка
всегда
Версия FortiGate

Пример:
v5.6.3


Статус

  • Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • 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.9/modules/fortios_report_chart_module.html

Spec-Zone.ru

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