fortinet.fortimanager.fmgr_waf_profile_signature_mainclass – Основной класс подписи.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_waf_profile_signature_mainclass.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать, прежде чем использовать данные из источников.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||
| bypass_validation логическое значение |
| устанавливается в True только в случае расхождений схемы модуля со структурой API FortiManager. Модуль продолжает выполнение без проверки параметров | |
| profile строка / обязательно | параметр (profile) в запрошенном URL | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия отказа будут переопределены | ||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успеха будут переопределены | ||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |
| waf_profile_signature_mainclass словарь | установленные параметры верхнего уровня | ||
| action строка |
| Действие. | |
| id целое число | ID основного класса подписи. | ||
| log строка |
| Включить/выключить ведение журнала. | |
| severity строка |
| Уровень серьезности. | |
| status строка |
| Статус. | |
| workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным или другим, включая root. | ||
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем | |
Примечания
Примечание
- Поддержка работы в режиме блокировки рабочего пространства в данном модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout выполняют соответствующие действия.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно модуль может завершиться неудачей при возвращении ненулевого кода rc. Параметры rc_failed и rc_succeeded также могут переопределить условия успеха или неудачи.
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Main signature class.
fmgr_waf_profile_signature_mainclass:
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: <your own value>
waf_profile_signature_mainclass:
action: <value in [allow, block, erase]>
id: <value of integer>
log: <value in [disable, enable]>
severity: <value in [low, medium, high]>
status: <value in [disable, enable]>
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запросённый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Дескриптивное сообщение ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_waf_profile_signature_mainclass_module.html