Модуль fortinet.fortimanager.fmgr_system_locallog_syslogd2_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_syslogd2_setting.

Новое в fortinet.fortimanager 2.0.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить протоколирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия завершения неудачно.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия успешного завершения.
system_locallog_syslogd2_setting словарь	Параметры верхнего уровня, которые установлены.
cert строка	Выбор локального сертификата, используемого для безопасного подключения.
csv строка	Формат CSV. disable - Отключить формат CSV. enable - Включить формат CSV. Варианты: `"disable"` `"enable"`
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 строка	Включить/выключить надежное протоколирование в реальном времени. disable - Отключить надежное протоколирование в реальном времени. enable - Включить надежное протоколирование в реальном времени. Варианты: `"disable"` `"enable"`
secure-connection строка	Устарело, пожалуйста, переименуйте на secure_connection. Включить/выключить подключение, защищенное протоколами TLS/SSL. disable - Отключить SSL подключение. enable - Включить SSL подключение. Варианты: `"disable"` `"enable"`
severity строка	Наименьший уровень серьезности для протоколирования. emergency - Уровень чрезвычайной ситуации. alert - Уровень тревоги. critical - Критический уровень. error - Уровень ошибки. warning - Уровень предупреждения. notification - Уведомление. information - Информационный уровень. debug - Уровень отладки. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status строка	Журнал удаленного syslog. disable - Не протоколировать на сервер удаленного syslog. enable - Протоколировать на сервер удаленного syslog. Варианты: `"disable"` `"enable"`

END_OF_DOCUMENT_MARKER

syslog-name строка	Устаревшее имя, пожалуйста, переименуйте на syslog_name. Имя удаленного сервера syslog.
workspace_locking_adom строка	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным или другим, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют соглашение об именовании с использованием символа подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается режим блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевой код возврата. Вы также можете переопределить условия для завершения выполнения с ошибкой или успехом с помощью параметров 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_syslogd2_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_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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_syslogd2_setting_module.html