Модуль fortinet.fortios.fortios_log_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_log_setting.
Новое в fortinet.fortios 2.0.0
Обзор
- Этот модуль способен настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры и категорию функций регистрации. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировано с FOS v6.0.0
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токенная аутентификация. Создается в GUI Fortigate. |
enable_log boolean | Включить/Выключить ведение журнала для задачи. Варианты:
|
log_setting dictionary | Настройка общих параметров ведения журнала. |
|
anonymization_hash string |
Хэш соли для анонимизации имени пользователя. |
|
brief_traffic_format string |
Включить/выключить краткий формат ведения журнала трафика. Варианты:
|
|
custom_log_fields list / elements=dictionary |
Пользовательские поля для добавления ко всем сообщениям журнала. |
|
field_id string / required |
Пользовательское поле журнала. Источник log.custom-field.id. |
|
daemon_log string |
Включить/выключить ведение журнала демона. Варианты:
|
|
expolicy_implicit_log string |
Включить/выключить ведение журнала неявной политики явного прокси-брандмауэра. Варианты:
|
|
extended_log string |
Включить/выключить расширенное ведение журнала трафика. Варианты:
|
|
faz_override string |
Включить/выключить переопределение настроек FortiAnalyzer. Варианты:
|
|
fortiview_weekly_data string |
Включить/выключить еженедельные данные FortiView. Варианты:
|
|
fwpolicy6_implicit_log string |
Включить/выключить ведение журнала неявной политики брандмауэра6. Варианты:
|
|
fwpolicy_implicit_log string |
Включить/выключить ведение журнала неявной политики брандмауэра. Варианты:
|
|
local_in_allow string |
Включить/выключить ведение журнала local-in-allow. Варианты:
|
|
local_in_deny_broadcast string |
Включить/выключить ведение журнала local-in-deny-broadcast. Варианты:
|
|
local_in_deny_unicast string |
Включить/выключить ведение журнала local-in-deny-unicast. Варианты:
|
|
local_out string |
Включить/выключить ведение журнала local-out. Варианты:
|
|
local_out_ioc_detection string |
Включить/выключить обнаружение IoC трафика local-out. Требуется включение local-out. Варианты:
|
|
log_invalid_packet string |
Включить/отключить протоколирование некорректных пакетов трафика. Варианты:
|
|
log_policy_comment string |
Включить/отключить вставку комментариев к политике в журналы трафика. Варианты:
|
|
log_policy_name string |
Включить/отключить вставку имени политики в журналы трафика. Варианты:
|
|
log_user_in_upper string |
Включить/отключить протоколирование с именем пользователя в верхнем регистре. Варианты:
|
|
long_live_session_stat string |
Включить/отключить протоколирование статистики сессий с длительным временем жизни. Варианты:
|
|
neighbor_event string |
Включить/отключить протоколирование событий соседей. Варианты:
|
|
resolve_ip string |
Включить/отключить добавление разрешенных доменных имен в журналы трафика, если это возможно. Варианты:
|
|
resolve_port string |
Включить/отключить добавление разрешенных имён служб в журналы трафика. Варианты:
|
|
rest_api_get string |
Включить/отключить протоколирование запросов REST API GET. Варианты:
|
|
rest_api_set string |
Включить/отключить протоколирование запросов REST API POST/PUT/DELETE. Варианты:
|
|
syslog_override string |
Включить/отключить переопределение настроек Syslog. Варианты:
|
|
user_anonymize string |
Включить/отключить анонимизацию имён пользователей в сообщениях журнала. Варианты:
|
member_path string | Путь к атрибуту члена для работы. Разделяется с помощью символа косой черты, если атрибутов несколько. Параметр, помеченный как member_path, является допустимым для операций с членами. |
member_state string | Добавить или удалить члена по указанному пути к атрибуту. Когда задан member_state, опция state игнорируется. Варианты:
|
vdom string | Виртуальный домен, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Модуль fortiosapi устарел; рекомендуется использовать httpapi для выполнения playbooks.
Примеры
- 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"
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_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_set: "enable"
syslog_override: "enable"
user_anonymize: "enable"
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа Fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления контента в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate при последнем применённом действии Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успешно Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_setting_module.html