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

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

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

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

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

Параметры

Параметр	Комментарии
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_certificates boolean	Указывает, нужно ли вычислять и показывать поле “certificates” в ответе, если уровень детализации — “full”. Варианты: `false` `true`
show_membership boolean	Указывает, нужно ли вычислять и показывать поле “groups” для каждого объекта в ответе. Доступно начиная с версии управления R81 JHF. Варианты: `false` `true`
version string	Версия Check Point. Если версия не указана, используется последняя.

Примеры

- name: show-user
  cp_mgmt_user_facts:
    name: myuser

- name: show-users
  cp_mgmt_user_facts:
    details_level: full

Авторы

Dor Berenstein (@chkp-dorbe)

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

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