cisco.ise.sponsored_guest_portal – Resource module for Sponsored Guest Portal

Note

This plugin is part of the cisco.ise collection (version 1.2.1).

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.

To use it in a playbook, specify: cisco.ise.sponsored_guest_portal.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Sponsored Guest Portal.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • ciscoisesdk >= 1.1.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
customizations
dictionary
Defines all of the Portal Customizations available.
globalCustomizations
dictionary
Sponsored Guest Portal's globalCustomizations.
backgroundImage
dictionary
Sponsored Guest Portal's backgroundImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerImage
dictionary
Sponsored Guest Portal's bannerImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerTitle
string
Sponsored Guest Portal's bannerTitle.
contactText
string
Sponsored Guest Portal's contactText.
desktopLogoImage
dictionary
Sponsored Guest Portal's desktopLogoImage.
data
string
Represented as base 64 encoded string of the image byte array.
footerElement
string
Sponsored Guest Portal's footerElement.
mobileLogoImage
dictionary
Sponsored Guest Portal's mobileLogoImage.
data
string
Represented as base 64 encoded string of the image byte array.
language
dictionary
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported.
viewLanguage
string
Sponsored Guest Portal's viewLanguage.
pageCustomizations
dictionary
Represent the entire page customization as a giant dictionary.
data
list / elements=string
The Dictionary will be exposed here as key value pair.
key
string
Sponsored Guest Portal's key.
value
string
Sponsored Guest Portal's value.
portalTheme
dictionary
Sponsored Guest Portal's portalTheme.
id
string
Sponsored Guest Portal's id.
name
string
The system- or user-assigned name of the portal theme.
themeData
string
A CSS file, represented as a Base64-encoded byte array.
portalTweakSettings
dictionary
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.
bannerColor
string
Hex value of color.
bannerTextColor
string
Sponsored Guest Portal's bannerTextColor.
pageBackgroundColor
string
Sponsored Guest Portal's pageBackgroundColor.
pageLabelAndTextColor
string
Sponsored Guest Portal's pageLabelAndTextColor.
description
string
Sponsored Guest Portal's description.
id
string
Sponsored Guest Portal's id.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
name
string
Sponsored Guest Portal's name.
portalTestUrl
string
URL to bring up a test page for this portal.
portalType
string
Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.
settings
dictionary
Defines all of the settings groups available for a portal.
aupSettings
dictionary
Sponsored Guest Portal's aupSettings.
displayFrequency
string
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values - FIRSTLOGIN, - EVERYLOGIN, - RECURRING.
displayFrequencyIntervalDays
integer
Number of days between AUP confirmations (when displayFrequency = recurring).
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
requireAupScrolling
boolean
    Choices:
  • no
  • yes
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true.
requireScrolling
boolean
    Choices:
  • no
  • yes
RequireScrolling flag.
skipAupForEmployees
boolean
    Choices:
  • no
  • yes
Only valid if requireAupAcceptance = true.
useDiffAupForEmployees
boolean
    Choices:
  • no
  • yes
Only valid if requireAupAcceptance = true.
authSuccessSettings
dictionary
Sponsored Guest Portal's authSuccessSettings.
redirectUrl
string
Target URL for redirection, used when successRedirect = URL.
successRedirect
string
After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL.
byodSettings
dictionary
Sponsored Guest Portal's byodSettings.
byodRegistrationSettings
dictionary
Configuration of BYOD endpoint Registration step configuration.
endPointIdentityGroupId
string
Identity group id for which endpoint belongs.
showDeviceID
boolean
    Choices:
  • no
  • yes
Display Device ID field during registration.
byodRegistrationSuccessSettings
dictionary
Sponsored Guest Portal's byodRegistrationSuccessSettings.
redirectUrl
string
Target URL for redirection, used when successRedirect = URL.
successRedirect
string
After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL.
byodWelcomeSettings
dictionary
Sponsored Guest Portal's byodWelcomeSettings.
aupDisplay
string
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
enableBYOD
boolean
    Choices:
  • no
  • yes
