Модуль cisco.ise.internal_user_info – Модуль информации о внутреннем пользователе
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.
Чтобы использовать его в книге задач, укажите: cisco.ise.internal_user_info.
Добавлена в cisco.ise 1.0.0
Описание
- Получение всех внутренних пользователей.
- Получение внутреннего пользователя по идентификатору.
- Получение внутреннего пользователя по имени.
- Этот API позволяет клиенту получить всех внутренних пользователей.
- Этот API позволяет клиенту получить внутреннего пользователя по ID.
- Этот API позволяет клиенту получить внутреннего пользователя по имени.
Примечание
Для этого модуля есть соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтрации. **Простая фильтрация** должна быть доступна через параметр строки запроса filter. Структура фильтра — тройка «поле оператор значение», разделенных точками. Можно отправлять несколько фильтров. По умолчанию логический оператор для ВСЕХ критериев фильтрации — AND, его можно изменить, используя параметр строки запроса «filterType=or». В описании модели данных каждого ресурса должно быть указано, является ли атрибут полем фильтра. Оператор ‘EQ’ описывает «Равно». Оператор ‘NEQ’ описывает «Не равно». Оператор ‘GT’ описывает «Больше, чем». Оператор ‘LT’ описывает «Меньше, чем». Оператор ‘STARTSW’ описывает «Начинается с». Оператор ‘NSTARTSW’ описывает «Не начинается с». Оператор ‘ENDSW’ описывает «Оканчивается на». Оператор ‘NENDSW’ описывает «Не оканчивается на». Оператор ‘CONTAINS’ описывает «Содержит». Оператор ‘NCONTAINS’ описывает «Не содержит». |
filterType строка | Параметр запроса filterType. По умолчанию логический оператор для ВСЕХ критериев фильтрации — AND, его можно изменить, используя этот параметр. |
id строка | Параметр пути id. |
ise_debug булево | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token булево добавлен в cisco.ise 3.0.0 | Флаг, информирующий SDK, отправлять ли токен CSRF в API ISE ERS. Если значение True, SDK предполагает, что проверка CSRF ISE включена. Если значение True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify булево | Флаг для включения или выключения проверки сертификата SSL. Варианты:
|
ise_version строка | Информирует SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit булево | Флаг для Identity Services Engine SDK для включения автоматической обработки лимита запросов. Варианты:
|
name строка | Параметр пути name. |
page целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов на странице. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Методы SDK используются internal_user.InternalUser.get_internal_user_by_id, internal_user.InternalUser.get_internal_user_by_name, internal_user.InternalUser.get_internal_user_generator,
- Используемые пути: get /ers/config/internaluser, get /ers/config/internaluser/name/{name}, get /ers/config/internaluser/{id},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all Internal User
cisco.ise.internal_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 1
size: 20
sortasc: string
sortdsc: string
filter: []
filterType: AND
register: result
- name: Get Internal User by id
cisco.ise.internal_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get Internal User by name
cisco.ise.internal_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
name: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлен в 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_info_module.html
