Модуль fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability – Настройка возможности подключения.
Примечание
Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в playbook, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability.
Новое в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / required | Параметр (adom) в запрошенном URL. |
bypass_validation boolean | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/Выключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
hotspot20_h2qpconncapability dictionary | Набор параметров верхнего уровня. |
|
esp-port string |
Устарело, переименуйте в esp_port. Установка сервиса порта ESP Варианты:
|
|
ftp-port string |
Устарело, переименуйте в ftp_port. Установка статуса сервиса порта FTP. Варианты:
|
|
http-port string |
Устарело, переименуйте в http_port. Установка статуса сервиса порта HTTP. Варианты:
|
|
icmp-port string |
Устарело, переименуйте в icmp_port. Установка статуса сервиса порта ICMP. Варианты:
|
|
ikev2-port string |
Устарело, переименуйте в ikev2_port. Установка статуса сервиса порта IKEv2 для IPsec VPN. Варианты:
|
|
ikev2-xx-port string |
Устарело, переименуйте в ikev2_xx_port. Установка UDP порта 4500 Варианты:
|
|
name string / required |
Имя возможности подключения. |
|
pptp-vpn-port string |
Устарело, переименуйте в pptp_vpn_port. Установка протокола туннелирования точка-точка. Варианты:
|
|
ssh-port string |
Устарело, переименуйте в ssh_port. Установка статуса сервиса порта SSH. Варианты:
|
|
tls-port string |
Устарело, переименуйте в tls_port. Установка TLS VPN Варианты:
|
|
voip-tcp-port string |
Устарело, переименуйте в voip_tcp_port. Установка статуса сервиса порта VoIP TCP. Варианты:
|
|
voip-udp-port string |
Устарело, переименуйте в voip_udp_port. Установка статуса сервиса порта VoIP UDP. Варианты:
|
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, с помощью которых будут переопределены условия для сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, с помощью которых будут переопределены условия для успеха. |
state string / required | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom string | ADOM для блокировки для FortiManager, работающего в режиме рабочей области; значение может быть global и другими, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания (в секундах) освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы именованы с использованием соглашения об именовании с подчеркиванием (snake_case). Пожалуйста, измените аргументы, такие как «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, но вы будете получать предупреждения об устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, если возвращается ненулевой код rc. Вы также можете переопределить условия сбоя или успеха с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure connection capability.
fortinet.fortimanager.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: present # <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: <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]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code integer |
Статус API-запроса. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описательное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией FortiManager. Возвращается: complex |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_h2qpconncapability_module.html