cisco.ise.sponsored_guest_portal – Resource module for Sponsored Guest Portal¶
Note
This plugin is part of the cisco.ise collection (version 0.0.9).
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.
Parameters¶
See Also¶
See also
- 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¶
- 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
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:
{}
|
Authors¶
Rafael Campos (@racampos)