Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_log_fact — Получение данных логов объектов журналов fortios.

Примечание

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

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

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

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

Новая версия в fortinet.fortios 2.1.0

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

Обзор

  • Получение логов, связанных с диском, памятью, fortianalyzer и forticloud.

Требования

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

  • установите коллекцию galaxy fortinet.fortios >= 2.1.0.

Параметры

Параметр

Комментарии

access_token

строка

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

enable_log

булево

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

Варианты:

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

filters

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

Список выражений для фильтрации возвращаемых результатов.

Элементы списка объединяются как ЛОГИЧЕСКОЕ И с оператором амперсанд.

Один элемент может быть соединен запятой как ЛОГИЧЕСКОЕ ИЛИ.

formatters

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

Список полей для отображения возвращаемых результатов.

params

словарь

параметр для каждого селектора, см. определение в списке выше.

selector

строка

Селектор извлекаемого типа журнала

Варианты:

  • "disk_virus_archive"
  • "memory_virus_archive"
  • "fortianalyzer_virus_archive"
  • "forticloud_virus_archive"
  • "disk_ips_archive"
  • "disk_app-ctrl_archive"
  • "memory_ips_archive"
  • "memory_app-ctrl_archive"
  • "fortianalyzer_ips_archive"
  • "fortianalyzer_app-ctrl_archive"
  • "forticloud_ips_archive"
  • "forticloud_app-ctrl_archive"
  • "disk_ips_archive-download"
  • "disk_app-ctrl_archive-download"
  • "memory_ips_archive-download"
  • "memory_app-ctrl_archive-download"
  • "fortianalyzer_ips_archive-download"
  • "fortianalyzer_app-ctrl_archive-download"
  • "forticloud_ips_archive-download"
  • "forticloud_app-ctrl_archive-download"
  • "disk_virus_raw"
  • "disk_webfilter_raw"
  • "disk_waf_raw"
  • "disk_ips_raw"
  • "disk_anomaly_raw"
  • "disk_app-ctrl_raw"
  • "disk_cifs_raw"
  • "disk_emailfilter_raw"
  • "disk_dlp_raw"
  • "disk_voip_raw"
  • "disk_gtp_raw"
  • "disk_dns_raw"
  • "disk_ssh_raw"
  • "disk_ssl_raw"
  • "disk_file-filter_raw"
  • "memory_virus_raw"
  • "memory_webfilter_raw"
  • "memory_waf_raw"
  • "memory_ips_raw"
  • "memory_anomaly_raw"
  • "memory_app-ctrl_raw"
  • "memory_cifs_raw"
  • "memory_emailfilter_raw"
  • "memory_dlp_raw"
  • "memory_voip_raw"
  • "memory_gtp_raw"
  • "memory_dns_raw"
  • "memory_ssh_raw"
  • "memory_ssl_raw"
  • "memory_file-filter_raw"
  • "fortianalyzer_virus_raw"
  • "fortianalyzer_webfilter_raw"
  • "fortianalyzer_waf_raw"
  • "fortianalyzer_ips_raw"
  • "fortianalyzer_anomaly_raw"
  • "fortianalyzer_app-ctrl_raw"
  • "fortianalyzer_cifs_raw"
  • "fortianalyzer_emailfilter_raw"
  • "fortianalyzer_dlp_raw"
  • "fortianalyzer_voip_raw"
  • "fortianalyzer_gtp_raw"
  • "fortianalyzer_dns_raw"
  • "fortianalyzer_ssh_raw"
  • "fortianalyzer_ssl_raw"
  • "fortianalyzer_file-filter_raw"
  • "forticloud_virus_raw"
  • "forticloud_webfilter_raw"
  • "forticloud_waf_raw"
  • "forticloud_ips_raw"
  • "forticloud_anomaly_raw"
  • "forticloud_app-ctrl_raw"
  • "forticloud_cifs_raw"
  • "forticloud_emailfilter_raw"
  • "forticloud_dlp_raw"
  • "forticloud_voip_raw"
  • "forticloud_gtp_raw"
  • "forticloud_dns_raw"
  • "forticloud_ssh_raw"
  • "forticloud_ssl_raw"
  • "forticloud_file-filter_raw"
  • "disk_event_vpn"
  • "disk_event_user"
  • "disk_event_router"
  • "disk_event_wireless"
  • "disk_event_wad"
  • "disk_event_endpoint"
  • "disk_event_ha"
  • "disk_event_compliance-check"
  • "disk_event_system"
  • "disk_event_connector"
  • "disk_event_security-rating"
  • "disk_event_fortiextender"
  • "disk_traffic_forward"
  • "disk_traffic_local"
  • "disk_traffic_multicast"
  • "disk_traffic_sniffer"
  • "disk_traffic_fortiview"
  • "disk_traffic_threat"
  • "memory_event_vpn"
  • "memory_event_user"
  • "memory_event_router"
  • "memory_event_wireless"
  • "memory_event_wad"
  • "memory_event_endpoint"
  • "memory_event_ha"
  • "memory_event_compliance-check"
  • "memory_event_system"
  • "memory_event_connector"
  • "memory_event_security-rating"
  • "memory_event_fortiextender"
  • "memory_traffic_forward"
  • "memory_traffic_local"
  • "memory_traffic_multicast"
  • "memory_traffic_sniffer"
  • "memory_traffic_fortiview"
  • "memory_traffic_threat"
  • "fortianalyzer_event_vpn"
  • "fortianalyzer_event_user"
  • "fortianalyzer_event_router"
  • "fortianalyzer_event_wireless"
  • "fortianalyzer_event_wad"
  • "fortianalyzer_event_endpoint"
  • "fortianalyzer_event_ha"
  • "fortianalyzer_event_compliance-check"
  • "fortianalyzer_event_system"
  • "fortianalyzer_event_connector"
  • "fortianalyzer_event_security-rating"
  • "fortianalyzer_event_fortiextender"
  • "fortianalyzer_traffic_forward"
  • "fortianalyzer_traffic_local"
  • "fortianalyzer_traffic_multicast"
  • "fortianalyzer_traffic_sniffer"
  • "fortianalyzer_traffic_fortiview"
  • "fortianalyzer_traffic_threat"
  • "forticloud_event_vpn"
  • "forticloud_event_user"
  • "forticloud_event_router"
  • "forticloud_event_wireless"
  • "forticloud_event_wad"
  • "forticloud_event_endpoint"
  • "forticloud_event_ha"
  • "forticloud_event_compliance-check"
  • "forticloud_event_system"
  • "forticloud_event_connector"
  • "forticloud_event_security-rating"
  • "forticloud_event_fortiextender"
  • "forticloud_traffic_forward"
  • "forticloud_traffic_local"
  • "forticloud_traffic_multicast"
  • "forticloud_traffic_sniffer"
  • "forticloud_traffic_fortiview"
  • "forticloud_traffic_threat"

