Модуль fortinet.fortimanager.fmgr_application_list_entries — записи списка приложений.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_application_list_entries.

Добавлено в fortinet.fortimanager 2.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
application_list_entries dictionary	Набор параметров верхнего уровня.
action string	Разрешить или заблокировать трафик либо сбросить соединение для трафика от этого приложения. Варианты: `"pass"` `"block"` `"reset"`
application any	(список) Идентификаторы разрешённых приложений.
behavior any	(список) Фильтр по поведению приложения.
category any	(список или строка) Список идентификаторов категорий.
exclusion any	(список) Идентификаторы исключённых приложений.
id integer / обязательный	Идентификатор записи.
log string	Включить или отключить ведение журнала для этого списка приложений. Варианты: `"disable"` `"enable"`
log_packet псевдонимы: log-packet string	Включить или отключить ведение журнала пакетов. Варианты: `"disable"` `"enable"`
parameters list / elements=dictionary	Параметры.
id integer	Идентификатор параметра.
members list / elements=dictionary	Элементы.
id integer	Параметр.
name string	Имя параметра.
value string	Значение параметра.
value string	Значение параметра.
per_ip_shaper псевдонимы: per-ip-shaper string	Формирователь трафика для каждого IP-адреса.
popularity list / elements=string	Фильтр популярности приложений Варианты: `"1"` `"2"` `"3"` `"4"` `"5"`
protocols any	(список) Фильтр по протоколам приложения.
quarantine string	Метод помещения в карантин. Варианты: `"none"` `"attacker"`
quarantine_expiry псевдонимы: quarantine-expiry string	Продолжительность карантина.
quarantine_log псевдонимы: quarantine-log string	Включить или отключить ведение журнала карантина. Варианты: `"disable"` `"enable"`
rate_count псевдонимы: rate-count integer	Количество событий за интервал.
rate_duration псевдонимы: rate-duration integer	Продолжительность
rate_mode псевдонимы: rate-mode string	Режим ограничения частоты. Варианты: `"periodical"` `"continuous"`
rate_track псевдонимы: rate-track string	Отслеживаемое поле протокола пакета. Варианты: `"none"` `"src-ip"` `"dest-ip"` `"dhcp-client-mac"` `"dns-domain"`
risk any	(список) Риск или последствия разрешения трафика от этого приложения
session_ttl псевдонимы: session-ttl integer	Время жизни сеанса (TTL)
shaper string	Формирователь трафика.
shaper_reverse псевдонимы: shaper-reverse string	Формирователь обратного трафика.
sub_category псевдонимы: sub-category any	(список) Список идентификаторов подкатегорий приложений.
tags string	Фильтр по тегам.
technology any	(список) Фильтр по технологиям приложений.
vendor any	(список) Фильтр по поставщикам приложений.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
list string / обязательный	Параметр (list) в запрошенном URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, переопределяющий условия, при которых задача завершается ошибкой.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия, при которых задача считается выполненной успешно.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочего пространства другим пользователем, в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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: Application list entries.
      fortinet.fortimanager.fmgr_application_list_entries:
        adom: ansible
        list: "ansible-test" # name
        state: present
        application_list_entries:
          action: pass
          behavior: "all"
          category: "2"
          id: 1
          log: enable
          log_packet: enable
          protocols: "all"

- 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 entries in application list
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "application_list_entries"
          params:
            adom: "ansible"
            list: "ansible-test" # name
            entries: "your_value"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: сложное значение

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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_entries_module.html