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

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

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

Описание

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

Требования

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

ansible>=2.15

Параметры

Параметр	Комментарии
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 строка	IP-адрес удалённого сервера syslog.
severity строка	Уровень важности логов, которые будут переданы на удалённый сервер. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status строка	Включить/выключить логирование устройства FortiSwitch на удалённый сервер syslog. Варианты: `"enable"` `"disable"`
vdom строка	Виртуальная область, из ранее определённых. VDOM — виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Устаревшее fortiosapi было снято с поддержки, httpapi является предпочтительным способом запуска playbooks
Модуль поддерживает 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 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_switch_controller_remote_log_module.html