fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog модуль — Настройка регистрации FortiSwitch устройства на удаленном сервере syslog.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog.
Новая функция в fortinet.fortimanager 2.1.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить для источников данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в значение True только в случае расхождения схемы модуля со структурой API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/выключить логирование для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
managed-switch строка | Устарело, используйте “managed_switch” |
managed_switch строка | Параметр (managed-switch) в запрошенном URL. |
proposed_method строка | Переопределенный метод для подлежащего запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут игнорироваться. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут игнорироваться. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
switchcontroller_managedswitch_remotelog словарь | Установленные параметры верхнего уровня. |
|
csv строка |
Включить/выключить разделитель запятыми. Варианты:
|
|
facility строка |
Утилита для записи в удаленный сервер syslog. Варианты:
|
|
name строка / обязательно |
Имя удаленного лога. |
|
port целое число |
Порт прослушивания удаленного сервера syslog. |
|
server строка |
IPv4-адрес удаленного сервера syslog. |
|
severity строка |
Уровень важности логов, которые будут переданы на удаленный сервер логов. Варианты:
|
|
status string |
Включить/выключить протоколирование устройства FortiSwitch на удалённый сервер syslog. Варианты:
|
workspace_locking_adom string | ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая 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 помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться ошибкой, если возвращается ненулевой 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: Configure logging by FortiSwitch device to a remote syslog server.
fortinet.fortimanager.fmgr_switchcontroller_managedswitch_remotelog:
# 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, ...]
adom: <your own value>
managed_switch: <your own value>
state: present # <value in [present, absent]>
switchcontroller_managedswitch_remotelog:
csv: <value in [disable, enable]>
facility: <value in [kernel, user, mail, ...]>
name: <string>
port: <integer>
server: <string>
severity: <value in [emergency, alert, critical, ...]>
status: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API-запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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_switchcontroller_managedswitch_remotelog_module.html
