cisco.ise.self_registered_portal 模块 – 自注册门户资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块,请参阅 要求 获取详细信息。

要在 playbook 中使用它,请指定: cisco.ise.self_registered_portal

cisco.ise 1.0.0 中的新增功能

概要

  • 管理自注册门户资源的创建、更新和删除操作。

  • 此 API 创建一个自注册门户。

  • 此 API 通过 ID 删除自注册门户。

  • 此 API 允许客户端通过 ID 更新自注册门户。

注意

此模块具有相应的 action 插件

要求

在执行此模块的主机上需要以下要求。

  • ciscoisesdk >= 2.2.3

  • python >= 3.5

参数

参数

注释

customizations

字典

定义所有可用的门户自定义项。

globalCustomizations

字典

自注册门户的 globalCustomizations。

backgroundImage

字典

自注册门户的 backgroundImage。

data

字符串

表示为图像字节数组的 base64 编码字符串。

bannerImage

字典

自注册门户的 bannerImage。

data

字符串

表示为图像字节数组的 base64 编码字符串。

bannerTitle

字符串

自注册门户的 bannerTitle。

contactText

字符串

自注册门户的 contactText。

desktopLogoImage

字典

自注册门户的 desktopLogoImage。

data

字符串

表示为图像字节数组的 base64 编码字符串。

footerElement

字符串

自注册门户的 footerElement。

mobileLogoImage

字典

自注册门户的 mobileLogoImage。

data

字符串

表示为图像字节数组的 base64 编码字符串。

language

字典

此属性仅支持读取操作,它允许显示英文自定义项。不支持其他语言。

viewLanguage

字符串

自注册门户的 viewLanguage。

pageCustomizations

字典

将整个页面自定义项表示为一个大型字典。

data

列表 / 元素=字典

字典将在此处作为键值对公开。

key

字符串

自注册门户的 key。

value

字符串

自注册门户的 value。

portalTheme

字典

自注册门户的 portalTheme。

id

字符串

自注册门户的 id。

name

字符串

门户主题的系统或用户分配名称。

themeData

字符串

一个 CSS 文件,表示为 Base64 编码的字节数组。

portalTweakSettings

字典

调整设置是对为门户选择的门户主题的自定义。更改门户主题选择后,将覆盖调整设置以匹配主题中的值。用户随后可以更改调整设置。

bannerColor

字符串

十六进制颜色值。

bannerTextColor

字符串

自注册门户的 bannerTextColor。

pageBackgroundColor

字符串

自注册门户的 pageBackgroundColor。

pageLabelAndTextColor

字符串

自注册门户的 pageLabelAndTextColor。

description

字符串

自注册门户的描述。

id

字符串

自注册门户的 id。

ise_debug

布尔值

用于 Identity Services Engine SDK 的标志,用于启用调试。

选项

  • false ← (默认)

  • true

ise_hostname

字符串 / 必需

Identity Services Engine 主机名。

ise_password

字符串 / 必需

用于身份验证的 Identity Services Engine 密码。

ise_single_request_timeout

整数

在 cisco.ise 3.0.0 中添加

RESTful HTTP 请求的超时时间(以秒为单位)。

默认值: 60

ise_username

字符串 / 必需

用于身份验证的 Identity Services Engine 用户名。

ise_uses_api_gateway

布尔值

在 cisco.ise 1.1.0 中添加

通知 SDK 是否使用 Identity Services Engine 的 API 网关发送请求的标志。

如果为 true,则使用 ISE 的 API 网关并将请求发送到 https://{{ise_hostname}}。

如果为 false,则将请求发送到 https://{{ise_hostname}}:{{port}},其中端口值取决于使用的服务(ERS、Mnt、UI、PxGrid)。

选项

  • false

  • true ← (默认)

ise_uses_csrf_token

布尔值

在 cisco.ise 3.0.0 中添加

通知 SDK 我们是否将 CSRF 令牌发送到 ISE 的 ERS API 的标志。

如果为 True,则 SDK 假设您的 ISE CSRF 检查已启用。

如果为 True,则假定您需要 SDK 为您自动管理 CSRF 令牌。

选项

  • false ← (默认)

  • true

