You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

cisco.ise.sponsor_portal module – Resource module for Sponsor Portal

Note

This module 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.sponsor_portal.

New in version 1.0.0: of cisco.ise

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis 

Manage operations create, update and delete of the resource Sponsor 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	Comments
customizations dictionary	Sponsor Portal’s customizations.
globalCustomizations dictionary	Sponsor Portal’s globalCustomizations.
backgroundImage dictionary	Sponsor Portal’s backgroundImage.
data string	Represented as base 64 encoded string of the image byte array.
bannerImage dictionary	Sponsor Portal’s bannerImage.
data string	Represented as base 64 encoded string of the image byte array.
bannerTitle string	Sponsor Portal’s bannerTitle.
contactText string	Sponsor Portal’s contactText.
desktopLogoImage dictionary	Sponsor Portal’s desktopLogoImage.
data string	Represented as base 64 encoded string of the image byte array.
footerElement string	Sponsor Portal’s footerElement.
mobileLogoImage dictionary	Sponsor 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	Sponsor Portal’s viewLanguage.
pageCustomizations dictionary	Sponsor Portal’s pageCustomizations.
data list / elements=string	The Dictionary will be exposed here as key value pair.
key string	Sponsor Portal’s key.
value string	Sponsor Portal’s value.
portalTheme dictionary	Sponsor Portal’s portalTheme.
id string	Sponsor 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	Sponsor Portal’s bannerTextColor.
pageBackgroundColor string	Sponsor Portal’s pageBackgroundColor.
pageLabelAndTextColor string	Sponsor Portal’s pageLabelAndTextColor.
description string	Sponsor Portal’s description.
id string	Sponsor Portal’s id.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: no ← (default) yes
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	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: no yes ← (default)
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: no yes ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: “3.1.0”
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: no yes ← (default)
name string	Sponsor 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	Sponsor 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	IncludeAup flag. Choices: no yes
requireScrolling boolean	RequireScrolling flag. Choices: no yes
loginPageSettings dictionary	Portal Login Page settings groups follow.
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	Include an Acceptable Use Policy (AUP) that should be displayed during login. Choices: no yes
maxFailedAttemptsBeforeRateLimit integer	Maximum failed login attempts before rate limiting.
requireAupAcceptance boolean	Require the portal user to accept the AUP. Only valid if includeAup = true. Choices: no yes
requireAupScrolling boolean	RequireAupScrolling flag. Choices: no yes
socialConfigs list / elements=string	Sponsor Portal’s socialConfigs.
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.
authenticationMethod string	Unique Id of the identity source sequence.
availableSsids string	Names of the SSIDs available for assignment to guest users by sponsors.
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.
fqdn string	The fully-qualified domain name (FQDN) that end-users will use to access this portal. Used only in Sponsor portal.
httpsPort integer	The port number that the allowed interfaces will listen on. Range from 8000 to 8999.
idleTimeout integer	Sponsor Portal’s idleTimeout.
postAccessBannerSettings dictionary	Sponsor Portal’s postAccessBannerSettings.
includePostAccessBanner boolean	IncludePostAccessBanner flag. Choices: no yes
postLoginBannerSettings dictionary	Sponsor Portal’s postLoginBannerSettings.
includePostAccessBanner boolean	Include a Post-Login Banner page. Choices: no yes
sponsorChangePasswordSettings dictionary	Sponsor Portal’s sponsorChangePasswordSettings.
allowSponsorToChangePwd boolean	Allow sponsors to change their own passwords. Choices: no yes
supportInfoSettings dictionary	Sponsor 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	IncludeBrowserUserAgent flag. Choices: no yes
includeFailureCode boolean	IncludeFailureCode flag. Choices: no yes
includeIpAddress boolean	IncludeIpAddress flag. Choices: no yes
includeMacAddr boolean	IncludeMacAddr flag. Choices: no yes
includePolicyServer boolean	IncludePolicyServer flag. Choices: no yes
includeSupportInfoPage boolean	IncludeSupportInfoPage flag. Choices: no yes

Notes 

Note

Does not support check_mode

Examples 

