fortinet.fortimanager.fmgr_ips_sensor – Настройка сенсора IPS.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_ips_sensor.
Новое в версии 2.10: модуля fortinet.fortimanager
Описание
- Этот модуль позволяет настроить устройство FortiManager, позволяя пользователю [ добавить получить установить обновить ] следующие API:
- /pm/config/adom/{adom}/obj/ips/sensor
- /pm/config/global/obj/ips/sensor
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием из источников данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| loose_validation boolean |
| Проверка параметров выполняется в свободном режиме |
| method строка / обязательный |
| Метод запроса |
| params список / элементы=строка | Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| url_params словарь | Параметры для каждого URL-адреса API-запроса Полный список параметров URL также см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest | |
| workspace_locking_adom строка | Имя домена для блокировки в случае работы FortiManager в режиме рабочей области Может быть глобальным или любым другим именем настраиваемого домена | |
| workspace_locking_timeout целое число | Значение по умолчанию: 300 | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем |
Примечания
Примечание
- Существует только три параметра верхнего уровня, где «метод» всегда обязателен, в то время как два других «параметры» и «параметры_url» могут быть необязательными.
- Из-за сложности схемы API fortimanager валидация выполняется вне процедуры проверки параметров Ansible.
- Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но в соответствии со структурой схемы API fortimanager нам требуется тривиальное преобразование при заполнении книги задач ansible.
Примеры
- 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: REQUESTING /PM/CONFIG/OBJ/IPS/SENSOR
fmgr_ips_sensor:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
block-malicious-url: <value in [disable, enable]>
comment: <value of string>
entries:
-
action: <value in [pass, block, reset, ...]>
application:
- <value of string>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
id: <value of integer>
location:
- <value of string>
log: <value in [disable, enable]>
log-attack-context: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
os:
- <value of string>
protocol:
- <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of string>
quarantine-log: <value in [disable, enable]>
rate-count: <value of integer>
rate-duration: <value of integer>
rate-mode: <value in [periodical, continuous]>
rate-track: <value in [none, src-ip, dest-ip, ...]>
rule: <value of string>
severity:
- <value of string>
status: <value in [disable, enable, default]>
extended-log: <value in [disable, enable]>
filter:
-
action: <value in [pass, block, default, ...]>
application:
- <value of string>
location:
- <value of string>
log: <value in [disable, enable, default]>
log-packet: <value in [disable, enable, default]>
name: <value of string>
os:
- <value of string>
protocol:
- <value of string>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
severity:
- <value of string>
status: <value in [disable, enable, default]>
name: <value of string>
override:
-
action: <value in [pass, block, reset]>
exempt-ip:
-
dst-ip: <value of string>
id: <value of integer>
src-ip: <value of string>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
quarantine: <value in [none, attacker, both, ...]>
quarantine-expiry: <value of integer>
quarantine-log: <value in [disable, enable]>
rule-id: <value of integer>
status: <value in [disable, enable]>
replacemsg-group: <value of string>
- name: REQUESTING /PM/CONFIG/OBJ/IPS/SENSOR
fmgr_ips_sensor:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
attr: <value of string>
fields:
-
- <value in [block-malicious-url, comment, extended-log, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| data словарь | всегда | Полезная нагрузка, возвращаемая в запросе |
| status словарь | всегда | Статус запроса API |
| url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
Авторы
- Frank Shen (@fshen01)
- Link Zheng (@zhengl)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortimanager/fmgr_ips_sensor_module.html