fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp — Настройка параметров протокола SMTP.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation булево |
| устанавливается в True только когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполняться без проверки параметров | |
| firewall_profileprotocoloptions_smtp словарь | устанавливаемые параметры верхнего уровня | ||
| inspect-all строка |
| Включает/выключает проверку всех портов для протокола. | |
| options список / элементы=строка |
| нет описания | |
| oversize-limit целое число | Максимальный размер файла в памяти, который может быть просканирован (1 - 383 МБ, по умолчанию = 10). | ||
| ports целое число | нет описания | ||
| scan-bzip2 строка |
| Включает/выключает сканирование файлов, сжатых с помощью BZip2. | |
| server-busy строка |
| Включает/выключает режим ожидания SMTP-сервера, когда сервер недоступен. | |
| status строка |
| Включает/выключает активный статус сканирования для этого протокола. | |
| uncompressed-nest-limit целое число | Максимальное количество вложенных уровней сжатия, которое может быть распаковано и просканировано (2 - 100, по умолчанию = 12). | ||
| uncompressed-oversize-limit целое число | Максимальный размер несжатого файла в памяти, который может быть просканирован (0 - 383 МБ, 0 = без ограничений, по умолчанию = 10). | ||
| profile-protocol-options строка / обязательно | параметр (profile-protocol-options) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия завершения работы будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успешного завершения работы будут переопределены | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| workspace_locking_adom строка | adom для блокировки FortiManager, работающего в режиме рабочей области; значение может быть глобальным и другими, включая корневой | ||
| workspace_locking_timeout целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно запуск одного модуля может завершиться неудачей при возврате ненулевого rc. Также можно переопределить условия неудачи или успеха с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure SMTP protocol options.
fmgr_firewall_profileprotocoloptions_smtp:
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-protocol-options: <your own value>
firewall_profileprotocoloptions_smtp:
inspect-all: <value in [disable, enable]>
options:
- oversize
- fragmail
- no-content-summary
- splice
oversize-limit: <value of integer>
ports: <value of integer>
scan-bzip2: <value in [disable, enable]>
server-busy: <value in [disable, enable]>
status: <value in [disable, enable]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запросённый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_profileprotocoloptions_smtp_module.html