Модуль cisco.ise.sponsored_guest_portal – Ресурсный модуль для портала спонсируемых гостей
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для подробной информации.
Для использования в playbook, укажите: cisco.ise.sponsored_guest_portal.
Новое в cisco.ise 1.0.0
Краткое описание
- Управление операциями создания, обновления и удаления ресурса Sponsored Guest Portal.
- Этот API создает портал спонсируемых гостей.
- Этот API удаляет портал спонсируемых гостей по ID.
- Этот API позволяет клиенту обновлять портал спонсируемых гостей по ID.
Примечание
Этот модуль имеет соответствующий плагин действия.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
customizations dictionary | Определяет все доступные настройки портала. |
|
globalCustomizations dictionary |
Глобальные настройки портала для гостей с оплатой. |
|
backgroundImage dictionary |
Фоновое изображение портала для гостей с оплатой. |
|
data string |
Представлено как строка, закодированная в base 64, из массива байтов изображения. |
|
bannerImage dictionary |
Баннерное изображение портала для гостей с оплатой. |
|
data string |
Представлено как строка, закодированная в base 64, из массива байтов изображения. |
|
bannerTitle string |
Заголовок баннера портала для гостей с оплатой. |
|
contactText string |
Контактный текст портала для гостей с оплатой. |
|
desktopLogoImage dictionary |
Логотип для настольных компьютеров портала для гостей с оплатой. |
|
data string |
Представлено как строка, закодированная в base 64, из массива байтов изображения. |
|
string |
Элемент нижнего колонтитула портала для гостей с оплатой. |
|
mobileLogoImage dictionary |
Логотип для мобильных устройств портала для гостей с оплатой. |
|
data string |
Представлено как строка, закодированная в base 64, из массива байтов изображения. |
|
language dictionary |
Это свойство поддерживается только для операции чтения, и оно позволяет отображать настройки на английском языке. Другие языки не поддерживаются. |
|
viewLanguage string |
Язык отображения портала для гостей с оплатой. |
|
pageCustomizations dictionary |
Представляет всю настройку страницы как один большой словарь. |
|
data list / elements=dictionary |
Словарь будет представлен здесь как пара ключ-значение. |
|
key string |
Ключ портала для гостей с оплатой. |
|
value string |
Значение портала для гостей с оплатой. |
|
portalTheme dictionary |
Тема портала для гостей с оплатой. |
|
id string |
Идентификатор портала для гостей с оплатой. |
|
name string |
Системное или назначенное пользователем имя темы портала. |
|
themeData string |
CSS-файл, представленный как закодированный в Base64 массив байтов. |
|
portalTweakSettings dictionary |
Настройки тонкой настройки — это настройка выбранной для портала темы портала. При изменении выбора темы портала настройки тонкой настройки перезаписываются в соответствии со значениями в теме. Настройки тонкой настройки могут быть изменены пользователем позже. |
|
bannerColor string |
Шестнадцатеричное значение цвета. |
|
bannerTextColor string |
Цвет баннера портала Sponsored Guest Portal. |
|
pageBackgroundColor string |
Цвет фона страницы портала Sponsored Guest Portal. |
|
pageLabelAndTextColor string |
Цвет подписей и текста страницы портала Sponsored Guest Portal. |
description string | Описание портала Sponsored Guest Portal. |
id string | Идентификатор портала Sponsored Guest Portal. |
ise_debug boolean | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname string / required | Имя хоста Identity Services Engine. |
ise_password string / required | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0 | Таймаут (в секундах) для HTTP-запросов RESTful. По умолчанию: |
ise_username string / required | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway boolean добавлено в cisco.ise 1.1.0 | Флаг, сообщающий SDK, следует ли использовать API Gateway Identity Services Engine для отправки запросов. Если это true, используется API Gateway ISE и запросы отправляются по адресу https://{{ise_hostname}}. Если это false, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0 | Флаг, сообщающий SDK, отправляем ли мы маркер CSRF в API ERS ISE. Если это True, SDK предполагает, что проверка CSRF вашего ISE включена. Если это True, предполагается, что вам необходимо, чтобы SDK автоматически управлял маркером CSRF. Варианты:
|
ise_verify boolean | Флаг для включения или отключения проверки SSL-сертификата. Варианты:
|
ise_version string | Сообщает SDK, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit boolean | Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты:
|
name string | Название портала Sponsored Guest Portal. |
portalTestUrl string | URL для вызова тестовой страницы этого портала. |
portalType string | Допустимые значения - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST. |
settings dictionary | Определяет все группы настроек, доступные для портала. |
|
aupSettings dictionary |
aupSettings портала Sponsored Guest Portal. |
|
displayFrequency string |
Как должен отображаться AUP, на странице или как ссылка. Действительно только если includeAup = true. Допустимые значения - FIRSTLOGIN, - EVERYLOGIN, - RECURRING. |
|
displayFrequencyIntervalDays integer |
Количество дней между подтверждениями AUP (когда displayFrequency = recurring). |
|
includeAup boolean |
Флаг IncludeAup. Choices:
|
|
requireAupScrolling boolean |
Требуется прокрутка портала пользователем до конца AUP. Действительно только если requireAupAcceptance = true. Choices:
|
|
requireScrolling boolean |
Флаг RequireScrolling. Choices:
|
|
skipAupForEmployees boolean |
Действительно только если requireAupAcceptance = true. Choices:
|
|
useDiffAupForEmployees boolean |
Действительно только если requireAupAcceptance = true. Choices:
|
|
authSuccessSettings dictionary |
authSuccessSettings портала Sponsored Guest Portal. |
|
redirectUrl string |
Целевой URL для перенаправления, используется, когда successRedirect = URL. |
|
successRedirect string |
Куда следует перенаправить устройство после успешной аутентификации. Допустимые значения - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL. |
|
byodSettings dictionary |
byodSettings портала Sponsored Guest Portal. |
|
byodRegistrationSettings dictionary |
Конфигурация шага регистрации конечной точки BYOD. |
|
endPointIdentityGroupId string |
Идентификатор группы идентификаторов, к которой принадлежит конечная точка. |
|
showDeviceID boolean |
Отображать поле Device ID во время регистрации. Choices:
|
|
byodRegistrationSuccessSettings dictionary |
byodRegistrationSuccessSettings портала Sponsored Guest Portal. |
|
redirectUrl string |
Целевой URL для перенаправления, используется, когда successRedirect = URL. |
|
successRedirect string |
Куда следует перенаправить устройство после успешной аутентификации. Допустимые значения - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL. |
|
byodWelcomeSettings dictionary |
byodWelcomeSettings портала Sponsored Guest Portal. |
|
aupDisplay string |
Как следует отображать AUP: на странице или как ссылку. Действительно только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK. |
|
enableBYOD boolean |
Флаг EnableBYOD. Choices:
|
|
enableGuestAccess boolean |
Флаг EnableGuestAccess. Choices:
|
|
includeAup boolean |
Флаг IncludeAup. Choices:
|
|
requireAupAcceptance boolean |
Флаг RequireAupAcceptance. Choices:
|
|
requireMDM boolean |
Флаг RequireMDM. Choices:
|
|
requireScrolling boolean |
Требуется, чтобы устройства BYOD прокрутили вниз до конца AUP. Действительно только если includeAup = true. Choices:
|
|
guestChangePasswordSettings dictionary |
guestChangePasswordSettings спонсируемого гостевого портала. |
|
allowChangePasswdAtFirstLogin boolean |
Разрешить гостю изменять свои собственные пароли. Choices:
|
|
guestDeviceRegistrationSettings dictionary |
guestDeviceRegistrationSettings спонсируемого гостевого портала. |
|
allowGuestsToRegisterDevices boolean |
Разрешить гостям регистрировать устройства. Choices:
|
|
autoRegisterGuestDevices boolean |
Автоматически регистрировать гостевые устройства. Choices:
|
|
loginPageSettings dictionary |
Далее следуют группы настроек страницы входа в портал. |
|
accessCode string |
Код доступа, который должен быть введен пользователем портала (действительно только если requireAccessCode = true). |
|
allowAlternateGuestPortal boolean |
Флаг AllowAlternateGuestPortal. Choices:
|
|
allowForgotPassword boolean |
Флаг AllowForgotPassword. Choices:
|
|
allowGuestToChangePassword boolean |
Требуется ввод кода доступа пользователем портала. Choices:
|
|
allowGuestToCreateAccounts boolean |
Флаг AllowGuestToCreateAccounts. Choices:
|
|
aupDisplay string |
Как следует отображать AUP, на странице или в виде ссылки. Действительно только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK. |
|
includeAup boolean |
Включить политику приемлемого использования (AUP), которая должна отображаться во время входа. Choices:
|
|
maxFailedAttemptsBeforeRateLimit integer |
Максимальное количество неудачных попыток входа перед ограничением скорости. |
|
requireAccessCode boolean |
Флаг RequireAccessCode. Choices:
|
|
requireAupAcceptance boolean |
Требуется, чтобы пользователь портала принял AUP. Действительно только если includeAup = true. Choices:
|
|
socialConfigs list / elements=dictionary |
Настройки socialConfigs портала Sponsored Guest. |
|
socialMediaType string |
Настройки socialMediaType портала Sponsored Guest. |
|
socialMediaValue string |
Настройки socialMediaValue портала Sponsored Guest. |
|
timeBetweenLoginsDuringRateLimit integer |
Время между попытками входа при ограничении скорости. |
|
portalSettings dictionary |
Порт, интерфейс, сертификат и другие основные настройки портала. |
|
allowedInterfaces list / elements=string |
Интерфейсы, на которых портал будет доступен. Допустимые значения - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2. |
|
alwaysUsedLanguage string |
Настройки alwaysUsedLanguage портала Sponsored Guest. |
|
assignedGuestTypeForEmployee string |
Уникальный идентификатор типа гостя. Сотрудники, использующие этот портал как гости, наследуют параметры входа от типа гостя. |
|
authenticationMethod string |
Уникальный идентификатор последовательности источников идентификации. |
|
certificateGroupTag string |
Логическое имя серверного сертификата x.509, который будет использоваться для портала. |
|
displayLang string |
Допустимые значения - USEBROWSERLOCALE, - ALWAYSUSE. |
|
fallbackLanguage string |
Используется, когда displayLang = USEBROWSERLOCALE. |
|
httpsPort integer |
Номер порта, который будут прослушивать разрешенные интерфейсы. Диапазон от 8000 до 8999. |
|
postAccessBannerSettings dictionary |
Настройки postAccessBannerSettings портала Sponsored Guest. |
|
includePostAccessBanner boolean |
Флаг IncludePostAccessBanner. Варианты:
|
|
postLoginBannerSettings dictionary |
Настройки postLoginBannerSettings портала Sponsored Guest. |
|
includePostAccessBanner boolean |
Включить страницу баннера после входа. Варианты:
|
|
supportInfoSettings dictionary |
Настройки supportInfoSettings портала Sponsored Guest. |
|
defaultEmptyFieldValue string |
Значение по умолчанию, отображаемое для пустого поля. Действительно только когда emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE. |
|
emptyFieldDisplay string |
Указывает, как обрабатываются пустые поля на странице информации о поддержке. Допустимые значения - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE. |
|
includeBrowserUserAgent boolean |
Флаг IncludeBrowserUserAgent. Варианты:
|
|
includeFailureCode boolean |
Флаг IncludeFailureCode. Варианты:
|
|
includeIpAddress boolean |
Флаг IncludeIpAddress. Варианты:
|
|
includeMacAddr boolean |
Флаг IncludeMacAddr. Варианты:
|
|
includePolicyServer boolean |
Флаг IncludePolicyServer. Варианты:
|
|
includeSupportInfoPage boolean |
Флаг IncludeSupportInfoPage. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: sponsored_guest_portal.SponsoredGuestPortal.create_sponsored_guest_portal, sponsored_guest_portal.SponsoredGuestPortal.delete_sponsored_guest_portal_by_id, sponsored_guest_portal.SponsoredGuestPortal.update_sponsored_guest_portal_by_id,
- Используемые пути: post /ers/config/sponsoredguestportal, delete /ers/config/sponsoredguestportal/{id}, put /ers/config/sponsoredguestportal/{id},
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения
Примеры
- name: Update by id
cisco.ise.sponsored_guest_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
id: string
name: string
portalTestUrl: string
portalType: string
settings:
aupSettings:
displayFrequency: string
displayFrequencyIntervalDays: 0
includeAup: true
requireAupScrolling: true
requireScrolling: true
skipAupForEmployees: true
useDiffAupForEmployees: true
authSuccessSettings:
redirectUrl: string
successRedirect: string
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
guestChangePasswordSettings:
allowChangePasswdAtFirstLogin: true
guestDeviceRegistrationSettings:
allowGuestsToRegisterDevices: true
autoRegisterGuestDevices: true
loginPageSettings:
accessCode: string
allowAlternateGuestPortal: true
allowForgotPassword: true
allowGuestToChangePassword: true
allowGuestToCreateAccounts: true
aupDisplay: string
includeAup: true
maxFailedAttemptsBeforeRateLimit: 0
requireAccessCode: true
requireAupAcceptance: true
socialConfigs:
- socialMediaType: string
socialMediaValue: string
timeBetweenLoginsDuringRateLimit: 0
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
assignedGuestTypeForEmployee: string
authenticationMethod: string
certificateGroupTag: string
displayLang: string
fallbackLanguage: string
httpsPort: 0
postAccessBannerSettings:
includePostAccessBanner: true
postLoginBannerSettings:
includePostAccessBanner: true
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
- name: Delete by id
cisco.ise.sponsored_guest_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.sponsored_guest_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
name: string
portalTestUrl: string
portalType: string
settings:
aupSettings:
displayFrequency: string
displayFrequencyIntervalDays: 0
includeAup: true
requireAupScrolling: true
requireScrolling: true
skipAupForEmployees: true
useDiffAupForEmployees: true
authSuccessSettings:
redirectUrl: string
successRedirect: string
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
guestChangePasswordSettings:
allowChangePasswdAtFirstLogin: true
guestDeviceRegistrationSettings:
allowGuestsToRegisterDevices: true
autoRegisterGuestDevices: true
loginPageSettings:
accessCode: string
allowAlternateGuestPortal: true
allowForgotPassword: true
allowGuestToChangePassword: true
allowGuestToCreateAccounts: true
aupDisplay: string
includeAup: true
maxFailedAttemptsBeforeRateLimit: 0
requireAccessCode: true
requireAupAcceptance: true
socialConfigs:
- socialMediaType: string
socialMediaValue: string
timeBetweenLoginsDuringRateLimit: 0
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
assignedGuestTypeForEmployee: string
authenticationMethod: string
certificateGroupTag: string
displayLang: string
fallbackLanguage: string
httpsPort: 0
postAccessBannerSettings:
includePostAccessBanner: true
postLoginBannerSettings:
includePostAccessBanner: true
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
ise_response dictionary | Словарь или список с ответом, возвращаемым Cisco ISE Python SDK Возвращается: всегда Пример: |
ise_update_response dictionary добавлено в 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/sponsored_guest_portal_module.html