selectors

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

Список селекторов для извлечения типа журнала.

filters

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

Список выражений для фильтрации возвращаемых результатов.

Элементы списка объединяются как ЛОГИЧЕСКОЕ И с оператором амперсанд.

Один элемент может быть соединен запятой как ЛОГИЧЕСКОЕ ИЛИ.

formatters

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

Список полей для отображения возвращаемых результатов.

params

словарь

параметр для каждого селектора, см. определение в списке выше.
END_OF_DOCUMENT_MARKER

selector

строка / обязательно

селектор типа извлекаемых логов

Варианты:

  • "disk_virus_archive"
  • "memory_virus_archive"
  • "fortianalyzer_virus_archive"
  • "forticloud_virus_archive"
  • "disk_ips_archive"
  • "disk_app-ctrl_archive"
  • "memory_ips_archive"
  • "memory_app-ctrl_archive"
  • "fortianalyzer_ips_archive"
  • "fortianalyzer_app-ctrl_archive"
  • "forticloud_ips_archive"
  • "forticloud_app-ctrl_archive"
  • "disk_ips_archive-download"
  • "disk_app-ctrl_archive-download"
  • "memory_ips_archive-download"
  • "memory_app-ctrl_archive-download"
  • "fortianalyzer_ips_archive-download"
  • "fortianalyzer_app-ctrl_archive-download"
  • "forticloud_ips_archive-download"
  • "forticloud_app-ctrl_archive-download"
  • "disk_virus_raw"
  • "disk_webfilter_raw"
  • "disk_waf_raw"
  • "disk_ips_raw"
  • "disk_anomaly_raw"
  • "disk_app-ctrl_raw"
  • "disk_cifs_raw"
  • "disk_emailfilter_raw"
  • "disk_dlp_raw"
  • "disk_voip_raw"
  • "disk_gtp_raw"
  • "disk_dns_raw"
  • "disk_ssh_raw"
  • "disk_ssl_raw"
  • "disk_file-filter_raw"
  • "memory_virus_raw"
  • "memory_webfilter_raw"
  • "memory_waf_raw"
  • "memory_ips_raw"
  • "memory_anomaly_raw"
  • "memory_app-ctrl_raw"
  • "memory_cifs_raw"
  • "memory_emailfilter_raw"
  • "memory_dlp_raw"
  • "memory_voip_raw"
  • "memory_gtp_raw"
  • "memory_dns_raw"
  • "memory_ssh_raw"
  • "memory_ssl_raw"
  • "memory_file-filter_raw"
  • "fortianalyzer_virus_raw"
  • "fortianalyzer_webfilter_raw"
  • "fortianalyzer_waf_raw"
  • "fortianalyzer_ips_raw"
  • "fortianalyzer_anomaly_raw"
  • "fortianalyzer_app-ctrl_raw"
  • "fortianalyzer_cifs_raw"
  • "fortianalyzer_emailfilter_raw"
  • "fortianalyzer_dlp_raw"
  • "fortianalyzer_voip_raw"
  • "fortianalyzer_gtp_raw"
  • "fortianalyzer_dns_raw"
  • "fortianalyzer_ssh_raw"
  • "fortianalyzer_ssl_raw"
  • "fortianalyzer_file-filter_raw"
  • "forticloud_virus_raw"
  • "forticloud_webfilter_raw"
  • "forticloud_waf_raw"
  • "forticloud_ips_raw"
  • "forticloud_anomaly_raw"
  • "forticloud_app-ctrl_raw"
  • "forticloud_cifs_raw"
  • "forticloud_emailfilter_raw"
  • "forticloud_dlp_raw"
  • "forticloud_voip_raw"
  • "forticloud_gtp_raw"
  • "forticloud_dns_raw"
  • "forticloud_ssh_raw"
  • "forticloud_ssl_raw"
  • "forticloud_file-filter_raw"
  • "disk_event_vpn"
  • "disk_event_user"
  • "disk_event_router"
  • "disk_event_wireless"
  • "disk_event_wad"
  • "disk_event_endpoint"
  • "disk_event_ha"
  • "disk_event_compliance-check"
  • "disk_event_system"
  • "disk_event_connector"
  • "disk_event_security-rating"
  • "disk_event_fortiextender"
  • "disk_traffic_forward"
  • "disk_traffic_local"
  • "disk_traffic_multicast"
  • "disk_traffic_sniffer"
  • "disk_traffic_fortiview"
  • "disk_traffic_threat"
  • "memory_event_vpn"
  • "memory_event_user"
  • "memory_event_router"
  • "memory_event_wireless"
  • "memory_event_wad"
  • "memory_event_endpoint"
  • "memory_event_ha"
  • "memory_event_compliance-check"
  • "memory_event_system"
  • "memory_event_connector"
  • "memory_event_security-rating"
  • "memory_event_fortiextender"
  • "memory_traffic_forward"
  • "memory_traffic_local"
  • "memory_traffic_multicast"
  • "memory_traffic_sniffer"
  • "memory_traffic_fortiview"
  • "memory_traffic_threat"
  • "fortianalyzer_event_vpn"
  • "fortianalyzer_event_user"
  • "fortianalyzer_event_router"
  • "fortianalyzer_event_wireless"
  • "fortianalyzer_event_wad"
  • "fortianalyzer_event_endpoint"
  • "fortianalyzer_event_ha"
  • "fortianalyzer_event_compliance-check"
  • "fortianalyzer_event_system"
  • "fortianalyzer_event_connector"
  • "fortianalyzer_event_security-rating"
  • "fortianalyzer_event_fortiextender"
  • "fortianalyzer_traffic_forward"
  • "fortianalyzer_traffic_local"
  • "fortianalyzer_traffic_multicast"
  • "fortianalyzer_traffic_sniffer"
  • "fortianalyzer_traffic_fortiview"
  • "fortianalyzer_traffic_threat"
  • "forticloud_event_vpn"
  • "forticloud_event_user"
  • "forticloud_event_router"
  • "forticloud_event_wireless"
  • "forticloud_event_wad"
  • "forticloud_event_endpoint"
  • "forticloud_event_ha"
  • "forticloud_event_compliance-check"
  • "forticloud_event_system"
  • "forticloud_event_connector"
  • "forticloud_event_security-rating"
  • "forticloud_event_fortiextender"
  • "forticloud_traffic_forward"
  • "forticloud_traffic_local"
  • "forticloud_traffic_multicast"
  • "forticloud_traffic_sniffer"
  • "forticloud_traffic_fortiview"
  • "forticloud_traffic_threat"

