Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_threat_rule_facts — получение сведений об объектах правил угроз Check Point через Web Services API

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 6.9.0).

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

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

Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_threat_rule_facts.

Добавлено в check_point.mgmt 1.0.0

  • Краткое описание
  • Параметры
  • Примеры

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

  • Получение сведений об объектах правил угроз на устройствах Check Point.
  • Все операции выполняются через Web Services API.
  • Этот модуль поддерживает обе операции: получение сведений об одном объекте и о нескольких объектах. Для получения сведений об одном объекте используйте параметр «name».
  • Доступно начиная с версии управления R80.

Параметры

Параметр

Комментарии

dereference_group_members

логическое значение

Определяет, следует ли раскрывать поле «members» в соответствии с уровнем детализации для каждого объекта в ответе.

Доступно начиная с версии управления R80.10.

Варианты:

  • false
  • true

details_level

строка

Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до его полного подробного представления.

Варианты:

  • "uid"
  • "standard"
  • "full"

filter

строка

Выражение поиска для фильтрации базы правил. Указанный текст должен в точности совпадать с тем, который используется в Smart Console. Логические операторы в выражении («AND», «OR») следует указывать заглавными буквами. Если оператор не указан, по умолчанию используется оператор OR.

filter_settings

словарь

Задаёт параметры фильтрации.

Доступно начиная с версии управления R80.10.

packet_search_settings

словарь

Если для «search-mode» задано значение «packet», этот объект позволяет задать параметры поиска пакетов.

expand_group_members

логическое значение

Если значение равно true и выражение поиска содержит UID или имя объекта-группы, результаты будут включать правила, соответствующие хотя бы одному элементу группы.

Доступно начиная с версии управления R80.20.

Варианты:

  • false
  • true

expand_group_with_exclusion_members

логическое значение

Если значение равно true и выражение поиска содержит UID или имя объекта-группы с исключениями, результаты будут включать правила, соответствующие хотя бы одному элементу части «include» и не входящие в часть «except».

Доступно начиная с версии управления R80.20.

Варианты:

  • false
  • true

match_on_any

логическое значение

Следует ли учитывать объект «Any» при поиске.

Варианты:

  • false
  • true

match_on_group_with_exclusion

логическое значение

Следует ли учитывать группу с исключениями при поиске.

Варианты:

  • false
  • true

match_on_negate

логическое значение

Следует ли учитывать при поиске ячейку с отрицанием.

Варианты:

  • false
  • true

search_mode

строка

При значении «general» включаются полнотекстовый поиск и поиск пакетов. В этом режиме поиск пакетов не будет учитывать объект «Any», ячейку с отрицанием или группу с исключениями. Если для search-mode задано значение «packet», по умолчанию включается поиск по объекту «Any», ячейке с отрицанием и группе с исключениями. Параметр packet-search-settings позволяет изменить поведение по умолчанию.

Варианты:

  • "general"
  • "packet"

layer

строка

Слой, которому принадлежит правило, указанный по имени или UID.

limit

целое число

Максимальное количество результатов. Этот параметр применим только при получении нескольких объектов.

name

строка

Имя объекта. Должно быть уникальным в домене.

offset

целое число

Количество результатов, которые нужно пропустить перед началом их возврата. Этот параметр применим только при получении нескольких объектов.

order

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

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

ASC

строка

Сортирует результаты по указанному полю в порядке возрастания.

Варианты:

  • "name"

DESC

строка

Сортирует результаты по указанному полю в порядке убывания.

Варианты:

  • "name"

package

строка

Имя пакета.

show_membership

логическое значение

Определяет, следует ли вычислять и отображать поле «groups» для каждого объекта в ответе.

Доступно начиная с версии управления R80.10.

Варианты:

  • false
  • true

use_object_dictionary

логическое значение

Н/Д

Варианты:

  • false
  • true

version

строка

Версия Check Point. Если версия не указана, используется последняя.

Примеры

- name: show-threat-rule
  cp_mgmt_threat_rule_facts:
    layer: New Layer 1
    name: Rule Name

- name: show-threat-rulebase
  cp_mgmt_threat_rule_facts:
    details_level: standard
    filter: ''
    limit: 20
    name: Threat Prevention
    offset: 0
    use_object_dictionary: false

Авторы

  • Or Soffer (@chkp-orso)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 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/check_point/mgmt/cp_mgmt_threat_rule_facts_module.html

Spec-Zone.ru

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