cisco.ise.byodportal module – Resource module for BYODportal
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.byodportal.
New in cisco.ise 1.0.0
Synopsis
Manage operation create of the resource BYODportal.
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 |
|---|---|
BYODportal’s customizations. |
|
BYODportal’s globalCustomizations. |
|
BYODportal’s backgroundImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
BYODportal’s bannerImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
BYODportal’s bannerTitle. |
|
BYODportal’s contactText. |
|
BYODportal’s footerElement. |
|
BYODportal’s mobileLogoImage. |
|
Represented as base 64 encoded string of the image byte array. |
|
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported. |
|
BYODportal’s pageCustomizations. |
|
The Dictionary will be exposed here as key value pair. |
|
BYODportal’s portalTheme. |
|
The unique internal identifier of the portal theme. |
|
The system- or user-assigned name of the portal theme. |
|
A CSS file, represented as a Base64-encoded byte array. |
|
BYODportal’s portalTweakSettings. |
|
BYODportal’s banneColor. |
|
BYODportal’s bannerTextColor. |
|
BYODportal’s pageBackgroundColor. |
|
BYODportal’s pageLabelAndTextColor. |
|
Description. |
|
Id. |
|
Flag for Identity Services Engine SDK to enable debugging. Choices: |
|
The Identity Services Engine hostname. |
|
The Identity Services Engine password to authenticate. |
|
Timeout (in seconds) for RESTful HTTP requests. Default: :ansible-option-default:`60` |
|
The Identity Services Engine username to authenticate. |
|
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: |
|
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: |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Identity Services Engine to use. |
|
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: |
|
Name. |
|
URL to bring up a test page for this portal. |
|
Allowed values byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest. |
|
BYODportal’s settings. |
|
BYODportal’s byodSettings. |
|
BYODportal’s byodRegistrationSettings. |
|
TIdentity group id for which endpoint belongs. |
|
Display Device ID field during registration. Choices: |
|
BYODportal’s byodRegistrationSuccessSettings. |
|
Target URL for redirection, used when successRedirect = url. |
|
After an Authentication Success where should device be redirected, allowedValues authSuccessPage, originatingURL and url. |
|
BYODportal’s byodWelcomeSettings. |
|
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. AllowedValues onPage, asLink. |
|
EnableBYOD flag. Choices: |
|
EnableGuestAccess flag. Choices: |
|
IncludeAup flag. Choices: |
|
RequireAupAcceptance flag. Choices: |
|
RequireMDM flag. Choices: |
|
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true. Choices: |
|
BYODportal’s portalSettings. |
|
Interfaces that the portal will be reachable on. Allowed values eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2. |
|
Used when displayLang = alwaysUse. |
|
Logical name of the x.509 server certificate that will be used for the portal. |
|
Allowed values useBrowserLocale and alwaysUse. |
|
Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal. |
|
Used when displayLang = useBrowserLocale. |
|
The port number that the allowed interfaces will listen on. Range from 8000 to 8999. |
|
BYODportal’s supportInfoSettings. |
|
The default value displayed for an empty field Only valid when emptyFieldDisplay = displayWithDefaultValue. |
|
Specifies how empty fields are handled on the Support Information Page. AllowedValues hide, displayWithNoValue and displayWithDefaultValue. |
|
IncludeBrowserUserAgent flag. Choices: |
|
IncludeFailureCode flag. Choices: |
|
IncludeIpAddress flag. Choices: |
|
IncludeMacAddr flag. Choices: |
|
IncludePolicyServer flag. Choices: |
|
IncludeSupportInfoPage flag. Choices: |
Notes
Note
SDK Method used are byodportal.Byodportal.create_byodportal,
Paths used are post /byodportal/,
Does not support
check_modeThe 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.byodportal:
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: BYOD
settings:
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: End Identity Group ID
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: Redirect URL
successRedirect: AUTHSUCCESSPAGE
byodWelcomeSettings:
aupDisplay: ASLINK
enableBYOD: true
enableGuestAccess: false
includeAup: true
requireAupAcceptance: false
requireMDM: false
requireScrolling: false
portalSettings:
allowedInterfaces:
- eth0
- bond0
alwaysUsedLanguage: English
availableSsids: []
certificateGroupTag: Default Portal Certificate Group
displayLang: USEBROWSERLOCALE
fallbackLanguage: English
httpsPort: 8443
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 |
|---|---|
A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always |