ise_verify

布尔值

启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

ise_version

字符串

通知 SDK 要使用的 Identity Services Engine 版本。

默认值: "3.1_Patch_1"

ise_wait_on_rate_limit

布尔值

身份服务引擎 SDK 的标志,用于启用自动速率限制处理。

选项

  • false

  • true ← (默认)

name

字符串

自助注册门户的名称。

portalTestUrl

字符串

用于打开此门户测试页面的 URL。

portalType

字符串

允许的值 - BYOD,- HOTSPOTGUEST,- MYDEVICE,- SELFREGGUEST,- SPONSOR,- SPONSOREDGUEST。

settings

字典

定义门户可用的所有设置组。

aupSettings

字典

自助注册门户的 aupSettings。

displayFrequency

字符串

AUP 的显示方式,以页面或链接方式显示。仅在 includeAup = true 时有效。允许的值 - FIRSTLOGIN,- EVERYLOGIN,- RECURRING。

displayFrequencyIntervalDays

整数

AUP 确认之间的时间间隔(以天为单位)(当 displayFrequency = recurring 时)。

includeAup

布尔值

要求门户用户阅读并接受 AUP。

选项

  • false

  • true

requireAupScrolling

布尔值

要求门户用户滚动到 AUP 的末尾。仅在 requireAupAcceptance = true 时有效。

选项

  • false

  • true

requireScrolling

布尔值

RequireScrolling 标志。

选项

  • false

  • true

skipAupForEmployees

布尔值

仅在 requireAupAcceptance = true 时有效。

选项

  • false

  • true

useDiffAupForEmployees

布尔值

仅在 requireAupAcceptance = true 时有效。

选项

  • false

  • true

authSuccessSettings

字典

自助注册门户的 authSuccessSettings。

redirectUrl

字符串

自助注册门户的 redirectUrl。

successRedirect

字符串

自助注册门户的 successRedirect。

byodSettings

字典

BYOD 设备欢迎、注册和成功步骤的配置。

byodRegistrationSettings

字典

BYOD 端点注册步骤配置。

endPointIdentityGroupId

字符串

端点所属的身份组 ID。

showDeviceID

布尔值

在注册期间显示设备 ID 字段。

选项

  • false

  • true

byodRegistrationSuccessSettings

字典

BYOD 端点注册成功步骤配置。

redirectUrl

字符串

重定向的目标 URL,在 successRedirect = URL 时使用。

successRedirect

字符串

身份验证成功后设备应重定向到的位置。允许的值 - AUTHSUCCESSPAGE,- ORIGINATINGURL,- URL。

byodWelcomeSettings

字典

BYOD 端点欢迎步骤配置。

aupDisplay

字符串

AUP 的显示方式,以页面或链接方式显示。仅在 includeAup = true 时有效。允许的值 - ONPAGE,- ASLINK。

enableBYOD

布尔值

EnableBYOD 标志。

选项

  • false

  • true

enableGuestAccess

布尔值

EnableGuestAccess 标志。

选项

  • false

  • true

includeAup

布尔值

IncludeAup 标志。

选项

  • false

  • true

requireAupAcceptance

布尔值

RequireAupAcceptance 标志。

选项

  • false

  • true

requireMDM

布尔值

RequireMDM 标志。

选项

  • false

  • true

requireScrolling

布尔值

要求 BYOD 设备滚动到 AUP 的底部,仅在 includeAup = true 时有效。

选项

  • false

  • true

guestChangePasswordSettings

字典

自助注册门户的 guestChangePasswordSettings。

allowChangePasswdAtFirstLogin

布尔值

允许访客更改自己的密码。

选项

  • false

  • true

guestDeviceRegistrationSettings

字典

自助注册门户的 guestDeviceRegistrationSettings。

allowGuestsToRegisterDevices

布尔值

允许访客注册设备。

选项

  • false

  • true

autoRegisterGuestDevices

布尔值

自动注册访客设备。

选项

  • false

  • true

loginPageSettings

字典

门户登录页面设置组如下。

accessCode

字符串

门户用户必须输入的访问代码(仅在 requireAccessCode = true 时有效)。

allowAlternateGuestPortal

