Модуль fortinet.fortimanager.fmgr_wanopt_profile_mapi – Включение/выключение оптимизации WAN для электронной почты MAPI и настройка функций оптимизации WAN для MAPI.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое значение | Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров. Варианты:
|
enable_log логическое значение | Включить/отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token строка | Авторизовать Ansible-клиент с помощью токена доступа к API forticloud. |
profile строка / обязательно | Параметр (profile) в запрошенном URL. |
proposed_method строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для завершения работы с ошибкой. |
rc_succeeded список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для успешного завершения. |
wanopt_profile_mapi словарь | Настроены верхнего уровня параметры. |
|
byte_caching строка |
Устарело, пожалуйста, переименуйте его в byte_caching. Включить/отключить кэширование байтов для HTTP. Варианты:
|
|
log_traffic строка |
Устарело, пожалуйста, переименуйте его в log_traffic. Включить/отключить ведение журнала. Варианты:
|
|
port любой тип |
(список) Единоразовое число порта или диапазон номеров портов для MAPI. |
|
secure_tunnel строка |
Устарело, пожалуйста, переименуйте его в secure_tunnel. Включить/отключить обеспечение безопасности туннеля WAN Opt с помощью SSL. Варианты:
|
|
status строка |
Включить/отключить HTTP WAN Optimization. Варианты:
|
|
tunnel_sharing строка |
Устарело, пожалуйста, переименуйте его в tunnel_sharing. Режим совместного использования туннеля для агрессивного/неагрессивного и/или интерактивного/неинтерактивного… Варианты:
|
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 MAPI email WAN Optimization and configure MAPI WAN Optimization features.
fortinet.fortimanager.fmgr_wanopt_profile_mapi:
# 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_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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на коллекцию
© 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_mapi_module.html
