Модуль cisco.ise.native_supplicant_profile_info – Модуль информации для профиля Native Supplicant

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.ise. Вам потребуются дополнительные зависимости для использования этого модуля. Подробности см. в разделе Требования.

Чтобы использовать его в книге задач, укажите: cisco.ise.native_supplicant_profile_info.

Новая в cisco.ise 1.0.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Получение всех профилей Native Supplicant.
Получение профиля Native Supplicant по идентификатору.
Этот API позволяет клиенту получить профиль native supplicant по идентификатору.
Этот API позволяет клиенту получить все профили native supplicant.

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
id строка	Параметр пути id.
ise_debug логический	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout целое число добавлено в cisco.ise 3.0.0	Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: `60`
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). Варианты: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логический добавлено в cisco.ise 3.0.0	Флаг, информирующий SDK, отправлять ли маркер CSRF в API ERS ISE. Если True, SDK предполагает, что проверка CSRF ISE включена. Если True, предполагается, что SDK должен автоматически управлять маркером CSRF. Варианты: `false` ← (по умолчанию) `true`
ise_verify логический	Флаг для включения или отключения проверки SSL-сертификатов. Варианты: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логический	Флаг для Identity Services Engine SDK для автоматической обработки ограничения скорости. Варианты: `false` `true` ← (по умолчанию)
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на странице.

Примечания

Примечание

Используемые методы SDK: native_supplicant_profile.NativeSupplicantProfile.get_native_supplicant_profile_by_id, native_supplicant_profile.NativeSupplicantProfile.get_native_supplicant_profile_generator,
Используемые пути: get /ers/config/nspprofile, get /ers/config/nspprofile/{id},
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE для NativeSupplicantProfile: Полная справка по API NativeSupplicantProfile.

Примеры

- name: Get all Native Supplicant Profile
  cisco.ise.native_supplicant_profile_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Native Supplicant Profile by id
  cisco.ise.native_supplicant_profile_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 Возвращается: всегда Пример: `{"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "wirelessProfiles": [{"actionType": "string", "allowedProtocol": "string", "certificateTemplateId": "string", "previousSsid": "string", "ssid": "string"}]}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращаемым Python SDK Cisco ISE Возвращается: всегда Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"wirelessProfiles\": [\n {\n \"ssid\": \"string\",\n \"allowedProtocol\": \"string\",\n \"certificateTemplateId\": \"string\",\n \"actionType\": \"string\",\n \"previousSsid\": \"string\"\n }\n ],\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Ключ

Описание

ise_response

словарь

Словарь или список со значением, возвращаемым Python SDK Cisco ISE

Возвращается: всегда

Пример: {"description": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "wirelessProfiles": [{"actionType": "string", "allowedProtocol": "string", "certificateTemplateId": "string", "previousSsid": "string", "ssid": "string"}]}

ise_responses

список / элементы=словарь

добавлен в cisco.ise 1.1.0

Словарь или список со значением, возвращаемым Python SDK Cisco ISE

Возвращается: всегда

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"wirelessProfiles\": [\n {\n \"ssid\": \"string\",\n \"allowedProtocol\": \"string\",\n \"certificateTemplateId\": \"string\",\n \"actionType\": \"string\",\n \"previousSsid\": \"string\"\n }\n ],\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Авторы

Rafael Campos (@racampos)

Ссылки на сборку

© 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/native_supplicant_profile_info_module.html