Модуль check_point.mgmt.cp_mgmt_user_group_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_user_group_facts.

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

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

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

Получение сведений об объектах групп пользователей на устройствах Check Point.
Все операции выполняются через 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	Выражение поиска для фильтрации объектов. Указанный текст должен в точности соответствовать тому, что вводится в обозревателе объектов 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	Версия Check Point. Если она не указана, используется последняя версия.

Примеры

- name: show-user-group
  cp_mgmt_user_group_facts:
    name: myusergroup

- name: show-user-groups
  cp_mgmt_user_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_user_group_facts_module.html