Модуль cisco.ise.native_supplicant_profile – Модуль ресурсов для профиля 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.

Новое в cisco.ise 1.0.0

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

Описание

Управление операциями обновления и удаления ресурса Профиля Native Supplicant.
Этот API удаляет профиль native supplicant.
Этот API позволяет клиенту обновить профиль native supplicant.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
description строка	Описание профиля Native Supplicant.
id строка	Идентификатор профиля Native Supplicant.
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` ← (по умолчанию)
name строка	Название профиля Native Supplicant.
wirelessProfiles список / элементы=словарь	WirelessProfiles профиля Native Supplicant.
actionType строка	Тип действия для WifiProfile. Допустимые значения - ADD, - UPDATE, - DELETE (требуется для обновления существующего WirelessProfile).
allowedProtocol строка	allowedProtocol профиля Native Supplicant.
certificateTemplateId строка	certificateTemplateId профиля Native Supplicant.
previousSSID строка	Предыдущий ssid для WifiProfile (требуется для обновления существующего WirelessProfile).
ssid строка	ssid профиля Native Supplicant.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update by id
  cisco.ise.native_supplicant_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    description: string
    id: string
    name: string
    wirelessProfiles:
    - actionType: string
      allowedProtocol: string
      certificateTemplateId: string
      previousSsid: string
      ssid: string

- name: Delete by id
  cisco.ise.native_supplicant_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

Значения возврата

Общие значения возврата описаны здесь, а следующие поля уникальны для этого модуля:

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращаемое значение: всегда Пример: `{"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_update_response словарь Добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращаемое значение: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

словарь

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

Возвращаемое значение: всегда

Пример: {"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_update_response

словарь

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

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

Возвращаемое значение: всегда

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Авторы

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_module.html