Модуль fortinet.fortios.fortios_log_syslogd_setting — Глобальные настройки удаленного сервера syslog в FortiOS и FortiGate Fortinet.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook укажите: fortinet.fortios.fortios_log_syslogd_setting.

Добавлена в fortinet.fortios 2.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Требования

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

ansible>=2.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.
enable_log булево	Включить/выключить протоколирование задачи. Выбооры: `false` ← (по умолчанию) `true`
log_syslogd_setting словарь	Глобальные настройки удаленного сервера syslog.
certificate строка	Сертификат, используемый для связи с сервером Syslog. Исходный сертификат.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"`
port целое число	Порт прослушивания сервера.
priority строка	Установить приоритет передачи журнала. Выбооры: `"default"` `"low"`
server строка	Адрес удаленного сервера syslog.
source_ip строка	IP-адрес источника syslog.
ssl_min_proto_version строка	Минимальная поддерживаемая версия протокола для подключений 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 — это виртуальная инстанция FortiGate, которая может настраиваться и использоваться как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Модуль fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks

Примеры

- name: Global settings for remote syslog server.
  fortinet.fortios.fortios_log_syslogd_setting:
      vdom: "{{ vdom }}"
      log_syslogd_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"
          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	Главный ключ (идентификатор), используемый в последнем вызове 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_syslogd_setting_module.html