cisco.ise.user_equipment_info модуль — Модуль информации об оборудовании пользователя
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: cisco.ise.user_equipment_info.
Новая функция в cisco.ise 1.0.0
Обзор
- Получение всей информации об оборудовании пользователя.
- Получение информации об оборудовании пользователя по идентификатору.
Примечание
Для этого модуля имеется соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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, и его можно изменить, используя этот параметр. |
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 для включения автоматической обработки лимитов скорости. Варианты:
|
page целое число | Параметр запроса page. Номер страницы. |
size целое число | Параметр запроса size. Количество объектов, возвращаемых на странице. |
sort строка | Параметр запроса sort. Тип сортировки — asc или desc. |
sortBy строка | Параметр запроса sortBy. Столбец, по которому нужно отсортировать объекты. |
userEquipmentId строка | Параметр пути userEquipmentId. Уникальный идентификатор объекта оборудования пользователя. |
Примечания
Примечание
- Используемые методы SDK: user_equipment.UserEquipment.get_user_equipment_by_id, user_equipment.UserEquipment.get_user_equipments_generator,
- Используемые пути: get /api/v1/fiveg/user-equipment, get /api/v1/fiveg/user-equipment/{userEquipmentId},
- Поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all User Equipment Info
cisco.ise.user_equipment_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
page: 0
size: 0
filter: string
filterType: string
sort: string
sortBy: string
register: result
- name: Get User Equipment Info by id
cisco.ise.user_equipment_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
userEquipmentId: 7c9484cf-0ebc-47ad-a9ef-bc12729ed73b
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/user_equipment_info_module.html
