Модуль cisco.ise.guest_user_info – Модуль информации о гостевом пользователе
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в книге задач, укажите: cisco.ise.guest_user_info.
Новая версия в cisco.ise 1.0.0
Описание
- Получить всех гостевых пользователей.
- Получить гостевого пользователя по идентификатору.
- Получить гостевого пользователя по имени.
- Этот API позволяет клиенту получить гостевого пользователя по идентификатору.
- Этот 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 для отправки запросов. Если 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 ERS ISE. Если 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: guest_user.GuestUser.get_guest_user_by_id, guest_user.GuestUser.get_guest_user_by_name, guest_user.GuestUser.get_guest_users_generator,
- Используемые пути: get /ers/config/guestuser, get /ers/config/guestuser/name/{name}, get /ers/config/guestuser/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Get all Guest User
cisco.ise.guest_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 Guest User by id
cisco.ise.guest_user_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
- name: Get Guest User by name
cisco.ise.guest_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/guest_user_info_module.html
