Модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_smtp — Настройка параметров протокола SMTP.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в значение True только в том случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_profileprotocoloptions_smtp словарь	Установка параметров верхнего уровня.
inspect-all строка	Устаревшее, пожалуйста, переименуйте на inspect_all. Включить/выключить проверку всех портов для протокола. Варианты: `"disable"` `"enable"`
options список / элементы=строка	Один или несколько параметров, которые могут быть применены к сеансу. Варианты: `"oversize"` `"fragmail"` `"no-content-summary"` `"splice"`
oversize-limit целое число	Устаревшее, пожалуйста, переименуйте на oversize_limit. Максимальный размер файла в памяти, который может быть просканирован
ports любой	(список) Порты для сканирования содержимого
proxy-after-tcp-handshake строка	Устаревшее, пожалуйста, переименуйте на proxy_after_tcp_handshake. Прокси-трафик после того, как установлено трехстороннее рукопожатие TCP Варианты: `"disable"` `"enable"`
scan-bzip2 строка	Устаревшее, пожалуйста, переименуйте на scan_bzip2. Включить/выключить сканирование файлов, сжатых с помощью BZip2. Варианты: `"disable"` `"enable"`
server-busy строка	Устаревшее, пожалуйста, переименуйте на server_busy. Включить/выключить SMTP-сервер занят, когда сервер недоступен. Варианты: `"disable"` `"enable"`
ssl-offloaded строка	Устаревшее, пожалуйста, переименуйте на ssl_offloaded. Расшифровка и шифрование SSL выполняются внешним устройством. Варианты: `"no"` `"yes"`
status строка	Включить/выключить активный статус сканирования для этого протокола. Варианты: `"disable"` `"enable"`
uncompressed-nest-limit целое число	Устаревшее, пожалуйста, переименуйте на uncompressed_nest_limit. Максимальное количество вложенных уровней сжатия, которые могут быть распакованы и…
uncompressed-oversize-limit целое число	Устаревшее, пожалуйста, переименуйте на uncompressed_oversize_limit. Максимальный размер несжатого файла в памяти, который может быть просканирован
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
profile-protocol-options строка	Устаревшее, пожалуйста, используйте «profile_protocol_options»
profile_protocol_options строка	Параметр (profile-protocol-options) в запрошенном URL.

END_OF_DOCUMENT_MARKER

proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут переопределены для завершения успешно.
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным или другим, включая root.
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 помогают в этом.
Обычно модуль может завершиться неудачно, если возвращается ненулевой 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 SMTP protocol options.
      fortinet.fortimanager.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: <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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрос URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией 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_firewall_profileprotocoloptions_smtp_module.html