fortinet.fortios.fortios_log_setting – Настройка общих параметров ведения журнала в Fortinet FortiOS и FortiGate.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в книге задач укажите: fortinet.fortios.fortios_log_setting.
Добавлена в версии 2.8: of fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю настраивать и изменять параметры ведения журнала и категорий настроек. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| access_token строка | Аутентификация на основе токенов. Создается в веб-интерфейсе Fortigate. | |||
| log_setting словарь | Настройка общих параметров ведения журнала. | |||
| brief_traffic_format строка |
| Включение/выключение краткого формата ведения журнала трафика. | ||
| custom_log_fields список / элементы=строка | Пользовательские поля, которые добавляются ко всем сообщениям журнала. | |||
| field_id строка | Пользовательское поле журнала. Источник журнала.custom-field.id. | |||
| daemon_log строка |
| Включение/выключение ведения журнала демона. | ||
| expolicy_implicit_log строка |
| Включение/выключение ведения журнала неявной политики явного прокси-брандмауэра. | ||
| fwpolicy6_implicit_log строка |
| Включение/выключение ведения журнала неявной политики брандмауэра версии 6. | ||
| fwpolicy_implicit_log строка |
| Включение/выключение ведения журнала неявной политики брандмауэра. | ||
| local_in_allow строка |
| Включение/выключение ведения журнала local-in-allow. | ||
| local_in_deny_broadcast строка |
| Включение/выключение ведения журнала local-in-deny-broadcast. | ||
| local_in_deny_unicast строка |
| Включение/выключение ведения журнала local-in-deny-unicast. | ||
| local_out строка |
| Включение/выключение ведения журнала local-out. | ||
| log_invalid_packet строка |
| Включение/выключение ведения журнала некорректных пакетов трафика. | ||
| log_policy_comment строка |
| Включение/выключение вставки комментариев политики в журналы трафика. | ||
| log_policy_name строка |
| Включение/выключение вставки имени политики в журналы трафика. | ||
| log_user_in_upper строка |
| Включение/выключение ведения журнала с user-in-upper. | ||
| neighbor_event строка |
| Включение/выключение ведения журнала событий соседства. | ||
| resolve_ip строка |
| Включение/выключение добавления разрешенных доменных имен в журналы трафика, если это возможно. | ||
| resolve_port строка |
| Включение/выключение добавления разрешенных имен служб в журналы трафика. | ||
| user_anonymize строка |
| Включение/выключение анонимизации имен пользователей в сообщениях журнала. | ||
| vdom строка | По умолчанию: "root" | Виртуальный домен, из ранее определенных. Vdom — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. | ||
Примечания
Примечание
- Устаревший fortiosapi устарел, httpapi — предпочтительный способ запуска книг задач
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure general log settings.
fortios_log_setting:
vdom: "{{ vdom }}"
log_setting:
brief_traffic_format: "enable"
custom_log_fields:
-
field_id: "<your_own_value> (source log.custom-field.id)"
daemon_log: "enable"
expolicy_implicit_log: "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"
log_invalid_packet: "enable"
log_policy_comment: "enable"
log_policy_name: "enable"
log_user_in_upper: "enable"
neighbor_event: "enable"
resolve_ip: "enable"
resolve_port: "enable"
user_anonymize: "enable"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 |
Авторы
- 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_log_setting_module.html