cisco.ise.hotspot_portal – Resource module for Hotspot 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.hotspot_portal.

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operations create, update and delete of the resource Hotspot 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
Hotspot Portal's globalCustomizations.
backgroundImage
dictionary
Hotspot Portal's backgroundImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerImage
dictionary
Hotspot Portal's bannerImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerTitle
string
Hotspot Portal's bannerTitle.
contactText
string
Hotspot Portal's contactText.
desktopLogoImage
dictionary
Hotspot Portal's desktopLogoImage.
data
string
Represented as base 64 encoded string of the image byte array.
footerElement
string
Hotspot Portal's footerElement.
mobileLogoImage
dictionary
Hotspot 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
Hotspot Portal's viewLanguage.
pageCustomizations
dictionary
Hotspot Portal's pageCustomizations.
data
list / elements=string
Hotspot Portal's data.
key
string
Hotspot Portal's key.
value
string
Hotspot Portal's value.
portalTheme
dictionary
Defines the configuration for portal theme.
id
string
The unique internal identifier of the portal theme.
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
Hotspot Portal's bannerTextColor.
pageBackgroundColor
string
Hotspot Portal's pageBackgroundColor.
pageLabelAndTextColor
string
Hotspot Portal's pageLabelAndTextColor.
description
string
Hotspot Portal's description.
id
string
Hotspot 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
Hotspot 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 BYOD.
aupSettings
dictionary
Configuration of the Acceptable Use Policy (AUP) for a portal.
accessCode
string
Access code that must be entered by the portal user (only valid if requireAccessCode = true).
includeAup
boolean
    Choices:
  • no
  • yes
Require the portal user to read and accept an AUP.
requireAccessCode
boolean
    Choices:
  • no
  • yes
Require the portal user to enter an access code. Only used in Hotspot portal.
requireScrolling
boolean
    Choices:
  • no
  • yes
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true.
authSuccessSettings
dictionary
Hotspot 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.
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
Used when displayLang = ALWAYSUSE.
certificateGroupTag
string
Logical name of the x.509 server certificate that will be used for the portal.
coaType
string
Allowed Values - COAREAUTHENTICATE, - COATERMINATE.
displayLang
string
Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
endpointIdentityGroup
string
Unique Id of the endpoint identity group where user's devices will be added. Used only in Hotspot Portal.
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
Hotspot Portal's postAccessBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
IncludePostAccessBanner flag.
postLoginBannerSettings
dictionary
Hotspot Portal's postLoginBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
Include a Post-Login Banner page.
supportInfoSettings
dictionary
Portal Support Information Settings.
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

Hotspot Portal reference

Complete reference of the Hotspot Portal object model.

Examples

- name: Update by id
  cisco.ise.hotspot_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:
        accessCode: string
        includeAup: true
        requireAccessCode: true
        requireScrolling: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      portalSettings:
        allowedInterfaces: string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        coaType: string
        displayLang: string
        endpointIdentityGroup: 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.hotspot_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.hotspot_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:
        accessCode: string
        includeAup: true
        requireAccessCode: true
        requireScrolling: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      portalSettings:
        allowedInterfaces: string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        coaType: string
        displayLang: string
        endpointIdentityGroup: 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", "endpointIdentityGroup": "string", "coaType": "string", "displayLang": "string", "fallbackLanguage": "string", "alwaysUsedLanguage": "string" }, "aupSettings": { "requireAccessCode": true, "accessCode": "string", "includeAup": true, "requireScrolling": true }, "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" }, "backgroundImage": { "data": "string" }, "bannerImage": { "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)