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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

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

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

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия неудачного выполнения.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_locallog_syslogd2_setting dictionary	Параметры верхнего уровня.
cert string	Выберите локальный сертификат, используемый для защищённого соединения.
csv string	Формат CSV. disable — отключить формат CSV. enable — включить формат CSV. Варианты: `"disable"` `"enable"`
facility string	Facility удалённого syslog. kernel — сообщения ядра. user — случайные сообщения пользовательского уровня. ntp — служба NTP. audit — журнал аудита. alert — журнал предупреждений. clock — служба времени. mail — почтовая система. daemon — системные службы. auth — сообщения безопасности и авторизации. syslog — сообщения, сформированные непосредственно службой syslog. lpr — подсистема линейной печати. news — подсистема сетевых новостей. uucp — подсистема сетевых новостей. cron — служба времени. authpriv — сообщения безопасности и авторизации ftp — служба FTP. local0 — зарезервировано для локального использования. local1 — зарезервировано для локального использования. local2 — зарезервировано для локального использования. local3 — зарезервировано для локального использования. local4 — зарезервировано для локального использования. local5 — зарезервировано для локального использования. local6 — зарезервировано для локального использования. local7 — зарезервировано для локального использования. Варианты: `"kernel"` `"user"` `"ntp"` `"audit"` `"alert"` `"clock"` `"mail"` `"daemon"` `"auth"` `"syslog"` `"lpr"` `"news"` `"uucp"` `"cron"` `"authpriv"` `"ftp"` `"local0"` `"local1"` `"local2"` `"local3"` `"local4"` `"local5"` `"local6"` `"local7"`
reliable string	Включить или отключить надёжное ведение журналов в реальном времени. disable — отключить надёжное ведение журналов в реальном времени. enable — включить надёжное ведение журналов в реальном времени. Варианты: `"disable"` `"enable"`
secure_connection псевдонимы: secure-connection string	Включить или отключить соединение, защищённое TLS/SSL. disable — отключить SSL-соединение. enable — включить SSL-соединение. Варианты: `"disable"` `"enable"`
severity string	Минимальный уровень важности для регистрации. emergency — аварийный уровень. alert — уровень предупреждения. critical — критический уровень. error — уровень ошибки. warning — уровень предупреждения. notification — уровень уведомления. information — информационный уровень. debug — уровень отладки. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status string	Ведение журнала удалённого syslog. disable — не вести журнал на удалённом сервере syslog. enable — вести журнал на удалённом сервере syslog. Варианты: `"disable"` `"enable"`
syslog_name псевдонимы: syslog-name string	Имя удалённого сервера syslog.
workspace_locking_adom string	ADOM для блокировки в FortiManager, работающем в режиме рабочей области. Значением может быть global или другой ADOM, включая 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: Settings for remote syslog server.
      fortinet.fortimanager.fmgr_system_locallog_syslogd2_setting:
        # workspace_locking_adom: <global or your adom name>
        system_locallog_syslogd2_setting:
          # csv: <value in [disable, enable]>
          # facility: <value in [kernel, user, ntp, ...]>
          # severity: <value in [emergency, alert, critical, ...]>
          # status: <value in [disable, enable]>
          # syslog_name: <string>
          # cert: <string>
          # reliable: <value in [disable, enable]>
          # secure_connection: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_system_locallog_syslogd2_setting_module.html