check_point.mgmt.cp_mgmt_nat_rule_facts – Получение фактов об объектах nat-rule на Checkpoint через API веб-служб
Примечание
Этот плагин входит в коллекцию check_point.mgmt (версия 1.0.6).
Для его установки используйте: ansible-galaxy collection install check_point.mgmt
Чтобы использовать его в книге задач, укажите: check_point.mgmt.cp_mgmt_nat_rule_facts
Новое в версии 2.9: модуля check_point.mgmt
Описание
- Получение фактов об объектах nat-rule на устройствах Checkpoint.
- Все операции выполняются через 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 или имя объекта группы с исключениями, результаты будут включать правила, которые соответствуют по крайней мере одному члену части "include" и не является членом части "except". | ||
| match_on_any boolean |
| Соответствие объекту 'Any'. | ||
| match_on_group_with_exclusion boolean |
| Соответствие группе с исключением. | ||
| match_on_negate boolean |
| Соответствие отрицательному элементу. | ||
| search_mode string |
| При значении 'general' включены как поиск по полному тексту, так и поиск по пакетам. В этом режиме поиск по пакетам не будет соответствовать объекту 'Any', отрицательному элементу или группе с исключением. Когда режим поиска установлен в 'packet', по умолчанию включено соответствие объекту 'Any', отрицательному элементу или группе с исключением. packet-search-settings можно использовать для изменения поведения по умолчанию. | ||
| limit integer | Максимальное количество возвращаемых результатов. Этот параметр актуален только для получения небольшого количества объектов. | |||
| offset integer | Количество результатов, которые нужно пропустить изначально. Этот параметр актуален только для получения небольшого количества объектов. | |||
| order list / elements=string | Сортирует результаты по критериям поиска. Автоматически сортирует результаты по имени по возрастанию. Этот параметр актуален только для получения небольшого количества объектов. | |||
| ASC string |
| Сортирует результаты по указанному полю в порядке возрастания. | ||
| DESC string |
| Сортирует результаты по указанному полю в порядке убывания. | ||
| package string | Название пакета. | |||
| rule_number string | Номер правила. | |||
| show_membership boolean |
| Указывает, нужно ли рассчитывать и отображать поле "groups" для каждого объекта в ответе. | ||
| use_object_dictionary boolean |
| Н/Д | ||
| version string | Версия checkpoint. Если не указана, используется последняя версия. | |||
Примеры
- name: show-nat-rule
cp_mgmt_nat_rule_facts:
package: standard
- name: show-nat-rulebase
cp_mgmt_nat_rule_facts:
details_level: standard
limit: 2
offset: 1
package: standard
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_nat_rule_facts_module.html