Модуль check_point.mgmt.cp_mgmt_simple_cluster_facts — получение сведений об объектах simple-cluster в 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_simple_cluster_facts.

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

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

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

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

Параметры

Параметр	Описание
details_level string	Уровень детализации некоторых полей в ответе: от отображения только значения UID объекта до полного представления объекта. Допустимые значения: `"uid"` `"standard"` `"full"`
domains_to_process list / elements=string	Указывает, в каких доменах выполнять команды. Этот параметр нельзя использовать с уровнем детализации full. Команду необходимо запускать только из System Domain и с параметром ignore-warnings, установленным в true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Доступно начиная с версии управления R81.
filter string	Выражение поиска для фильтрации объектов. Указанный текст должен в точности совпадать с текстом, который вводится в обозревателе объектов SmartConsole. Логические операторы в выражении (‘AND’, ‘OR’) необходимо указывать заглавными буквами. Поиск выполняется как по IP-адресам, так и по тексту в имени, комментарии, тегах и т. д. Доступно начиная с версии управления R81 JHF.
limit integer	Максимальное количество возвращаемых результатов. Этот параметр применим только при получении нескольких объектов.
limit_interfaces integer	Ограничение количества отображаемых интерфейсов. Значение по умолчанию — 50.
name string	Имя объекта. Этот параметр применим только при получении сведений об определённом объекте.
offset integer	Количество результатов, которые необходимо пропустить в начале. Этот параметр применим только при получении нескольких объектов.
order list / elements=dictionary	Сортировка результатов по критериям поиска. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применим только при получении нескольких объектов.
ASC string	Сортировка результатов по указанному полю в порядке возрастания. Допустимые значения: `"name"`
DESC string	Сортировка результатов по указанному полю в порядке убывания. Допустимые значения: `"name"`
show_membership boolean	Указывает, следует ли вычислять и отображать поле “groups” для каждого объекта в ответе. Допустимые значения: `false` `true`
show_portals_certificate boolean	Указывает, следует ли отображать значение сертификата порталов в ответе. Доступно начиная с версии управления R81 JHF. Допустимые значения: `false` `true`
version string	Версия Checkpoint. Если она не указана, используется последняя версия.

Примеры

- name: show-simple-cluster
  cp_mgmt_simple_cluster_facts:
    name: cluster1

- name: show-simple-clusters
  cp_mgmt_simple_cluster_facts:
    details_level: standard
    limit: 50
    offset: 0

Авторы

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_simple_cluster_facts_module.html