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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.guest_user_deny.

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

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

Обзор

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
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 ISE ERS. Если значение 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_user.GuestUser.deny_guest_user_by_id,
Используемые пути: put /ers/config/guestuser/deny/{id},
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

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