Модуль cisco.ise.guest_user_reinstate – Модуль ресурсов для восстановления пользователя гостевой сети

Примечание

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

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

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

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

Новый в cisco.ise 1.0.0

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

Описание

Управление обновлением операции ресурса "Восстановление пользователя гостевой сети".
Этот API позволяет клиенту восстановить пользователя гостевой сети по ID.
Этот API позволяет клиенту восстановить пользователя гостевой сети по имени.

Примечание

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

Требования

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

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 для отправки запросов. Если значение истинно, используется API-шлюз ISE и отправка запросов на https://{{ise_hostname}}. Если значение ложно, запросы отправляются на 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 строка	Параметр пути имени.

Примечания

Примечание

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

Примеры

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

- name: Update by id
  cisco.ise.guest_user_reinstate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: 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_reinstate_module.html