fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_mapi модуль — Настройка параметров протокола MAPI.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation булево | Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log булево | Включить/выключить ведение журнала для задачи. Варианты:
|
firewall_profileprotocoloptions_mapi словарь | Параметры верхнего уровня. |
|
options список / элементы=строка |
Один или несколько параметров, которые можно применить к сеансу. Варианты:
|
|
oversize-limit целое число |
Устарело, пожалуйста, переименуйте на oversize_limit. Максимальный размер файла в оперативной памяти, который может быть просканирован |
|
ports любой |
(список) Порты для сканирования содержимого |
|
scan-bzip2 строка |
Устарело, пожалуйста, переименуйте на scan_bzip2. Включить/выключить сканирование файлов, сжатых в формате BZip2. Варианты:
|
|
status строка |
Включить/выключить активный статус сканирования для данного протокола. Варианты:
|
|
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. Варианты:
|
rc_failed список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия отказа. |
rc_succeeded список / элементы=целое число | Список rc-кодов, с которыми будут переопределены условия успеха. |
workspace_locking_adom строка | Область домена для блокировки FortiManager, работающего в рабочем пространстве. Значение может быть глобальным и другими, включая корень. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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 MAPI protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_mapi:
# 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_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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложный |
Ссылки на коллекцию
© 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_mapi_module.html
