Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_log_setting — настройка общих параметров журналирования в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_log_setting.

Добавлено в fortinet.fortios 2.0.0

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

Обзор

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

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

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

Варианты:

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

log_setting

dictionary

Настройка общих параметров журналирования.

anonymization_hash

string

Соль хеша для анонимизации имён пользователей.

brief_traffic_format

string

Включить или отключить краткий формат журналирования трафика.

Варианты:

  • "enable"
  • "disable"

custom_log_fields

list / elements=dictionary

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

field_id

string / обязательный

Пользовательское поле журнала. Источник: log.custom-field.id.

daemon_log

string

Включить или отключить журналирование демона.

Варианты:

  • "enable"
  • "disable"

expolicy_implicit_log

string

Включить или отключить журналирование неявной политики прокси-брандмауэра.

Варианты:

  • "enable"
  • "disable"

extended_log

string

Включить или отключить расширенное журналирование трафика.

Варианты:

  • "enable"
  • "disable"

extended_utm_log

string

Включить или отключить расширенное журналирование UTM.

Варианты:

  • "enable"
  • "disable"

faz_override

string

Включить или отключить переопределение настроек FortiAnalyzer.

Варианты:

  • "enable"
  • "disable"

fortiview_weekly_data

string

Включить или отключить еженедельные данные FortiView.

Варианты:

  • "enable"
  • "disable"

fwpolicy6_implicit_log

string

Включить или отключить журналирование неявной политики брандмауэра policy6.

Варианты:

  • "enable"
  • "disable"

fwpolicy_implicit_log

string

Включить или отключить журналирование неявной политики брандмауэра.

Варианты:

  • "enable"
  • "disable"

local_in_allow

string

Включить или отключить журналирование local-in-allow.

Варианты:

  • "enable"
  • "disable"

local_in_deny_broadcast

string

Включить или отключить журналирование local-in-deny-broadcast.

Варианты:

  • "enable"
  • "disable"

local_in_deny_unicast

string

Включить или отключить журналирование local-in-deny-unicast.

Варианты:

  • "enable"
  • "disable"

local_in_policy_log

string

Включить или отключить журналирование политики local-in.

Варианты:

  • "enable"
  • "disable"

local_out

string

Включить или отключить журналирование local-out.

Варианты:

  • "enable"
  • "disable"

local_out_ioc_detection

string

Включить или отключить обнаружение IoC в исходящем локальном трафике. Для этого необходимо включить local-out.

Варианты:

  • "enable"
  • "disable"

log_invalid_packet

string

Включить или отключить журналирование трафика с недопустимыми пакетами.

Варианты:

  • "enable"
  • "disable"

log_policy_comment

string

Включить или отключить добавление комментариев к политикам в журналы трафика.

Варианты:

  • "enable"
  • "disable"

log_policy_name

string

Включить или отключить добавление имён политик в журналы трафика.

Варианты:

  • "enable"
  • "disable"

log_user_in_upper

string

Включить или отключить журналы с параметром user-in-upper.

Варианты:

  • "enable"
  • "disable"

long_live_session_stat

string

Включить или отключить журналирование статистики длительных сеансов.

Варианты:

  • "enable"
  • "disable"

neighbor_event

string

Включить или отключить журналирование событий соседей.

Варианты:

  • "enable"
  • "disable"

resolve_ip

string

Включить или отключить добавление разрешённых доменных имён в журналы трафика, если это возможно.

Варианты:

  • "enable"
  • "disable"

resolve_port

string

Включить или отключить добавление разрешённых имён служб в журналы трафика.

Варианты:

  • "enable"
  • "disable"

rest_api_get

string

Включить или отключить журналирование запросов REST API GET.

Варианты:

  • "enable"
  • "disable"

rest_api_performance

string

Включить или отключить запись сведений об использовании памяти и производительности REST API в журналы rest-api-get/set.

Варианты:

  • "enable"
  • "disable"

rest_api_set

string

Включить или отключить журналирование запросов REST API POST/PUT/DELETE.

Варианты:

  • "enable"
  • "disable"

syslog_override

string

Включить или отключить переопределение настроек Syslog.

Варианты:

  • "enable"
  • "disable"

user_anonymize

string

Включить или отключить анонимизацию имён пользователей в сообщениях журнала.

Варианты:

  • "enable"
  • "disable"

web_svc_perf

string

Включить или отключить журналирование производительности web-svc.

Варианты:

  • "enable"
  • "disable"

zone_name

string

Включить или отключить журналирование имён зон.

Варианты:

  • "enable"
  • "disable"

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path можно использовать для выполнения операции над элементом.

member_state

string

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

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

vdom

string

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

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

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi.
  • Модуль поддерживает check_mode.

Примеры

- name: Configure general log settings.
  fortinet.fortios.fortios_log_setting:
      vdom: "{{ vdom }}"
      log_setting:
          anonymization_hash: "<your_own_value>"
          brief_traffic_format: "enable"
          custom_log_fields:
              -
                  field_id: "<your_own_value> (source log.custom-field.id)"
          daemon_log: "enable"
          expolicy_implicit_log: "enable"
          extended_log: "enable"
          extended_utm_log: "enable"
          faz_override: "enable"
          fortiview_weekly_data: "enable"
          fwpolicy_implicit_log: "enable"
          fwpolicy6_implicit_log: "enable"
          local_in_allow: "enable"
          local_in_deny_broadcast: "enable"
          local_in_deny_unicast: "enable"
          local_in_policy_log: "enable"
          local_out: "enable"
          local_out_ioc_detection: "enable"
          log_invalid_packet: "enable"
          log_policy_comment: "enable"
          log_policy_name: "enable"
          log_user_in_upper: "enable"
          long_live_session_stat: "enable"
          neighbor_event: "enable"
          resolve_ip: "enable"
          resolve_port: "enable"
          rest_api_get: "enable"
          rest_api_performance: "enable"
          rest_api_set: "enable"
          syslog_override: "enable"
          user_anonymize: "enable"
          web_svc_perf: "enable"
          zone_name: "enable"

Возвращаемые значения

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

Ключ

Описание

build

string

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

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат последней выполненной операции, полученный от FortiGate

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

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

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

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

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

Пример: "success"

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

Spec-Zone.ru

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