EnableBYOD flag.
enableGuestAccess
boolean
    Choices:
  • no
  • yes
EnableGuestAccess flag.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
requireAupAcceptance
boolean
    Choices:
  • no
  • yes
RequireAupAcceptance flag.
requireMDM
boolean
    Choices:
  • no
  • yes
RequireMDM flag.
requireScrolling
boolean
    Choices:
  • no
  • yes
Require BYOD devices to scroll down to the bottom of the AUP. Only valid if includeAup = true.
guestChangePasswordSettings
dictionary
Sponsored Guest Portal's guestChangePasswordSettings.
allowChangePasswdAtFirstLogin
boolean
    Choices:
  • no
  • yes
Allow guest to change their own passwords.
guestDeviceRegistrationSettings
dictionary
Sponsored Guest Portal's guestDeviceRegistrationSettings.
allowGuestsToRegisterDevices
boolean
    Choices:
  • no
  • yes
Allow guests to register devices.
autoRegisterGuestDevices
boolean
    Choices:
  • no
  • yes
Automatically register guest devices.
loginPageSettings
dictionary
Portal Login Page settings groups follow.
accessCode
string
Access code that must be entered by the portal user (only valid if requireAccessCode = true).
allowAlternateGuestPortal
boolean
    Choices:
  • no
  • yes
AllowAlternateGuestPortal flag.
allowForgotPassword
boolean
    Choices:
  • no
  • yes
AllowForgotPassword flag.
allowGuestToChangePassword
boolean
    Choices:
  • no
  • yes
Require the portal user to enter an access code.
allowGuestToCreateAccounts
boolean
    Choices:
  • no
  • yes
AllowGuestToCreateAccounts flag.
aupDisplay
string
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
includeAup
boolean
    Choices:
  • no
  • yes
Include an Acceptable Use Policy (AUP) that should be displayed during login.
maxFailedAttemptsBeforeRateLimit
integer
Maximum failed login attempts before rate limiting.
requireAccessCode
boolean
    Choices:
  • no
  • yes
RequireAccessCode flag.
requireAupAcceptance
boolean
    Choices:
  • no
  • yes
Require the portal user to accept the AUP. Only valid if includeAup = true.
socialConfigs
list / elements=string
Sponsored Guest Portal's socialConfigs.
socialMediaType
string
Sponsored Guest Portal's socialMediaType.
socialMediaValue
string
Sponsored Guest Portal's socialMediaValue.
timeBetweenLoginsDuringRateLimit
integer
Time between login attempts when rate limiting.
portalSettings
dictionary
The port, interface, certificate, and other basic settings of a portal.
allowedInterfaces
string
Interfaces that the portal will be reachable on. Allowed values - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
alwaysUsedLanguage
string
Sponsored Guest Portal's alwaysUsedLanguage.
assignedGuestTypeForEmployee
string
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type.
authenticationMethod
string
Unique Id of the identity source sequence.
certificateGroupTag
string
Logical name of the x.509 server certificate that will be used for the portal.
displayLang
string
Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
fallbackLanguage
string
Used when displayLang = USEBROWSERLOCALE.
httpsPort
integer
The port number that the allowed interfaces will listen on. Range from 8000 to 8999.
postAccessBannerSettings
dictionary
Sponsored Guest Portal's postAccessBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
IncludePostAccessBanner flag.
postLoginBannerSettings
dictionary
Sponsored Guest Portal's postLoginBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
Include a Post-Login Banner page.
supportInfoSettings
dictionary
Sponsored Guest Portal's supportInfoSettings.
defaultEmptyFieldValue
string
The default value displayed for an empty field. Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
emptyFieldDisplay
string
Specifies how empty fields are handled on the Support Information Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
includeBrowserUserAgent
boolean
    Choices:
  • no
  • yes
