Модуль check_point.mgmt.cp_mgmt_threat_exception_facts — получение сведений об объектах исключений угроз в Check Point через 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_exception_facts.
Добавлено в check_point.mgmt 1.0.0
Краткое описание
- Получение сведений об объектах исключений угроз на устройствах Check Point.
- Все операции выполняются через API веб-служб.
- Модуль выполняет обе операции: получение сведений об отдельном объекте и получение сведений о нескольких объектах. Чтобы получить сведения об отдельном объекте, используйте параметр ‘name’.
- Доступно начиная с версии R80 системы управления.
Параметры
Параметр | Комментарии |
|---|---|
dereference_group_members boolean | Указывает, нужно ли раскрывать поле “members” в соответствии с уровнем детализации для каждого объекта в ответе. Доступно начиная с версии R80.10 системы управления. Варианты:
|
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
exception_group_name string | Имя группы исключений. |
exception_group_uid string | UID группы исключений. |
filter string | Выражение поиска для фильтрации базы правил. Указанный текст должен точно совпадать с тем, который вводится в Smart Console. Логические операторы в выражении (‘AND’, ‘OR’) необходимо указывать заглавными буквами. Если оператор не указан, применяется оператор OR по умолчанию. Доступно начиная с версии R80.10 системы управления. |
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=dictionary | Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов. |
|
ASC string |
Сортирует результаты по указанному полю в порядке возрастания. Варианты:
|
|
DESC string |
Сортирует результаты по указанному полю в порядке убывания. Варианты:
|
package string | Имя пакета. |
rule_name string | Имя родительского правила. |
show_membership boolean | Указывает, нужно ли вычислять и показывать поле “groups” для каждого объекта в ответе. Доступно начиная с версии R80.10 системы управления. Варианты:
|
use_object_dictionary boolean | Не применимо Варианты:
|
version string | Версия Check Point. Если не указана, используется последняя версия. |
Примеры
- 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
Ссылки на коллекцию
© 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_exception_facts_module.html