Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_wanopt_profile — настройка профилей оптимизации WAN.

Примечание

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

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

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

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

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

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

Обзор

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

Параметры

Параметр

Комментарии

access_token

string

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

adom

string / обязательный

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

bypass_validation

boolean

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

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

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

proposed_method

string

Метод, переопределяющий метод базового запроса Json RPC.

Варианты:

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

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия возникновения ошибки.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

revision_note

string

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

state

string / обязательный

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

Варианты:

  • "present"
  • "absent"

wanopt_profile

dictionary

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

auth_group

псевдонимы: auth-group

string

При необходимости добавьте группу аутентификации, чтобы ограничить доступ к туннелю оптимизации WAN узлами, входящими в эту группу аутентификации.

cifs

dictionary

CIFS.

byte_caching

псевдонимы: byte-caching

string

Включить/отключить кэширование байтов.

Варианты:

  • "disable"
  • "enable"

log_traffic

псевдонимы: log-traffic

string

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

Варианты:

  • "disable"
  • "enable"

port

any

(список) Один номер порта или диапазон номеров портов для CIFS.

prefer_chunking

псевдонимы: prefer-chunking

string

Выберите динамическое или фиксированное разбиение данных на фрагменты для оптимизации WAN.

Варианты:

  • "dynamic"
  • "fix"

protocol_opt

псевдонимы: protocol-opt

string

Выберите оптимизацию для конкретного протокола или общую оптимизацию TCP.

Варианты:

  • "protocol"
  • "tcp"

secure_tunnel

псевдонимы: secure-tunnel

string

Включить/отключить защиту туннеля оптимизации WAN с помощью SSL.

Варианты:

  • "disable"
  • "enable"

status

string

Включить/отключить оптимизацию WAN.

Варианты:

  • "disable"
  • "enable"

tunnel_sharing

псевдонимы: tunnel-sharing

string

Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов.

Варианты:

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

comments

string

Комментарий.

ftp

dictionary

FTP.

byte_caching

псевдонимы: byte-caching

string

Включить/отключить кэширование байтов.

Варианты:

  • "disable"
  • "enable"

log_traffic

псевдонимы: log-traffic

string

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

Варианты:

  • "disable"
  • "enable"

port

any

(список) Один номер порта или диапазон номеров портов для FTP.

prefer_chunking

псевдонимы: prefer-chunking

string

Выберите динамическое или фиксированное разбиение данных на фрагменты для оптимизации WAN.

Варианты:

  • "dynamic"
  • "fix"

protocol_opt

псевдонимы: protocol-opt

string

Выберите оптимизацию для конкретного протокола или общую оптимизацию TCP.

Варианты:

  • "protocol"
  • "tcp"

secure_tunnel

псевдонимы: secure-tunnel

string

Включить/отключить защиту туннеля оптимизации WAN с помощью SSL.

Варианты:

  • "disable"
  • "enable"

ssl

string

Включить/отключить разгрузку SSL/TLS

Варианты:

  • "disable"
  • "enable"

status

string

Включить/отключить оптимизацию WAN.

Варианты:

  • "disable"
  • "enable"

tunnel_sharing

псевдонимы: tunnel-sharing

string

Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов.

Варианты:

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

http

dictionary

HTTP.

byte_caching

псевдонимы: byte-caching

string

Включить/отключить кэширование байтов.

Варианты:

  • "disable"
  • "enable"

log_traffic

псевдонимы: log-traffic

string

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

Варианты:

  • "disable"
  • "enable"

port

any

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

prefer_chunking

псевдонимы: prefer-chunking

string

Выберите динамическое или фиксированное разбиение данных на фрагменты для оптимизации WAN.

Варианты:

  • "dynamic"
  • "fix"

protocol_opt

псевдонимы: protocol-opt

string

Выберите оптимизацию для конкретного протокола или общую оптимизацию TCP.

Варианты:

  • "protocol"
  • "tcp"

secure_tunnel

псевдонимы: secure-tunnel

string

Включить/отключить защиту туннеля оптимизации WAN с помощью SSL.

Варианты:

  • "disable"
  • "enable"

ssl

string

Включить/отключить разгрузку SSL/TLS

Варианты:

  • "disable"
  • "enable"

ssl_port

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

any

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

status

string

Включить/отключить оптимизацию WAN.

Варианты:

  • "disable"
  • "enable"

tunnel_non_http

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

string

Настройте обработку не-HTTP-трафика, когда профиль, настроенный для HTTP-трафика, принимает не-HTTP-сеанс.

Варианты:

  • "disable"
  • "enable"

tunnel_sharing

