модуль fortinet.fortios.fortios_switch_controller_remote_log — Настройка ведения журналов устройством FortiSwitch на удалённом сервере 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_switch_controller_remote_log.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для выполнения операции над элементом.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, нужно ли создать или удалить объект. Варианты: `"present"` `"absent"`
switch_controller_remote_log словарь	Настройка ведения журналов устройством FortiSwitch на удалённом сервере syslog.
csv строка	Включить или отключить строки в формате CSV (значения, разделённые запятыми). Варианты: `"enable"` `"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"`
name строка / обязательный	Имя удалённого журнала.
port целое число	Порт удалённого сервера syslog, на котором он принимает подключения.
server строка	IPv4-адрес удалённого сервера syslog.
severity строка	Уровень важности журналов, передаваемых на удалённый сервер журналов. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status строка	Включить или отключить ведение журналов устройством FortiSwitch на удалённом сервере syslog. Варианты: `"enable"` `"disable"`
vdom строка	Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure logging by FortiSwitch device to a remote syslog server.
  fortinet.fortios.fortios_switch_controller_remote_log:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      switch_controller_remote_log:
          csv: "enable"
          facility: "kernel"
          name: "default_name_5"
          port: "514"
          server: "192.168.100.40"
          severity: "emergency"
          status: "enable"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращённый FortiGate после последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем вызове 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_switch_controller_remote_log_module.html