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

Примечание

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

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

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

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

Добавлена в 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_tcp словарь	Установленные параметры верхнего уровня.
byte-caching строка	Устарело, пожалуйста, переименуйте на byte_caching. Включить/выключить кэширование байтов для HTTP. Варианты: `"disable"` `"enable"`
byte-caching-opt строка	Устарело, пожалуйста, переименуйте на byte_caching_opt. Выбор того, использует ли кэширование байтов TCP только системную память или и память, и… Варианты: `"mem-only"` `"mem-disk"`
log-traffic строка	Устарело, пожалуйста, переименуйте на log_traffic. Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
port строка	Номер одного порта или диапазон номеров портов для TCP.
secure-tunnel строка	Устарело, пожалуйста, переименуйте на secure_tunnel. Включить/выключить шифрование туннеля WAN Opt с помощью SSL. Варианты: `"disable"` `"enable"`
ssl строка	Включить/выключить SSL/TLS-отгрузку. Варианты: `"disable"` `"enable"`
ssl-port любой	(список) Устарело, пожалуйста, переименуйте на ssl_port. Порт, на котором ожидается трафик HTTPS для SSL/TLS-отгрузки.
status строка	Включить/выключить HTTP WAN Optimization. Варианты: `"disable"` `"enable"`
tunnel-sharing строка	Устарело, пожалуйста, переименуйте на tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного/неинтерактивного… Варианты: `"private"` `"shared"` `"express-shared"`
workspace_locking_adom строка	Adom для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.

workspace_locking_timeout

integer

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

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

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют название с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
В этом модуле FortiManager поддерживается режим блокировки рабочей области, параметры workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращён ненулевой код возврата. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров 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 TCP WAN Optimization and configure TCP WAN Optimization features.
      fortinet.fortimanager.fmgr_wanopt_profile_tcp:
        # 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_tcp:
          byte_caching: <value in [disable, enable]>
          byte_caching_opt: <value in [mem-only, mem-disk]>
          log_traffic: <value in [disable, enable]>
          port: <string>
          secure_tunnel: <value in [disable, enable]>
          ssl: <value in [disable, enable]>
          ssl_port: <list or integer>
          status: <value in [disable, enable]>
          tunnel_sharing: <value in [private, shared, express-shared]>

Значения возврата

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

Ключ	Описание
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_wanopt_profile_tcp_module.html