Модуль cisco.ise.guest_user – Модуль ресурсов для пользователя гостя
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: cisco.ise.guest_user.
Новая в cisco.ise 1.0.0
Обзор
- Управление операциями создания, обновления и удаления ресурса «Пользователь гостя».
- Этот API создаёт пользователя гостя.
- Этот API удаляет пользователя гостя по идентификатору.
- Этот API удаляет пользователя гостя.
- Этот API позволяет клиенту обновить пользователя гостя по идентификатору.
- Этот API позволяет клиенту обновить пользователя гостя по имени.
Примечание
Этот модуль имеет соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
customFields словарь | Карта ключ-значение. |
description строка | Описание гостевого пользователя. |
guestAccessInfo словарь | guestAccessInfo гостевого пользователя. |
|
fromDate строка |
fromDate гостевого пользователя. |
|
groupTag строка |
groupTag гостевого пользователя. |
|
location строка |
Расположение гостевого пользователя. |
|
ssid строка |
ssid гостевого пользователя. |
|
toDate строка |
toDate гостевого пользователя. |
|
validDays целое число |
validDays гостевого пользователя. |
guestInfo словарь | guestInfo гостевого пользователя. |
|
company строка |
Компания гостевого пользователя. |
|
creationTime строка |
creationTime гостевого пользователя. |
|
emailAddress строка |
Электронная почта гостевого пользователя. |
|
enabled логическое |
Это поле используется только для операции Get, не применимо для операций Create, Update. Варианты:
|
|
firstName строка |
Имя гостевого пользователя. |
|
lastName строка |
Фамилия гостевого пользователя. |
|
notificationLanguage строка |
Язык уведомлений гостевого пользователя. |
|
password строка |
Пароль гостевого пользователя. |
|
phoneNumber строка |
Номер телефона должен быть в формате E.164. |
|
smsServiceProvider строка |
smsServiceProvider гостевого пользователя. |
|
userName строка |
Если учетная запись необходимо создать с помощью номера мобильного телефона, укажите его здесь. |
guestType строка | guestType гостевого пользователя. |
id строка | id гостевого пользователя. |
ise_debug логическое | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
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 в ERS API ISE. Если значение истинно, SDK предполагает, что проверка CSRF ISE включена. Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify логическое | Флаг для включения или выключения проверки SSL-сертификатов. Варианты:
|
ise_version строка | Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit логическое | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничений скорости. Варианты:
|
name строка | Имя гостевого пользователя. |
portalId строка | portalId гостевого пользователя. |
reasonForVisit строка | Причина посещения гостевого пользователя. |
sponsorUserId строка | sponsorUserId гостевого пользователя. |
sponsorUserName строка | sponsorUserName гостевого пользователя. |
status строка | Статус гостевого пользователя. |
statusReason строка | Причина статуса гостевого пользователя. |
Примечания
Примечание
- Используемые методы SDK: guest_user.GuestUser.create_guest_user, guest_user.GuestUser.delete_guest_user_by_id, guest_user.GuestUser.delete_guest_user_by_name, guest_user.GuestUser.update_guest_user_by_id, guest_user.GuestUser.update_guest_user_by_name,
- Используемые пути: post /ers/config/guestuser, delete /ers/config/guestuser/name/{name}, delete /ers/config/guestuser/{id}, put /ers/config/guestuser/name/{name}, put /ers/config/guestuser/{id},
- Не поддерживает
check_mode - Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
Примеры
- name: Update by name
cisco.ise.guest_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customFields: {}
description: string
guestAccessInfo:
fromDate: string
groupTag: string
location: string
ssid: string
toDate: string
validDays: 0
guestInfo:
company: string
creationTime: string
emailAddress: string
enabled: true
firstName: string
lastName: string
notificationLanguage: string
password: string
phoneNumber: string
smsServiceProvider: string
userName: string
guestType: string
id: string
name: string
portalId: string
reasonForVisit: string
sponsorUserId: string
sponsorUserName: string
status: string
statusReason: string
- name: Delete by name
cisco.ise.guest_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
name: string
- name: Update by id
cisco.ise.guest_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customFields: {}
description: string
guestAccessInfo:
fromDate: string
groupTag: string
location: string
ssid: string
toDate: string
validDays: 0
guestInfo:
company: string
creationTime: string
emailAddress: string
enabled: true
firstName: string
lastName: string
notificationLanguage: string
password: string
phoneNumber: string
smsServiceProvider: string
userName: string
guestType: string
id: string
name: string
portalId: string
reasonForVisit: string
sponsorUserId: string
sponsorUserName: string
status: string
statusReason: string
- name: Delete by id
cisco.ise.guest_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.guest_user:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customFields: {}
description: string
guestAccessInfo:
fromDate: string
groupTag: string
location: string
ssid: string
toDate: string
validDays: 0
guestInfo:
company: string
creationTime: string
emailAddress: string
enabled: true
firstName: string
lastName: string
notificationLanguage: string
password: string
phoneNumber: string
smsServiceProvider: string
userName: string
guestType: string
name: string
portalId: string
reasonForVisit: string
sponsorUserId: string
sponsorUserName: string
status: string
statusReason: string
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_update_response словарь добавлен в cisco.ise 1.1.0 | Словарь или список с ответом, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: |
Ссылки на сборку
© 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_module.html