check_point.mgmt.cp_mgmt_access_rule_facts – Получение фактов объектов правил доступа на Check Point через API веб-служб
Примечание
Этот плагин входит в состав коллекции check_point.mgmt (версия 1.0.6).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt
Для использования в плейбуке укажите: check_point.mgmt.cp_mgmt_access_rule_facts
В версии 2.9: коллекции check_point.mgmt
Обзор
- Получение фактов объектов правил доступа на устройствах Check Point.
- Все операции выполняются через API веб-служб.
- Этот модуль обрабатывает обе операции: получение конкретного объекта и получение нескольких объектов. Для получения конкретного объекта используйте параметр «name».
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| dereference_group_members boolean |
| Указывает, следует ли разыменовывать поле "members" по уровню детализации для каждого объекта в ответе. | ||
| details_level 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 или имя объекта группы с исключением, результаты будут включать правила, которые соответствуют по крайней мере одному члену части "включать" и не является членом части "исключать". | ||
| match_on_any boolean |
| Соответствие объекту 'Любой'. | ||
| match_on_group_with_exclusion boolean |
| Соответствие группе с исключением. | ||
| match_on_negate boolean |
| Соответствие отрицательному элементу. | ||
| search_mode string |
| Если установлен в 'general', включены и поиск по полному тексту, и поиск пакетов. В этом режиме поиск пакетов не будет соответствовать объекту 'Любой', отрицательному элементу или группе с исключением. Если search-mode установлен в 'packet', по умолчанию включено соответствие объекту 'Любой', отрицательному элементу или группе с исключением. packet-search-settings могут быть предоставлены для изменения поведения по умолчанию. | ||
| hits_settings dictionary | Н/Д | |||
| from_date string | Формат: 'ГГГГ-ММ-ДД', 'ГГГГ-мм-ддЧЧ:мм:сс'. | |||
| target string | Имя шлюза назначения или UID. | |||
| to_date string | Формат: 'ГГГГ-ММ-ДД', 'ГГГГ-мм-ддЧЧ:мм:сс'. | |||
| layer string | Уровень, к которому принадлежит правило, определяется по имени или UID. | |||
| limit integer | Не более указанного количества результатов будет возвращено. Этот параметр актуален только для получения нескольких объектов. | |||
| name string | Имя объекта. Должно быть уникальным в домене. | |||
| offset integer | Пропустить указанное количество результатов перед началом возвращения. Этот параметр актуален только для получения нескольких объектов. | |||
| order list / elements=string | Сортировка результатов по заданному полю. По умолчанию результаты отсортированы по имени в порядке возрастания. Этот параметр актуален только для получения нескольких объектов. | |||
| ASC string |
| Сортировка результатов по заданному полю в порядке возрастания. | ||
| DESC string |
| Сортировка результатов по заданному полю в порядке убывания. | ||
| package string | Название пакета. | |||
| show_as_ranges boolean |
| Если true, параметры source, destination и services & applications отображаются как диапазоны IP-адресов и портов, а не сетевых объектов. Объекты, которые не представлены с помощью IP-адресов или номеров портов, отображаются как объекты. Кроме того, ответ для каждого правила не содержит параметры source, source-negate, destination, destination-negate, service и service-negate, а вместо этого содержит параметры source-ranges, destination-ranges и service-ranges. Обратите внимание, запрос на отображение правил в виде диапазонов ограничен 20 правилами на запрос, в противном случае возвращается ошибка. Если вы хотите запросить больше правил, используйте параметры offset и limit для ограничения запроса. | ||
| show_hits boolean |
| Н/Д | ||
| show_membership boolean |
| Указывает, следует ли рассчитывать и отображать поле "groups" для каждого объекта в ответе. | ||
| use_object_dictionary boolean |
| Н/Д | ||
| version string | Версия checkpoint. Если не указана, используется последняя. | |||
Примеры
- 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
Авторы
- 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.10/collections/check_point/mgmt/cp_mgmt_access_rule_facts_module.html
