Модуль cisco.ise.guest_type_sms — Модуль ресурсов для типа гостевого SMS

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.ise.guest_type_sms.

Новинка в cisco.ise 1.0.0

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

Описание

Управление обновлением операции ресурса «Тип гостевого SMS».
Этот API позволяет клиенту обновлять тип гостевого SMS по ID.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
additionalData список / элементы=словарь	Дополнительные данные типа гостевого SMS.
name строка	Имя типа гостевого SMS.
value строка	Значение типа гостевого SMS.
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` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Update by id
  cisco.ise.guest_type_sms:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    additionalData:
    - name: phoneNumber
      value: phoneNumber
    - name: serviceProvider
      value: serviceProvider
    id: string

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

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

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

Авторы

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