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

Примечание

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

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_locallog_syslogd_setting.

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

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation boolean	Устанавливать в значение True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без валидации параметров. Варианты: `false` ← (default) `true`
enable_log boolean	Включить/Выключить ведение журнала для задачи. Варианты: `false` ← (default) `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_syslogd_setting dictionary	Набор параметров верхнего уровня.
cert string	Выберите локальный сертификат, используемый для защищённого соединения.
csv string	Формат CSV. disable - Отключить формат CSV. enable - Включить формат CSV. Варианты: `"disable"` `"enable"`
facility string	Удаленный 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 string	Устарело, переименуйте в secure_connection. Включить/выключить соединение, защищённое 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 string	Устаревшее, переименуйте на syslog_name. Имя удаленного сервера syslog.
workspace_locking_adom string	Область управления (ADOM) для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Settings for remote syslog server.
      fortinet.fortimanager.fmgr_system_locallog_syslogd_setting:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        system_locallog_syslogd_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 словарь	Результат запроса. Возвращается: всегда
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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_locallog_syslogd_setting_module.html