Spec-Zone.ru › Ansible

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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • Примеры содержат все параметры и значения, которые необходимо скорректировать с учетом источников данных перед использованием.

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

string / обязательный

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

firewall_profileprotocoloptions_mapi

dictionary

Заданные параметры верхнего уровня.

options

list / элементы=string

Один или несколько параметров, применяемых к сеансу.

Варианты:

  • "fragmail"
  • "oversize"
  • "no-content-summary"

oversize_limit

псевдонимы: oversize-limit

integer

Максимальный размер файла в памяти, который можно проверить

ports

any

(список) Порты, на которых проверяется содержимое

scan_bzip2

псевдонимы: scan-bzip2

string

Включить или отключить проверку файлов, сжатых с помощью BZip2.

Варианты:

  • "disable"
  • "enable"

status

string

Включить или отключить активную проверку этого протокола.

Варианты:

  • "disable"
  • "enable"

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.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / элементы=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.

rc_succeeded

list / элементы=integer

Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global, а также другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания (в секундах), пока другой пользователь снимет блокировку рабочей области.

По умолчанию: 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 MAPI protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_mapi:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        profile_protocol_options: <your own value>
        firewall_profileprotocoloptions_mapi:
          # options: ["fragmail", "oversize", "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>

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

Возвращается: всегда

Пример: 0

response_data

list / элементы=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Статус запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / элементы=string

Предупреждение, если используемые в плейбуке параметры не поддерживаются текущей версией 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_mapi_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API