Модуль cisco.ise.active_directory_groups_by_domain_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_groups_by_domain_info.

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

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
additionalData список / элементы=словарь	Дополнительные данные для получения информации о группах Active Directory по домену.
name строка	Имя для получения информации о группах Active Directory по домену.
value строка	Значение для получения информации о группах Active Directory по домену.
id строка	Параметр пути Id.
ise_debug логический тип	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `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 для отправки запросов. Если значение истина, используется шлюз API ISE, и запросы отправляются на https://{{ise_hostname}}. Если значение ложь, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты: `false` `true` ← (значение по умолчанию)
ise_uses_csrf_token логический тип добавлено в cisco.ise 3.0.0	Флаг, информирующий SDK, отправлять ли токен CSRF в API ERS ISE. Если значение истинно, SDK предполагает, что проверка CSRF ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты: `false` ← (значение по умолчанию) `true`
ise_verify логический тип	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (значение по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логический тип	Флаг для включения автоматической обработки лимита запросов в SDK Identity Services Engine. Варианты: `false` `true` ← (значение по умолчанию)

Примечания

Примечание

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

Примеры

- name: Get all Active Directory Groups By Domain
  cisco.ise.active_directory_groups_by_domain_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
    additionalData:
    - name: domain
      value: Required. The domain whose groups we want to fetch
    - name: filter
      value: Optional. Exact match filter on group's CN
    - name: sidFilter
      value: Optional. Exact match filter on group's SID, optionally specifying the domain
        as prefix. e.g. S-1-5-33-544 and R1.dom/S-1-5-33-544 are legal
    - name: typeFilter
      value: Optional. Can be exactly one of:BUILTIN, DOMAIN LOCAL, GLOBAL, UNIVERSAL
  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_groups_by_domain_info_module.html