sorters

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

Список выражений для сортировки возвращенных результатов.

Элементы списка упорядочены по возрастанию с оператором амперсанд.

Один элемент может быть упорядочен по убыванию с запятой внутри.

сортировки

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

Список выражений для сортировки возвращенных результатов.

Элементы списка упорядочены по возрастанию с оператором амперсанд.

Один элемент может быть упорядочен по убыванию с запятой внутри.

vdom

строка

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

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

Примечания

Примечание

  • Разные селекторы могут иметь разные параметры, пользователи должны просмотреть их для конкретного селектора.
  • Для некоторых селекторов объекты являются глобальными, параметры использовать нельзя.
  • Не все параметры являются обязательными для селектора.
  • Этот модуль предназначен исключительно для API логов FortiOS.

Примеры

- name: get disk event user and memory event user at once.
  fortinet.fortios.fortios_log_fact:
      access_token: "you_own_value"
      selectors:
          - selector: disk_event_user
            filters:
                - log_id==41000
          - selector: memory_event_user

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

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

Ключ

Описание

build

строка

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

rows

целое число

Количество строк для возврата

Возвращается: всегда

Пример: 400

serial

строка

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

session_id

целое число

Идентификатор сеанса для запроса

Возвращается: всегда

Пример: 7

start

целое число

Номер строки для первой возвращаемой строки

Возвращается: всегда

Пример: 0

status

строка

Указание результата операции

Возвращается: всегда

Пример: "success"

subcategory

строка

Тип лога, который можно получить

Возвращается: всегда

Пример: "system"

total_lines

целое число

Общее количество строк, возвращенных в результате

Возвращается: всегда

Пример: 510

vdom

строка

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

строка

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@fshen01)

Ссылки на сборку

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (источники)

© 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_log_fact_module.html

Spec-Zone.ru

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