Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в книге задач укажите: fortinet.fortios.fortios_report_chart.

Новое в версии 2.8: of fortinet.fortios

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

Обзор

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токенов. Сгенерировано из интерфейса Fortigate.
report_chart
словарь
Настройка виджета диаграммы отчета.
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
целое число / обязательно
ID.
mapping
список / элементы=строка
Отображение детали в определенном отображаемом значении при определенных условиях.
displayname
строка
Отображаемое имя.
id
целое число / обязательно
id
op
строка
    Варианты:
  • none
  • больше
  • больше или равно
  • меньше
  • меньше или равно
  • равно
  • между
Оператор сравнения.
value1
строка
Значение 1.
value2
строка
Значение 2.
value_type
строка
    Варианты:
  • целое число
  • строка
Тип значения.
comments
строка
Комментарий.
dataset
строка
Связать набор данных с диаграммой.
dimension
строка
    Варианты:
  • 2D
  • 3D
Размерность.
drill_down_charts
список / элементы=строка
Вложенные диаграммы.
chart_name
строка
Название вложенной диаграммы.
id
целое число / обязательно
ID вложенной диаграммы.
status
строка
    Варианты:
  • включено
  • выключено
Включить/выключить эту вложенную диаграмму.
favorite
строка
    Варианты:
  • Ложь
  • Истина
Избранное.
graph_type
строка
    Варианты:
  • нет
  • столбчатая
  • круговая
  • линейная
  • потоковая
Тип графика.
legend
строка
    Варианты:
  • включено
  • выключено
Включить/выключить область легенды.
legend_font_size
целое число
Размер шрифта области легенды.
name
строка / обязательно
Имя виджета диаграммы
period
строка
    Варианты:
  • последние24часа
  • последние7дней
Период времени.
policy
целое число
Используется политикой мониторинга.
state
строка
    Варианты:
  • present
  • absent
Устарело
Начиная с Ansible 2.9, мы рекомендуем использовать параметр «state» на верхнем уровне.
Указывает, следует ли создавать или удалять объект.
style
строка
    Варианты:
  • автоматически
  • ручной
Стиль.
title
строка
Заголовок диаграммы.
title_font_size
целое число
Размер шрифта заголовка диаграммы.
type
строка
    Варианты:
  • график
  • таблица
Тип диаграммы.
value_series
словарь
Серия значений круговой диаграммы.
databind
строка
Выражение значения серии значений.
x_series
словарь
X-серия диаграммы.
caption
строка
Подпись X-серии.
caption_font_size
целое число
Размер шрифта подписи X-серии.
databind
строка
Выражение значения X-серии.
font_size
целое число
Размер шрифта метки X-серии.
is_category
строка
    Варианты:
  • Истина
  • Ложь
X-серия представляет категорию или нет.
label_angle
строка
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки X-серии.
scale_direction
строка
    Варианты:
  • уменьшение
  • увеличение
Направление шкалы (увеличение или уменьшение).
scale_format
string
    Варианты:
  • ГГГГ-ММ-ДД-ЧЧ-ММ
  • ГГГГ-ММ-ДД ЧЧ
  • ГГГГ-ММ-ДД
  • ГГГГ-ММ
  • ГГГГ
  • ЧЧ-ММ
  • ММ-ДД
Формат даты/времени.
scale_step
integer
Шаг шкалы.
scale_unit
string
    Варианты:
  • минута
  • час
  • день
  • месяц
  • год
Единица шкалы.
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-ряда.
extra_y_legend
string
Тип/название легенды дополнительного Y-ряда.
font_size
integer
Размер шрифта метки Y-ряда.
group
string
Группа опций Y-ряда.
label_angle
string
    Варианты:
  • 45 градусов
  • вертикально
  • горизонтально
Угол метки Y-ряда.
unit
string
Единица измерения Y-ряда.
y_legend
string
Тип/название легенды первого Y-ряда.
state
string
добавлено в 2.9 fortios
    Варианты:
  • present
  • absent
Указывает, нужно ли создавать или удалять объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещён на этот внешний уровень.
vdom
string
Значение по умолчанию:
"root"
Виртуальная область, среди тех, которые были определены ранее. VDOM — виртуальная копия FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Report chart widget configuration.
    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: "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
string
всегда
Номер сборки образа fortigate

Пример:
1547
http_method
string
всегда
Последний метод, используемый для предоставления содержимого в FortiGate

Пример:
PUT
http_status
string
всегда
Последний результат, предоставленный FortiGate при последнем применённом действии

Пример:
200
mkey
string
успех
Главный ключ (id), использованный в последнем вызове FortiGate

Пример:
id
name
string
всегда
Имя таблицы, используемой для выполнения запроса

Пример:
urlfilter
path
string
всегда
Путь таблицы, используемой для выполнения запроса

Пример:
webfilter
revision
string
всегда
Внутренний номер ревизии

Пример:
17.0.2.10658
serial
string
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
string
всегда
Указание результата операции

Пример:
успех
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_report_chart_module.html

Spec-Zone.ru

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