Spec-Zone.ru › Ansible 2.9

fortios_report_layout – Макет отчетов в FortiOS и FortiGate Fortinet

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

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

Обзор

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

Требования

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

  • fortiosapi>=0.9.8

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
host
строка
IP-адрес FortiOS или FortiGate.
https
логическое
    Варианты:
  • нет
  • да ←
Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password
строка
По умолчанию:
""
Пароль FortiOS или FortiGate.
report_layout
словарь
По умолчанию:
null
Настройка макета отчета.
body_item
список
Настройка элемента тела отчета.
chart
строка
Название диаграммы элемента отчета.
chart_options
строка
    Варианты:
  • include-no-data
  • hide-title
  • show-caption
Параметры диаграммы отчета.
column
целое число
Номер столбца раздела отчета.
content
строка
Текстовое содержимое элемента отчета.
description
строка
Описание.
drill_down_items
строка
Управление отображением диаграмм с детализацией.
drill_down_types
строка
Управление объединением ключей родительского элемента.
hide
строка
    Варианты:
  • включить
  • выключить
Включить/выключить скрытие элемента в отчете.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
list
список
Настройка элемента списка отчета.
content
строка
Содержимое записи списка.
id
целое число / обязательно
Идентификатор записи списка.
list_component
строка
    Варианты:
  • маркер
  • нумерованный
Компонент списка элемента отчета.
misc_component
строка
    Варианты:
  • горизонтальная линия
  • разрыв страницы
  • разрыв столбца
  • начало раздела
Разное компонент элемента отчета.
parameters
список
Параметры.
id
целое число / обязательно
Идентификатор.
name
строка
Имя поля, соответствующего полю параметров, определенных в наборе данных.
value
строка
Значение для замены соответствующего поля параметров, определенных в наборе данных.
style
строка
Стиль элемента отчета.
table_caption_style
строка
Стиль подписи табличной диаграммы.
table_column_widths
строка
Ширина столбцов таблицы элемента отчета.
table_even_row_style
строка
Стиль четных строк табличной диаграммы.
table_head_style
строка
Стиль заголовка табличной диаграммы.
table_odd_row_style
строка
Стиль нечетных строк табличной диаграммы.
text_component
строка
    Варианты:
  • текст
  • заголовок1
  • заголовок2
  • заголовок3
Компонент текста элемента отчета.
title
строка
Заголовок раздела отчета.
top_n
целое число
Значение верхнего.
type
строка
    Варианты:
  • текст
  • изображение
  • диаграмма
  • разное
Тип элемента отчета.
cutoff_option
строка
    Варианты:
  • во время выполнения
  • настройка
Параметр отсечения — либо во время выполнения, либо настройка.
cutoff_time
строка
Настраиваемое время отсечения для генерации отчета [чч:мм].
day
строка
    Варианты:
  • воскресенье
  • понедельник
  • вторник
  • среда
  • четверг
  • пятница
  • суббота
Дни недели для генерации отчета.
description
строка
Описание.
email_recipients
строка
Получатели электронной почты для сгенерированных отчетов.
email_send
строка
    Варианты:
  • включить
  • выключить
Включить/выключить отправку электронных писем после генерации отчетов.
формат
строка
    Варианты:
  • pdf
Формат отчета.
max_pdf_report
целое число
Максимальное количество отчетов PDF для хранения одновременно (старейший отчет перезаписывается).
название
строка / обязательно
Имя макета отчета.
параметры
строка
    Варианты:
  • включать-содержание
  • автоматическое-нумерование-заголовков
  • отображать-график-как-заголовок
  • показывать-html-навигацию-перед-заголовком
  • заглушка-параметр
Параметры макета отчета.
страница
словарь
Настройка страницы отчета.
разрыв_колонки_перед
строка
    Варианты:
  • заголовок1
  • заголовок2
  • заголовок3
Автоматический разрыв колонки на странице отчета перед заголовком.
подвал
словарь
Настройка подвала страницы отчета.
элемент_подвала
список
Настройка элемента подвала отчета.
содержание
строка
Текстовое содержание элемента отчета.
описание
строка
Описание.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
стиль
строка
Стиль элемента отчета.
тип
строка
    Варианты:
  • текст
  • изображение
