модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp — настройка параметров протокола SMTP.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp.
Добавлено в fortinet.fortimanager 2.0.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить/отключить ведение журнала для задачи. Варианты:
|
firewall_profileprotocoloptions_smtp dictionary | Набор параметров верхнего уровня. |
|
inspect_all псевдонимы: inspect-all string |
Включить/отключить проверку всех портов для протокола. Варианты:
|
|
options list / элементы=string |
Один или несколько параметров, применяемых к сеансу. Варианты:
|
|
oversize_limit псевдонимы: oversize-limit integer |
Максимальный размер файла в памяти, который можно проверить |
|
ports any |
(список) Порты для проверки содержимого |
|
proxy_after_tcp_handshake псевдонимы: proxy-after-tcp-handshake string |
Проксировать трафик после установления трёхстороннего рукопожатия TCP Варианты:
|
|
scan_bzip2 псевдонимы: scan-bzip2 string |
Включить/отключить проверку файлов, сжатых с помощью BZip2. Варианты:
|
|
server_busy псевдонимы: server-busy string |
Включить/отключить ответ «сервер SMTP занят», если сервер недоступен. Варианты:
|
|
ssl_offloaded псевдонимы: ssl-offloaded string |
Расшифровка и шифрование SSL выполняются внешним устройством. Варианты:
|
|
status string |
Включить/отключить проверку этого протокола. Варианты:
|
|
uncompressed_nest_limit псевдонимы: uncompressed-nest-limit integer |
Максимальная глубина вложенности сжатия, которое можно распаковать и проверить |
|
uncompressed_oversize_limit псевдонимы: uncompressed-oversize-limit integer |
Максимальный размер распакованного файла в памяти, который можно проверить |
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
profile-protocol-options string | Устарело, используйте “profile_protocol_options” |
profile_protocol_options string | Параметр (profile-protocol-options) в запрашиваемом URL. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / элементы=integer | Список кодов rc, переопределяющий условия, при которых запрос считается неудачным. |
rc_succeeded list / элементы=integer | Список кодов rc, переопределяющий условия, при которых запрос считается успешным. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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: Configure SMTP protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp:
# workspace_locking_adom: <global or your adom name>
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: <integer>
# ports: <list or integer>
# scan_bzip2: <value in [disable, enable]>
# server_busy: <value in [disable, enable]>
# status: <value in [disable, enable]>
# uncompressed_nest_limit: <integer>
# uncompressed_oversize_limit: <integer>
# ssl_offloaded: <value in [no, yes]>
# proxy_after_tcp_handshake: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / элементы=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / элементы=string | Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложных условиях |
Ссылки на коллекцию
© 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_firewall_profileprotocoloptions_smtp_module.html