Spec-Zone.ru › Ansible

модуль fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability — настройка возможностей подключения.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability.

Добавлено в fortinet.fortimanager 2.0.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль позволяет настраивать устройство FortiManager.
  • Примеры содержат все параметры и значения, которые необходимо скорректировать с учётом источников данных перед использованием.

Параметры

Параметр

Комментарии

access_token

строка

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

строка / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

логическое значение

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager; модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

логическое значение

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

hotspot20_h2qpconncapability

словарь

Набор параметров верхнего уровня.

esp_port

псевдонимы: esp-port

строка

Задать состояние службы порта ESP

Варианты:

  • "closed"
  • "open"
  • "unknown"

ftp_port

псевдонимы: ftp-port

строка

Задать состояние службы порта FTP.

Варианты:

  • "closed"
  • "open"
  • "unknown"

http_port

псевдонимы: http-port

строка

Задать состояние службы порта HTTP.

Варианты:

  • "closed"
  • "open"
  • "unknown"

icmp_port

псевдонимы: icmp-port

строка

Задать состояние службы порта ICMP.

Варианты:

  • "closed"
  • "open"
  • "unknown"

ikev2_port

псевдонимы: ikev2-port

строка

Задать состояние службы порта IKEv2 для IPsec VPN.

Варианты:

  • "closed"
  • "open"
  • "unknown"

ikev2_xx_port

псевдонимы: ikev2-xx-port

строка

Задать порт UDP 4500

Варианты:

  • "closed"
  • "open"
  • "unknown"

name

строка / обязательный

Имя возможности подключения.

pptp_vpn_port

псевдонимы: pptp-vpn-port

строка

Задать параметры протокола туннелирования «точка-точка» (PPTP)

Варианты:

  • "closed"
  • "open"
  • "unknown"

ssh_port

псевдонимы: ssh-port

строка

Задать состояние службы порта SSH.

Варианты:

  • "closed"
  • "open"
  • "unknown"

tls_port

псевдонимы: tls-port

строка

Задать параметры TLS VPN

Варианты:

  • "closed"
  • "open"
  • "unknown"

voip_tcp_port

псевдонимы: voip-tcp-port

строка

Задать состояние службы порта TCP для VoIP.

Варианты:

  • "closed"
  • "open"
  • "unknown"

voip_udp_port

псевдонимы: voip-udp-port

строка

Задать состояние службы порта UDP для VoIP.

Варианты:

  • "closed"
  • "open"
  • "unknown"

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

список / элементы=целое число

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

строка

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

строка / обязательный

Указание на создание, обновление или удаление объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другой ADOM, включая root.

workspace_locking_timeout

целое число

Максимальное время ожидания в секундах, пока другой пользователь освободит блокировку рабочей области.

По умолчанию: 300

Примечания

Примечание

  • Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля завершается ошибкой, если возвращается ненулевой код rc. Условия неудачного или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure connection capability.
      fortinet.fortimanager.fmgr_hotspot20_h2qpconncapability:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        hotspot20_h2qpconncapability:
          name: "your value" # Required variable, string
          # 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]>
          # 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

словарь

Результат запроса.

Возвращается: всегда

request_url

строка

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

целое число

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

список / элементы=строка

Ответ API.

Возвращается: всегда

response_message

строка

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

словарь

Информация о целевой системе.

Возвращается: всегда

rc

целое число

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

список / элементы=строка

Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager.

Возвращается: в сложных случаях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_hotspot20_h2qpconncapability_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API