cisco.ise.byod_portal 模块 – BYOD 门户资源模块
注意
此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。
如果您正在使用 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。
要在剧本中使用它，请指定：cisco.ise.byod_portal。
cisco.ise 1.0.0 中的新增功能
概要
管理 BYOD 门户资源的创建、更新和删除操作。
此 API 创建一个 BYOD 门户。
此 API 通过 ID 删除 BYOD 门户。
此 API 允许客户端通过 ID 更新 BYOD 门户。
注意
此模块具有相应的 动作插件。
要求
执行此模块的主机需要以下要求。
ciscoisesdk >= 2.2.3
python >= 3.5
参数
参数 |
注释 |
|---|---|
定义 BYOD 可用的所有门户自定义项。 |
|
表示门户全局自定义项。 |
|
BYOD 门户的 backgroundImage。 |
|
表示为图像字节数组的 base64 编码字符串。 |
|
BYOD 门户的 bannerImage。 |
|
表示为图像字节数组的 base64 编码字符串。 |
|
BYOD 门户的 bannerTitle。 |
|
BYOD 门户的 contactText。 |
|
BYOD 门户的 desktopLogoImage。 |
|
表示为图像字节数组的 base64 编码字符串。 |
|
BYOD 门户的 footerElement。 |
|
BYOD 门户的 mobileLogoImage。 |
|
表示为图像字节数组的 base64 编码字符串。 |
|
此属性仅支持读取操作，它允许以英语显示自定义项。不支持其他语言。 |
|
BYOD 门户的 viewLanguage。 |
|
将整个页面自定义项表示为一个大型字典。 |
|
字典将在此处作为键值对显示。 |
|
BYOD 门户的键。 |
|
BYOD 门户的值。 |
|
定义门户主题的配置。 |
|
门户主题的唯一内部标识符。 |
|
门户主题的系统或用户分配名称。 |
|
一个 CSS 文件，表示为 Base64 编码的字节数组。 |
|
调整设置是对为门户选择的门户主题的自定义。更改门户主题选择时，调整设置将被覆盖以匹配主题中的值。用户随后可以更改调整设置。 |
|
十六进制颜色值。 |
|
BYOD 门户的 bannerTextColor。 |
|
BYOD 门户的 pageBackgroundColor。 |
|
BYOD 门户的 pageLabelAndTextColor。 |
|
BYOD 门户的描述。 |
|
资源 UUID，更新时必填。 |
|
用于 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。 |
|
定义 BYOD 可用的所有设置组。 |
|
BYOD 设备欢迎、注册和成功步骤的配置。 |
|
BYOD 门户的 byodRegistrationSettings。 |
|
BYOD 门户的 endPointIdentityGroupId。 |
|
ShowDeviceID 标志。 选项
|
|
BYOD 门户的 byodRegistrationSuccessSettings。 |
|
重定向的目标 URL，在 successRedirect = URL 时使用。 |
|
身份验证成功后，设备应重定向到的位置。允许的值。 |
|
BYOD 端点欢迎步骤配置的配置。 |
|
AUP 的显示方式，页面显示或链接显示。仅当 includeAup = true 时有效。允许的值 - ONPAGE，- ASLINK。 |
|
启用 BYOD 标志。 选项
|
|
启用访客访问标志。 选项
|
|
包含 AUP 标志。 选项
|
|
需要接受 AUP 标志。 选项
|
|
需要 MDM 标志。 选项
|
|
要求 BYOD 设备滚动到 AUP 底部，仅当 includeAup = true 时有效。 选项
|
|
端口、接口、证书和其他门户的基本设置。 |
|
门户可在其上访问的接口。允许的值 - eth0，- eth1，- eth2，- eth3，- eth4，- eth5，- bond0，- bond1，- bond2。 |
|
在 displayLang = ALWAYSUSE 时使用。 |
|
将用于门户的 x.509 服务器证书的逻辑名称。 |
|
允许的值 - USEBROWSERLOCALE，- ALWAYSUSE。 |
|
将添加用户设备的端点身份组的唯一 ID。仅在热点门户中使用。 |
|
在 displayLang = USEBROWSERLOCALE 时使用。 |
|
允许的接口将监听的端口号。范围从 8000 到 8999。 |
|
BYOD 门户的 supportInfoSettings。 |
|
空字段显示的默认值。仅当 emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE 时有效。 |
|
指定如何在支持信息页面上处理空字段。允许的值 - HIDE，- DISPLAYWITHNOVALUE，- DISPLAYWITHDEFAULTVALUE。 |
|
包含浏览器用户代理标志。 选项
|
|
包含失败代码标志。 选项
|
|
包含 IP 地址标志。 选项
|
|
包含 MAC 地址标志。 选项
|
|
包含策略服务器标志。 选项
|
|
包含支持信息页面标志。 选项
|
注释
注意
使用的 SDK 方法为 byod_portal.ByodPortal.create_byod_portal、byod_portal.ByodPortal.delete_byod_portal_by_id、byod_portal.ByodPortal.update_byod_portal_by_id，
使用的路径为 post /ers/config/byodportal、delete /ers/config/byodportal/{id}、put /ers/config/byodportal/{id}，
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco ISE SDK 的嵌入式连接管理器。
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。
示例
- name: Update by id
cisco.ise.byod_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:
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
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
certificateGroupTag: string
displayLang: string
endpointIdentityGroup: string
fallbackLanguage: string
httpsPort: 0
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
- name: Delete by id
cisco.ise.byod_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.byod_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:
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
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
certificateGroupTag: string
displayLang: string
endpointIdentityGroup: string
fallbackLanguage: string
httpsPort: 0
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
返回值
常见的返回值已在 此处 记录，以下是此模块特有的字段。
键 |
描述 |
|---|---|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终 示例： |
|
包含 Cisco ISE Python SDK 返回的响应的字典或列表。 返回值：始终 示例： |