Модуль cisco.ise.internal_user – Модуль ресурсов для внутренних пользователей
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в плейбуке, укажите: cisco.ise.internal_user.
Новый в cisco.ise 1.0.0
Описание
- Управление операциями создания, обновления и удаления ресурсов «Внутренний пользователь».
- Этот API создаёт внутреннего пользователя.
- Этот API удаляет внутреннего пользователя по ID.
- Этот API удаляет внутреннего пользователя по имени.
- Этот API позволяет клиенту обновить внутреннего пользователя по ID.
- Этот API позволяет клиенту обновить внутреннего пользователя по имени.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
changePassword boolean | Флаг ChangePassword. Варианты:
|
customAttributes dictionary | Соответствие ключ-значение. |
description string | Описание внутреннего пользователя. |
string | Электронная почта внутреннего пользователя. |
enabled boolean | Включен/выключен ли пользователь. Для использования в качестве фильтра значения должны быть «Enabled» или «Disabled». Регистр символов имеет значение. Например, ‘ERSObjectURL?filter=enabled.EQ.Enabled’. Варианты:
|
enablePassword string | Пароль enable внутреннего пользователя. |
expiryDate string | Для хранения информации о дате истечения срока действия внутреннего пользователя. Формат = «ГГГГ-ММ-ДД». |
expiryDateEnabled boolean | Флаг ExpiryDateEnabled. Варианты:
|
firstName string | Имя внутреннего пользователя. |
id string | Идентификатор внутреннего пользователя. |
identityGroups string | CSV идентификаторов групп идентификации. |
ise_debug boolean | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname string / required | Имя хоста Identity Services Engine. |
ise_password string / required | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0 | Таймаут (в секундах) для HTTP-запросов RESTful. По умолчанию: |
ise_username string / required | Имя пользователя 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). Варианты:
|
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0 | Флаг, сообщающий SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, предполагается, что вам необходимо, чтобы SDK автоматически управлял токеном CSRF. Варианты:
|
ise_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version string | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit boolean | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
lastName string | Фамилия внутреннего пользователя. |
name string | Имя внутреннего пользователя. |
password string | Пароль внутреннего пользователя. |
passwordIDStore string | Хранилище идентификаторов, где хранится пароль внутреннего пользователя. |
Примечания
Примечание
- Используемые методы SDK: internal_user.InternalUser.create_internal_user, internal_user.InternalUser.delete_internal_user_by_id, internal_user.InternalUser.delete_internal_user_by_name, internal_user.InternalUser.update_internal_user_by_id, internal_user.InternalUser.update_internal_user_by_name,
- Используемые пути: post /ers/config/internaluser, delete /ers/config/internaluser/name/{name}, delete /ers/config/internaluser/{id}, put /ers/config/internaluser/name/{name}, put /ers/config/internaluser/{id},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Update by name
cisco.ise.internal_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
changePassword: true
customAttributes: {}
description: string
email: string
enablePassword: string
enabled: true
expiryDate: string
expiryDateEnabled: true
firstName: string
id: string
identityGroups: string
lastName: string
name: string
password: string
passwordIDStore: string
- name: Delete by name
cisco.ise.internal_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
name: string
- name: Update by id
cisco.ise.internal_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
changePassword: true
customAttributes: {}
description: string
email: string
enablePassword: string
enabled: true
expiryDate: string
expiryDateEnabled: true
firstName: string
id: string
identityGroups: string
lastName: string
name: string
password: string
passwordIDStore: string
- name: Delete by id
cisco.ise.internal_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.internal_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
changePassword: true
customAttributes: {}
description: string
email: string
enablePassword: string
enabled: true
expiryDate: string
expiryDateEnabled: true
firstName: string
identityGroups: string
lastName: string
name: string
password: string
passwordIDStore: string
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением возврата Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_update_response словарь добавлен в cisco.ise 1.1.0 | Словарь или список со значением возврата Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/internal_user_module.html