布尔值

AllowAlternateGuestPortal 标志。

选项

  • false

  • true

allowForgotPassword

布尔值

AllowForgotPassword 标志。

选项

  • false

  • true

allowGuestToChangePassword

布尔值

要求门户用户输入访问代码。

选项

  • false

  • true

allowGuestToCreateAccounts

布尔值

AllowGuestToCreateAccounts 标志。

选项

  • false

  • true

allowGuestToUseSocialAccounts

布尔值

AllowGuestToUseSocialAccounts 标志。

选项

  • false

  • true

allowShowGuestForm

布尔值

AllowShowGuestForm 标志。

选项

  • false

  • true

alternateGuestPortal

字符串

自助注册门户的 alternateGuestPortal。

aupDisplay

字符串

AUP 的显示方式,以页面或链接方式显示。仅在 includeAup = true 时有效。允许的值 - ONPAGE,- ASLINK。

includeAup

布尔值

包含一个在登录期间应显示的可接受使用策略 (AUP)。

选项

  • false

  • true

maxFailedAttemptsBeforeRateLimit

整数

在实施速率限制之前的最大登录失败尝试次数。

requireAccessCode

布尔值

要求门户用户输入访问代码。

选项

  • false

  • true

requireAupAcceptance

布尔值

要求门户用户接受 AUP。仅在 includeAup = true 时有效。

选项

  • false

  • true

socialConfigs

列表 / 元素=字典

自助注册门户的 socialConfigs。

socialMediaType

字符串

自助注册门户的 socialMediaType。

socialMediaValue

字符串

自助注册门户的 socialMediaValue。

timeBetweenLoginsDuringRateLimit

整数

实施速率限制时登录尝试之间的时间间隔。

portalSettings

字典

门户的端口、接口、证书和其他基本设置。

allowedInterfaces

列表 / 元素=字符串

门户可访问的接口。允许的值 - eth0,- eth1,- eth2,- eth3,- eth4,- eth5,- bond0,- bond1,- bond2。

alwaysUsedLanguage

字符串

自助注册门户的 alwaysUsedLanguage。

assignedGuestTypeForEmployee

字符串

访客类型的唯一 ID。使用此门户作为访客的员工继承访客类型的登录选项。

authenticationMethod

字符串

身份源序列的唯一 ID。

certificateGroupTag

字符串

将用于门户的 x.509 服务器证书的逻辑名称。

displayLang

字符串

允许的值 - USEBROWSERLOCALE,- ALWAYSUSE。

fallbackLanguage

字符串

在 displayLang = USEBROWSERLOCALE 时使用。

httpsPort

整数

允许的接口将监听的端口号。范围从 8000 到 8999。

postAccessBannerSettings

字典

自助注册门户的 postAccessBannerSettings。

includePostAccessBanner

布尔值

IncludePostAccessBanner 标志。

选项

  • false

  • true

postLoginBannerSettings

字典

自助注册门户的 postLoginBannerSettings。

includePostAccessBanner

布尔值

包含登录后横幅页面。

选项

  • false

  • true

selfRegPageSettings

字典

自助注册门户的 selfRegPageSettings。

accountValidityDuration

整数

自助注册的访客帐户在此 account_validity_time_units 数内有效。

accountValidityTimeUnits

字符串

account_validity_duration 的时间单位。允许的值 - DAYS,- HOURS,- MINUTES。

allowGraceAccess

布尔值

AllowGraceAccess 标志。

选项

  • false

  • true

approvalEmailAddresses

字符串

仅在 requireGuestApproval = true 且 sendApprovalRequestTo = SELECTEDEMAILADDRESSES 时有效。

approveDenyLinksTimeUnits

字符串

此属性与 approveDenyLinksValidFor 一起指定链接可以使用的时间长度。仅在 requireGuestApproval = true 时有效。允许的值 - DAYS,- HOURS,- MINUTES。

approveDenyLinksValidFor

整数

此属性与 approveDenyLinksTimeUnits 一起指定链接可以使用的时间长度。仅在 requireGuestApproval = true 时有效。

assignGuestsToGuestType

字符串

访客被分配到此访客类型。

aupDisplay

字符串

