Модуль cisco.ise.guest_type_info – Модуль информации о типе гостя
Примечание
Этот модуль входит в коллекцию cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.guest_type_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 для отправки запросов. Если 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, который включает автоматическую обработку ограничений скорости. Варианты:
|
page целое число | Параметр запроса страницы. Номер страницы. |
size целое число | Параметр запроса размера. Количество объектов, возвращаемых на страницу. |
sortasc строка | Параметр запроса sortasc. Сортировка по возрастанию. |
sortdsc строка | Параметр запроса sortdsc. Сортировка по убыванию. |
Примечания
Примечание
- Используемые методы SDK: guest_type.GuestType.get_guest_type_by_id, guest_type.GuestType.get_guest_type_generator,
- Используемые пути: get /ers/config/guesttype, get /ers/config/guesttype/{id},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Guest Type
cisco.ise.guest_type_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 Type by id
cisco.ise.guest_type_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/guest_type_info_module.html
