fortinet.fortimanager.fmgr_fmupdate_avips_webproxy – Настройка веб-прокси для использования с обновлениями FortiGuard антивируса и IPS.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_fmupdate_avips_webproxy.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль способен настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| bypass_validation boolean |
| устанавливается в True только при несовпадении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров | |
| fmupdate_avips_webproxy словарь | устанавливаемые параметры верхнего уровня | ||
| ip строка | По умолчанию: "0.0.0.0" | IPv4 адрес веб-прокси. | |
| ip6 строка | По умолчанию: "::" | IPv6 адрес веб-прокси. | |
| mode строка |
| Режим веб-прокси: прокси - http-прокси, туннель - http-туннель (по умолчанию = прокси). прокси - HTTP прокси. туннель - HTTP туннель. | |
| password строка | нет описания | ||
| port целое число | По умолчанию: 80 | Порт веб-прокси (1 - 65535, по умолчанию = 80). | |
| status строка |
| Включение/выключение подключений через веб-прокси (по умолчанию = выключено). выключено - Выключение параметра. включено - Включение параметра. | |
| username строка | Имя пользователя, используемое для аутентификации. | ||
| rc_failed список / элементы=строка | список rc кодов, при которых условия будут нарушены | ||
| rc_succeeded список / элементы=строка | список rc кодов, при которых условия будут выполнены | ||
| state строка / обязательно |
| направление создания, обновления или удаления объекта | |
| 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: Configure the web proxy for use with FortiGuard antivirus and IPS updates.
fmgr_fmupdate_avips_webproxy:
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, ...]
fmupdate_avips_webproxy:
ip: <value of string>
ip6: <value of string>
mode: <value in [proxy, tunnel]>
password: <value of string>
port: <value of integer>
status: <value in [disable, enable]>
username: <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_fmupdate_avips_webproxy_module.html