cisco.ise.subscriber_info модуль — Модуль информации о подписчике
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Чтобы использовать его в книге задач, укажите: cisco.ise.subscriber_info.
Добавлена в cisco.ise 2.8.0
Обзор
- Получение всех подписчиков.
- Получение подписчика по идентификатору.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter строка | Параметр запроса фильтрации. .. Контейнер **Простая фильтрация** должна быть доступна через параметр строки запроса фильтра. Структура фильтра — тройка «поле оператор значение», разделенные точками. Можно отправлять несколько фильтров. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — И, и его можно изменить, используя параметр строки запроса *”filterType=or”*. Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтра. Оператор «EQ» описывает «Равно». Оператор «NEQ» описывает «Не равно». Оператор «GT» описывает «Больше чем». Оператор «LT» описывает «Меньше чем». Оператор «STARTSW» описывает «Начинается с». Оператор «NSTARTSW» описывает «Не начинается с». Оператор «ENDSW» описывает «Заканчивается на». Оператор «NENDSW» описывает «Не заканчивается на». Оператор «CONTAINS» описывает «Содержит». Оператор «NCONTAINS» описывает «Не содержит». |
filterType строка | Параметр запроса FilterType. Логический оператор, общий для ВСЕХ критериев фильтрации, по умолчанию — И, и его можно изменить, используя параметр. |
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 целое число | Параметр запроса размера. Количество объектов, возвращаемых на страницу. |
sort строка | Параметр запроса сортировки. Тип сортировки — asc или desc. |
sortBy строка | Параметр запроса sortBy. Столбец для сортировки объектов. |
subscriberId строка | Параметр пути subscriberId. Уникальный идентификатор объекта абонента. |
Примечания
Примечание
- Используемые методы SDK: subscriber.Subscriber.get_all_subscribers_generator, subscriber.Subscriber.get_subscriber_by_id,
- Используемые пути: get /api/v1/fiveg/subscriber, get /api/v1/fiveg/subscriber/{subscriberId},
- Поддерживает
check_mode - Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Subscriber
cisco.ise.subscriber_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 Subscriber by id
cisco.ise.subscriber_info:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
subscriberId: string
register: result
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_responses список / элементы=словарь | Словарь или список с ответом, возвращенным 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/subscriber_info_module.html
