cisco.ise.sponsoredguestportal module – Resource module for Sponsoredguestportal
Note
This module is part of the cisco.ise collection (version 3.0.0).
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.sponsoredguestportal.
New in cisco.ise 1.0.0
Synopsis
Manage operation create of the resource Sponsoredguestportal.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 2.0.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Sponsoredguestportal’s customizations. |
|
Sponsoredguestportal’s globalCustomizations. |
|
Sponsoredguestportal’s backgroundImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
Sponsoredguestportal’s bannerImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
Sponsoredguestportal’s bannerTitle. |
|
Sponsoredguestportal’s contactText. |
|
Sponsoredguestportal’s footerElement. |
|
Sponsoredguestportal’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. |
|
Sponsoredguestportal’s pageCustomizations. |
|
The Dictionary will be exposed here as key value pair. |
|
Sponsoredguestportal’s portalTheme. |
|
The unique internal identifier of the portal theme. |
|
The system- or user-assigned name of the portal theme. |
|
A CSS file, represented as a Base64-encoded byte array. |
|
Sponsoredguestportal’s portalTweakSettings. |
|
Sponsoredguestportal’s banneColor. |
|
Sponsoredguestportal’s bannerTextColor. |
|
Sponsoredguestportal’s pageBackgroundColor. |
|
Sponsoredguestportal’s pageLabelAndTextColor. |
|
Description. |
|
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: :ansible-option-default:`60` |
|
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. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Name. |
|
URL to bring up a test page for this portal. |
|
Allowed values byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest. |
|
Sponsoredguestportal’s settings. |
|
Sponsoredguestportal’s aupSettings. |
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values firstLogin, everyLogin and recurring. |
|
Number of days between AUP confirmations (when displayFrequency = recurring). |
|
Require the portal user to read and accept an AUP. Choices: |
|
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. Choices: |
|
Only valid if requireAupAcceptance = true. Choices: |
|
Only valid if requireAupAcceptance = true. Choices: |
|
Sponsoredguestportal’s authSuccessSettings. |
|
Target URL for redirection, used when successRedirect = url. |
|
After an Authentication Success where should user be redirected. Allowed Values authSuccessPage, originatingURL and url. |
|
Sponsoredguestportal’s byodSettings. |
|
Sponsoredguestportal’s byodRegistrationSettings. |
|
TIdentity group id for which endpoint belongs. |
|
Display Device ID field during registration. Choices: |
|
Sponsoredguestportal’s byodRegistrationSuccessSettings. |
|
Target URL for redirection, used when successRedirect = url. |
|
After an Authentication Success where should device be redirected, allowedValues authSuccessPage, originatingURL and url. |
|
Sponsoredguestportal’s byodWelcomeSettings. |
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. AllowedValues 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: |
|
Sponsoredguestportal’s guestChangePasswordSettings. |
|
Allow guest to change their own passwords. Choices: |
|
Sponsoredguestportal’s guestDeviceRegistrationSettings. |
|
Allow guests to register devices. Choices: |
|
Automatically register guest devices. Choices: |
|
Sponsoredguestportal’s loginPageSettings. |
|
Access code that must be entered by the portal user (only valid if requireAccessCode = true). |
|
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 and asLink. |
|
Include an Acceptable Use Policy (AUP) that should be displayed during login. Choices: |
|
Maximum failed login attempts before rate limiting. |
|
Require the portal user to enter an access code. Choices: |
|
Require the portal user to accept the AUP. Only valid if includeAup = true. Choices: |
|
Time between login attempts when rate limiting. |
|
Sponsoredguestportal’s portalSettings. |
|
Interfaces that the portal will be reachable on. Allowed values eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2. |
|
Used when displayLang = alwaysUse. |
|
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 and alwaysUse. |
|
Used when displayLang = useBrowserLocale. |
|
The port number that the allowed interfaces will listen on. Range from 8000 to 8999. |
|
Sponsoredguestportal’s postLoginBannerSettings. |
|
Include a Post-Login Banner page. Choices: |
|
Sponsoredguestportal’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. AllowedValues hide, displayWithNoValue and 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 sponsoredguestportal.Sponsoredguestportal.create_sponsoredguestportal,
Paths used are post /sponsoredguestportal/,
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: Create
cisco.ise.sponsoredguestportal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
bannerImage:
data: base 64 encoded value of image
bannerTitle: Banner Title
contactText: 'Contact Information '
desktopLogoImage:
data: base 64 encoded value of image
footerElement: Footer Element
mobileLogoImage:
data: base 64 encoded value of image
language:
viewLanguage: English
pageCustomizations:
data:
- key: ui_contact_link
value: Contact Support
portalTheme:
id: themeId
name: ThemeName
themeData: Base 64 encoded string of Theme CSS file
portalTweakSettings:
bannerColor: Banner Color from GUI
bannerTextColor: Banner Text color code from GUI
pageBackgroundColor: Color code from GUI
pageLabelAndTextColor: Label and Text color from GUI
description: description
id: f75760e7-a4f9-40ef-93bb-88a97e9fb171
name: name
portalType: SPONSOREDGUEST
settings:
aupSettings:
displayFrequency: FIRSTLOGIN
includeAup: false
requireAccessCode: false
requireScrolling: false
skipAupForEmployees: false
useDiffAupForEmployees: false
authSuccessSettings:
redirectUrl: www.cisco.com
successRedirect: AUTHSUCCESSPAGE
guestChangePasswordSettings:
allowChangePasswdAtFirstLogin: false
guestDeviceRegistrationSettings:
allowGuestsToRegisterDevices: true
autoRegisterGuestDevices: false
loginPageSettings:
accessCode: Access code
allowAlternateGuestPortal: false
allowForgotPassword: false
allowGuestToChangePassword: false
allowGuestToCreateAccounts: false
allowGuestToUseSocialAccounts: false
allowShowGuestForm: false
aupDisplay: ASLINK
includeAup: false
maxFailedAttemptsBeforeRateLimit: 5
requireAccessCode: false
requireAupAcceptance: false
requireAupScrolling: false
socialConfigs: []
timeBetweenLoginsDuringRateLimit: 2
portalSettings:
allowedInterfaces:
- eth0
- bond0
alwaysUsedLanguage: English
assignedGuestTypeForEmployee: Guest Type
authenticationMethod: Identity Source
availableSsids: []
certificateGroupTag: Default Portal Certificate Group
displayLang: USEBROWSERLOCALE
fallbackLanguage: English
httpsPort: 8443
postLoginBannerSettings:
includePostAccessBanner: true
supportInfoSettings:
emptyFieldDisplay: HIDE
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: false
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 |