fortinet.fortimanager.fmgr_application_list – Настройка списков управления приложениями.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в книге задач, укажите: fortinet.fortimanager.fmgr_application_list.
Новое в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательный | параметр (adom) в запрошенном URL | ||||
| application_list словарь | параметры верхнего уровня | ||||
| app-replacemsg строка |
| Включить/выключить сообщения замены для заблокированных приложений. | |||
| comment строка | комментарии | ||||
| deep-app-inspection строка |
| Включить/выключить глубокую проверку приложений. | |||
| entries список / элементы=строка | нет описания | ||||
| action строка |
| Пропустить или заблокировать трафик, или сбросить соединение для трафика из этого приложения. | |||
| application целое число | нет описания | ||||
| behavior строка | нет описания | ||||
| category строка | Список идентификаторов категорий. | ||||
| id целое число | Идентификатор записи. | ||||
| log строка |
| Включить/выключить протоколирование для этого списка приложений. | |||
| log-packet строка |
| Включить/выключить протоколирование пакетов. | |||
| parameters список / элементы=строка | нет описания | ||||
| id целое число | Идентификатор параметра. | ||||
| value строка | Значение параметра. | ||||
| per-ip-shaper строка | Формирование трафика на основе IP. | ||||
| popularity список / элементы=строка |
| нет описания | |||
| protocols строка | нет описания | ||||
| quarantine строка |
| Метод карантина. | |||
| quarantine-expiry строка | Срок карантина. (Формат ###д###ч###м, минимум 1м, максимум 364д23ч59м, по умолчанию = 5м). Требуется карантин, установленный в ... | ||||
| quarantine-log строка |
| Включить/выключить протоколирование карантина. | |||
| rate-count целое число | Количество лимита. | ||||
| rate-duration целое число | Продолжительность (сек) лимита. | ||||
| rate-mode строка |
| Режим ограничения скорости. | |||
| rate-track строка |
| Отслеживание поля протокола пакета. | |||
| risk целое число | нет описания | ||||
| session-ttl целое число | Session TTL (0 = по умолчанию). | ||||
| shaper строка | Формирование трафика. | ||||
| shaper-reverse строка | Формирование обратного трафика. | ||||
| sub-category целое число | нет описания | ||||
| technology строка | нет описания | ||||
| vendor строка | нет описания | ||||
| extended-log строка |
| Включить/выключить расширенное протоколирование. | |||
| name строка | Имя списка. | ||||
| options список / элементы=строка |
| нет описания | |||
| other-application-action строка |
| Действие для других приложений. | |||
| other-application-log строка |
| Включить/выключить протоколирование для других приложений. | |||
| p2p-black-list список / элементы=строка |
| нет описания | |||
| replacemsg-group строка | Группа сообщений замены. | ||||
| unknown-application-action строка |
| Пропустить или заблокировать трафик от неизвестных приложений. | |||
| unknown-application-log строка |
| Включить/выключить протоколирование для неизвестных приложений. | |||
| bypass_validation булево |
| устанавливается в True только когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров | |||
| rc_failed список / элементы=строка | список кодов rc, с которыми будут переопределены условия для отказа | ||||
| rc_succeeded список / элементы=строка | список кодов rc, с которыми будут переопределены условия для успеха | ||||
| state строка / обязательный |
| направление на создание, обновление или удаление объекта | |||
| 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: Configure application control lists.
fmgr_application_list:
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>
state: <value in [present, absent]>
application_list:
app-replacemsg: <value in [disable, enable]>
comment: <value of string>
deep-app-inspection: <value in [disable, enable]>
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>
extended-log: <value in [disable, enable]>
name: <value of string>
options:
- allow-dns
- allow-icmp
- allow-http
- allow-ssl
- allow-quic
other-application-action: <value in [pass, block]>
other-application-log: <value in [disable, enable]>
p2p-black-list:
- skype
- edonkey
- bittorrent
replacemsg-group: <value of string>
unknown-application-action: <value in [pass, block]>
unknown-application-log: <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_application_list_module.html