Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_report_setting — Настройка отчетов в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Чтобы использовать его в плане, укажите: fortinet.fortios.fortios_report_setting.

Новая функция в fortinet.fortios 2.0.0

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

Обзор

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

Требования

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

  • ansible>=2.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.

enable_log

логический

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

строка

Путь к атрибуту элемента для работы.

Разделяется слешем, если атрибутов несколько.

Параметр с member_path подходит для операций с элементами.

member_state

строка

Добавить или удалить элемент по указанному пути атрибута.

При указании member_state опция state игнорируется.

Варианты:

  • "present"
  • "absent"

report_setting

словарь

Настройка параметров отчета.

fortiview

строка

Включить/выключить исторические данные FortiView.

Варианты:

  • "enable"
  • "disable"

pdf_report

строка

Включить/выключить отчет в формате PDF.

Варианты:

  • "enable"
  • "disable"

report_source

список / элементы=строка

Источник данных отчета.

Варианты:

  • "forward-traffic"
  • "sniffer-traffic"
  • "local-deny-traffic"

top_n

целое число

Количество элементов для заполнения (1000 - 20000).

web_browsing_threshold

целое число

Пороговое значение для расчета времени веб-серфинга (3-15 мин).

vdom

строка

Виртуальная область, определённая ранее. VDOM — виртуальная реализация FortiGate, настраиваемая как отдельное устройство.

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

Примечания

Примечание

  • Модуль fortiosapi устарел, рекомендуемый способ выполнения playbooks — httpapi.

Примеры

- name: Report setting configuration.
  fortinet.fortios.fortios_report_setting:
      vdom: "{{ vdom }}"
      report_setting:
          fortiview: "enable"
          pdf_report: "enable"
          report_source: "forward-traffic"
          top_n: "1000"
          web_browsing_threshold: "3"

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для этого модуля:

Ключ

Описание

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"

Авторы

  • 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_report_setting_module.html

Spec-Zone.ru

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