Spec-Zone.ru › Ansible

fortinet.fortimanager.fmgr_application_list модуль — Настройка списков управления приложениями.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 / required

Параметр (adom) в запрошенном URL.

application_list

dictionary

Набор параметров верхнего уровня.

app-replacemsg

string

Устарело, переименуйте в app_replacemsg. Включить/отключить сообщения о замене для заблокированных приложений.

Варианты:

  • "disable"
  • "enable"

comment

string

Комментарии

control-default-network-services

string

Устарело, переименуйте в control_default_network_services. Включить/отключить принудительное использование протоколов через выбранные порты.

Варианты:

  • "disable"
  • "enable"

deep-app-inspection

string

Устарело, переименуйте в deep_app_inspection. Включить/отключить глубокий анализ приложений.

Варианты:

  • "disable"
  • "enable"

default-network-services

list / elements=dictionary

Устарело, переименуйте в default_network_services. Службы сети по умолчанию.

id

integer

Идентификатор записи.

port

integer

Номер порта.

services

list / elements=string

сетевые протоколы.

Варианты:

  • "http"
  • "ssh"
  • "telnet"
  • "ftp"
  • "dns"
  • "smtp"
  • "pop3"
  • "imap"
  • "snmp"
  • "nntp"
  • "https"

violation-action

string

Устарело, переименуйте в violation_action. Действие для протоколов, не включенных в белый список для выбранного порта.

Варианты:

  • "block"
  • "monitor"
  • "pass"

enforce-default-app-port

string

Устарело, переименуйте в enforce_default_app_port. Включить/отключить принудительное использование порта приложения по умолчанию для разрешенных…

Варианты:

  • "disable"
  • "enable"

entries

list / elements=dictionary

Записи.

action

string

Пропускать или блокировать трафик, или сбрасывать соединение для трафика от этого приложения.

Варианты:

  • "pass"
  • "block"
  • "reset"

application

any

(список) Идентификатор разрешенных приложений.

behavior

any

(список) Фильтр поведения приложения.

category

any

(список или str) Список идентификаторов категорий.

exclusion

any

(список) Идентификатор исключенных приложений.

id

integer

Идентификатор записи.

log

string

Включить/отключить ведение журнала для этого списка приложений.

Варианты:

  • "disable"
  • "enable"

log-packet

string

Устарело, переименуйте в log_packet. Включить/отключить логирование пакетов.

Choices:

  • "disable"
  • "enable"

parameters

list / elements=dictionary

Параметры.

id

integer

Идентификатор параметра.

members

list / elements=dictionary

Участники.

id

integer

Параметр.

name

string

Имя параметра.

value

string

Значение параметра.

value

string

Значение параметра.

per-ip-shaper

string

Устарело, переименуйте в per_ip_shaper. Формирователь трафика на каждый IP-адрес.

popularity

list / elements=string

Фильтр популярности приложения

Choices:

  • "1"
  • "2"
  • "3"
  • "4"
  • "5"

protocols

any

(list) Фильтр протокола приложения.

quarantine

string

Метод карантина.

Choices:

  • "none"
  • "attacker"

quarantine-expiry

string

Устарело, переименуйте в quarantine_expiry. Продолжительность карантина.

quarantine-log

string

Устарело, переименуйте в quarantine_log. Включить/отключить логирование карантина.

Choices:

  • "disable"
  • "enable"

rate-count

integer

Устарело, переименуйте в rate_count. Количество скорости.

rate-duration

integer

Устарело, переименуйте в rate_duration. Продолжительность

rate-mode

string

Устарело, переименуйте в rate_mode. Режим ограничения скорости.

Choices:

  • "periodical"
  • "continuous"

rate-track

string

Устарело, переименуйте в rate_track. Отслеживать поле протокола пакета.

Choices:

  • "none"
  • "src-ip"
  • "dest-ip"
  • "dhcp-client-mac"
  • "dns-domain"

risk

any

(list) Риск, или влияние, разрешения трафика от этого приложения.

session-ttl

integer

Устарело, переименуйте в session_ttl. Время жизни сессии.

shaper

string

Формирователь трафика.

shaper-reverse

string

Устарело, переименуйте в shaper_reverse. Обратный формирователь трафика.

sub-category

any

(list) Устарело, переименуйте в sub_category. Список идентификаторов подкатегорий приложений.

метки

строка

Фильтр меток.

технология

любой

(список) Фильтр технологий приложений.

производитель

любой

(список) Фильтр производителей приложений.

extended-log

строка

Устарело, пожалуйста, переименуйте на extended_log. Включить/выключить расширенное ведение журнала.

Варианты:

  • "disable"
  • "enable"

force-inclusion-ssl-di-sigs

строка

Устарело, пожалуйста, переименуйте на force_inclusion_ssl_di_sigs. Включить/выключить принудительное включение сигнатур SSL глубокого анализа…

Варианты:

  • "disable"
  • "enable"

имя

строка / обязательно

Имя списка.

параметры

список / элементы=строка

Основные протоколы приложений, разрешенные по умолчанию.

Варианты:

  • "allow-dns"
  • "allow-icmp"
  • "allow-http"
  • "allow-ssl"
  • "allow-quic"

действие-других-приложений

строка

Устарело, пожалуйста, переименуйте на other_application_action. Действие для других приложений.

Варианты:

  • "pass"
  • "block"

журнал-других-приложений

строка

Устарело, пожалуйста, переименуйте на other_application_log. Включить/выключить ведение журнала для других приложений.

Варианты:

  • "disable"
  • "enable"

p2p-чёрный-список

список / элементы=строка

Устарело, пожалуйста, переименуйте на p2p_black_list. Приложения P2P, которые необходимо занести в чёрный список.

Варианты:

  • "skype"
  • "edonkey"
  • "bittorrent"

p2p-блокированный-список

список / элементы=строка

Устарело, пожалуйста, переименуйте на p2p_block_list. Приложения P2P, которые необходимо занести в список блокировки.

Варианты:

  • "skype"
  • "edonkey"
  • "bittorrent"

replacemsg-группа

строка

Устарело, пожалуйста, переименуйте на replacemsg_group. Группа сообщений замены.

действие-неизвестного-приложения

строка

Устарело, пожалуйста, переименуйте на unknown_application_action. Пропускать или блокировать трафик от неизвестных приложений.

Варианты:

  • "pass"
  • "block"

журнал-неизвестного-приложения

строка

Устарело, пожалуйста, переименуйте на unknown_application_log. Включить/выключить ведение журнала для неизвестных приложений.

Варианты:

  • "disable"
  • "enable"

bypass_validation

булево

Устанавливать только в значение True, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров.

Варианты:

  • false ← (по умолчанию)
  • true

enable_log

булево

Включить/выключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

forticloud_access_token

строка

Авторизовать клиент Ansible с помощью токена доступа к API forticloud.

proposed_method

строка

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

список / элементы=целое число

Список кодов rc, при которых условия будут считаться невыполненными.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых условия будут считаться выполненными.

state

строка / обязательно

Директива для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

ADOM для блокировки в режиме работы FortiManager в рабочем пространстве. Значение может быть глобальным и другими, включая корневой.

workspace_locking_timeout

целое число

Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства.

По умолчанию: 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: 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

словарь

Результат запроса.

Возвращается: всегда

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_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API