модуль fortinet.fortimanager.fmgr_system_syslog — Серверы Syslog.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_syslog.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры содержат все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия, при которых выполнение считается успешным. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Варианты:
|
system_syslog dictionary | Набор параметров верхнего уровня. |
|
ip string |
IP-адрес или имя хоста сервера Syslog. |
|
local_cert псевдонимы: local-cert string |
Выберите локальный сертификат, используемый для защищённого соединения. |
|
name string / обязательный |
Имя сервера Syslog. |
|
peer_cert_cn псевдонимы: peer-cert-cn string |
Общее имя сертификата сервера Syslog. |
|
port integer |
Порт сервера Syslog. |
|
reliable string |
Включить или отключить надёжное соединение с сервером Syslog. disable — отключить надёжное соединение с сервером Syslog. enable — включить надёжное соединение с сервером Syslog. Варианты:
|
|
secure_connection псевдонимы: secure-connection string |
Включить или отключить соединение, защищённое TLS/SSL. disable — отключить соединение SSL. enable — включить соединение SSL. Варианты:
|
|
ssl_protocol псевдонимы: ssl-protocol string |
Установить минимальную версию протокола SSL для соединения с сервером Syslog. follow-global-ssl-protocol — использовать системные настройки. sslv3 — установить SSLv3 в качестве минимальной версии. tlsv1. tlsv1. tlsv1. tlsv1. Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Syslog servers.
fortinet.fortimanager.fmgr_system_syslog:
# workspace_locking_adom: <global or your adom name>
state: present # <value in [present, absent]>
system_syslog:
name: "your value" # Required variable, string
# ip: <string>
# port: <integer>
# local_cert: <string>
# peer_cert_cn: <string>
# reliable: <value in [disable, enable]>
# secure_connection: <value in [disable, enable]>
# ssl_protocol: <value in [follow-global-ssl-protocol, sslv3, tlsv1.0, ...]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: при соответствующих условиях |
Ссылки на коллекцию
© 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_syslog_module.html
