File: //usr/lib/python3.9/site-packages/ansible_collections/cisco/ise/plugins/modules/byod_portal.py
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: byod_portal
short_description: Resource module for BYOD Portal
description:
- Manage operations create, update and delete of the resource BYOD Portal.
- This API creates a BYOD portal.
- This API deletes a BYOD portal by ID.
- This API allows the client to update a BYOD portal by ID.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
customizations:
description: Defines all of the Portal Customizations available for a BYOD.
suboptions:
globalCustomizations:
description: Represent the portal Global customizations.
suboptions:
backgroundImage:
description: BYOD Portal's backgroundImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
bannerImage:
description: BYOD Portal's bannerImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
bannerTitle:
description: BYOD Portal's bannerTitle.
type: str
contactText:
description: BYOD Portal's contactText.
type: str
desktopLogoImage:
description: BYOD Portal's desktopLogoImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
footerElement:
description: BYOD Portal's footerElement.
type: str
mobileLogoImage:
description: BYOD Portal's mobileLogoImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
type: dict
language:
description: This property is supported only for Read operation and it allows
to show the customizations in English. Other languages are not supported.
suboptions:
viewLanguage:
description: BYOD Portal's viewLanguage.
type: str
type: dict
pageCustomizations:
description: Represent the entire page customization as a giant dictionary.
suboptions:
data:
description: The Dictionary will be exposed here as key value pair.
elements: dict
suboptions:
key:
description: BYOD Portal's key.
type: str
value:
description: BYOD Portal's value.
type: str
type: list
type: dict
portalTheme:
description: Defines the configuration for portal theme.
suboptions:
id:
description: The unique internal identifier of the portal theme.
type: str
name:
description: The system- or user-assigned name of the portal theme.
type: str
themeData:
description: A CSS file, represented as a Base64-encoded byte array.
type: str
type: dict
portalTweakSettings:
description: The Tweak Settings are a customization of the Portal Theme that
has been selected for the portal. When the Portal Theme selection is changed,
the Tweak Settings are overwritten to match the values in the theme. The Tweak
Settings can subsequently be changed by the user.
suboptions:
bannerColor:
description: Hex value of color.
type: str
bannerTextColor:
description: BYOD Portal's bannerTextColor.
type: str
pageBackgroundColor:
description: BYOD Portal's pageBackgroundColor.
type: str
pageLabelAndTextColor:
description: BYOD Portal's pageLabelAndTextColor.
type: str
type: dict
type: dict
description:
description: BYOD Portal's description.
type: str
id:
description: Resource UUID, mandatory for update.
type: str
name:
description: Resource Name.
type: str
portalTestUrl:
description: URL to bring up a test page for this portal.
type: str
portalType:
description: Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST,
- SPONSOR, - SPONSOREDGUEST.
type: str
settings:
description: Defines all of the settings groups available for a BYOD.
suboptions:
byodSettings:
description: Configuration of BYOD Device Welcome, Registration and Success
steps.
suboptions:
byodRegistrationSettings:
description: BYOD Portal's byodRegistrationSettings.
suboptions:
endPointIdentityGroupId:
description: BYOD Portal's endPointIdentityGroupId.
type: str
showDeviceID:
description: ShowDeviceID flag.
type: bool
type: dict
byodRegistrationSuccessSettings:
description: BYOD Portal's byodRegistrationSuccessSettings.
suboptions:
redirectUrl:
description: Target URL for redirection, used when successRedirect =
URL.
type: str
successRedirect:
description: After an Authentication Success where should device be
redirected. Allowed values.
type: str
type: dict
byodWelcomeSettings:
description: Configuration of BYOD endpoint welcome step configuration.
suboptions:
aupDisplay:
description: How the AUP should be displayed, either on page or as a
link. Only valid if includeAup = true. Allowed values - ONPAGE, -
ASLINK.
type: str
enableBYOD:
description: EnableBYOD flag.
type: bool
enableGuestAccess:
description: EnableGuestAccess flag.
type: bool
includeAup:
description: IncludeAup flag.
type: bool
requireAupAcceptance:
description: RequireAupAcceptance flag.
type: bool
requireMDM:
description: RequireMDM flag.
type: bool
requireScrolling:
description: Require BYOD devices to scroll down to the bottom of the
AUP, Only valid if includeAup = true.
type: bool
type: dict
type: dict
portalSettings:
description: The port, interface, certificate, and other basic settings of a
portal.
suboptions:
allowedInterfaces:
description: Interfaces that the portal will be reachable on. Allowed values
- eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
elements: str
type: list
alwaysUsedLanguage:
description: Used when displayLang = ALWAYSUSE.
type: str
certificateGroupTag:
description: Logical name of the x.509 server certificate that will be used
for the portal.
type: str
displayLang:
description: Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
type: str
endpointIdentityGroup:
description: Unique Id of the endpoint identity group where user's devices
will be added. Used only in Hotspot Portal.
type: str
fallbackLanguage:
description: Used when displayLang = USEBROWSERLOCALE.
type: str
httpsPort:
description: The port number that the allowed interfaces will listen on.
Range from 8000 to 8999.
type: int
type: dict
supportInfoSettings:
description: BYOD Portal's supportInfoSettings.
suboptions:
defaultEmptyFieldValue:
description: The default value displayed for an empty field. Only valid
when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
type: str
emptyFieldDisplay:
description: Specifies how empty fields are handled on the Support Information
Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
type: str
includeBrowserUserAgent:
description: IncludeBrowserUserAgent flag.
type: bool
includeFailureCode:
description: IncludeFailureCode flag.
type: bool
includeIpAddress:
description: IncludeIpAddress flag.
type: bool
includeMacAddr:
description: IncludeMacAddr flag.
type: bool
includePolicyServer:
description: IncludePolicyServer flag.
type: bool
includeSupportInfoPage:
description: IncludeSupportInfoPage flag.
type: bool
type: dict
type: dict
requirements:
- ciscoisesdk >= 2.0.8
- python >= 3.5
notes:
- SDK Method used are
byod_portal.ByodPortal.create_byod_portal,
byod_portal.ByodPortal.delete_byod_portal_by_id,
byod_portal.ByodPortal.update_byod_portal_by_id,
- Paths used are
post /ers/config/byodportal,
delete /ers/config/byodportal/{id},
put /ers/config/byodportal/{id},
"""
EXAMPLES = r"""
- name: Update by id
cisco.ise.byod_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
id: string
name: string
portalTestUrl: string
portalType: string
settings:
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
certificateGroupTag: string
displayLang: string
endpointIdentityGroup: string
fallbackLanguage: string
httpsPort: 0
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
- name: Delete by id
cisco.ise.byod_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.byod_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
id: string
name: string
portalTestUrl: string
portalType: string
settings:
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
certificateGroupTag: string
displayLang: string
endpointIdentityGroup: string
fallbackLanguage: string
httpsPort: 0
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"id": "string",
"name": "string",
"description": "string",
"portalType": "string",
"portalTestUrl": "string",
"settings": {
"portalSettings": {
"httpsPort": 0,
"allowedInterfaces": [
"string"
],
"certificateGroupTag": "string",
"endpointIdentityGroup": "string",
"displayLang": "string",
"fallbackLanguage": "string",
"alwaysUsedLanguage": "string"
},
"byodSettings": {
"byodWelcomeSettings": {
"enableBYOD": true,
"enableGuestAccess": true,
"requireMDM": true,
"includeAup": true,
"aupDisplay": "string",
"requireAupAcceptance": true,
"requireScrolling": true
},
"byodRegistrationSettings": {
"showDeviceID": true,
"endPointIdentityGroupId": "string"
},
"byodRegistrationSuccessSettings": {
"successRedirect": "string",
"redirectUrl": "string"
}
},
"supportInfoSettings": {
"includeSupportInfoPage": true,
"includeMacAddr": true,
"includeIpAddress": true,
"includeBrowserUserAgent": true,
"includePolicyServer": true,
"includeFailureCode": true,
"emptyFieldDisplay": "string",
"defaultEmptyFieldValue": "string"
}
},
"customizations": {
"portalTheme": {
"id": "string",
"name": "string",
"themeData": "string"
},
"portalTweakSettings": {
"bannerColor": "string",
"bannerTextColor": "string",
"pageBackgroundColor": "string",
"pageLabelAndTextColor": "string"
},
"language": {
"viewLanguage": "string"
},
"globalCustomizations": {
"mobileLogoImage": {
"data": "string"
},
"desktopLogoImage": {
"data": "string"
},
"bannerImage": {
"data": "string"
},
"backgroundImage": {
"data": "string"
},
"bannerTitle": "string",
"contactText": "string",
"footerElement": "string"
},
"pageCustomizations": {
"data": [
{
"key": "string",
"value": "string"
}
]
}
},
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
version_added: '1.1.0'
type: dict
sample: >
{
"UpdatedFieldsList": {
"updatedField": [
{
"field": "string",
"oldValue": "string",
"newValue": "string"
}
],
"field": "string",
"oldValue": "string",
"newValue": "string"
}
}
"""