fortinet.fortimanager.fmgr_system_syslog – Серверы Syslog.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_system_syslog.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation логическое значение |
| устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых условия завершения с ошибкой будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия завершения с успехом будут переопределены | ||
| state строка / обязательный |
| инструкция по созданию, обновлению или удалению объекта | |
| system_syslog словарь | установленные параметры верхнего уровня | ||
| ip строка | IP-адрес или имя хоста сервера Syslog. | ||
| name строка | Имя сервера Syslog. | ||
| port целое число | Значение по умолчанию: 514 | Порт сервера Syslog. | |
| workspace_locking_adom строка | область (adom), которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным или другим, включая корневое. | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем | |
Примечания
Примечание
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте инструкцию state present.
- Для удаления объекта используйте инструкцию state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается код rc отличной от нуля. Параметры rc_failed и rc_succeeded позволяют переопределить условия завершения с ошибкой или успехом.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Syslog servers.
fmgr_system_syslog:
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, ...]
state: <value in [present, absent]>
system_syslog:
ip: <value of string>
name: <value of string>
port: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны в этом разделе, а следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | статус запроса API |
| response_message строка | всегда | описательное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_system_syslog_module.html
