check_point.mgmt.cp_mgmt_threat_exception_facts – Получение фактов об объектах исключений угроз на Check Point через API веб-служб
Примечание
Этот плагин является частью коллекции check_point.mgmt (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt
Для использования в плейбуке укажите: check_point.mgmt.cp_mgmt_threat_exception_facts
Введено в версии 2.9: of check_point.mgmt
Обзор
- Получение фактов об объектах исключений угроз на устройствах Check Point.
- Все операции выполняются через API веб-служб.
- Этот модуль обрабатывает обе операции: получение конкретного объекта и получение нескольких объектов. Для получения конкретного объекта используйте параметр «name».
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| dereference_group_members boolean |
| Указывает, нужно ли разыменовывать поле «members» по уровню детализации для каждого объекта в ответе. | ||
| details_level string |
| Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью детализированного представления объекта. | ||
| exception_group_name string | Имя группы исключений. | |||
| exception_group_uid string | UID группы исключений. | |||
| filter string | Выражение поиска для фильтрации базы правил. Предоставленный текст должен быть точно таким же, как и в Smart Console. Логические операторы в выражении ('AND', 'OR') должны быть предоставлены заглавными буквами. Если оператор не используется, применяется оператор OR по умолчанию. | |||
| filter_settings dictionary | Устанавливает предпочтения фильтра. | |||
| packet_search_settings dictionary | Когда 'search-mode' установлен в 'packet', этот объект позволяет установить предпочтения поиска пакетов. | |||
| expand_group_members boolean |
| Если true, если выражение поиска содержит UID или имя объекта группы, результаты будут включать правила, которые соответствуют по крайней мере одному члену группы. | ||
| expand_group_with_exclusion_members boolean |
| Если true, если выражение поиска содержит UID или имя объекта группы с исключениями, результаты будут включать правила, которые соответствуют по крайней мере одному члену части "include" и не являются членом части "except". | ||
| match_on_any boolean |
| Соответствовать ли объекту 'Any'. | ||
| match_on_group_with_exclusion boolean |
| Соответствовать ли группе с исключениями. | ||
| match_on_negate boolean |
| Соответствовать ли отрицательному элементу. | ||
| search_mode string |
| Если установлено 'general', включены как поиск по полному тексту, так и поиск по пакетам. В этом режиме поиск по пакетам не будет соответствовать объекту 'Any', отрицательному элементу или группе с исключениями. Когда search-mode установлен в 'packet', по умолчанию включено соответствие объекту 'Any', отрицательному элементу или группе с исключениями. packet-search-settings могут быть предоставлены для изменения поведения по умолчанию. | ||
| layer string | Слой, к которому относится правило, определенный по имени или UID. | |||
| limit integer | Не более указанного количества результатов будет возвращено. Этот параметр актуален только для получения небольшого количества объектов. | |||
| name string | Имя слоя, содержащего родительское правило угрозы. Этот параметр актуален только для получения небольшого количества объектов. | |||
| offset integer | Пропустить указанное количество результатов перед началом возврата. Этот параметр актуален только для получения небольшого количества объектов. | |||
| order list / elements=string | Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр актуален только для получения небольшого количества объектов. | |||
| ASC string |
| Сортирует результаты по указанному полю в порядке возрастания. | ||
| DESC string |
| Сортирует результаты по указанному полю в порядке убывания. | ||
| package string | Имя пакета. | |||
| rule_name string | Имя родительского правила. | |||
| show_membership boolean |
| Указывает, нужно ли вычислять и показывать поле "groups" для каждого объекта в ответе. | ||
| use_object_dictionary boolean |
| Н/Д | ||
| version string | Версия checkpoint. Если не указана, используется последняя версия. | |||
Примеры
- name: show-threat-exception
cp_mgmt_threat_exception_facts:
name: Exception Rule
layer: New Layer 1
rule_name: Threat Rule 1
- name: show-threat-rule-exception-rulebase
cp_mgmt_threat_exception_facts:
name: Standard Threat Prevention
rule_name: Threat Rule 1
Авторы
- Or Soffer (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_threat_exception_facts_module.html