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

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_application_list_entries.

Новый в fortinet.fortimanager 2.0.0

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
application_list_entries dictionary	Набор параметров верхнего уровня.
action string	Пропустить или заблокировать трафик, или сбросить соединение для трафика от этого приложения. Варианты: `"pass"` `"block"` `"reset"`
application any	(list) ID разрешенных приложений.
behavior any	(list) Фильтр поведения приложения.
category any	(list or str) Список ID категорий.
exclusion any	(list) ID исключенных приложений.
id integer / required	ID записи.
log string	Включить/отключить ведение журнала для этого списка приложений. Варианты: `"disable"` `"enable"`
log-packet string	Устарело, пожалуйста, переименуйте его в log_packet. Включить/отключить ведение журнала пакетов. Варианты: `"disable"` `"enable"`
parameters list / elements=dictionary	Параметры.
id integer	ID параметра.
members list / elements=dictionary	Участники.
id integer	Параметр.
name string	Имя параметра.
value string	Значение параметра.
value string	Значение параметра.
per-ip-shaper string	Устарело, пожалуйста, переименуйте его в per_ip_shaper. Формирователь трафика на каждый IP-адрес.
popularity list / elements=string	Фильтр популярности приложения Варианты: `"1"` `"2"` `"3"` `"4"` `"5"`
protocols any	(list) Фильтр протокола приложения.
quarantine string	Метод карантина. Варианты: `"none"` `"attacker"`
quarantine-expiry string	Устарело, пожалуйста, переименуйте его в quarantine_expiry. Продолжительность карантина.

quarantine-log string	Устарело, пожалуйста, переименуйте на quarantine_log. Включить/выключить журналирование карантина. Варианты: `"disable"` `"enable"`
rate-count integer	Устарело, пожалуйста, переименуйте на rate_count. Количество показателя.
rate-duration integer	Устарело, пожалуйста, переименуйте на rate_duration. Длительность
rate-mode string	Устарело, пожалуйста, переименуйте на rate_mode. Режим ограничения скорости. Варианты: `"periodical"` `"continuous"`
rate-track string	Устарело, пожалуйста, переименуйте на rate_track. Отслеживание поля протокола пакета. Варианты: `"none"` `"src-ip"` `"dest-ip"` `"dhcp-client-mac"` `"dns-domain"`
risk any	(список) Риск или влияние на разрешение трафика от данного приложения
session-ttl integer	Устарело, пожалуйста, переименуйте на session_ttl. TTL сеанса
shaper string	Формировщик трафика.
shaper-reverse string	Устарело, пожалуйста, переименуйте на shaper_reverse. Обратный формировщик трафика.
sub-category any	(список) Устарело, пожалуйста, переименуйте на sub_category. Список идентификаторов подкатегории приложения.
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 / обязательно	Параметр (список) в запрошенном URL.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с которыми будут переопределены условия для сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с которыми будут переопределены условия для успеха.
state string / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`

workspace_locking_adom string	ADOM для блокировки FortiManager в режиме рабочей области, значение может быть глобальным и другими, включая 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 помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Также вы можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_application_list_entries_module.html