cp_mgmt_access_rule_facts – Получение фактов об объектах правил доступа на Check Point через веб-сервис API
Новая версия с 2.9.
Обзор
- Получение фактов об объектах правил доступа на устройствах Check Point.
- Все операции выполняются через веб-сервис API.
- Этот модуль обрабатывает обе операции: получение конкретного объекта и получение нескольких объектов. Для получения конкретного объекта используйте параметр «имя».
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| dereference_group_members boolean |
| Указывает, следует ли разыменовывать поле "members" по уровню детализации для каждого объекта в ответе. | ||
| details_level строка |
| Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. | ||
| filter строка | Выражение поиска для фильтрации базы правил. Предоставленный текст должен быть точно таким же, как в Smart Console. Логические операторы в выражении ('AND', 'OR') должны быть предоставлены заглавными буквами. Если оператор не используется, применяется оператор по умолчанию OR. | |||
| filter_settings словарь | Настройка параметров фильтра. | |||
| packet_search_settings словарь | Когда 'search-mode' установлен в 'packet', этот объект позволяет установить параметры поиска пакетов. | |||
| expand_group_members boolean |
| Если значение true, если выражение поиска содержит UID или имя объекта группы, результаты будут включать правила, которые совпадают по крайней мере с одним членом группы. | ||
| expand_group_with_exclusion_members boolean |
| Если значение true, если выражение поиска содержит UID или имя объекта группы с исключением, результаты будут включать правила, которые совпадают по крайней мере с одним членом части "включая", и не является членом части "исключая". | ||
| match_on_any boolean |
| Совпадение с объектом 'Любой'. | ||
| match_on_group_with_exclusion boolean |
| Совпадение с группой с исключением. | ||
| match_on_negate boolean |
| Совпадение с отрицательной ячейкой. | ||
| search_mode строка |
| При установке в 'general' включены как поиск по полному тексту, так и поиск по пакетам. В этом режиме поиск по пакетам не будет соответствовать объекту 'Любой', отрицательной ячейке или группе с исключением. Если search-mode установлен в 'packet', по умолчанию включены сопоставление с объектом 'Любой', отрицательной ячейкой или группой с исключением. packet-search-settings могут быть предоставлены для изменения поведения по умолчанию. | ||
| hits_settings словарь | Н/Д | |||
| from_date строка | Формат, 'ГГГГ-ММ-ДД', 'ГГГГ-мм-ддЧЧ:мм:сс'. | |||
| target строка | Имя или UID шлюза назначения. | |||
| to_date строка | Формат, 'ГГГГ-ММ-ДД', 'ГГГГ-мм-ддЧЧ:мм:сс'. | |||
| layer строка | Слой, к которому принадлежит правило, определяемый по имени или UID. | |||
| limit целое число | Не более указанного количества результатов будет возвращено. Этот параметр актуален только для получения нескольких объектов. | |||
| name строка | Имя объекта. Должно быть уникальным в домене. | |||
| offset целое число | Пропустить указанное количество результатов перед началом их возврата. Этот параметр актуален только для получения нескольких объектов. | |||
| order список | Сортировка результатов по заданному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр актуален только для получения нескольких объектов. | |||
| ASC строка |
| Сортировка результатов по заданному полю в порядке возрастания. | ||
| DESC строка |
| Сортировка результатов по заданному полю в порядке убывания. | ||
| package строка | Имя пакета. | |||
| show_as_ranges boolean |
| При значении true параметры источника, назначения и служб/приложений отображаются как диапазоны IP-адресов и портов, а не сетевых объектов. Объекты, которые не представлены с использованием IP-адресов или номеров портов, представляются как объекты. Кроме того, ответ по каждому правилу не содержит параметры источник, источник-отрицание, назначение, назначение-отрицание, служба и служба-отрицание, а вместо этого содержит параметры источник-диапазоны, назначение-диапазоны и служба-диапазоны. Примечание. Запрос отображения правил в виде диапазонов ограничен до 20 правил на запрос, в противном случае возвращается ошибка. Если вы хотите запросить больше правил, используйте параметры смещения и ограничения для ограничения запроса. | ||
| show_hits boolean |
| Н/Д | ||
| show_membership boolean |
| Указывает, следует ли вычислять и отображать поле "группы" для каждого объекта в ответе. | ||
| use_object_dictionary boolean |
| Н/Д | ||
| version строка | Версия Check Point. Если не указана, используется последняя версия. | |||
Примеры
- name: show-access-rule
cp_mgmt_access_rule_facts:
layer: Network
name: Rule 1
- name: show-access-rulebase
cp_mgmt_access_rule_facts:
details_level: standard
limit: 20
name: Network
offset: 0
use_object_dictionary: true
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Or Soffer (@chkp-orso)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cp_mgmt_access_rule_facts_module.html