AUP 的显示方式,以页面或链接方式显示。仅在 includeAup = true 时有效。允许的值 - ONPAGE,- ASLINK。

authenticateSponsorsUsingPortalList

布尔值

AuthenticateSponsorsUsingPortalList 标志。

选项

  • false

  • true

autoLoginSelfWait

布尔值

允许访客在赞助商批准后从自助注册自动登录。访客无需提供凭据即可登录。

选项

  • false

  • true

autoLoginTimePeriod

整数

自动登录等待赞助商批准的时间段。如果时间超过,访客必须通过提供凭据手动登录。默认值为 5 分钟。

credentialNotificationUsingEmail

布尔值

如果为 true,则使用电子邮件发送批准后的凭据通知。仅在 requireGuestApproval = true 时有效。

选项

  • false

  • true

credentialNotificationUsingSMS

布尔值

如果为 true,则使用短信发送批准后的凭据通知。仅在 requireGuestApproval = true 时有效。

选项

  • false

  • true

enableGuestEmailBlacklist

布尔值

禁止来自选定域的电子邮件地址的访客。

选项

  • false

  • true

enableGuestEmailWhitelist

布尔值

允许来自选定域的电子邮件地址的访客。

选项

  • false

  • true

fieldCompany

字典

自助注册门户的 fieldCompany。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldEmailAddr

字典

自助注册门户的 fieldEmailAddr。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldFirstName

字典

自助注册门户的 fieldFirstName。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldLastName

字典

自助注册门户的 fieldLastName。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldLocation

字典

自助注册门户的 fieldLocation。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldPersonBeingVisited

字典

自助注册门户的 fieldPersonBeingVisited。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldPhoneNo

字典

自助注册门户的 fieldPhoneNo。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldReasonForVisit

字典

自助注册门户的 fieldReasonForVisit。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldSMSProvider

字典

自助注册门户的 fieldSMSProvider。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

fieldUserName

字典

自助注册门户的 fieldUserName。

include

布尔值

Include 标志。

选项

  • false

  • true

require

布尔值

仅在 include = true 时适用。

选项

  • false

  • true

graceAccessExpireInterval

整数

自助注册门户的 graceAccessExpireInterval。

graceAccessSendAccountExpiration

布尔值

GraceAccessSendAccountExpiration 标志。

选项

  • false

  • true

guestEmailBlacklistDomains

列表 / 元素=字符串

禁止来自选定域的电子邮件地址的访客。

guestEmailWhitelistDomains

列表 / 元素=字符串

电子邮件地址位于这些域之一中的自助注册访客将被允许。仅在 enableGuestEmailWhitelist = true 时有效。

includeAup

布尔值

包含一个在登录期间应显示的可接受使用策略 (AUP)。

选项

  • false

  • true

postRegistrationRedirect

字符串

注册提交后将访客用户重定向到以下页面之一。仅在 requireGuestApproval = true 时有效。允许的值 - SELFREGISTRATIONSUCCESS,- LOGINPAGEWITHINSTRUCTIONS - URL。

postRegistrationRedirectUrl

字符串

注册后访客用户被重定向到的 URL。仅在 requireGuestApproval = true 且 postRegistrationRedirect = URL 时有效。

registrationCode

字符串

访客用户必须输入的注册代码。

requireApproverToAuthenticate

布尔值

当自助注册的访客需要批准时,批准请求将通过电子邮件发送给一个或多个赞助用户。如果 Cisco ISE 管理员选择在电子邮件中包含批准链接,则如果此属性为 true,则单击该链接的赞助用户将需要输入其用户名和密码。仅在 requireGuestApproval = true 时有效。

选项

  • false

  • true

requireAupAcceptance

布尔值

要求门户用户接受 AUP。仅在 includeAup = true 时有效。

选项

  • false

  • true

requireGuestApproval

布尔值

如果为 true,则要求自助注册的访客获得批准。

选项

  • false

  • true

requireRegistrationCode

布尔值

自助注册的访客需要输入注册代码。

选项

  • false

  • true

selectableLocations

列表 / 元素=字符串

访客可以从这些位置中选择来设置其时区。

selectableSMSProviders

