fortinet.fortimanager.fmgr_vap_portalmessageoverrides – Индивидуальные переопределения сообщений.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_vap_portalmessageoverrides.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| rc_failed список / элементы=строка | список кодов rc, при которых будут игнорироваться условия для неудачи | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых будут игнорироваться условия для успеха | ||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | |
| vap строка / обязательно | параметр (vap) в запрошенном URL | ||
| vap_portalmessageoverrides словарь | установленные параметры верхнего уровня | ||
| auth-disclaimer-page строка | Переопределяет сообщение auth-disclaimer-page сообщением из группы portal-message-overrides. | ||
| auth-login-failed-page строка | Переопределяет сообщение auth-login-failed-page сообщением из группы portal-message-overrides. | ||
| auth-login-page строка | Переопределяет сообщение auth-login-page сообщением из группы portal-message-overrides. | ||
| auth-reject-page строка | Переопределяет сообщение auth-reject-page сообщением из группы portal-message-overrides. | ||
| 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: Individual message overrides.
fmgr_vap_portalmessageoverrides:
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>
vap: <your own value>
vap_portalmessageoverrides:
auth-disclaimer-page: <value of string>
auth-login-failed-page: <value of string>
auth-login-page: <value of string>
auth-reject-page: <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_vap_portalmessageoverrides_module.html
