Модуль fortinet.fortios.fortios_log_syslogd2_setting — глобальные настройки удалённого сервера syslog в 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_syslogd2_setting.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию log_syslogd2 и категорию настроек. Перед использованием необходимо настроить все параметры и значения в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, необходимы следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate. |
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
log_syslogd2_setting dictionary | Глобальные настройки удалённого сервера syslog. |
|
certificate string |
Сертификат для связи с сервером Syslog. Источник: certificate.local.name. |
|
custom_field_name list / элементы=dictionary |
Имя пользовательского поля для журналов в формате CEF. |
|
custom string |
Пользовательское имя поля [A-Za-z0-9_]. |
|
id integer / обязательный |
Идентификатор записи. См. <a href=’#notes’>Примечания</a>. |
|
name string |
Имя поля [A-Za-z0-9_]. |
|
enc_algorithm string |
Включить/отключить надёжную передачу журналов syslog с шифрованием TLS. Варианты:
|
|
facility string |
Функция удалённого syslog. Варианты:
|
|
format string |
Формат журнала. Варианты:
|
|
interface string |
Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты:
|
|
max_log_rate integer |
Максимальная скорость передачи журналов Syslog в МБ/с (0 = без ограничений). |
|
mode string |
Передача журналов на удалённый сервер syslog по UDP/надёжному TCP. Варианты:
|
|
port integer |
Порт, на котором сервер ожидает подключений. |
|
priority string |
Задаёт приоритет передачи журналов. Варианты:
|
|
server string |
Адрес удалённого сервера syslog. |
|
source_ip string |
IP-адрес источника Syslog. |
|
source_ip_interface string |
Исходный интерфейс Syslog. Источник: system.interface.name. |
|
ssl_min_proto_version string |
Минимальная поддерживаемая версия протокола для соединений SSL/TLS. Варианты:
|
|
status string |
Включить/отключить ведение журналов на удалённом сервере syslog. Варианты:
|
|
syslog_type integer |
Скрытый индекс настройки Syslog. |
|
vrf_select integer |
Идентификатор VRF, используемый для подключения к серверу. |
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path допускает выполнение операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан member_state, параметр state игнорируется. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Global settings for remote syslog server.
fortinet.fortios.fortios_log_syslogd2_setting:
vdom: "{{ vdom }}"
log_syslogd2_setting:
certificate: "<your_own_value> (source certificate.local.name)"
custom_field_name:
-
custom: "<your_own_value>"
id: "6"
name: "default_name_7"
enc_algorithm: "high-medium"
facility: "kernel"
format: "default"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
max_log_rate: "0"
mode: "udp"
port: "514"
priority: "default"
server: "192.168.100.40"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
ssl_min_proto_version: "default"
status: "enable"
syslog_type: "2147483647"
vrf_select: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (id), использованный при последнем вызове 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_syslogd2_setting_module.html
