Модуль fortinet.fortimanager.fmgr_devprof_log_syslogd_setting — глобальные настройки удалённого сервера syslog.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_devprof_log_syslogd_setting.

Добавлено в fortinet.fortimanager 1.0.0

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

Обзор

Этот модуль позволяет настраивать устройство FortiManager.
Примеры содержат все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
devprof string / обязательный	Параметр (devprof) в запрошенном URL.
devprof_log_syslogd_setting dictionary	Набор параметров верхнего уровня.
certificate string	Сертификат для связи с сервером Syslog.
csv string	Включение/отключение форматирования журналов в формате CSV. Варианты: `"disable"` `"enable"`
custom_field_name псевдонимы: custom-field-name list / элементы=dictionary	Имя пользовательского поля.
custom string	Пользовательское имя поля.
id integer	Идентификатор записи.
name string	Имя поля.
enc_algorithm псевдонимы: enc-algorithm string	Включение/отключение надёжной отправки системных журналов с шифрованием TLS. Варианты: `"high"` `"low"` `"disable"` `"high-medium"`
facility string	Категория удалённого 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 string	Формат журнала. Варианты: `"default"` `"csv"` `"cef"` `"rfc5424"` `"json"` `"custom"`
interface string	Укажите исходящий интерфейс для связи с сервером.
interface_select_method псевдонимы: interface-select-method string	Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты: `"auto"` `"sdwan"` `"specify"`
log_templates псевдонимы: log-templates list / элементы=dictionary	Шаблоны журналов.
category string	Категория. Варианты: `"app-ctrl"` `"attack"` `"dlp"` `"event"` `"traffic"` `"virus"` `"voip"` `"webfilter"` `"spam"` `"anomaly"` `"waf"` `"dns"` `"ssh"` `"ssl"` `"file-filter"` `"icap"` `"virtual-patch"`
empty_value_indicator псевдонимы: empty-value-indicator string	Индикатор пустого значения.
id integer	Идентификатор.
template string	Шаблон.
max_log_rate псевдонимы: max-log-rate integer	Максимальная скорость передачи журналов Syslog в МБ/с
mode string	Передача журналов на удалённый сервер syslog по UDP/надёжному TCP. Варианты: `"udp"` `"legacy-reliable"` `"reliable"`
port integer	Порт, на котором сервер ожидает подключения.
priority string	Установите приоритет передачи журналов. Варианты: `"low"` `"default"`
reliable string	Включение/отключение надёжной отправки журналов Варианты: `"disable"` `"enable"`
server string	Адрес удалённого сервера syslog.
source_ip псевдонимы: source-ip string	Исходный IP-адрес syslog.
source_ip_interface псевдонимы: source-ip-interface any	(список) Исходный интерфейс syslog.
ssl_min_proto_version псевдонимы: ssl-min-proto-version string	Минимальная поддерживаемая версия протокола для соединений SSL/TLS Варианты: `"default"` `"TLSv1-1"` `"TLSv1-2"` `"SSLv3"` `"TLSv1"` `"TLSv1-3"`
status string	Включение/отключение ведения журналов на удалённом сервере syslog. Варианты: `"disable"` `"enable"`
syslog_type псевдонимы: syslog-type integer	Тип syslog.
vrf_select псевдонимы: vrf-select integer	Идентификатор VRF, используемый для подключения к серверу.
enable_log boolean	Включение/отключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другое значение, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов соответствуют соглашению об использовании подчёркиваний (snake_case). Замените аргументы вида «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании выводятся предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия успешного или неуспешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Global settings for remote syslog server.
      fortinet.fortimanager.fmgr_devprof_log_syslogd_setting:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        devprof: <your own value>
        devprof_log_syslogd_setting:
          # certificate: <string>
          # enc_algorithm: <value in [high, low, disable, ...]>
          # facility: <value in [kernel, user, mail, ...]>
          # mode: <value in [udp, legacy-reliable, reliable]>
          # port: <integer>
          # server: <string>
          # ssl_min_proto_version: <value in [default, TLSv1-1, TLSv1-2, ...]>
          # status: <value in [disable, enable]>
          # reliable: <value in [disable, enable]>
          # csv: <value in [disable, enable]>
          # max_log_rate: <integer>
          # priority: <value in [low, default]>
          # interface: <string>
          # interface_select_method: <value in [auto, sdwan, specify]>
          # format: <value in [default, csv, cef, ...]>
          # syslog_type: <integer>
          # custom_field_name:
          #   - custom: <string>
          #     id: <integer>
          #     name: <string>
          # source_ip: <string>
          # source_ip_interface: <list or string>
          # vrf_select: <integer>
          # log_templates:
          #   - category: <value in [app-ctrl, attack, dlp, ...]>
          #     empty_value_indicator: <string>
          #     id: <integer>
          #     template: <string>

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

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

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_devprof_log_syslogd_setting_module.html