.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.sponsored_guest_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.sponsored_guest_portal -- Resource module for Sponsored Guest Portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 0.0.9). To install it use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.sponsored_guest_portal`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Sponsored Guest Portal. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
customizations
dictionary
Sponsored Guest Portal's customizations.
globalCustomizations
dictionary
Sponsored Guest Portal's globalCustomizations.
bannerImage
dictionary
Sponsored Guest Portal's bannerImage.
data
string
Sponsored Guest Portal's data.
bannerTitle
string
Sponsored Guest Portal's bannerTitle.
contactText
string
Sponsored Guest Portal's contactText.
desktopLogoImage
dictionary
Sponsored Guest Portal's desktopLogoImage.
data
string
Sponsored Guest Portal's data.
footerElement
string
Sponsored Guest Portal's footerElement.
mobileLogoImage
dictionary
Sponsored Guest Portal's mobileLogoImage.
data
string
Sponsored Guest Portal's data.
language
dictionary
Sponsored Guest Portal's language.
viewLanguage
string
Sponsored Guest Portal's viewLanguage.
pageCustomizations
dictionary
Sponsored Guest Portal's pageCustomizations.
data
list / elements=string
Sponsored Guest Portal's data.
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
Sponsored Guest Portal's name.
themeData
string
Sponsored Guest Portal's themeData.
portalTweakSettings
dictionary
Sponsored Guest Portal's portalTweakSettings.
bannerColor
string
Sponsored Guest Portal's bannerColor.
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.
name
string
Sponsored Guest Portal's name.
portalType
string
Sponsored Guest Portal's portalType.
settings
dictionary
Sponsored Guest Portal's settings.
aupSettings
dictionary
Sponsored Guest Portal's aupSettings.
displayFrequency
string
Sponsored Guest Portal's displayFrequency.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
requireAccessCode
boolean
    Choices:
  • no
  • yes
RequireAccessCode flag.
requireScrolling
boolean
    Choices:
  • no
  • yes
RequireScrolling flag.
skipAupForEmployees
boolean
    Choices:
  • no
  • yes
SkipAupForEmployees flag.
useDiffAupForEmployees
boolean
    Choices:
  • no
  • yes
UseDiffAupForEmployees flag.
authSuccessSettings
dictionary
Sponsored Guest Portal's authSuccessSettings.
redirectUrl
string
Sponsored Guest Portal's redirectUrl.
successRedirect
string
Sponsored Guest Portal's successRedirect.
guestChangePasswordSettings
dictionary
Sponsored Guest Portal's guestChangePasswordSettings.
allowChangePasswdAtFirstLogin
boolean
    Choices:
  • no
  • yes
AllowChangePasswdAtFirstLogin flag.
guestDeviceRegistrationSettings
dictionary
Sponsored Guest Portal's guestDeviceRegistrationSettings.
allowGuestsToRegisterDevices
boolean
    Choices:
  • no
  • yes
AllowGuestsToRegisterDevices flag.
autoRegisterGuestDevices
boolean
    Choices:
  • no
  • yes
AutoRegisterGuestDevices flag.
loginPageSettings
dictionary
Sponsored Guest Portal's loginPageSettings.
accessCode
string
Sponsored Guest Portal's accessCode.
allowAlternateGuestPortal
boolean
    Choices:
  • no
  • yes
AllowAlternateGuestPortal flag.
allowGuestToChangePassword
boolean
    Choices:
  • no
  • yes
AllowGuestToChangePassword flag.
allowGuestToCreateAccounts
boolean
    Choices:
  • no
  • yes
AllowGuestToCreateAccounts flag.
allowGuestToUseSocialAccounts
boolean
    Choices:
  • no
  • yes
AllowGuestToUseSocialAccounts flag.
allowShowGuestForm
boolean
    Choices:
  • no
  • yes
AllowShowGuestForm flag.
aupDisplay
string
Sponsored Guest Portal's aupDisplay.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
maxFailedAttemptsBeforeRateLimit
integer
Sponsored Guest Portal's maxFailedAttemptsBeforeRateLimit.
requireAccessCode
boolean
    Choices:
  • no
  • yes
RequireAccessCode flag.
requireAupAcceptance
boolean
    Choices:
  • no
  • yes
RequireAupAcceptance flag.
requireAupScrolling
boolean
    Choices:
  • no
  • yes
RequireAupScrolling flag.
socialConfigs
list / elements=string
Sponsored Guest Portal's socialConfigs.
timeBetweenLoginsDuringRateLimit
integer
Sponsored Guest Portal's timeBetweenLoginsDuringRateLimit.
portalSettings
dictionary
Sponsored Guest Portal's portalSettings.
allowedInterfaces
list / elements=string
Sponsored Guest Portal's allowedInterfaces.
alwaysUsedLanguage
string
Sponsored Guest Portal's alwaysUsedLanguage.
assignedGuestTypeForEmployee
string
Sponsored Guest Portal's assignedGuestTypeForEmployee.
authenticationMethod
string
Sponsored Guest Portal's authenticationMethod.
availableSsids
list / elements=string
Sponsored Guest Portal's availableSsids.
certificateGroupTag
string
Sponsored Guest Portal's certificateGroupTag.
displayLang
string
Sponsored Guest Portal's displayLang.
fallbackLanguage
string
Sponsored Guest Portal's fallbackLanguage.
httpsPort
integer
Sponsored Guest Portal's httpsPort.
postLoginBannerSettings
dictionary
Sponsored Guest Portal's postLoginBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
IncludePostAccessBanner flag.
supportInfoSettings
dictionary
Sponsored Guest Portal's supportInfoSettings.
emptyFieldDisplay
string
Sponsored Guest Portal's emptyFieldDisplay.
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 .. Seealso See Also -------- .. seealso:: :ref:`cisco.ise.plugins.module_utils.definitions.sponsored_guest_portal ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.sponsored_guest_portal** module. `Sponsored Guest Portal reference `_ Complete reference of the Sponsored Guest Portal object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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: 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: id 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 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 - 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: 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: id 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 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 - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
ise_response
dictionary
always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{}


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors