fortios_log_setting – Настройка общих параметров журналов в Fortinet FortiOS и FortiGate
Новая версия 2.8.
Обзор
- Этот модуль позволяет настроить FortiGate или FortiOS, позволяя пользователю устанавливать и изменять параметры и категории функций ведения журналов. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Проверено с FOS v6.0.2
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| host - / обязательно | IP-адрес FortiOS или FortiGate. | |||
| https boolean |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | ||
| log_setting - | Значение по умолчанию: null | Настройка общих параметров ведения журнала. | ||
| brief-traffic-format - |
| Включить/выключить протоколирование трафика в кратком формате. | ||
| custom-log-fields - | Пользовательские поля для добавления во все сообщения журнала. | |||
| field-id - / обязательно | Пользовательское поле журнала. Источник журнала.custom-field.id. | |||
| daemon-log - |
| Включить/выключить ведение журнала демона. | ||
| expolicy-implicit-log - |
| Включить/выключить ведение журнала явного политики прокси-брандмауэра. | ||
| fwpolicy-implicit-log - |
| Включить/выключить ведение журнала неявной политики брандмауэра. | ||
| fwpolicy6-implicit-log - |
| Включить/выключить ведение журнала неявной политики брандмауэра IPv6. | ||
| 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 - |
| Включить/выключить анонимизацию имен пользователей в сообщениях журнала. | ||
| password - | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | ||
| username - / обязательно | Имя пользователя FortiOS или FortiGate. | |||
| vdom - | Значение по умолчанию: "root" | Виртуальный домен, среди ранее определенных. Vdom — виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. | ||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Запускается как local_action в вашем playbook
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure general log settings.
fortios_log_setting:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
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 строка | всегда | Указание результата операции Пример: success |
| vdom строка | всегда | Используемый виртуальный домен Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/fortios_log_setting_module.html