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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список кодов rc, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
wanopt_profile словарь	Параметры верхнего уровня, заданные в настройках.
auth-group строка	Устарело, пожалуйста, переименуйте на auth_group. Дополнительно добавить группу аутентификации для ограничения доступа к WAN Опти…
cifs словарь	Cifs.
byte_caching строка	Устарело, пожалуйста, переименуйте на byte_caching. Включить/выключить кеширование байтов. Варианты: `"disable"` `"enable"`
log_traffic строка	Устарело, пожалуйста, переименуйте на log_traffic. Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
port любой	(список) Номер одного порта или диапазон портов для CIFS.
prefer_chunking строка	Устарело, пожалуйста, переименуйте на prefer_chunking. Выбрать динамическое или фиксированного размера разбиение данных для WAN Оптимизации. Варианты: `"dynamic"` `"fix"`
protocol_opt строка	Устарело, пожалуйста, переименуйте на protocol_opt. Выбрать оптимизацию для конкретного протокола или общую оптимизацию TCP. Варианты: `"protocol"` `"tcp"`
secure_tunnel строка	Устарело, пожалуйста, переименуйте на secure_tunnel. Включить/выключить шифрование туннеля WAN Opt с помощью SSL. Варианты: `"disable"` `"enable"`
status строка	Включить/выключить WAN Оптимизацию. Варианты: `"disable"` `"enable"`
tunnel_sharing строка	Устарело, пожалуйста, переименуйте на tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или взаимно… Варианты: `"private"` `"shared"` `"express-shared"`

comments string	Комментарий.
ftp dictionary	Ftp.
byte-caching string	Устарело, переименуйте в byte_caching. Включить/отключить кэширование байтов. Choices: `"disable"` `"enable"`
log-traffic string	Устарело, переименуйте в log_traffic. Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
port any	(список) Номер одного порта или диапазон номеров портов для FTP.
prefer-chunking string	Устарело, переименуйте в prefer_chunking. Выберите динамическое или фрагментирование данных фиксированного размера для WAN Optimization. Choices: `"dynamic"` `"fix"`
protocol-opt string	Устарело, переименуйте в protocol_opt. Выберите оптимизацию, специфичную для протокола, или общую оптимизацию TCP. Choices: `"protocol"` `"tcp"`
secure-tunnel string	Устарело, переименуйте в secure_tunnel. Включить/отключить защиту туннеля WAN Opt с помощью SSL. Choices: `"disable"` `"enable"`
ssl string	Включить/отключить разгрузку SSL/TLS Choices: `"disable"` `"enable"`
status string	Включить/отключить WAN Optimization. Choices: `"disable"` `"enable"`
tunnel-sharing string	Устарело, переименуйте в tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного… Choices: `"private"` `"shared"` `"express-shared"`
http dictionary	Http.
byte-caching string	Устарело, переименуйте в byte_caching. Включить/отключить кэширование байтов. Choices: `"disable"` `"enable"`
log-traffic string	Устарело, переименуйте в log_traffic. Включить/отключить ведение журнала. Choices: `"disable"` `"enable"`
port any	(список) Номер одного порта или диапазон номеров портов для HTTP.
prefer-chunking string	Устарело, переименуйте в prefer_chunking. Выберите динамическое или фрагментирование данных фиксированного размера для WAN Optimization. Choices: `"dynamic"` `"fix"`
protocol-opt string	Устарело, переименуйте в protocol_opt. Выберите оптимизацию, специфичную для протокола, или общую оптимизацию TCP. Choices: `"protocol"` `"tcp"`
secure-tunnel string	Устарело, переименуйте в secure_tunnel. Включить/отключить защиту туннеля WAN Opt с помощью SSL. Choices: `"disable"` `"enable"`
ssl string	Включить/отключить разгрузку SSL/TLS Choices: `"disable"` `"enable"`

ssl-port any	(list) Устарело, переименуйте в ssl_port. Порт, на котором ожидается трафик HTTPS для разгрузки SSL/TLS.
status string	Включить/выключить оптимизацию WAN. Варианты: `"disable"` `"enable"`
tunnel-non-http string	Устарело, переименуйте в tunnel_non_http. Настройте обработку не-HTTP трафика при конфигурации профиля… Варианты: `"disable"` `"enable"`
tunnel-sharing string	Устарело, переименуйте в tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного… Варианты: `"private"` `"shared"` `"express-shared"`
unknown-http-version string	Устарело, переименуйте в unknown_http_version. Как обрабатывать HTTP-сессии, не соответствующие HTTP 0. Варианты: `"best-effort"` `"reject"` `"tunnel"`
mapi dictionary	Mapi.
byte-caching string	Устарело, переименуйте в byte_caching. Включить/выключить кэширование байтов. Варианты: `"disable"` `"enable"`
log-traffic string	Устарело, переименуйте в log_traffic. Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
port any	(list) Номер одного порта или диапазон номеров портов для MAPI.
secure-tunnel string	Устарело, переименуйте в secure_tunnel. Включить/выключить защиту туннеля WAN Opt с помощью SSL. Варианты: `"disable"` `"enable"`
status string	Включить/выключить оптимизацию WAN. Варианты: `"disable"` `"enable"`
tunnel-sharing string	Устарело, переименуйте в tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного… Варианты: `"private"` `"shared"` `"express-shared"`
name string / required	Имя профиля.
tcp dictionary	Tcp.
byte-caching string	Устарело, переименуйте в byte_caching. Включить/выключить кэширование байтов. Варианты: `"disable"` `"enable"`
byte-caching-opt string	Устарело, переименуйте в byte_caching_opt. Выберите, использует ли кэширование байтов TCP только системную память или и … Варианты: `"mem-only"` `"mem-disk"`
log-traffic string	Устарело, переименуйте в log_traffic. Включить/выключить ведение журнала. Варианты: `"disable"` `"enable"`
port string	Номера портов или диапазоны номеров портов для TCP.
secure-tunnel string	Устарело, переименуйте в secure_tunnel. Включить/выключить защиту туннеля WAN Opt с помощью SSL. Варианты: `"disable"` `"enable"`

ssl строка	Включить/выключить SSL/TLS offloading Варианты: `"disable"` `"enable"`
ssl-port любой	(список) Устарело, пожалуйста, переименуйте на ssl_port. Номера портов или диапазоны портов, на которых ожидается трафик HTTPS…
status строка	Включить/выключить WAN Optimization. Варианты: `"disable"` `"enable"`
tunnel-sharing строка	Устарело, пожалуйста, переименуйте на tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного… Варианты: `"private"` `"shared"` `"express-shared"`
transparent строка	Включить/выключить прозрачный режим. Варианты: `"disable"` `"enable"`
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 помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться неудачей при возвращении ненулевого кода 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: Configure WAN optimization profiles.
      fortinet.fortimanager.fmgr_wanopt_profile:
        # 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>
        state: present # <value in [present, absent]>
        wanopt_profile:
          auth_group: <string>
          comments: <string>
          name: <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 словарь	Результат запроса. Возвращается: всегда
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_module.html