cisco.ise.hotspot_portal – Resource module for Hotspot 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.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.
Parameters¶
See Also¶
See also
- cisco.ise.plugins.module_utils.definitions.hotspot_portal
The official documentation on the cisco.ise.plugins.module_utils.definitions.hotspot_portal module.
- Hotspot Portal reference
Complete reference of the Hotspot Portal object model.
Examples¶
- 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:
bannerTitle: Hotspot Portal
contactText: Contact Support
footerElement: ''
language:
viewLanguage: English
pageCustomizations:
data:
- key: ui_contact_ip_address_label
value: SVAgYWRkcmVzczo=
- key: ui_error_content_label
value: RXJyb3I=
- key: ui_success_optional_content_2
value: ''
- key: ui_success_optional_content_1
value: ''
- key: ui_post_access_optional_content_1
value: ''
- key: ui_post_access_optional_content_2
value: ''
- key: ui_success_message
value: WW91IGhhdmUgc3VjY2Vzc2Z1bGx5IGNvbm5lY3RlZCB0byB0aGUgbmV0d29yay4=
- key: ui_contact_optional_content_1
value: ''
- key: ui_contact_optional_content_2
value: ''
- key: ui_vlan_unsupported_error_message
value: VG8gYWNjZXNzIHRoZSBuZXR3b3JrLCB5b3UgbXVzdCBtYW51YWxseSByZXNldCB0aGUgSVAgYWRkcmVzcyBvbiB5b3VyIGRldml...
- key: ui_user_last_login_pass_time_label
value: TGFzdCBMb2dpbjo=
- key: ui_post_access_content_label
value: V2VsY29tZSBNZXNzYWdl
- key: ui_success_returning_message
value: ''
- key: ui_error_page_title
value: RXJyb3I=
- key: ui_vlan_instruction_message
value: ''
- key: ui_contact_sessioninfo_text
value: VGhpcyBpbmZvcm1hdGlvbiBwcm92aWRlcyBkZXRhaWxzIHRoYXQgdGhlIGhlbHAgZGVzayBtaWdodCBuZWVkIHRvIHJlc29sdmU...
- key: ui_contact_content_label
value: U3VwcG9ydCBJbmZvcm1hdGlvbg==
- key: ui_contact_sessioninfo_title
value: U2Vzc2lvbiBJbmZvcm1hdGlvbg==
- key: ui_aup_accept_button
value: QWNjZXB0
- key: ui_error_optional_content_2
value: ''
- key: ui_error_optional_content_1
value: ''
- key: ui_vlan_install_error_message
value: SW5zdGFsbGF0aW9uIG9mIHRoZSBhcHBsaWNhdGlvbiBmYWlsZWQuIEZvbGxvdyB0aGUgaW5zdHJ1Y3Rpb25zIGJlbG93IHRvIGN...
- key: ui_footer_label
value: ''
- key: ui_post_access_instruction_message
value: ''
- key: ui_post_access_page_title
value: UG9zdC1BY2Nlc3MgQmFubmVy
- key: ui_aup_content_label
value: QWNjZXB0YWJsZSBVc2UgUG9saWN5
- key: ui_contact_page_title
value: U3VwcG9ydCBJbmZvcm1hdGlvbg==
- key: ui_contact_instruction_message
value: U2hhcmUgdGhlc2UgZGV0YWlscyB3aXRoIHRoZSBoZWxwIGRlc2sgd2hlbiB0cm91Ymxlc2hvb3RpbmcgaXNzdWVzIHdpdGggdGh...
- key: ui_session_timeout_error
value: WW91ciBzZXNzaW9uIGhhcyB0aW1lZCBvdXQuIENsaWNrIFJldHJ5IHRvIHRyeSBhZ2Fpbi4=
- key: ui_vlan_page_title
value: Q29ubmVjdGluZyB0byBOZXR3b3Jr
- key: ui_contact_helpdesk_text
value: Q29udGFjdCB0aGUgaGVscCBkZXNrIGF0ICh4eHgpIHh4eC14eHh4Lg==
- key: ui_aup_registration_code_label
value: QWNjZXNzIGNvZGU6
- key: ui_vlan_coa_error_message
value: VW5hYmxlIHRvIGNvbW11bmljYXRlIHdpdGggc2VydmVyIHRvIHBlcmZvcm0gdGhlIGNoYW5nZSBvZiBhdXRob3JpemF0aW9uICh...
- key: ui_vlan_execute_message
value: UmVsZWFzaW5nIGFuZCByZW5ld2luZyB5b3VyIElQIGFkZHJlc3Mu
- key: ui_vlan_execute_error_message
value: VW5hYmxlIHRvIHJlbmV3IHRoZSBJUCBhZGRyZXNzLiBZb3UgbWlnaHQgbmVlZCB0byBkaXNhYmxlIG9yIHJlZHVjZSB0aGUgc2V...
- key: ui_contact_failure_code_label
value: RmFpbHVyZSBjb2RlOg==
- key: ui_contact_link
value: Q29udGFjdCBTdXBwb3J0
- key: ui_success_instruction_message
value: ''
- key: ui_aup_page_title
value: QWNjZXB0YWJsZSBVc2UgUG9saWN5
- key: ui_contact_user_agent_label
value: VXNlciBhZ2VudDo=
- key: ui_aup_hotspot_text
value: UGxlYXNlIGFjY2VwdCB0aGUgcG9saWN5OllvdSBhcmUgcmVzcG9uc2libGUgZm9yIG1haW50YWluaW5nIHRoZSBjb25maWRlbnR...
- key: ui_vlan_content_label
value: Q29ubmVjdGluZyB0byBOZXR3b3Jr
- key: ui_aup_optional_content_2
value: ''
- key: ui_vlan_install_message
value: WW91ciB3ZWIgYnJvd3NlciBpcyBhdHRlbXB0aW5nIHRvIGRvd25sb2FkIGFuIGFwcGxpY2F0aW9uLCB3aGljaCB3aWxsIGF1dG9...
- key: ui_contact_mac_address_label
value: TUFDIGFkZHJlc3M6
- key: ui_aup_optional_content_1
value: ''
- key: ui_error_instruction_message
value: ''
- key: ui_success_content_label
value: Q29ubmVjdGlvbiBTdWNjZXNzZnVs
- key: ui_contact_title_label
value: U3VwcG9ydCBJbmZvcm1hdGlvbg==
- key: ui_vlan_java_disabled_error_message
value: VG8gY29udGludWUsIGluc3RhbGwgYW5kIGVuYWJsZSB0aGUgbGF0ZXN0IEphdmEgdmVyc2lvbiwgYW5kIG1ha2Ugc3VyZSB0aGU...
- key: ui_post_access_continue_button
value: Q29udGludWU=
- key: ui_javascript_disabled_message
value: WW91IG11c3QgdHVybiBvbiBKYXZhU2NyaXB0IHRvIHVzZSB0aGlzIHdlYiBzaXRlLg==
- key: ui_contact_policy_server_label
value: UG9saWN5IHNlcnZlcjo=
- key: ui_user_last_login_ipaddr_label
value: RnJvbTo=
- key: ui_success_page_title
value: Q29ubmVjdGlvbiBTdWNjZXNzZnVs
- key: ui_contact_helpdesk_title
value: U3VwcG9ydCBJbmZvcm1hdGlvbg==
- key: ui_aup_decline_button
value: RGVjbGluZQ==
- key: ui_aup_decline_error
value: WW91IGNob3NlIHRvIHJlamVjdCB0aGUgQWNjZXB0YWJsZSBVc2UgUG9saWN5LiBXZSBjYW5ub3QgYWxsb3cgYWNjZXNzIHRvIHR...
- key: ui_session_timeout_retry_button
value: UmV0cnk=
- key: ui_post_access_message
value: Q2xpY2sgPGI+Q29udGludWU8L2I+IHRvIGNvbm5lY3QgdG8gdGhlIG5ldHdvcmsu
- key: ui_vlan_optional_content_2
value: ''
- key: ui_vlan_optional_content_1
value: ''
- key: ui_aup_agreement_label
value: SSBhZ3JlZSB0byB0aGUgdGVybXMgYW5kIGNvbmRpdGlvbnM=
- key: ui_contact_message
value: Q29udGFjdCBJbmZvcm1hdGlvbg==
- key: ui_field_required_error
value: VGhpcyBmaWVsZCBpcyByZXF1aXJlZC4=
- key: ui_banner_label
value: SG90c3BvdCBQb3J0YWw=
- key: ui_aup_instruction_message
value: UGxlYXNlIHJlYWQgdGhlIEFjY2VwdGFibGUgVXNlIFBvbGljeS4=
portalTheme:
id: 9eb421c0-8c01-11e6-996c-525400b48521
name: Default Blue theme
description: Guests do not require username and password credentials to access the
network, but you can optionally require an access code
name: Hotspot Guest Portal (default)
portalType: HOTSPOTGUEST
settings:
aupSettings:
includeAup: true
requireScrolling: false
authSuccessSettings:
successRedirect: AUTHSUCCESSPAGE
portalSettings:
allowedInterfaces:
- eth0
- bond0
alwaysUsedLanguage: English
certificateGroupTag: Default Portal Certificate Group
coaType: COAREAUTHENTICATE
displayLang: USEBROWSERLOCALE
endpointIdentityGroup: aa178bd0-8bff-11e6-996c-525400b48521
fallbackLanguage: English
httpsPort: 8443
postAccessBannerSettings:
includePostAccessBanner: false
supportInfoSettings:
emptyFieldDisplay: HIDE
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: false
- 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
description: ''
id: bd533907-bb9e-43d3-aef2-9a9f2a9dbb35
name: My Hotspot Guest Portal
settings:
portalSettings:
allowedInterfaces:
- eth0
- eth1
- bond0
httpsPort: 8443
- 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
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)