псевдонимы: tunnel-sharing

string

Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов.

Варианты:

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

unknown_http_version

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

string

Способ обработки HTTP-сеансов, не соответствующих HTTP 0.

Варианты:

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

mapi

dictionary

MAPI.

byte_caching

псевдонимы: byte-caching

string

Включить/отключить кэширование байтов.

Варианты:

  • "disable"
  • "enable"

log_traffic

псевдонимы: log-traffic

string

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

Варианты:

  • "disable"
  • "enable"

port

any

(список) Один номер порта или диапазон номеров портов для MAPI.

secure_tunnel

псевдонимы: secure-tunnel

string

Включить/отключить защиту туннеля оптимизации WAN с помощью SSL.

Варианты:

  • "disable"
  • "enable"

status

string

Включение/отключение оптимизации WAN.

Варианты:

  • "disable"
  • "enable"

tunnel_sharing

псевдонимы: tunnel-sharing

string

Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов.

Варианты:

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

name

string / обязательный

Имя профиля.

tcp

dictionary

TCP.

byte_caching

псевдонимы: byte-caching

string

Включение/отключение кэширования байтов.

Варианты:

  • "disable"
  • "enable"

byte_caching_opt

псевдонимы: byte-caching-opt

string

Выберите, будет ли кэширование байтов TCP использовать только системную память или и память, и дисковое пространство.

Варианты:

  • "mem-only"
  • "mem-disk"

log_traffic

псевдонимы: log-traffic

string

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

Варианты:

  • "disable"
  • "enable"

port

string

Номера портов или диапазоны номеров портов TCP.

secure_tunnel

псевдонимы: secure-tunnel

string

Включение/отключение защиты туннеля WAN Opt с помощью SSL.

Варианты:

  • "disable"
  • "enable"

ssl

string

Включение/отключение разгрузки SSL/TLS

Варианты:

  • "disable"
  • "enable"

ssl_port

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

any

(список) Номера портов или диапазоны номеров портов, на которых ожидается HTTPS-трафик для разгрузки SSL/TLS.

status

string

Включение/отключение оптимизации WAN.

Варианты:

  • "disable"
  • "enable"

tunnel_sharing

псевдонимы: tunnel-sharing

string

Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов.

Варианты:

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

transparent

string

Включение/отключение прозрачного режима.

Варианты:

  • "disable"
  • "enable"

workspace_locking_adom

string

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

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. Условия ошибки или успешного завершения также можно переопределить с помощью параметров 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 WAN optimization profiles.
      fortinet.fortimanager.fmgr_wanopt_profile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        wanopt_profile:
          name: "your value" # Required variable, string
          # auth_group: <string>
          # comments: <string>
          # transparent: <value in [disable, enable]>
          # cifs:
          #   byte_caching: <value in [disable, enable]>
          #   log_traffic: <value in [disable, enable]>
          #   prefer_chunking: <value in [dynamic, fix]>
          #   protocol_opt: <value in [protocol, tcp]>
          #   secure_tunnel: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   tunnel_sharing: <value in [private, shared, express-shared]>
          #   port: <list or integer>
          # ftp:
          #   byte_caching: <value in [disable, enable]>
          #   log_traffic: <value in [disable, enable]>
          #   prefer_chunking: <value in [dynamic, fix]>
          #   protocol_opt: <value in [protocol, tcp]>
          #   secure_tunnel: <value in [disable, enable]>
          #   ssl: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   tunnel_sharing: <value in [private, shared, express-shared]>
          #   port: <list or integer>
          # http:
          #   byte_caching: <value in [disable, enable]>
          #   log_traffic: <value in [disable, enable]>
          #   prefer_chunking: <value in [dynamic, fix]>
          #   protocol_opt: <value in [protocol, tcp]>
          #   secure_tunnel: <value in [disable, enable]>
          #   ssl: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   tunnel_sharing: <value in [private, shared, express-shared]>
          #   tunnel_non_http: <value in [disable, enable]>
          #   unknown_http_version: <value in [best-effort, reject, tunnel]>
          #   port: <list or integer>
          #   ssl_port: <list or integer>
          # mapi:
          #   byte_caching: <value in [disable, enable]>
          #   log_traffic: <value in [disable, enable]>
          #   secure_tunnel: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   tunnel_sharing: <value in [private, shared, express-shared]>
          #   port: <list or integer>
          # 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

dictionary

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

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

request_url

string

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

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

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

response_code

integer

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

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

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

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

Пример: "OK."

system_information

dictionary

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

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

rc

integer

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

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

Пример: 0

version_check_warning

list / elements=string

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

Spec-Zone.ru

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