Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_user_group_facts — Получение фактов об объектах групп пользователей на Checkpoint через API веб-служб

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).

Вы, возможно, уже установили эту коллекцию, если используете пакет 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

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

Обзор

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

Параметры

Параметр

Комментарии

dereference_group_members

boolean

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

Варианты:

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

filter

string

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

limit

integer

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

name

string

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

offset

integer

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

order

list / elements=dictionary

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

ASC

string

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

Варианты:

  • "name"

DESC

string

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

Варианты:

  • "name"

show_membership

boolean

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

Варианты:

  • false
  • true

version

string

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_user_group_facts_module.html

Spec-Zone.ru

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