cisco.ise.sponsored_guest_portal 模块 – 赞助访客门户的资源模块
注意
此模块是 cisco.ise 集合（版本 2.9.6）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在 Playbook 中使用它，请指定：cisco.ise.sponsored_guest_portal。
cisco.ise 1.0.0 中的新增功能
概要
管理赞助访客门户资源的创建、更新和删除操作。
此 API 创建一个赞助访客门户。
此 API 按 ID 删除赞助访客门户。
此 API 允许客户端按 ID 更新赞助访客门户。
注意
此模块有一个对应的 操作插件。
要求
执行此模块的主机需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
定义所有可用的门户自定义项。 |
|
赞助访客门户的 globalCustomizations。 |
|
赞助访客门户的 backgroundImage。 |
|
表示为图像字节数组的 base 64 编码字符串。 |
|
赞助访客门户的 bannerImage。 |
|
表示为图像字节数组的 base 64 编码字符串。 |
|
赞助访客门户的 bannerTitle。 |
|
赞助访客门户的 contactText。 |
|
赞助访客门户的 desktopLogoImage。 |
|
表示为图像字节数组的 base 64 编码字符串。 |
|
赞助访客门户的 footerElement。 |
|
赞助访客门户的 mobileLogoImage。 |
|
表示为图像字节数组的 base 64 编码字符串。 |
|
此属性仅支持读取操作，它允许以英语显示自定义项。不支持其他语言。 |
|
赞助访客门户的 viewLanguage。 |
|
将整个页面自定义表示为一个巨大的字典。 |
|
字典将在此处公开为键值对。 |
|
赞助访客门户的 key。 |
|
赞助访客门户的 value。 |
|
赞助访客门户的 portalTheme。 |
|
赞助访客门户的 id。 |
|
门户主题的系统分配名称或用户分配名称。 |
|
一个 CSS 文件，表示为 Base64 编码的字节数组。 |
|
调整设置是对为门户选择的门户主题的自定义。当更改门户主题选择时，调整设置将被覆盖以匹配主题中的值。用户随后可以更改调整设置。 |
|
颜色的十六进制值。 |
|
赞助访客门户的 bannerTextColor。 |
|
赞助访客门户的 pageBackgroundColor。 |
|
赞助访客门户的 pageLabelAndTextColor。 |
|
赞助访客门户的 description。 |
|
赞助访客门户的 id。 |
|
用于启用调试的 Identity Services Engine SDK 的标志。 选择
|
|
Identity Services Engine 主机名。 |
|
用于身份验证的 Identity Services Engine 密码。 |
|
RESTful HTTP 请求的超时（以秒为单位）。 默认值: |
|
用于身份验证的 Identity Services Engine 用户名。 |
|
一个标志，通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API。 如果为 True，则 SDK 假定您的 ISE CSRF 检查已启用。 如果为 True，则假定您需要 SDK 自动为您管理 CSRF 令牌。 选择
|
|
启用或禁用 SSL 证书验证的标志。 选择
|
|
通知 SDK 要使用哪个版本的 Identity Services Engine。 默认值: |
|
用于 Identity Services Engine SDK 的标志，启用自动速率限制处理。 选择
|
|
赞助访客门户的名称。 |
|
用于为此门户打开测试页面的 URL。 |
|
允许的值 - BYOD，- HOTSPOTGUEST，- MYDEVICE，- SELFREGGUEST，- SPONSOR，- SPONSOREDGUEST。 |
|
定义门户可用的所有设置组。 |
|
赞助访客门户的 aupSettings。 |
|
AUP 的显示方式，在页面上显示还是作为链接显示。仅当 includeAup = true 时有效。允许的值 - FIRSTLOGIN，- EVERYLOGIN，- RECURRING。 |
|
AUP 确认之间的天数（当 displayFrequency = recurring 时）。 |
|
IncludeAup 标志。 选择
|
|
要求门户用户滚动到 AUP 的末尾。仅当 requireAupAcceptance = true 时有效。 选择
|
|
RequireScrolling 标志。 选择
|
|
仅当 requireAupAcceptance = true 时有效。 选择
|
|
仅当 requireAupAcceptance = true 时有效。 选择
|
|
赞助访客门户的 authSuccessSettings。 |
|
重定向的目标 URL，当 successRedirect = URL 时使用。 |
|
身份验证成功后，设备应重定向到哪里。允许的值 - AUTHSUCCESSPAGE，- ORIGINATINGURL，- URL。 |
|
赞助访客门户的 byodSettings。 |
|
BYOD 端点注册步骤配置。 |
|
端点所属的身份组 ID。 |
|
在注册期间显示设备 ID 字段。 选择
|
|
赞助访客门户的 byodRegistrationSuccessSettings。 |
|
重定向的目标 URL，当 successRedirect = URL 时使用。 |
|
身份验证成功后，设备应重定向到哪里。允许的值 - AUTHSUCCESSPAGE，- ORIGINATINGURL，- URL。 |
|
赞助访客门户的 byodWelcomeSettings。 |
|
AUP 的显示方式，在页面上显示还是作为链接显示。仅当 includeAup = true 时有效。允许的值 - ONPAGE，- ASLINK。 |
|
EnableBYOD 标志。 选择
|
|
EnableGuestAccess 标志。 选择
|
|
IncludeAup 标志。 选择
|
|
RequireAupAcceptance 标志。 选择
|
|
RequireMDM 标志。 选择
|
|
要求 BYOD 设备滚动到 AUP 的底部。仅当 includeAup = true 时有效。 选择
|
|
赞助访客门户的 guestChangePasswordSettings。 |
|
允许访客更改自己的密码。 选择
|
|
赞助访客门户的 guestDeviceRegistrationSettings。 |
|
允许访客注册设备。 选择
|
|
自动注册访客设备。 选择
|
|
门户登录页面设置组如下。 |
|
必须由门户用户输入的访问代码（仅当 requireAccessCode = true 时有效）。 |
|
AllowAlternateGuestPortal 标志。 选择
|
|
AllowForgotPassword 标志。 选择
|
|
要求门户用户输入访问代码。 选择
|
|
AllowGuestToCreateAccounts 标志。 选择
|
|
AUP 的显示方式，在页面上显示还是作为链接显示。仅当 includeAup = true 时有效。允许的值 - ONPAGE，- ASLINK。 |
|
包含一个在登录期间应显示的《可接受使用策略》(AUP)。 选择
|
|
在速率限制之前的最大登录失败次数。 |
|
RequireAccessCode 标志。 选择
|
|
要求门户用户接受 AUP。仅当 includeAup = true 时有效。 选择
|
|
赞助访客门户的 socialConfigs。 |
|
赞助访客门户的 socialMediaType。 |
|
赞助访客门户的 socialMediaValue。 |
|
速率限制期间登录尝试之间的时间。 |
|
门户的端口、接口、证书和其他基本设置。 |
|
门户将可访问的接口。允许的值 - eth0，- eth1，- eth2，- eth3，- eth4，- eth5，- bond0，- bond1，- bond2。 |
|
赞助访客门户的 alwaysUsedLanguage。 |
|
访客类型的唯一 ID。使用此门户作为访客的员工将继承访客类型的登录选项。 |
|
身份源序列的唯一 ID。 |
|
将用于门户的 x.509 服务器证书的逻辑名称。 |
|
允许的值 - USEBROWSERLOCALE，- ALWAYSUSE。 |
|
当 displayLang = USEBROWSERLOCALE 时使用。 |
|
允许的接口将侦听的端口号。范围从 8000 到 8999。 |
|
赞助访客门户的 postAccessBannerSettings。 |
|
IncludePostAccessBanner 标志。 选择
|
|
赞助访客门户的 postLoginBannerSettings。 |
|
包含一个登录后横幅页面。 选择
|
|
赞助访客门户的 supportInfoSettings。 |
|
为空字段显示的默认值。仅当 emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE 时有效。 |
|
指定如何在“支持信息”页面上处理空字段。允许的值 - HIDE，- DISPLAYWITHNOVALUE，- DISPLAYWITHDEFAULTVALUE。 |
|
IncludeBrowserUserAgent 标志。 选择
|
|
IncludeFailureCode 标志。 选择
|
|
IncludeIpAddress 标志。 选择
|
|
IncludeMacAddr 标志。 选择
|
|
IncludePolicyServer 标志。 选择
|
|
IncludeSupportInfoPage 标志。 选择
|
Notes
注意
使用的 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 用于建立连接
Examples
- 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
Return Values
常用的返回值记录在 此处，以下是此模块特有的字段
Key |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 Returned: always 示例: |
|
一个字典或列表，其中包含 Cisco ISE Python SDK 返回的响应 Returned: always 示例: |