Модуль cisco.ise.guest_user_sms – Модуль ресурсов для SMS-сообщений гостевых пользователей

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.guest_user_sms.

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Управление обновлением ресурса SMS гостевого пользователя.
Этот API позволяет клиенту обновлять SMS гостевого пользователя по идентификатору.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
id строка	Параметр пути id.
ise_debug логическое	Флаг для включения отладки в SDK Identity Services Engine. Варианты: `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` ← (по умолчанию)
...	...

Примечания

Примечание

Используемые методы SDK: guest_user.GuestUser.update_guest_user_sms,
Используемые пути: put /ers/config/guestuser/sms/{id}/portalId/{portalId},
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.guest_user_sms:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
    portalId: string

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

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

Ключ	Описание
ise_response словарь	Словарь или список, содержащий ответ, возвращенный Python SDK Cisco ISE Возвращается: всегда Пример: `{}`

Авторы

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/guest_user_sms_module.html