Модуль check_point.mgmt.cp_mgmt_group_facts — получение сведений об объектах групп Check Point через Web Services 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_group_facts.
Добавлено в check_point.mgmt 1.0.0
Краткое описание
- Получение сведений об объектах групп на устройствах Check Point.
- Все операции выполняются через Web Services API.
- Этот модуль поддерживает обе операции: получение сведений об одном объекте и получение сведений о нескольких объектах. Для получения сведений об определённом объекте используйте параметр ‘name’.
- Доступно начиная с версии R80 системы управления.
Параметры
Параметр | Комментарии |
|---|---|
async_response boolean | Выполнять команду в асинхронном режиме и возвращать UID задачи. Используйте команду show-task, чтобы проверить ход выполнения задачи. Доступно начиная с версии R81.20 системы управления. Варианты:
|
dereference_group_members boolean | Определяет, следует ли раскрывать поле “members” с указанным уровнем подробности для каждого объекта в ответе. Доступно начиная с версии R80.10 системы управления. Варианты:
|
details_level string | Уровень подробности для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
domains_to_process list / elements=string добавлено в check_point.mgmt 6.4.0 | Указывает, в каких доменах выполнять команды. Этот параметр нельзя использовать с уровнем подробности full; команды необходимо выполнять только из домена System Domain и при значении ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Доступно начиная с версии R81 системы управления. |
filter string добавлено в check_point.mgmt 6.4.0 | Поисковое выражение для фильтрации объектов. Указанный текст должен в точности совпадать с текстом, который можно ввести в обозревателе объектов SmartConsole. Логические операторы в выражении (‘AND’, ‘OR’) необходимо указывать заглавными буквами. Поиск выполняется как по IP-адресам, так и по тексту в имени, комментарии, тегах и т. д. Доступно начиная с версии R81 JHF системы управления. |
limit integer | Будет возвращено не более указанного количества результатов. Этот параметр применим только при получении нескольких объектов. |
name string | Имя объекта. Этот параметр применим только при получении сведений об определённом объекте. |
offset integer | Пропустить указанное количество результатов перед началом их возврата. Этот параметр применим только при получении нескольких объектов. |
order list / elements=dictionary | Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов. |
|
ASC string |
Сортирует результаты по указанному полю в порядке возрастания. Варианты:
|
|
DESC string |
Сортирует результаты по указанному полю в порядке убывания. Варианты:
|
show_as_ranges boolean | Если значение true, совпавшее содержимое группы отображается в виде диапазонов IP-адресов, а не сетевых объектов.<br />Объекты, которые нельзя представить с помощью IP-адресов, отображаются как объекты.<br />Параметр ‘members’ не включается в ответ; вместо него отображается параметр ‘ranges’. Доступно начиная с версии R80.20 системы управления. Варианты:
|
show_membership boolean | Определяет, следует ли вычислять и отображать поле “groups” для каждого объекта в ответе. Доступно начиная с версии R80.10 системы управления. Варианты:
|
version string | Версия Check Point. Если версия не указана, используется последняя. |
Примеры
- name: show-group
cp_mgmt_group_facts:
name: Demo_Group
- name: show-groups
cp_mgmt_group_facts:
details_level: standard
limit: 50
offset: 0
Ссылки на коллекцию
© 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_group_facts_module.html