fortinet.fortimanager.fmgr_icap_server – Настройка серверов ICAP.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_icap_server.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только в случае расхождений между структурой схемы модуля и структурой API FortiManager; модуль продолжает выполнение без проверки параметров | |
| icap_server словарь | устанавливаемые параметры верхнего уровня | ||
| ip-address строка | IPv4-адрес сервера ICAP. | ||
| ip-version строка |
| Версия IP. | |
| ip6-address строка | IPv6-адрес сервера ICAP. | ||
| max-connections целое число | Максимальное количество одновременных подключений к серверу ICAP. | ||
| name строка | Имя сервера. | ||
| port целое число | Порт сервера ICAP. | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия будут игнорироваться | ||
| state строка / обязательно |
| директива создания, обновления или удаления объекта | |
| workspace_locking_adom строка | домен для блокировки в режиме работы FortiManager в пространстве рабочих мест, может принимать значение global и другие, включая root | ||
| 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: Configure ICAP servers.
fmgr_icap_server:
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>
state: <value in [present, absent]>
icap_server:
ip-address: <value of string>
ip-version: <value in [4, 6]>
ip6-address: <value of string>
max-connections: <value of integer>
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_icap_server_module.html