- name: Update by id
  cisco.ise.sponsor_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
        requireScrolling: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireAupScrolling: true
        socialConfigs: []
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces: string
        authenticationMethod: string
        availableSsids: string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        fqdn: string
        httpsPort: 0
        idleTimeout: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      sponsorChangePasswordSettings:
        allowSponsorToChangePwd: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.sponsor_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.sponsor_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
        requireScrolling: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireAupScrolling: true
        socialConfigs: []
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces: string
        authenticationMethod: string
        availableSsids: string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        fqdn: string
        httpsPort: 0
        idleTimeout: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      sponsorChangePasswordSettings:
        allowSponsorToChangePwd: 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

dictionary

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”description\”: \”string\”,\n \”portalType\”: \”string\”,\n \”portalTestUrl\”: \”string\”,\n \”settings\”: {\n \”portalSettings\”: {\n \”httpsPort\”: 0,\n \”allowedInterfaces\”: [\n \”string\”\n ],\n \”certificateGroupTag\”: \”string\”,\n \”fqdn\”: \”string\”,\n \”authenticationMethod\”: \”string\”,\n \”idleTimeout\”: 0,\n \”displayLang\”: \”string\”,\n \”fallbackLanguage\”: \”string\”,\n \”availableSsids\”: \”string\”\n },\n \”loginPageSettings\”: {\n \”maxFailedAttemptsBeforeRateLimit\”: 0,\n \”timeBetweenLoginsDuringRateLimit\”: 0,\n \”includeAup\”: true,\n \”aupDisplay\”: \”string\”,\n \”requireAupAcceptance\”: true,\n \”requireAupScrolling\”: true,\n \”socialConfigs\”: []\n },\n \”aupSettings\”: {\n \”includeAup\”: true,\n \”requireScrolling\”: true,\n \”displayFrequency\”: \”string\”,\n \”displayFrequencyIntervalDays\”: 0\n },\n \”sponsorChangePasswordSettings\”: {\n \”allowSponsorToChangePwd\”: true\n },\n \”postLoginBannerSettings\”: {\n \”includePostAccessBanner\”: true\n },\n \”postAccessBannerSettings\”: {\n \”includePostAccessBanner\”: true\n },\n \”supportInfoSettings\”: {\n \”includeSupportInfoPage\”: true,\n \”includeMacAddr\”: true,\n \”includeIpAddress\”: true,\n \”includeBrowserUserAgent\”: true,\n \”includePolicyServer\”: true,\n \”includeFailureCode\”: true,\n \”emptyFieldDisplay\”: \”string\”,\n \”defaultEmptyFieldValue\”: \”string\”\n }\n },\n \”customizations\”: {\n \”portalTheme\”: {\n \”id\”: \”string\”,\n \”name\”: \”string\”,\n \”themeData\”: \”string\”\n },\n \”portalTweakSettings\”: {\n \”bannerColor\”: \”string\”,\n \”bannerTextColor\”: \”string\”,\n \”pageBackgroundColor\”: \”string\”,\n \”pageLabelAndTextColor\”: \”string\”\n },\n \”language\”: {\n \”viewLanguage\”: \”string\”\n },\n \”globalCustomizations\”: {\n \”mobileLogoImage\”: {\n \”data\”: \”string\”\n },\n \”desktopLogoImage\”: {\n \”data\”: \”string\”\n },\n \”bannerImage\”: {\n \”data\”: \”string\”\n },\n \”backgroundImage\”: {\n \”data\”: \”string\”\n },\n \”bannerTitle\”: \”string\”,\n \”contactText\”: \”string\”,\n \”footerElement\”: \”string\”\n },\n \”pageCustomizations\”: {\n \”data\”: [\n {\n \”key\”: \”string\”,\n \”value\”: \”string\”\n }\n ]\n }\n },\n \”link\”: {\n \”rel\”: \”string\”,\n \”href\”: \”string\”,\n \”type\”: \”string\”\n }\n}\n”

dictionary

added in 1.1.0 of cisco.ise

A dictionary or list with the response returned by the Cisco ISE Python SDK

Returned: always

Sample: “{\n \”UpdatedFieldsList\”: {\n \”updatedField\”: {\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n },\n \”field\”: \”string\”,\n \”oldValue\”: \”string\”,\n \”newValue\”: \”string\”\n }\n}\n”

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.sponsor_portal module – Resource module for Sponsor Portal

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

See Also 

Examples 

Return Values 