Тип элемента отчета.
стиль
строка
Стиль подвала отчета.
шапка
словарь
Настройка заголовка страницы отчета.
элемент_шапки
список
Настройка элемента заголовка отчета.
содержание
строка
Текстовое содержание элемента отчета.
описание
строка
Описание.
id
целое число / обязательно
Идентификатор элемента отчета.
img_src
строка
Имя файла изображения элемента отчета.
стиль
строка
Стиль элемента отчета.
тип
строка
    Варианты:
  • текст
  • изображение
Тип элемента отчета.
стиль
строка
Стиль заголовка отчета.
параметры
строка
    Варианты:
  • шапка-на-первой-странице
  • подвал-на-первой-странице
Параметры страницы отчета.
разрыв_страницы_перед
строка
    Варианты:
  • заголовок1
  • заголовок2
  • заголовок3
Автоматический разрыв страницы отчета перед заголовком.
бумага
строка
    Варианты:
  • a4
  • letter
Бумага для страницы отчета.
тип_расписания
строка
    Варианты:
  • по_требованию
  • ежедневно
  • еженедельно
Тип расписания отчета.
состояние
строка
    Варианты:
  • текущий
  • отсутствует
Устарело
Начиная с Ansible 2.9, рекомендуется использовать параметр 'состояние' на верхнем уровне.
Указывает, нужно ли создать или удалить объект.
тема_стиля
строка
Тема стиля отчета.
подзаголовок
строка
Подзаголовок отчета.
время
строка
Время генерации отчета [чч:мм].
заголовок
строка
Заголовок отчета.
ssl_verify
булево
добавлен в 2.9
    Варианты:
  • нет
  • да ←
Обеспечивает, что сертификат FortiGate должен быть проверен надлежащим удостоверяющим центром.
состояние
строка
добавлен в 2.9
    Варианты:
  • текущий
  • отсутствует
Указывает, нужно ли создать или удалить объект. Этот атрибут уже был в предыдущей версии на более глубоком уровне. Он был вынесен на этот внешний уровень.
имя_пользователя
строка
Имя пользователя FortiOS или FortiGate.
vdom
строка
Значение по умолчанию:
"root"
Виртуальный домен, среди тех, которые определены ранее. Vdom — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

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

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Report layout configuration.
    fortios_report_layout:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      report_layout:
        body_item:
         -
            chart: "<your_own_value>"
            chart_options: "include-no-data"
            column: "6"
            content: "<your_own_value>"
            description: "<your_own_value>"
            drill_down_items: "<your_own_value>"
            drill_down_types: "<your_own_value>"
            hide: "enable"
            id:  "12"
            img_src: "<your_own_value>"
            list:
             -
                content: "<your_own_value>"
                id:  "16"
            list_component: "bullet"
            misc_component: "hline"
            parameters:
             -
                id:  "20"
                name: "default_name_21"
                value: "<your_own_value>"
            style: "<your_own_value>"
            table_caption_style: "<your_own_value>"
            table_column_widths: "<your_own_value>"
            table_even_row_style: "<your_own_value>"
            table_head_style: "<your_own_value>"
            table_odd_row_style: "<your_own_value>"
            text_component: "text"
            title: "<your_own_value>"
            top_n: "31"
            type: "text"
        cutoff_option: "run-time"
        cutoff_time: "<your_own_value>"
        day: "sunday"
        description: "<your_own_value>"
        email_recipients: "<your_own_value>"
        email_send: "enable"
        format: "pdf"
        max_pdf_report: "40"
        name: "default_name_41"
        options: "include-table-of-content"
        page:
            column_break_before: "heading1"
            footer:
                footer_item:
                 -
                    content: "<your_own_value>"
                    description: "<your_own_value>"
                    id:  "49"
                    img_src: "<your_own_value>"
                    style: "<your_own_value>"
                    type: "text"
                style: "<your_own_value>"
            header:
                header_item:
                 -
                    content: "<your_own_value>"
                    description: "<your_own_value>"
                    id:  "58"
                    img_src: "<your_own_value>"
                    style: "<your_own_value>"
                    type: "text"
                style: "<your_own_value>"
            options: "header-on-first-page"
            page_break_before: "heading1"
            paper: "a4"
        schedule_type: "demand"
        style_theme: "<your_own_value>"
        subtitle: "<your_own_value>"
        time: "<your_own_value>"
        title: "<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
строка
всегда
Указание результата операции

Пример:
успех
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_layout_module.html

Spec-Zone.ru

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