Модуль cisco.ise.guest_user_approve — Модуль ресурсов для утверждения пользователя-гостя
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: cisco.ise.guest_user_approve.
Добавлена в cisco.ise 1.0.0
Описание
- Управление обновлением операции ресурса «Утверждение пользователя-гостя».
- Этот API позволяет клиенту утвердить пользователя-гостя по его идентификатору.
Примечание
У этого модуля есть соответствующий плагин действий.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
id строка | Параметр пути идентификатора. |
ise_debug логическое значение | Флаг для включения отладки в SDK Identity Services Engine. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлено в cisco.ise 3.0.0 | Таймаут (в секундах) для RESTful HTTP-запросов. По умолчанию: |
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). Варианты:
|
ise_uses_csrf_token логическое значение добавлено в cisco.ise 3.0.0 | Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE. Если значение истинно, SDK предполагает, что проверка CSRF вашего ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое значение | Флаг для включения или отключения проверки сертификатов SSL. Варианты:
|
ise_version строка | Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit логическое значение | Флаг для включения автоматической обработки лимита запросов в SDK Identity Services Engine. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: guest_user.GuestUser.approve_guest_user_by_id,
- Используемые пути: put /ers/config/guestuser/approve/{id},
- Не поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Update by id
cisco.ise.guest_user_approve:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
id: string
Значения возврата
Общие значения возврата описаны здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список, содержащий ответ, возвращённый Python SDK Cisco ISE Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_approve_module.html