cisco.ise.sponsored_guest_portal module – Resource module for Sponsored Guest Portal
Note
This module is part of the cisco.ise collection (version 2.9.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.ise.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.ise.sponsored_guest_portal.
New in cisco.ise 1.0.0
Synopsis
Manage operations create, update and delete of the resource Sponsored Guest Portal.
This API creates a sponsored guest portal.
This API deletes a sponsored guest portal by ID.
This API allows the client to update a sponsored guest portal by ID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.2.3
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Defines all of the Portal Customizations available. |
|
Sponsored Guest Portal’s globalCustomizations. |
|
Sponsored Guest Portal’s backgroundImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
Sponsored Guest Portal’s bannerImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
Sponsored Guest Portal’s bannerTitle. |
|
Sponsored Guest Portal’s contactText. |
|
Sponsored Guest Portal’s desktopLogoImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
Sponsored Guest Portal’s footerElement. |
|
Sponsored Guest Portal’s mobileLogoImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported. |
|
Sponsored Guest Portal’s viewLanguage. |
|
Represent the entire page customization as a giant dictionary. |
|
The Dictionary will be exposed here as key value pair. |
|
Sponsored Guest Portal’s key. |
|
Sponsored Guest Portal’s value. |
|
Sponsored Guest Portal’s portalTheme. |
|
Sponsored Guest Portal’s id. |
|
The system- or user-assigned name of the portal theme. |
|
A CSS file, represented as a Base64-encoded byte array. |
|
The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user. |
|
Hex value of color. |
|
Sponsored Guest Portal’s bannerTextColor. |
|
Sponsored Guest Portal’s pageBackgroundColor. |
|
Sponsored Guest Portal’s pageLabelAndTextColor. |
|
Sponsored Guest Portal’s description. |
|
Sponsored Guest Portal’s id. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices:
|
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: |
|
The Identity Services Engine username to authenticate. |
|
Flag that informs the SDK whether to use the Identity Services Engine’s API Gateway to send requests. If it is true, it uses the ISE’s API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid). Choices:
|
|
Flag that informs the SDK whether we send the CSRF token to ISE’s ERS APIs. If it is True, the SDK assumes that your ISE CSRF Check is enabled. If it is True, it assumes you need the SDK to manage the CSRF token automatically for you. Choices:
|
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Identity Services Engine to use. Default: |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices:
|
|
Sponsored Guest Portal’s name. |
|
URL to bring up a test page for this portal. |
|
Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST. |
|
Defines all of the settings groups available for a portal. |
|
Sponsored Guest Portal’s aupSettings. |
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values - FIRSTLOGIN, - EVERYLOGIN, - RECURRING. |
|
Number of days between AUP confirmations (when displayFrequency = recurring). |
|
IncludeAup flag. Choices:
|
|
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. Choices:
|
|
RequireScrolling flag. Choices:
|
|
Only valid if requireAupAcceptance = true. Choices:
|
|
Only valid if requireAupAcceptance = true. Choices:
|
|
Sponsored Guest Portal’s authSuccessSettings. |
|
Target URL for redirection, used when successRedirect = URL. |
|
After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL. |
|
Sponsored Guest Portal’s byodSettings. |
|
Configuration of BYOD endpoint Registration step configuration. |
|
Identity group id for which endpoint belongs. |
|
Display Device ID field during registration. Choices:
|
|
Sponsored Guest Portal’s byodRegistrationSuccessSettings. |
|
Target URL for redirection, used when successRedirect = URL. |
|
After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL. |
|
Sponsored Guest Portal’s byodWelcomeSettings. |
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK. |
|
EnableBYOD flag. Choices:
|
|
EnableGuestAccess flag. Choices:
|
|
IncludeAup flag. Choices:
|
|
RequireAupAcceptance flag. Choices:
|
|
RequireMDM flag. Choices:
|
|
Require BYOD devices to scroll down to the bottom of the AUP. Only valid if includeAup = true. Choices:
|
|
Sponsored Guest Portal’s guestChangePasswordSettings. |
|
Allow guest to change their own passwords. Choices:
|
|
Sponsored Guest Portal’s guestDeviceRegistrationSettings. |
|
Allow guests to register devices. Choices:
|
|
Automatically register guest devices. Choices:
|
|
Portal Login Page settings groups follow. |
|
Access code that must be entered by the portal user (only valid if requireAccessCode = true). |
|
AllowAlternateGuestPortal flag. Choices:
|
|
AllowForgotPassword flag. Choices:
|
|
Require the portal user to enter an access code. Choices:
|
|
AllowGuestToCreateAccounts flag. Choices:
|
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK. |
|
Include an Acceptable Use Policy (AUP) that should be displayed during login. Choices:
|
|
Maximum failed login attempts before rate limiting. |
|
RequireAccessCode flag. Choices:
|
|
Require the portal user to accept the AUP. Only valid if includeAup = true. Choices:
|
|
Sponsored Guest Portal’s socialConfigs. |
|
Sponsored Guest Portal’s socialMediaType. |
|
Sponsored Guest Portal’s socialMediaValue. |
|
Time between login attempts when rate limiting. |
|
The port, interface, certificate, and other basic settings of a portal. |
|
Interfaces that the portal will be reachable on. Allowed values - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2. |
|
Sponsored Guest Portal’s alwaysUsedLanguage. |
|
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type. |
|
Unique Id of the identity source sequence. |
|
Logical name of the x.509 server certificate that will be used for the portal. |
|
Allowed values - USEBROWSERLOCALE, - ALWAYSUSE. |
|
Used when displayLang = USEBROWSERLOCALE. |
|
The port number that the allowed interfaces will listen on. Range from 8000 to 8999. |
|
Sponsored Guest Portal’s postAccessBannerSettings. |
|
IncludePostAccessBanner flag. Choices:
|
|
Sponsored Guest Portal’s postLoginBannerSettings. |
|
Include a Post-Login Banner page. Choices:
|
|
Sponsored Guest Portal’s supportInfoSettings. |
|
The default value displayed for an empty field. Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE. |
|
Specifies how empty fields are handled on the Support Information Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE. |
|
IncludeBrowserUserAgent flag. Choices:
|
|
IncludeFailureCode flag. Choices:
|
|
IncludeIpAddress flag. Choices:
|
|
IncludeMacAddr flag. Choices:
|
|
IncludePolicyServer flag. Choices:
|
|
IncludeSupportInfoPage flag. Choices:
|
Notes
Note
SDK Method used are 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,
Paths used are post /ers/config/sponsoredguestportal, delete /ers/config/sponsoredguestportal/{id}, put /ers/config/sponsoredguestportal/{id},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK
The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection
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
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |
|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always Sample: |