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

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

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

Примечания

Примечание

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

Примеры

- name: Update by name
  cisco.ise.guest_user_suspend:
    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_suspend:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    additionalData:
    - name: reason
      value: reason
    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_user_suspend_module.html