cisco.ise.identity_group модуль – Ресурсный модуль для группы идентификаторов

Примечание

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

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

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

Для использования в playbook, укажите: cisco.ise.identity_group.

Новое в cisco.ise 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

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

Управление операциями создания и обновления ресурса Identity Group.
Этот API создает группу идентификаторов.
Этот API позволяет клиенту обновлять группу идентификаторов.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
description string	Описание группы идентификаторов.
id string	Идентификатор группы идентификаторов.
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	Тайм-аут (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / обязательно	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в cisco.ise 1.1.0	Флаг, который сообщает SDK, следует ли использовать API Gateway Identity Services Engine для отправки запросов. Если это true, он использует API Gateway 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 ERS ISE. Если это 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` ← (по умолчанию)
name string	Имя группы идентификаторов.
parent string	Родительская группа идентификаторов.

Примечания

Примечание

Используемые методы SDK: identity_groups.IdentityGroups.create_identity_group, identity_groups.IdentityGroups.update_identity_group_by_id,
Используемые пути: post /ers/config/identitygroup, put /ers/config/identitygroup/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE для IdentityGroups: Полная справка по API IdentityGroups.

Примеры

- name: Update by id
  cisco.ise.identity_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    parent: string

- name: Create
  cisco.ise.identity_group:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    name: string
    parent: string

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

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

Ключ	Описание
ise_response dictionary	Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "parent": "string"}`
ise_update_response dictionary добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/identity_group_module.html