Модуль cisco.ise.pxgrid_user_groups_info – Модуль информации для pxGrid User Groups Info

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: cisco.ise.pxgrid_user_groups_info.

Добавлен в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение информации о группах пользователей pxGrid.

Примечание

Этот модуль имеет соответствующий плагин действий.

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Выбори: `false` ← (по умолчанию) `true`
ise_hostname string / обязательный	Имя хоста Identity Services Engine.
ise_password string / обязательный	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: `60`
ise_username string / обязательный	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в cisco.ise 1.1.0	Флаг, информирующий SDK, использовать ли API шлюз Identity Services Engine для отправки запросов. Если True, используется API шлюз ISE и отправляются запросы по адресу https://{{ise_hostname}}. Если False, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Выбори: `false` `true` ← (по умолчанию)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, информирующий SDK, отправлять ли CSRF-токен в API ISE ERS. Если True, SDK предполагает, что проверка CSRF в ISE включена. Если True, предполагается, что SDK должен автоматически управлять CSRF-токен. Выбори: `false` ← (по умолчанию) `true`
ise_verify boolean	Флаг для включения или выключения проверки SSL-сертификатов. Выбори: `false` `true` ← (по умолчанию)
ise_version string	Информирует SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки лимитов запросов. Выбори: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: session_directory.SessionDirectory.get_user_groups,
Используемые пути: post /ise/session/getUserGroups,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK.
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения.

Примеры

- name: Get all pxGrid User Groups Info
  cisco.ise.pxgrid_user_groups_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
  register: result

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
ise_response dictionary	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{}`

Авторы

Rafael Campos (@racampos)

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

© 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/cisco/ise/pxgrid_user_groups_info_module.html