Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_quic модуль — Настройка QUIC.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_quic.

Новое в fortinet.fortimanager 2.3.0

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

Обзор

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

Параметры

Параметр

Комментарии

access-proxy

строка

Устаревшее, используйте «access_proxy»

access_proxy

строка

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

access_token

строка

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

adom

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

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

api-gateway

строка

Устаревшее, используйте «api_gateway»

api_gateway

строка

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

bypass_validation

логическое

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

Варианты:

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

enable_log

логическое

Включить/выключить логирование для задачи.

Варианты:

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

firewall_accessproxy_apigateway_quic

словарь

Параметры верхнего уровня.

ack_delay_exponent

целое число

Устаревшее, переименуйте на ack_delay_exponent. Экспонента задержки подтверждения.

active_connection_id_limit

целое число

Устаревшее, переименуйте на active_connection_id_limit. Предел активных идентификаторов соединений.

active_migration

строка

Устаревшее, переименуйте на active_migration. Включить/выключить активную миграцию

Варианты:

  • "disable"
  • "enable"

grease_quic_bit

строка

Устаревшее, переименуйте на grease_quic_bit. Включить/выключить бит grease QUIC

Варианты:

  • "disable"
  • "enable"

max_ack_delay

целое число

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

max_datagram_frame_size

целое число

Устаревшее, переименуйте на max_datagram_frame_size. Максимальный размер кадра датаграммы в байтах

max_idle_timeout

целое число

Устаревшее, переименуйте на max_idle_timeout. Максимальный интервал бездействия в миллисекундах

max_udp_payload_size

целое число

Устаревшее, переименуйте на max_udp_payload_size. Максимальный размер полезной нагрузки UDP в байтах

forticloud_access_token

строка

Авторизует Ansible-клиент с токеном доступа к forticloud API.

proposed_method

строка

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

Варианты:

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

rc_failed

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

Список кодов rc, с которыми будут переопределены условия завершения с ошибкой.

rc_succeeded

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

Список кодов rc, с которыми будут переопределены условия успешного завершения.

workspace_locking_adom

строка

Область управления (ADOM), которую нужно заблокировать для FortiManager, работающего в режиме рабочей области. Значение может быть глобальным, а также другими, включая 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

Примеры

- 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: QUIC setting.
      fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_quic:
        # 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>
        access_proxy: <your own value>
        api_gateway: <your own value>
        firewall_accessproxy_apigateway_quic:
          ack_delay_exponent: <integer>
          active_connection_id_limit: <integer>
          active_migration: <value in [disable, enable]>
          grease_quic_bit: <value in [disable, enable]>
          max_ack_delay: <integer>
          max_datagram_frame_size: <integer>
          max_idle_timeout: <integer>
          max_udp_payload_size: <integer>

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ

Описание

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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_accessproxy_apigateway_quic_module.html

Spec-Zone.ru

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