Модуль fortinet.fortios.fortios_log_fortianalyzer_override_setting — переопределение настроек FortiAnalyzer в FortiOS и FortiGate от Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_log_fortianalyzer_override_setting.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию log_fortianalyzer и категорию override_setting. Примеры содержат все параметры и значения, которые перед использованием необходимо настроить в соответствии с источниками данных. Проверено с FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
log_fortianalyzer_override_setting dictionary | Переопределение настроек FortiAnalyzer. |
|
__change_ip integer |
Скрытый атрибут. |
|
access_config string |
Включить или отключить доступ FortiAnalyzer к конфигурации и данным. Варианты:
|
|
alt_server string |
Альтернативный FortiAnalyzer. |
|
certificate string |
Сертификат для связи с FortiAnalyzer. Источник: certificate.local.name. |
|
certificate_verification string |
Включить или отключить проверку подлинности FortiAnalyzer с помощью сертификата. Варианты:
|
|
conn_timeout integer |
Тайм-аут подключения к FortiAnalyzer в секундах (для состояния и буфера журналов). |
|
enc_algorithm string |
Настройка уровня защиты SSL для безопасной связи с FortiAnalyzer. Варианты:
|
|
fallback_to_primary string |
Включить или отключить переключение этого устройства FortiGate на основной FortiAnalyzer, когда он становится доступен. Варианты:
|
|
faz_type integer |
Скрытый индекс настройки FortiAnalyzer. |
|
hmac_algorithm string |
Алгоритм хеширования для входа в OFTP. Варианты:
|
|
interface string |
Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для подключения к серверу. Варианты:
|
|
ips_archive string |
Включить или отключить архивацию пакетов IPS в журнале. Варианты:
|
|
max_log_rate integer |
Максимальная скорость передачи журналов в FortiAnalyzer, МБ/с (0 = без ограничений). |
|
mgmt_name string |
Скрытое имя управления FortiAnalyzer. |
|
monitor_failure_retry_period integer |
Интервал между повторными попытками подключения к FortiAnalyzer, в секундах (для состояния и буфера журналов). |
|
monitor_keepalive_period integer |
Интервал между пакетами поддержания соединения OFTP, в секундах (для состояния и буфера журналов). |
|
override string |
Включить или отключить переопределение настроек FortiAnalyzer либо использовать глобальные настройки. Варианты:
|
|
string |
Предварительно заданный ключ для автоматической авторизации на FortiAnalyzer. |
|
priority string |
Задать приоритет передачи журналов. Варианты:
|
|
reliable string |
Включить или отключить надёжное ведение журналов в FortiAnalyzer. Варианты:
|
|
serial list / elements=dictionary |
Серийные номера FortiAnalyzer. |
|
name string / обязательный |
Серийный номер. |
|
server string |
Удалённый FortiAnalyzer. |
|
server_cert_ca string |
Обязательный центр сертификации на FortiGate в цепочке сертификатов сервера. Источники: certificate.ca.name, vpn.certificate.ca.name. |
|
source_ip string |
Исходный адрес IPv4 или IPv6 для связи с FortiAnalyzer. |
|
ssl_min_proto_version string |
Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты:
|
|
status string |
Включить или отключить ведение журналов в FortiAnalyzer. Варианты:
|
|
upload_day string |
День недели (месяца) для отправки журналов. |
|
upload_interval string |
Частота отправки файлов журналов в FortiAnalyzer. Варианты:
|
|
upload_option string |
Включить или отключить запись журналов на жёсткий диск с последующей отправкой в FortiAnalyzer. Варианты:
|
|
upload_time string |
Время отправки журналов (чч:мм). |
|
use_management_vdom string |
Включить или отключить использование IP-адреса управляющего VDOM в качестве исходного IP-адреса для журналов, отправляемых в FortiAnalyzer. Варианты:
|
|
vrf_select integer |
Идентификатор VRF, используемого для подключения к серверу. |
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
vdom string | Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Override FortiAnalyzer settings.
fortinet.fortios.fortios_log_fortianalyzer_override_setting:
vdom: "{{ vdom }}"
log_fortianalyzer_override_setting:
__change_ip: "127"
access_config: "enable"
alt_server: "<your_own_value>"
certificate: "<your_own_value> (source certificate.local.name)"
certificate_verification: "enable"
conn_timeout: "10"
enc_algorithm: "high-medium"
fallback_to_primary: "enable"
faz_type: "2147483647"
hmac_algorithm: "sha256"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
max_log_rate: "0"
mgmt_name: "<your_own_value>"
monitor_failure_retry_period: "5"
monitor_keepalive_period: "5"
override: "enable"
preshared_key: "<your_own_value>"
priority: "default"
reliable: "enable"
serial:
-
name: "default_name_25"
server: "192.168.100.40"
server_cert_ca: "<your_own_value> (source certificate.ca.name vpn.certificate.ca.name)"
source_ip: "84.230.14.43"
ssl_min_proto_version: "default"
status: "enable"
upload_day: "<your_own_value>"
upload_interval: "daily"
upload_option: "store-and-upload"
upload_time: "<your_own_value>"
use_management_vdom: "enable"
vrf_select: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate для последней выполненной операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_fortianalyzer_override_setting_module.html