列表 / 元素=字符串

此属性是短信提供商名称的数组。

sendApprovalRequestTo

字符串

指定发送批准请求的位置。仅在 requireGuestApproval = true 时有效。允许的值 - SELECTEDEMAILADDRESSES,- PERSONBEINGVISITED。

sponsorPortalList

列表 / 元素=字符串

自助注册门户的 sponsorPortalList。

selfRegSuccessSettings

字典

自助注册门户的 selfRegSuccessSettings。

allowGuestLoginFromSelfregSuccessPage

布尔值

AllowGuestLoginFromSelfregSuccessPage 标志。

选项

  • false

  • true

allowGuestSendSelfUsingEmail

布尔值

AllowGuestSendSelfUsingEmail 标志。

选项

  • false

  • true

allowGuestSendSelfUsingPrint

布尔值

AllowGuestSendSelfUsingPrint 标志。

选项

  • false

  • true

allowGuestSendSelfUsingSMS

布尔值

AllowGuestSendSelfUsingSMS 标志。

选项

  • false

  • true

aupOnPage

布尔值

AupOnPage 标志。

选项

  • false

  • true

includeAup

布尔值

IncludeAup 标志。

选项

  • false

  • true

includeCompany

布尔值

IncludeCompany 标志。

选项

  • false

  • true

includeEmailAddr

布尔值

IncludeEmailAddr 标志。

选项

  • false

  • true

includeFirstName

布尔值

IncludeFirstName 标志。

选项

  • false

  • true

includeLastName

布尔值

IncludeLastName 标志。

选项

  • false

  • true

includeLocation

布尔值

IncludeLocation 标志。

选项

  • false

  • true

includePassword

布尔值

IncludePassword 标志。

选项

  • false

  • true

includePersonBeingVisited

布尔值

IncludePersonBeingVisited 标志。

选项

  • false

  • true

includePhoneNo

布尔值

IncludePhoneNo 标志。

选项

  • false

  • true

includeReasonForVisit

布尔值

IncludeReasonForVisit 标志。

选项

  • false

  • true

includeSMSProvider

布尔值

IncludeSMSProvider 标志。

选项

  • false

  • true

includeUserName

布尔值

IncludeUserName 标志。

选项

  • false

  • true

requireAupAcceptance

布尔值

RequireAupAcceptance 标志。

选项

  • false

  • true

requireAupScrolling

布尔值

RequireAupScrolling 标志。

选项

  • false

  • true

supportInfoSettings

字典

自助注册门户的 supportInfoSettings。

defaultEmptyFieldValue

字符串

显示为空字段的默认值。仅在 emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE 时有效。

emptyFieldDisplay

字符串

指定如何在支持信息页面上处理空字段。允许的值 - HIDE,- DISPLAYWITHNOVALUE,- DISPLAYWITHDEFAULTVALUE。

includeBrowserUserAgent

布尔值

IncludeBrowserUserAgent 标志。

选项

  • false

  • true

includeFailureCode

布尔值

IncludeFailureCode 标志。

选项

  • false

  • true

includeIpAddress

布尔值

IncludeIpAddress 标志。

选项

  • false

  • true

includeMacAddr

布尔值

IncludeMacAddr 标志。

选项

  • false

  • true

includePolicyServer

布尔值

IncludePolicyServer 标志。

选项

  • false

  • true

includeSupportInfoPage

布尔值

IncludeSupportInfoPage 标志。

选项

  • false

  • true

注释

注意

  • 使用的 SDK 方法为 self_registered_portal.SelfRegisteredPortal.create_self_registered_portal、self_registered_portal.SelfRegisteredPortal.delete_self_registered_portal_by_id、self_registered_portal.SelfRegisteredPortal.update_self_registered_portal_by_id。

  • 使用的路径为 post /ers/config/selfregportal、delete /ers/config/selfregportal/{id}、put /ers/config/selfregportal/{id}。

  • 不支持 check_mode

  • 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用来自 Cisco ISE SDK 的嵌入式连接管理器。

  • 以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接。

另请参见

另请参见

Cisco ISE 自助注册门户文档。

自助注册门户 API 的完整参考。

示例

