Spec-Zone.ru › Ansible

модуль check_point.mgmt.cp_mgmt_gsn_handover_group_facts — получение сведений об объектах gsn-handover-group в 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_gsn_handover_group_facts.

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

  • Обзор
  • Параметры
  • Примеры

Обзор

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

Параметры

Параметр

Описание

dereference_group_members

boolean

Указывает, следует ли раскрывать поле “members” до уровня подробной информации для каждого объекта в ответе.

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

Допустимые значения:

  • false
  • true

details_level

string

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

Допустимые значения:

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

domains_to_process

list / elements=string

Указывает, в каких доменах выполнять команды. Параметр нельзя использовать с уровнем детализации full; команды необходимо выполнять только из системного домена и с параметром ignore-warnings, равным true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

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

filter

string

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

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

limit

integer

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

name

string

Имя объекта. Этот параметр применим только при получении конкретного объекта.

offset

integer

Количество результатов, которые нужно пропустить в начале. Этот параметр применим только при получении нескольких объектов.

order

list / elements=dictionary

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

ASC

string

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

Допустимые значения:

  • "name"

DESC

string

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

Допустимые значения:

  • "name"

show_membership

boolean

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

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

Допустимые значения:

  • false
  • true

version

string

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

Примеры

- name: show-gsn-handover-group
  cp_mgmt_gsn_handover_group_facts:
    name: gsnhandovergroup

- name: show-gsn-handover-groups
  cp_mgmt_gsn_handover_group_facts:
    details_level: full

Авторы

  • 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_gsn_handover_group_facts_module.html

Spec-Zone.ru

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