fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability – Настройка возможности подключения.
Примечание
Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability.
Новое в версии 2.10: of fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только при различиях между схемой модуля и структурой API FortiManager. Модуль продолжает выполнение без проверки параметров | |
| hotspot20_h2qpconncapability словарь | настройка верхнего уровня | ||
| esp-port строка |
| Устанавливает состояние службы порта ESP (используется IPsec VPN). | |
| ftp-port строка |
| Устанавливает состояние службы порта FTP. | |
| http-port строка |
| Устанавливает состояние службы порта HTTP. | |
| icmp-port строка |
| Устанавливает состояние службы порта ICMP. | |
| ikev2-port строка |
| Устанавливает состояние службы порта IKEv2 для IPsec VPN. | |
| ikev2-xx-port строка |
| Устанавливает состояние службы UDP порта 4500 (который может использоваться IKEv2 для IPsec VPN). | |
| name строка | Имя возможности подключения. | ||
| pptp-vpn-port строка |
| Устанавливает состояние службы порта PPTP VPN. | |
| ssh-port строка |
| Устанавливает состояние службы порта SSH. | |
| tls-port строка |
| Устанавливает состояние службы порта TLS VPN (HTTPS). | |
| voip-tcp-port строка |
| Устанавливает состояние службы порта VoIP TCP. | |
| voip-udp-port строка |
| Устанавливает состояние службы порта VoIP UDP. | |
| 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: Configure connection capability.
fmgr_hotspot20_h2qpconncapability:
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]>
hotspot20_h2qpconncapability:
esp-port: <value in [closed, open, unknown]>
ftp-port: <value in [closed, open, unknown]>
http-port: <value in [closed, open, unknown]>
icmp-port: <value in [closed, open, unknown]>
ikev2-port: <value in [closed, open, unknown]>
ikev2-xx-port: <value in [closed, open, unknown]>
name: <value of string>
pptp-vpn-port: <value in [closed, open, unknown]>
ssh-port: <value in [closed, open, unknown]>
tls-port: <value in [closed, open, unknown]>
voip-tcp-port: <value in [closed, open, unknown]>
voip-udp-port: <value in [closed, open, unknown]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_hotspot20_h2qpconncapability_module.html