- name: Update by id
  cisco.ise.self_registered_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
        allowGuestToUseSocialAccounts: true
        allowShowGuestForm: true
        alternateGuestPortal: string
        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
      selfRegPageSettings:
        accountValidityDuration: 0
        accountValidityTimeUnits: string
        allowGraceAccess: true
        approvalEmailAddresses: string
        approveDenyLinksTimeUnits: string
        approveDenyLinksValidFor: 0
        assignGuestsToGuestType: string
        aupDisplay: string
        authenticateSponsorsUsingPortalList: true
        autoLoginSelfWait: true
        autoLoginTimePeriod: 0
        credentialNotificationUsingEmail: true
        credentialNotificationUsingSms: true
        enableGuestEmailBlacklist: true
        enableGuestEmailWhitelist: true
        fieldCompany:
          include: true
          require: true
        fieldEmailAddr:
          include: true
          require: true
        fieldFirstName:
          include: true
          require: true
        fieldLastName:
          include: true
          require: true
        fieldLocation:
          include: true
          require: true
        fieldPersonBeingVisited:
          include: true
          require: true
        fieldPhoneNo:
          include: true
          require: true
        fieldReasonForVisit:
          include: true
          require: true
        fieldSmsProvider:
          include: true
          require: true
        fieldUserName:
          include: true
          require: true
        graceAccessExpireInterval: 0
        graceAccessSendAccountExpiration: true
        guestEmailBlacklistDomains:
        - string
        guestEmailWhitelistDomains:
        - string
        includeAup: true
        postRegistrationRedirect: string
        postRegistrationRedirectUrl: string
        registrationCode: string
        requireApproverToAuthenticate: true
        requireAupAcceptance: true
        requireGuestApproval: true
        requireRegistrationCode: true
        selectableLocations:
        - string
        selectableSmsProviders:
        - string
        sendApprovalRequestTo: string
        sponsorPortalList:
        - string
      selfRegSuccessSettings:
        allowGuestLoginFromSelfregSuccessPage: true
        allowGuestSendSelfUsingEmail: true
        allowGuestSendSelfUsingPrint: true
        allowGuestSendSelfUsingSms: true
        aupOnPage: true
        includeAup: true
        includeCompany: true
        includeEmailAddr: true
        includeFirstName: true
        includeLastName: true
        includeLocation: true
        includePassword: true
        includePersonBeingVisited: true
        includePhoneNo: true
        includeReasonForVisit: true
        includeSmsProvider: true
        includeUserName: true
        requireAupAcceptance: true
        requireAupScrolling: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.self_registered_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.self_registered_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
        allowGuestToUseSocialAccounts: true
        allowShowGuestForm: true
        alternateGuestPortal: string
        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
      selfRegPageSettings:
        accountValidityDuration: 0
        accountValidityTimeUnits: string
        allowGraceAccess: true
        approvalEmailAddresses: string
        approveDenyLinksTimeUnits: string
        approveDenyLinksValidFor: 0
        assignGuestsToGuestType: string
        aupDisplay: string
        authenticateSponsorsUsingPortalList: true
        autoLoginSelfWait: true
        autoLoginTimePeriod: 0
        credentialNotificationUsingEmail: true
        credentialNotificationUsingSms: true
        enableGuestEmailBlacklist: true
        enableGuestEmailWhitelist: true
        fieldCompany:
          include: true
          require: true
        fieldEmailAddr:
          include: true
          require: true
        fieldFirstName:
          include: true
          require: true
        fieldLastName:
          include: true
          require: true
        fieldLocation:
          include: true
          require: true
        fieldPersonBeingVisited:
          include: true
          require: true
        fieldPhoneNo:
          include: true
          require: true
        fieldReasonForVisit:
          include: true
          require: true
        fieldSmsProvider:
          include: true
          require: true
        fieldUserName:
          include: true
          require: true
        graceAccessExpireInterval: 0
        graceAccessSendAccountExpiration: true
        guestEmailBlacklistDomains:
        - string
        guestEmailWhitelistDomains:
        - string
        includeAup: true
        postRegistrationRedirect: string
        postRegistrationRedirectUrl: string
        registrationCode: string
        requireApproverToAuthenticate: true
        requireAupAcceptance: true
        requireGuestApproval: true
        requireRegistrationCode: true
        selectableLocations:
        - string
        selectableSmsProviders:
        - string
        sendApprovalRequestTo: string
        sponsorPortalList:
        - string
      selfRegSuccessSettings:
        allowGuestLoginFromSelfregSuccessPage: true
        allowGuestSendSelfUsingEmail: true
        allowGuestSendSelfUsingPrint: true
        allowGuestSendSelfUsingSms: true
        aupOnPage: true
        includeAup: true
        includeCompany: true
        includeEmailAddr: true
        includeFirstName: true
        includeLastName: true
        includeLocation: true
        includePassword: true
        includePersonBeingVisited: true
        includePhoneNo: true
        includeReasonForVisit: true
        includeSmsProvider: true
        includeUserName: true
        requireAupAcceptance: true
        requireAupScrolling: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

