fortinet.fortimanager.fmgr_application_list_entries – Записи списка приложений.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в книге задач укажите: fortinet.fortimanager.fmgr_application_list_entries
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| application_list_entries словарь | параметры верхнего уровня | |||
| action строка |
| Пропустить или заблокировать трафик или сбросить подключение для трафика из этого приложения. | ||
| application целое число | нет описания | |||
| behavior строка | нет описания | |||
| category строка | Список ID категорий. | |||
| id целое число | ID записи. | |||
| log строка |
| Включить/выключить ведение журнала для этого списка приложений. | ||
| log-packet строка |
| Включить/выключить ведение журнала пакетов. | ||
| parameters список / элементы=строка | нет описания | |||
| id целое число | ID параметра. | |||
| value строка | Значение параметра. | |||
| per-ip-shaper строка | Формирование трафика по IP-адресу. | |||
| popularity список / элементы=строка |
| нет описания | ||
| protocols строка | нет описания | |||
| quarantine строка |
| Метод карантина. | ||
| quarantine-expiry строка | Срок карантина. (Формат ###d##h##m, минимум 1m, максимум 364d23h59m, по умолчанию = 5m). Требуется, чтобы карантин был установлен на attacker. | |||
| quarantine-log строка |
| Включить/выключить ведение журнала карантина. | ||
| rate-count целое число | Количество скорости. | |||
| rate-duration целое число | Продолжительность (сек) скорости. | |||
| rate-mode строка |
| Режим ограничения скорости. | ||
| rate-track строка |
| Отслеживать поле протокола пакета. | ||
| risk целое число | нет описания | |||
| session-ttl целое число | TTL сессии (0 = по умолчанию). | |||
| shaper строка | Формирование трафика. | |||
| shaper-reverse строка | Обратное формирование трафика. | |||
| sub-category целое число | нет описания | |||
| technology строка | нет описания | |||
| vendor строка | нет описания | |||
| bypass_validation логический тип |
| устанавливается только в случае, если схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | ||
| list строка / обязательно | параметр (list) в запрошенном URL | |||
| rc_failed список / элементы=строка | список кодов rc, с которыми условия отказа будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми условия успеха будут переопределены | |||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | ||
| workspace_locking_adom строка | область для блокировки для FortiManager, работающего в режиме рабочей области, значение может быть global и другими, включая 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: Application list entries.
fmgr_application_list_entries:
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>
list: <your own value>
state: <value in [present, absent]>
application_list_entries:
action: <value in [pass, block, reset]>
application: <value of integer>
behavior: <value of string>
category: <value of string>
id: <value of integer>
log: <value in [disable, enable]>
log-packet: <value in [disable, enable]>
parameters:
-
id: <value of integer>
value: <value of string>
per-ip-shaper: <value of string>
popularity:
- 1
- 2
- 3
- 4
- 5
protocols: <value of string>
quarantine: <value in [none, attacker]>
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, ...]>
risk: <value of integer>
session-ttl: <value of integer>
shaper: <value of string>
shaper-reverse: <value of string>
sub-category: <value of integer>
technology: <value of string>
vendor: <value of string>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_application_list_entries_module.html
