Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_log_syslogd2_override_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_override_setting.

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • ansible>=2.16

Параметры

Параметр

Комментарии

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

строка

Включить или отключить надёжную передачу сообщений syslog с шифрованием TLS.

Варианты:

  • "high-medium"
  • "high"
  • "low"
  • "disable"

facility

строка

Категория 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

строка

Укажите исходящий интерфейс для связи с сервером. Источник: system.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.

source_ip

строка

Исходный IP-адрес syslog.

source_ip_interface

строка

Исходный интерфейс syslog. Источник: system.interface.name.

ssl_min_proto_version

строка

Минимальная поддерживаемая версия протокола для подключений SSL/TLS.

Варианты:

  • "default"
  • "SSLv3"
  • "TLSv1"
  • "TLSv1-1"
  • "TLSv1-2"
  • "TLSv1-3"

status

строка

Включить или отключить ведение журналов на удалённом сервере syslog.

Варианты:

  • "enable"
  • "disable"

syslog_type

целое число

Индекс скрытой настройки Syslog.

use_management_vdom

строка

Включить или отключить использование управляющего VDOM в качестве исходного VDOM для журналов, отправляемых на сервер syslog.

Варианты:

  • "enable"
  • "disable"

vrf_select

целое число

Идентификатор VRF, используемый для подключения к серверу.

member_path

строка

Путь к атрибуту элемента, над которым нужно выполнить операцию.

Если атрибутов несколько, разделяйте их косой чертой.

Параметр с атрибутом member_path можно использовать для выполнения операции с элементом.

member_state

строка

Добавить или удалить элемент в указанном пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

vdom

строка

Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- 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"
          source_ip_interface: "<your_own_value> (source system.interface.name)"
          ssl_min_proto_version: "default"
          status: "enable"
          syslog_type: "2147483647"
          use_management_vdom: "enable"
          vrf_select: "0"

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

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

Ключ

Описание

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"

Авторы

  • 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–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_override_setting_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API