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

Примечание

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

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

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

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

Добавлено в fortinet.fortimanager 2.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.
profile string / обязательный	Параметр (profile) в запрашиваемом URL.
proposed_method string	Переопределяемый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых операция считается неудачной.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых операция считается успешной.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
wanopt_profile_mapi dictionary	Набор параметров верхнего уровня.
byte_caching псевдонимы: byte-caching string	Включить или отключить кэширование байтов для HTTP. Варианты: `"disable"` `"enable"`
log_traffic псевдонимы: log-traffic string	Включить или отключить ведение журнала. Варианты: `"disable"` `"enable"`
port any	(список) Один номер порта или диапазон номеров портов для MAPI.
secure_tunnel псевдонимы: secure-tunnel string	Включить или отключить защиту туннеля WAN Opt с помощью SSL. Варианты: `"disable"` `"enable"`
status string	Включить или отключить оптимизацию WAN для HTTP. Варианты: `"disable"` `"enable"`
tunnel_sharing псевдонимы: tunnel-sharing string	Режим совместного использования туннеля для агрессивных/неагрессивных и/или интерактивных/неинтерактивных протоколов. Варианты: `"private"` `"shared"` `"express-shared"`
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другой ADOM, включая 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.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Enable/disable MAPI email WAN Optimization and configure MAPI WAN Optimization features.
      fortinet.fortimanager.fmgr_wanopt_profile_mapi:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile: <your own value>
        wanopt_profile_mapi:
          # byte_caching: <value in [disable, enable]>
          # log_traffic: <value in [disable, enable]>
          # port: <list or integer>
          # secure_tunnel: <value in [disable, enable]>
          # 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 / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=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_mapi_module.html