Модуль cisco.ise.active_directory_user_groups_info – Модуль информации для групп пользователей Active Directory

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.active_directory_user_groups_info.

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

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

Описание

Получение всех групп пользователей Active Directory.
Этот API позволяет клиенту получить группы, членами которых является заданный пользователь.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
additionalData список / элементы=словарь	Дополнительные данные Active Directory Get User Groups Info.
name строка	Имя Active Directory Get User Groups Info.
value строка	Значение Active Directory Get User Groups Info.
id строка	Параметр пути id.
ise_debug логическое	Флаг для включения отладки Identity Services Engine SDK. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0	Таймаут (в секундах) для RESTful HTTP запросов. По умолчанию: `60`
ise_username строка / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway логическое добавлен в 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 логическое добавлен в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправлять ли маркер CSRF в API ERS ISE. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, предполагается, что SDK должен автоматически управлять маркером CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для Identity Services Engine SDK для включения автоматического управления ограничениями скорости. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемый метод SDK - active_directory.ActiveDirectory.get_user_groups,
Используемые пути - put /ers/config/activedirectory/{id}/getUserGroups,
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Get all Active Directory User Groups
  cisco.ise.active_directory_user_groups_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
    additionalData:
    - name: username
      value: Required. The user to get its groups.
  register: result

Значения возврата

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"groups": [{"name": "string", "sid": "string", "type": "string"}]}`

Авторы

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/active_directory_user_groups_info_module.html