Spec-Zone.ru › Ansible

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

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

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

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

  • Получение сведений об объектах хостов на устройствах Check Point.
  • Все операции выполняются через API веб-служб.
  • Модуль поддерживает обе операции: получение сведений об одном объекте и получение сведений о нескольких объектах. Для получения сведений об определённом объекте используйте параметр «name».
  • Доступно начиная с версии управления R80.

Параметры

Параметр

Описание

details_level

строка

Для некоторых полей в ответе можно указать уровень детализации: от отображения только значения UID объекта до полного представления объекта.

Варианты:

  • "uid"
  • "standard"
  • "full"

domains_to_process

список / элементы=строка

добавлено в check_point.mgmt 6.4.0

Указывает, в каких доменах выполнять команды. Нельзя использовать со значением full параметра details-level. Команды должны запускаться только из системного домена и с параметром ignore-warnings, равным true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

Доступно начиная с версии управления R81.

filter

строка

добавлено в check_point.mgmt 6.4.0

Выражение поиска для фильтрации объектов. Указанный текст должен в точности совпадать с тем, который вводится в обозревателе объектов SmartConsole. Логические операторы в выражении («AND», «OR») следует указывать заглавными буквами. Поиск выполняется как по IP-адресам, так и по тексту в именах, комментариях, тегах и других полях.

Доступно начиная с версии управления R81 JHF.

limit

целое число

Возвращается не более указанного количества результатов. Этот параметр применяется только при получении нескольких объектов.

name

строка

Имя объекта. Этот параметр применяется только при получении сведений об определённом объекте.

offset

целое число

Пропустить указанное количество результатов перед началом их возврата. Этот параметр применяется только при получении нескольких объектов.

order

список / элементы=словарь

Сортирует результаты по указанному полю. По умолчанию результаты сортируются по имени в порядке возрастания. Этот параметр применяется только при получении нескольких объектов.

ASC

строка

Сортирует результаты по указанному полю в порядке возрастания.

Варианты:

  • "name"

DESC

строка

Сортирует результаты по указанному полю в порядке убывания.

Варианты:

  • "name"

show_membership

логическое значение

Указывает, следует ли вычислять и отображать поле «groups» для каждого объекта в ответе.

Доступно начиная с версии управления R80.10.

Варианты:

  • false
  • true

version

строка

Версия Check Point. Если она не указана, используется последняя версия.

Примеры

- name: show-host
  cp_mgmt_host_facts:
    name: New Host 1

- name: show-hosts
  cp_mgmt_host_facts:
    details_level: standard
    limit: 50
    offset: 0

Авторы

  • Or Soffer (@chkp-orso)

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

  • Отслеживание ошибок
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API