Модуль check_point.mgmt.cp_mgmt_vpn_community_star_facts — получение сведений об объектах vpn-community-star на 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_vpn_community_star_facts.
Добавлено в check_point.mgmt 1.0.0
Краткое описание
- Получение сведений об объектах vpn-community-star на устройствах Check Point.
- Все операции выполняются через Web Services API.
- Этот модуль поддерживает обе операции: получение сведений об одном объекте и получение сведений о нескольких объектах. Чтобы получить сведения об одном объекте, используйте параметр ‘name’.
- Доступно начиная с версии R80 для управления.
Параметры
Параметр | Описание |
|---|---|
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до его полного подробного представления. Варианты:
|
domains_to_process list / элементы=string добавлено в check_point.mgmt 6.4.0 | Указывает, в каких доменах выполнять команды. Нельзя использовать с уровнем детализации full; команды должны выполняться только из системного домена и с параметром ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Доступно начиная с версии R81 для управления. |
filter string добавлено в check_point.mgmt 6.4.0 | Поисковое выражение для фильтрации объектов. Указанный текст должен в точности совпадать с тем, который вводится в SmartConsole Object Explorer. Логические операторы в выражении (‘AND’, ‘OR’) необходимо указывать заглавными буквами. Поиск включает поиск по IP-адресу и текстовый поиск по имени, комментарию, тегам и т. д. Доступно начиная с версии R81 JHF для управления. |
limit integer | Будет возвращено не более указанного количества результатов. Этот параметр применяется только при получении нескольких объектов. |
name string | Имя объекта. Этот параметр применяется только при получении сведений об одном объекте. |
offset integer | Пропустить указанное количество результатов, прежде чем начать их возвращать. Этот параметр применяется только при получении нескольких объектов. |
order list / элементы=dictionary | Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применяется только при получении нескольких объектов. |
|
ASC string |
Сортирует результаты по указанному полю в порядке возрастания. Варианты:
|
|
DESC string |
Сортирует результаты по указанному полю в порядке убывания. Варианты:
|
version string | Версия Check Point. Если не указана, используется последняя версия. |
Примеры
- name: show-vpn-community-star
cp_mgmt_vpn_community_star_facts:
name: New_VPN_Community_Meshed_1
- name: show-vpn-communities-star
cp_mgmt_vpn_community_star_facts:
details_level: full
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_vpn_community_star_facts_module.html