Модуль fortinet.fortimanager.fmgr_application_list — настройка списков управления приложениями.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_application_list.
Добавлено в fortinet.fortimanager 1.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательный | Параметр (adom) в запрашиваемом URL. |
application_list dictionary | Набор параметров верхнего уровня. |
|
app_replacemsg aliases: app-replacemsg string |
Включить или отключить сообщения-замены для заблокированных приложений. Варианты:
|
|
comment string |
Комментарии |
|
control_default_network_services aliases: control-default-network-services string |
Включить или отключить применение протоколов на выбранных портах. Варианты:
|
|
deep_app_inspection aliases: deep-app-inspection string |
Включить или отключить углубленную проверку приложений. Варианты:
|
|
default_network_services aliases: default-network-services list / elements=dictionary |
Службы сети по умолчанию. |
|
id integer |
Идентификатор записи. |
|
port integer |
Номер порта. |
|
services list / elements=string |
Сетевые протоколы. Варианты:
|
|
violation_action aliases: violation-action string |
Действие для протоколов, не включенных в белый список на выбранном порту. Варианты:
|
|
enforce_default_app_port aliases: enforce-default-app-port string |
Включить или отключить принудительное использование портов приложений по умолчанию для разрешенных приложений. Варианты:
|
|
entries list / elements=dictionary |
Записи. |
|
action string |
Пропускать или блокировать трафик либо сбрасывать соединение для трафика от этого приложения. Варианты:
|
|
application any |
(список) Идентификаторы разрешенных приложений. |
|
behavior any |
(список) Фильтр по поведению приложения. |
|
category any |
(список или строка) Список идентификаторов категорий. |
|
exclusion any |
(список) Идентификаторы исключенных приложений. |
|
id integer |
Идентификатор записи. |
|
log string |
Включить или отключить ведение журнала для этого списка приложений. Варианты:
|
|
log_packet aliases: log-packet string |
Включить или отключить ведение журнала пакетов. Варианты:
|
|
parameters list / elements=dictionary |
Параметры. |
|
id integer |
Идентификатор параметра. |
|
members list / elements=dictionary |
Элементы. |
|
id integer |
Параметр. |
|
name string |
Имя параметра. |
|
value string |
Значение параметра. |
|
value string |
Значение параметра. |
|
per_ip_shaper aliases: per-ip-shaper string |
Формирователь трафика для каждого IP-адреса. |
|
popularity list / elements=string |
Фильтр популярности приложений Варианты:
|
|
protocols any |
(список) Фильтр протоколов приложений. |
|
quarantine string |
Способ помещения в карантин. Варианты:
|
|
quarantine_expiry aliases: quarantine-expiry string |
Длительность карантина. |
|
quarantine_log aliases: quarantine-log string |
Включить или отключить ведение журнала карантина. Варианты:
|
|
rate_count aliases: rate-count integer |
Количество событий за интервал. |
|
rate_duration aliases: rate-duration integer |
Длительность |
|
rate_mode aliases: rate-mode string |
Режим ограничения скорости. Варианты:
|
|
rate_track aliases: rate-track string |
Отслеживать поле протокола пакета. Варианты:
|
|
risk any |
(список) Риск или последствия разрешения трафика от этого приложения |
|
session_ttl aliases: session-ttl integer |
Время жизни сеанса (TTL) |
|
shaper string |
Формирователь трафика. |
|
shaper_reverse aliases: shaper-reverse string |
Формирователь обратного трафика. |
|
sub_category aliases: sub-category any |
(список) Список идентификаторов подкатегорий приложений. |
|
tags string |
Фильтр по тегам. |
|
technology any |
(список) Фильтр по технологии приложения. |
|
vendor any |
(список) Фильтр по поставщику приложения. |
|
extended_log aliases: extended-log string |
Включить или отключить расширенное ведение журнала. Варианты:
|
|
force_inclusion_ssl_di_sigs aliases: force-inclusion-ssl-di-sigs string |
Включить или отключить принудительное включение сигнатур углубленной проверки SSL. Варианты:
|
|
name string / обязательный |
Имя списка. |
|
options list / elements=string |
Базовые сигнатуры протоколов приложений, разрешенные по умолчанию. Варианты:
|
|
other_application_action aliases: other-application-action string |
Действие для других приложений. Варианты:
|
|
other_application_log aliases: other-application-log string |
Включить или отключить ведение журнала для других приложений. Варианты:
|
|
p2p_black_list aliases: p2p-black-list list / elements=string |
P2P-приложения, которые необходимо добавить в черный список. Варианты:
|
|
p2p_block_list псевдонимы: p2p-block-list list / elements=string |
P2P-приложения, которые необходимо заблокировать. Варианты:
|
|
replacemsg_group псевдонимы: replacemsg-group string |
Группа сообщений для замены. |
|
unknown_application_action псевдонимы: unknown-application-action string |
Разрешить или заблокировать трафик неизвестных приложений. Варианты:
|
|
unknown_application_log псевдонимы: unknown-application-log string |
Включить или отключить ведение журнала для неизвестных приложений. Варианты:
|
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых будут переопределены условия сбоя. |
rc_succeeded list / elements=integer | Список кодов rc, для которых будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание создать, обновить или удалить объект. Варианты:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания, пока другой пользователь снимет блокировку рабочей области. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
- Чтобы создать или обновить объект, используйте директиву state present.
- Чтобы удалить объект, используйте директиву state absent.
Примеры
- name: Example playbook
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure application control lists.
fortinet.fortimanager.fmgr_application_list:
adom: ansible
state: present
application_list:
app_replacemsg: enable
comment: "ansible-test-comment"
deep_app_inspection: enable
extended_log: disable
name: "ansible-test"
other_application_action: pass
other_application_log: disable
unknown_application_action: pass
unknown_application_log: disable
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the application list
fortinet.fortimanager.fmgr_fact:
facts:
selector: "application_list"
params:
adom: "ansible"
list: "your_value"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: при определённых условиях |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_application_list_module.html