cisco.ise.hotspotportal module – Resource module for Hotspotportal

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.hotspotportal.

New in cisco.ise 1.0.0

Synopsis

  • Manage operation create of the resource Hotspotportal.

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

customizations

dictionary

Hotspotportal’s customizations.

globalCustomizations

dictionary

Hotspotportal’s globalCustomizations.

backgroundImage

dictionary

Hotspotportal’s backgroundImage.

data

string

Represented as base 64 encoded string of the image byte array.

bannerImage

dictionary

Hotspotportal’s bannerImage.

data

string

Represented as base 64 encoded string of the image byte array.

bannerTitle

string

Hotspotportal’s bannerTitle.

contactText

string

Hotspotportal’s contactText.

footerElement

string

Hotspotportal’s footerElement.

mobileLogoImage

dictionary

Hotspotportal’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.

pageCustomizations

dictionary

Hotspotportal’s pageCustomizations.

data

list / elements=dictionary

The Dictionary will be exposed here as key value pair.

portalTheme

dictionary

Hotspotportal’s portalTheme.

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

Hotspotportal’s portalTweakSettings.

banneColor

string

Hotspotportal’s banneColor.

bannerTextColor

string

Hotspotportal’s bannerTextColor.

pageBackgroundColor

string

Hotspotportal’s pageBackgroundColor.

pageLabelAndTextColor

string

Hotspotportal’s pageLabelAndTextColor.

description

string

Description.

id

string

Id.

ise_debug

boolean

Flag for Identity Services Engine SDK to enable debugging.

Choices:

ise_hostname

string / required

The Identity Services Engine hostname.

ise_password

string / required

The Identity Services Engine password to authenticate.

ise_single_request_timeout

integer

added in cisco.ise 3.0.0

Timeout (in seconds) for RESTful HTTP requests.

Default: :ansible-option-default:`60`

ise_username

string / required

The Identity Services Engine username to authenticate.

ise_uses_api_gateway

boolean

added in cisco.ise 1.1.0

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:

ise_uses_csrf_token

boolean

added in cisco.ise 3.0.0

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:

ise_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

ise_version

string

Informs the SDK which version of Identity Services Engine to use.

Default: :ansible-option-default:`"3.1\_Patch\_1"`

ise_wait_on_rate_limit

boolean

Flag for Identity Services Engine SDK to enable automatic rate-limit handling.

Choices:

name

string

Name.

portalTestUrl

string

URL to bring up a test page for this portal.

portalType

string

Allowed values byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest.

settings

dictionary

Hotspotportal’s settings.

aupSettings

dictionary

Hotspotportal’s aupSettings.

accessCode

string

Access code that must be entered by the portal user (only valid if requireAccessCode = true).

includeAup

boolean

Require the portal user to read and accept an AUP.

Choices:

requireAccessCode

boolean

Require the portal user to enter an access code. Only used in Hotspot portal.

Choices:

requireAupScrolling

boolean

Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true.

Choices:

authSuccessSettings

dictionary

Hotspotportal’s authSuccessSettings.

redirectUrl

string

Target URL for redirection, used when successRedirect = url.

successRedirect

string

After an Authentication Success where should user be redirected. Allowed Values authSuccessPage, originatingURL and url.

portalSettings

dictionary

Hotspotportal’s portalSettings.

allowedInterfaces

string

Interfaces that the portal will be reachable on. Allowed values eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and 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 and coaTerminate.

displayLang

string

Allowed values useBrowserLocale and 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

float

The port number that the allowed interfaces will listen on. Range from 8000 to 8999.

postLoginBannerSettings

dictionary

Hotspotportal’s postLoginBannerSettings.

includePostAccessBanner

boolean

Include a Post-Login Banner page.

Choices:

supportInfoSettings

dictionary

Hotspotportal’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. AllowedValues hide, displayWithNoValue and displayWithDefaultValue.

includeBrowserUserAgent

boolean

IncludeBrowserUserAgent flag.

Choices:

includeFailureCode

boolean

IncludeFailureCode flag.

Choices:

includeIpAddress

boolean

IncludeIpAddress flag.

Choices:

includeMacAddr

boolean

IncludeMacAddr flag.

Choices:

includePolicyServer

boolean

IncludePolicyServer flag.

Choices:

includeSupportInfoPage

boolean

IncludeSupportInfoPage flag.

Choices:

Notes

Note

  • SDK Method used are hotspotportal.Hotspotportal.create_hotspotportal,

  • Paths used are post /hotspotportal/,

  • Does not support check_mode

  • The 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.hotspotportal:
    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: HOTSPOTGUEST
    settings:
      aupSettings:
        displayFrequency: FIRSTLOGIN
        includeAup: false
        requireAccessCode: false
        requireScrolling: false
        skipAupForEmployees: false
        useDiffAupForEmployees: false
      authSuccessSettings:
        redirectUrl: www.cisco.com
        successRedirect: AUTHSUCCESSPAGE
      portalSettings:
        allowedInterfaces:
          - eth0
          - bond0
        alwaysUsedLanguage: English
        availableSsids: []
        certificateGroupTag: Default Portal Certificate Group
        coaType: COAREAUTHENTICATE
        displayLang: USEBROWSERLOCALE
        endpointIdentityGroup: f14227b0-6e5c-11e6-8f6a-005056873bd0
        fallbackLanguage: English
        httpsPort: 8443
      postAccessBannerSettings:
        includePostAccessBanner: false
      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

ise_response

list / elements=dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"`

Authors

  • Rafael Campos (@racampos)