返回值

常见的返回值已在此处记录,以下是此模块特有的字段

描述

ise_response

字典

Cisco ISE Python SDK返回的响应字典或列表

返回:始终

示例: {"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", "link": {"href": "string", "rel": "string", "type": "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, "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "alternateGuestPortal": "string", "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}, "selfRegPageSettings": {"accountValidityDuration": 0, "accountValidityTimeUnits": "string", "allowGraceAccess": true, "approvalEmailAddresses": "string", "approveDenyLinksTimeUnits": "string", "approveDenyLinksValidFor": 0, "assignGuestsToGuestType": "string", "aupDisplay": "string", "authenticateSponsorsUsingPortalList": true, "autoLoginSelfWait": true, "autoLoginTimePeriod": 0, "credentialNotificationUsingEmail": true, "credentialNotificationUsingSms": true, "enableGuestEmailBlacklist": true, "enableGuestEmailWhitelist": true, "fieldCompany": {"include": true, "require": true}, "fieldEmailAddr": {"include": true, "require": true}, "fieldFirstName": {"include": true, "require": true}, "fieldLastName": {"include": true, "require": true}, "fieldLocation": {"include": true, "require": true}, "fieldPersonBeingVisited": {"include": true, "require": true}, "fieldPhoneNo": {"include": true, "require": true}, "fieldReasonForVisit": {"include": true, "require": true}, "fieldSmsProvider": {"include": true, "require": true}, "fieldUserName": {"include": true, "require": true}, "graceAccessExpireInterval": 0, "graceAccessSendAccountExpiration": true, "guestEmailBlacklistDomains": ["string"], "guestEmailWhitelistDomains": ["string"], "includeAup": true, "postRegistrationRedirect": "string", "postRegistrationRedirectUrl": "string", "registrationCode": "string", "requireApproverToAuthenticate": true, "requireAupAcceptance": true, "requireGuestApproval": true, "requireRegistrationCode": true, "selectableLocations": ["string"], "selectableSmsProviders": ["string"], "sendApprovalRequestTo": "string", "sponsorPortalList": ["string"]}, "selfRegSuccessSettings": {"allowGuestLoginFromSelfregSuccessPage": true, "allowGuestSendSelfUsingEmail": true, "allowGuestSendSelfUsingPrint": true, "allowGuestSendSelfUsingSms": true, "aupOnPage": true, "includeAup": true, "includeCompany": true, "includeEmailAddr": true, "includeFirstName": true, "includeLastName": true, "includeLocation": true, "includePassword": true, "includePersonBeingVisited": true, "includePhoneNo": true, "includeReasonForVisit": true, "includeSmsProvider": true, "includeUserName": true, "requireAupAcceptance": true, "requireAupScrolling": true}, "supportInfoSettings": {"defaultEmptyFieldValue": "string", "emptyFieldDisplay": "string", "includeBrowserUserAgent": true, "includeFailureCode": true, "includeIpAddress": true, "includeMacAddr": true, "includePolicyServer": true, "includeSupportInfoPage": true}}}

ise_update_response

字典

在 cisco.ise 1.1.0 中添加

Cisco ISE Python SDK返回的响应字典或列表

返回:始终

示例: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

作者

  • Rafael Campos (@racampos)