Модуль cisco.ise.guest_ssid_info — Модуль информации о гостевых SSID
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Для использования в playbook укажите: cisco.ise.guest_ssid_info.
Новая функция в cisco.ise 1.0.0
Обзор
- Получить все гостевые SSID.
- Получить гостевой SSID по идентификатору.
- Этот API позволяет клиенту получить гостевой SSID по идентификатору.
- Этот API позволяет клиенту получить все гостевые SSID.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
filter список / элементы=строка | Параметр запроса фильтрации. **Простая фильтрация** должна быть доступна через параметр строки запроса фильтрации. Структура фильтра представляет собой тройку поля, оператора и значения, разделенных точками. Можно отправлять несколько фильтров. Логический оператор, общий для всех критериев фильтрации, по умолчанию будет AND и может быть изменён с помощью параметра строки запроса «filterType=or». Описание модели данных каждого ресурса должно указывать, является ли атрибут полем фильтрации. Оператор ‘EQ’ описывает «равно». Оператор ‘NEQ’ описывает «не равно». Оператор ‘GT’ описывает «больше». Оператор ‘LT’ описывает «меньше». Оператор ‘STARTSW’ описывает «начинается с». Оператор ‘NSTARTSW’ описывает «не начинается с». Оператор ‘ENDSW’ описывает «заканчивается на». Оператор ‘NENDSW’ описывает «не заканчивается на». Оператор ‘CONTAINS’ описывает «содержит». Оператор ‘NCONTAINS’ описывает «не содержит». |
filterType строка | Параметр запроса filterType. Логический оператор, общий для всех критериев фильтрации, по умолчанию будет AND и может быть изменён с помощью параметра. |
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_ssid.GuestSsid.get_guest_ssid_by_id, guest_ssid.GuestSsid.get_guest_ssid_generator,
- Используемые пути: get /ers/config/guestssid, get /ers/config/guestssid/{id},
- Поддерживает
check_mode - Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Get all Guest SSID
cisco.ise.guest_ssid_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 SSID by id
cisco.ise.guest_ssid_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/guest_ssid_info_module.html
