Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_wanopt_profile_http — Включение/выключение HTTP оптимизации WAN и настройка функций HTTP оптимизации WAN.

Примечание

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

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

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

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

Новое в 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.

profile

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

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

proposed_method

строка

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

Варианты:

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

rc_failed

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

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

rc_succeeded

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

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

wanopt_profile_http

словарь

Настройка параметров верхнего уровня.

byte_caching

строка

Устарело, пожалуйста, переименуйте на byte_caching. Включить/выключить кэширование байтов для HTTP.

Варианты:

  • "disable"
  • "enable"

log_traffic

строка

Устарело, пожалуйста, переименуйте на log_traffic. Включить/выключить ведение журнала.

Варианты:

  • "disable"
  • "enable"

port

любой

(список) Единый номер порта или диапазон номеров портов для HTTP.

prefer_chunking

строка

Устарело, пожалуйста, переименуйте на prefer_chunking. Выбрать динамическое или фиксированное разбиение данных на блоки для HTTP WAN Optimization.

Варианты:

  • "dynamic"
  • "fix"

protocol_opt

строка

Устарело, пожалуйста, переименуйте на protocol_opt. Выбрать оптимизацию протокола или общую оптимизацию TCP.

Варианты:

  • "protocol"
  • "tcp"

secure_tunnel

строка

Устарело, пожалуйста, переименуйте на secure_tunnel. Включить/выключить защищенное соединение WAN Opt туннеля с использованием SSL.

Варианты:

  • "disable"
  • "enable"

ssl

строка

Включить/выключить SSL/TLS offloading

Варианты:

  • "disable"
  • "enable"

ssl_port

любой

(список) Устарело, пожалуйста, переименуйте на ssl_port. Порт, на котором ожидается HTTPS-трафик для SSL/TLS offloading.

status

строка

Включить/выключить HTTP WAN Optimization.

Варианты:

  • "disable"
  • "enable"

tunnel-non-http

строка

Устаревший параметр, пожалуйста, переименуйте его на tunnel_non_http. Настройка обработки не-HTTP трафика, когда профиль настроен для H…

Варианты:

  • "disable"
  • "enable"

tunnel-sharing

строка

Устаревший параметр, пожалуйста, переименуйте его на tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного/неинтерактивного…

Варианты:

  • "private"
  • "shared"
  • "express-shared"

unknown-http-version

строка

Устаревший параметр, пожалуйста, переименуйте его на unknown_http_version. Способ обработки HTTP-сессий, не соответствующих HTTP 0.

Варианты:

  • "best-effort"
  • "reject"
  • "tunnel"

workspace_locking_adom

строка

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

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: Enable/disable HTTP WAN Optimization and configure HTTP WAN Optimization features.
      fortinet.fortimanager.fmgr_wanopt_profile_http:
        # 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>
        profile: <your own value>
        wanopt_profile_http:
          byte_caching: <value in [disable, enable]>
          log_traffic: <value in [disable, enable]>
          port: <list or integer>
          prefer_chunking: <value in [dynamic, fix]>
          secure_tunnel: <value in [disable, enable]>
          ssl: <value in [disable, enable]>
          ssl_port: <list or integer>
          status: <value in [disable, enable]>
          tunnel_non_http: <value in [disable, enable]>
          tunnel_sharing: <value in [private, shared, express-shared]>
          unknown_http_version: <value in [best-effort, reject, tunnel]>
          protocol_opt: <value in [protocol, tcp]>

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

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

Ключ

Описание

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

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

Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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_wanopt_profile_http_module.html

Spec-Zone.ru

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