Модуль fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_imap — настройка параметров протокола IMAP.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в 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_imap словарь	Набор параметров верхнего уровня.
address_ip_rating псевдонимы: address-ip-rating строка	Рейтинг IP-адреса. Варианты: `"disable"` `"enable"`
inspect_all псевдонимы: inspect-all строка	Включить или отключить проверку всех портов для протокола. Варианты: `"disable"` `"enable"`
options список / элементы=строка	Один или несколько параметров, которые можно применить к сеансу. Варианты: `"oversize"` `"fragmail"` `"no-content-summary"`
oversize_limit псевдонимы: oversize-limit целое число	Максимальный размер файла в памяти, который можно проверить
ports любой	(список) Порты для проверки содержимого
proxy_after_tcp_handshake псевдонимы: proxy-after-tcp-handshake строка	Проксировать трафик после установления трёхэтапного рукопожатия TCP Варианты: `"disable"` `"enable"`
scan_bzip2 псевдонимы: scan-bzip2 строка	Включить или отключить проверку файлов, сжатых с помощью BZip2. Варианты: `"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.
proposed_method строка	Метод, переопределяющий метод базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded список / элементы=целое число	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note строка	Примечание об изменении, которое можно указать при создании или обновлении объекта.
workspace_locking_adom строка	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие ADOM, включая 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
  gather_facts: false
  tasks:
    - name: Configure IMAP protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_imap:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_imap:
          # inspect_all: <value in [disable, enable]>
          # options: ["oversize", "fragmail", "no-content-summary"]
          # oversize_limit: <integer>
          # ports: <list or integer>
          # scan_bzip2: <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]>
          # address_ip_rating: <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–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_imap_module.html