Модуль check_point.mgmt.cp_mgmt_objects_facts — получение сведений об объектах Checkpoint через 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_objects_facts.

Добавлено в check_point.mgmt 3.0.0

Краткое описание
Параметры
Примеры

Краткое описание

Получение сведений об объектах на устройствах Checkpoint.
Все операции выполняются через API веб-служб.
Этот модуль поддерживает обе операции: получение сведений об одном объекте и о нескольких объектах. Чтобы получить сведения об определённом объекте, используйте параметр ‘name’.
Доступно начиная с версии управления R80.

Параметры

Параметр	Комментарии
dereference_group_members логическое значение	Определяет, следует ли раскрывать поле “members” согласно уровню детализации для каждого объекта в ответе. Доступно начиная с версии управления R80.10. Варианты: `false` `true`
details_level строка	Для некоторых полей в ответе можно задавать уровень детализации: от отображения только значения UID объекта до его полного подробного представления. Варианты: `"uid"` `"standard"` `"full"`
domains_to_process список / элементы=строка	Указывает домены, в которых будут выполняться команды. Нельзя использовать со значением details-level full; запускать команды можно только из системного домена и при значении ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Доступно начиная с версии управления R81.
filter строка	Выражение поиска для фильтрации объектов. Указанный текст должен в точности совпадать с тем, который используется в Smart Console. Логические операторы в выражении (‘AND’, ‘OR’) необходимо указывать заглавными буквами. По умолчанию поиск выполняется как по тексту, так и по IP-адресу. Чтобы выполнять поиск только по IP-адресу, задайте для параметра “ip-only” значение true. Доступно начиная с версии управления R80.10.
ip_only логическое значение	Если используется параметр “filter”, задайте это поле, чтобы искать объекты только по IP-адресу, не выполняя текстовый поиск.<br><br>Варианты поиска по IP-адресу<br>     <ul><li>Совпадения по полному IPv4-адресу для:<br>         - Хостов, хостов Check Point и шлюзов с точным совпадением IPv4-адреса либо с интерфейсами, подсеть которых содержит искомый адрес<br>         - IPv4-сетей и диапазонов IPv4-адресов, содержащих искомый адрес</li> <br>     <li>Совпадения по частичному IPv4-адресу для:<br>         - Хостов, сетей, хостов Check Point и шлюзов, IPv4-адрес которых начинается с искомого адреса<br>         - Хостов, хостов Check Point и шлюзов с интерфейсами, адрес подсети которых начинается с искомого адреса<br>         - Диапазонов IPv4-адресов, первый или последний адрес которых начинается с искомого адреса<br>         - IPv4-сетей и диапазонов IPv4-адресов, содержащих сеть, полученную из искомого адреса путём добавления отсутствующих октетов (нулей)<br>         - Хостов, хостов Check Point и шлюзов с интерфейсами, подсеть которых содержит сеть, полученную из искомого адреса путём добавления отсутствующих октетов (нулей)</li><br>     <li>IPv6-адрес:<br>         - Не поддерживается</li></ul><br><br> * Хост Check Point — это сервер типа Network Policy Management, Logging & Status, SmartEvent и т. д.<br> * При проверке, начинается ли один IP-адрес с другого (частичного) IP-адреса, учитываются только полные октеты <br> * Примеры поиска по IP-адресу приведены в разделе «Примеры». Доступно начиная с версии управления R80.10. Варианты: `false` `true`
limit целое число	Максимальное количество возвращаемых результатов. Этот параметр применим только при получении сведений об определённом объекте.
offset целое число	Количество результатов, которые следует пропустить в начале. Этот параметр применим только при получении сведений об определённом объекте.
order список / элементы=словарь	Сортирует результаты по критериям поиска. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении сведений об определённом объекте.
ASC строка	Сортирует результаты по указанному полю в порядке возрастания. Варианты: `"name"`
DESC строка	Сортирует результаты по указанному полю в порядке убывания. Варианты: `"name"`
show_membership логическое значение	Определяет, следует ли вычислять и отображать поле “groups” для каждого объекта в ответе. Доступно начиная с версии управления R80.10. Варианты: `false` `true`
type строка	Тип объекта, например host, service-tcp, network, address-range…
uid строка	Уникальный идентификатор объекта.
uids список / элементы=строка	Список UID объектов для получения. Доступно начиная с версии управления R81.10 JHF.
version строка	Версия Checkpoint. Если она не указана, используется последняя версия.

Примеры

- name: show-objects
  cp_mgmt_objects_facts:
    limit: 50
    offset: 0
    order:
      - ASC: name
    type: group

- name: show-object
  cp_mgmt_objects_facts:
    uid: ef82887c-d08f-49a3-a18f-a376be633848

Авторы

Eden Brillant (@chkp-edenbr)

Ссылки на коллекцию

© 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_objects_facts_module.html