fortinet.fortimanager.fmgr_devprof_system_replacemsg_admin – Сообщения замены.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_devprof_system_replacemsg_admin
Добавлен в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, используя источники данных, перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только в том случае, если структура схемы модуля отличается от структуры API FortiManager. В таком случае выполнение модуля продолжается без проверки параметров | |
| devprof строка / обязательный | параметр (devprof) в запрошенном URL | ||
| devprof_system_replacemsg_admin словарь | устанавливаемые параметры верхнего уровня | ||
| buffer строка | Строка сообщения. | ||
| format строка |
| Флаг формата. | |
| header строка |
| Флаг заголовка. | |
| msg-type строка | Тип сообщения. | ||
| rc_failed список / элементы=строка | Список кодов rc, при которых условия будут считаться выполненными с ошибкой. | ||
| rc_succeeded список / элементы=строка | Список кодов rc, при которых условия будут считаться выполненными успешно. | ||
| state строка / обязательный |
| Директива для создания, обновления или удаления объекта. | |
| workspace_locking_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: Replacement messages.
fmgr_devprof_system_replacemsg_admin:
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>
devprof: <your own value>
devprof_system_replacemsg_admin:
buffer: <value of string>
format: <value in [none, text, html, ...]>
header: <value in [none, http, 8bit]>
msg-type: <value of string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_devprof_system_replacemsg_admin_module.html
