Модуль cisco.ise.byod_portal_info — Модуль информации для портала BYOD
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: cisco.ise.byod_portal_info.
Новая функция в cisco.ise 1.0.0
Описание
- Получение всех порталов BYOD.
- Получение портала BYOD по идентификатору.
- Этот API позволяет клиенту получить портал BYOD по ID.
- Этот API позволяет клиенту получить все порталы BYOD.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр фильтрации запроса. **Простая фильтрация** должна быть доступна через параметр строки запроса 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 — byod_portal.ByodPortal.get_byod_portal_by_id, byod_portal.ByodPortal.get_byod_portal_generator,
- Используемые пути — get /ers/config/byodportal, get /ers/config/byodportal/{id},
- Поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all BYOD Portal
cisco.ise.byod_portal_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 BYOD Portal by id
cisco.ise.byod_portal_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список со значением, возвращённым Python SDK Cisco ISE Возвращается: всегда Пример: |
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0 | Словарь или список со значением, возвращённым Python SDK Cisco ISE Возвращается: всегда Пример: |
Ссылки на коллекции
© 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/byod_portal_info_module.html
