Модуль fortinet.fortios.fortios_log_syslogd2_override_setting – Настройка параметров удаленного сервера syslog в 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_syslogd2_override_setting.

Впервые в fortinet.fortios 2.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию log_syslogd2 и категорию override_setting. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировался на FOS v6.0.0

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

ansible>=2.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate.
enable_log булево	Включить/выключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
log_syslogd2_override_setting словарь	Переопределение настроек удаленного сервера syslog.
certificate строка	Сертификат, используемый для связи с сервером Syslog. Источник сертификата certificate.local.name.
custom_field_name список / элементы=словарь	Наименование пользовательского поля для протоколирования в формате CEF.
custom строка	Пользовательское имя поля [A-Za-z0-9_].
id целое число / обязательно	Идентификатор записи. См. <a href=’#notes’>Примечания</a>.
name строка	Имя поля [A-Za-z0-9_].
enc_algorithm строка	Включить/выключить надежное syslogging с шифрованием TLS. Варианты: `"high-medium"` `"high"` `"low"` `"disable"`
facility строка	Утилита удаленного syslog. Варианты: `"kernel"` `"user"` `"mail"` `"daemon"` `"auth"` `"syslog"` `"lpr"` `"news"` `"uucp"` `"cron"` `"authpriv"` `"ftp"` `"ntp"` `"audit"` `"alert"` `"clock"` `"local0"` `"local1"` `"local2"` `"local3"` `"local4"` `"local5"` `"local6"` `"local7"`
format строка	Формат лога. Варианты: `"default"` `"csv"` `"cef"` `"rfc5424"` `"json"`
interface строка	Укажите исходящий интерфейс для достижения сервера. Источник системы.interface.name.
interface_select_method строка	Укажите способ выбора исходящего интерфейса для достижения сервера. Варианты: `"auto"` `"sdwan"` `"specify"`
max_log_rate целое число	Максимальная скорость syslog в Мбит/с (0 = без ограничений).
mode строка	Протоколирование удаленного syslog по UDP/надежному TCP. Варианты: `"udp"` `"legacy-reliable"` `"reliable"`
override строка	Включить/выключить переопределение настроек syslog. Варианты: `"enable"` `"disable"`
port целое число	Порт прослушивания сервера.
priority строка	Установите приоритет передачи логов. Варианты: `"default"` `"low"`
server строка	Адрес удаленного сервера syslog.

END_OF_DOCUMENT_MARKER

source_ip string	IP-адрес источника syslog.
ssl_min_proto_version string	Минимальная поддерживаемая версия протокола для SSL/TLS-соединений. Варианты: `"default"` `"SSLv3"` `"TLSv1"` `"TLSv1-1"` `"TLSv1-2"` `"TLSv1-3"`
status string	Включить/отключить удаленный syslog-логгинг. Варианты: `"enable"` `"disable"`
syslog_type integer	Скрытый индекс настройки Syslog.
member_path string	Путь к атрибуту члена для обработки. Разделен символом косой черты, если атрибутов несколько. Параметр, помеченный member_path, является допустимым для выполнения операции с членом.
member_state string	Добавить или удалить члена по указанному пути к атрибуту. Когда member_state указан, опция state игнорируется. Варианты: `"present"` `"absent"`
vdom string	Виртуальная область (VDOM) из ранее определенных. VDOM — виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельное устройство. Значение по умолчанию: `"root"`

Примечания

Примечание

Устаревший модуль fortiosapi больше не поддерживается, httpapi — предпочтительный способ выполнения playbook.

Примеры

- name: Override settings for remote syslog server.
  fortinet.fortios.fortios_log_syslogd2_override_setting:
      vdom: "{{ vdom }}"
      log_syslogd2_override_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"
          override: "enable"
          port: "514"
          priority: "default"
          server: "192.168.100.40"
          source_ip: "84.230.14.43"
          ssl_min_proto_version: "default"
          status: "enable"
          syslog_type: "2147483647"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для подготовки контента в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат, полученный от FortiGate при последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey string	Главный ключ (id), использованный в последнем вызове FortiGate Возвращается: успешно Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Указание результата операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_log_syslogd2_override_setting_module.html