Модуль cisco.ise.admin_user_info – Модуль информации об административных пользователях
Примечание
Этот модуль входит в состав коллекции cisco.ise (версия 2.9.3).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробные сведения см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.admin_user_info.
Добавлен в cisco.ise 1.0.0
Описание
- Получение всех административных пользователей.
- Получение административного пользователя по идентификатору.
- Этот API позволяет клиенту получить всех административных пользователей.
- Этот API позволяет клиенту получить административного пользователя по его идентификатору.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется данный модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтра. **Простая фильтрация** должна быть доступна через строку запроса параметра фильтра. Структура фильтра — тройка: поле, оператор и значение, разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для всех критериев фильтра, по умолчанию — И, и его можно изменить, используя параметр строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор ‘EQ’ описывает «Равно». Оператор ‘NEQ’ описывает «Не равно». Оператор ‘GT’ описывает «Больше, чем». Оператор ‘LT’ описывает «Меньше, чем». Оператор ‘STARTSW’ описывает «Начинается с». Оператор ‘NSTARTSW’ описывает «Не начинается с». Оператор ‘ENDSW’ описывает «Заканчивается на». Оператор ‘NENDSW’ описывает «Не заканчивается на». Оператор ‘CONTAINS’ описывает «Содержит». Оператор ‘NCONTAINS’ описывает «Не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для всех критериев фильтра, по умолчанию — И, и его можно изменить, используя этот параметр. |
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 для отправки запросов. Если значение истинно, используется API шлюз ISE, и запросы отправляются на https://{{ise_hostname}}. Если значение ложно, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token логическое значение добавлено в cisco.ise 3.0.0 | Флаг, информирующий SDK о том, отправлять ли токен CSRF в API ERS ISE. Если значение истинно, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое значение | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
ise_version строка | Уведомляет SDK о версии Identity Services Engine, которую нужно использовать. По умолчанию: |
ise_wait_on_rate_limit логическое значение | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на страницу. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: admin_user.AdminUser.get_admin_user_by_id, admin_user.AdminUser.get_admin_users_generator,
- Используемые пути: get /ers/config/adminuser, get /ers/config/adminuser/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all Admin User
cisco.ise.admin_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 Admin User by id
cisco.ise.admin_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: 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/admin_user_info_module.html