IncludeBrowserUserAgent flag.
includeFailureCode
boolean
    Choices:
  • no
  • yes
IncludeFailureCode flag.
includeIpAddress
boolean
    Choices:
  • no
  • yes
IncludeIpAddress flag.
includeMacAddr
boolean
    Choices:
  • no
  • yes
IncludeMacAddr flag.
includePolicyServer
boolean
    Choices:
  • no
  • yes
IncludePolicyServer flag.
includeSupportInfoPage
boolean
    Choices:
  • no
  • yes
IncludeSupportInfoPage flag.

Notes

Note

  • Does not support check_mode

See Also

See also

Sponsored Guest Portal reference

Complete reference of the Sponsored Guest Portal object model.

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 Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "id": "string", "name": "string", "description": "string", "portalType": "string", "portalTestUrl": "string", "settings": { "portalSettings": { "httpsPort": 0, "allowedInterfaces": [ "string" ], "certificateGroupTag": "string", "authenticationMethod": "string", "assignedGuestTypeForEmployee": "string", "displayLang": "string", "fallbackLanguage": "string", "alwaysUsedLanguage": "string" }, "loginPageSettings": { "requireAccessCode": true, "maxFailedAttemptsBeforeRateLimit": 0, "timeBetweenLoginsDuringRateLimit": 0, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "accessCode": "string", "allowGuestToCreateAccounts": true, "allowForgotPassword": true, "allowGuestToChangePassword": true, "allowAlternateGuestPortal": true, "socialConfigs": [ { "socialMediaType": "string", "socialMediaValue": "string" } ] }, "aupSettings": { "includeAup": true, "requireAupScrolling": true, "useDiffAupForEmployees": true, "skipAupForEmployees": true, "displayFrequencyIntervalDays": 0, "requireScrolling": true, "displayFrequency": "string" }, "guestChangePasswordSettings": { "allowChangePasswdAtFirstLogin": true }, "guestDeviceRegistrationSettings": { "autoRegisterGuestDevices": true, "allowGuestsToRegisterDevices": true }, "byodSettings": { "byodWelcomeSettings": { "enableBYOD": true, "enableGuestAccess": true, "requireMDM": true, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "requireScrolling": true }, "byodRegistrationSettings": { "showDeviceID": true, "endPointIdentityGroupId": "string" }, "byodRegistrationSuccessSettings": { "successRedirect": "string", "redirectUrl": "string" } }, "postAccessBannerSettings": { "includePostAccessBanner": true }, "authSuccessSettings": { "successRedirect": "string", "redirectUrl": "string" }, "postLoginBannerSettings": { "includePostAccessBanner": true }, "supportInfoSettings": { "includeSupportInfoPage": true, "includeMacAddr": true, "includeIpAddress": true, "includeBrowserUserAgent": true, "includePolicyServer": true, "includeFailureCode": true, "emptyFieldDisplay": "string", "defaultEmptyFieldValue": "string" } }, "customizations": { "portalTheme": { "id": "string", "name": "string", "themeData": "string" }, "portalTweakSettings": { "bannerColor": "string", "bannerTextColor": "string", "pageBackgroundColor": "string", "pageLabelAndTextColor": "string" }, "language": { "viewLanguage": "string" }, "globalCustomizations": { "mobileLogoImage": { "data": "string" }, "desktopLogoImage": { "data": "string" }, "bannerImage": { "data": "string" }, "backgroundImage": { "data": "string" }, "bannerTitle": "string", "contactText": "string", "footerElement": "string" }, "pageCustomizations": { "data": [ { "key": "string", "value": "string" } ] } }, "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response
dictionary
added in 1.1.0 of cisco.ise
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": { "field": "string", "oldValue": "string", "newValue": "string" }, "field": "string", "oldValue": "string", "newValue": "string" } }


Authors

  • Rafael Campos (@racampos)