Spec-Zone.ru › Ansible 2.8

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

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

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

Обзор

  • Этот модуль позволяет настроить FortiGate или FortiOS, позволяя пользователю устанавливать и изменять параметры отчёта и категории графиков. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.2

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
- / обязательно
IP-адрес FortiOS или FortiGate.
https
boolean
    Варианты:
  • 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
Оператор сравнения.
value-type
-
    Варианты:
  • integer
  • string
Тип значения.
value1
-
Значение 1.
value2
-
Значение 2.
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
Указывает, нужно ли создать или удалить объект.
style
-
    Варианты:
  • auto
  • manual
Стиль.
title
-
Заголовок графика.
title-font-size
-
Размер шрифта заголовка графика.
тип
-
    Варианты:
  • график
  • таблица
Тип диаграммы.
ряд-значений
-
Ряд значений круговой диаграммы.
databind
-
Выражение значения ряда значений.
ось-x
-
Ось X диаграммы.
заголовок
-
Заголовок оси X.
размер-шрифта-заголовка
-
Размер шрифта заголовка оси X.
databind
-
Выражение значения оси X.
размер-шрифта
-
Размер шрифта метки оси X.
является-категорией
-
    Варианты:
  • да
  • нет
Ось X представляет категорию или нет.
угол-метки
-
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки оси X.
направление-масштаба
-
    Варианты:
  • убывание
  • возрастание
Направление увеличения или уменьшения масштаба.
формат-масштаба
-
    Варианты:
  • ГГГГ-ММ-ДД-ЧЧ-ММ
  • ГГГГ-ММ-ДД ЧЧ
  • ГГГГ-ММ-ДД
  • ГГГГ-ММ
  • ГГГГ
  • ЧЧ-ММ
  • ММ-ДД
Формат даты/времени.
шаг-масштаба
-
Шаг масштаба.
единица-масштаба
-
    Варианты:
  • минута
  • час
  • день
  • месяц
  • год
Единица масштаба.
единица
-
Единица измерения оси X.
ось-y
-
Ось Y диаграммы.
заголовок
-
Заголовок оси Y.
размер-шрифта-заголовка
-
Размер шрифта заголовка оси Y.
databind
-
Выражение значения оси Y.
дополнительное-databind
-
Дополнительное значение оси Y.
дополнительная-y
-
    Варианты:
  • включено
  • выключено
Разрешить другое значение оси Y
дополнительная-y-легенда
-
Тип/имя легенды для дополнительной оси Y.
размер-шрифта
-
Размер шрифта метки оси Y.
группа
-
Параметр группировки оси Y.
угол-метки
-
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки оси Y.
единица
-
Единица измерения оси Y.
y-легенда
-
Тип/имя легенды первой оси Y.
имя_пользователя
- / обязательно
Имя пользователя FortiOS или FortiGate.
vdom
-
По умолчанию:
"root"
Виртуальная область, определенная ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

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

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Report chart widget configuration.
    fortios_report_chart:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      report_chart:
        state: "present"
        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.8/modules/fortios_report_chart_module.html

Spec-Zone.ru

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