.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.ise.byod_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.byod_portal -- Resource module for Byod Portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.byod_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 Byod 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 >= 1.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
customizations
dictionary
Defines all of the Portal Customizations available for a BYOD.
globalCustomizations
dictionary
Represent the portal Global customizations.
backgroundImage
dictionary
Byod Portal's backgroundImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerImage
dictionary
Byod Portal's bannerImage.
data
string
Represented as base 64 encoded string of the image byte array.
bannerTitle
string
Byod Portal's bannerTitle.
contactText
string
Byod Portal's contactText.
desktopLogoImage
dictionary
Byod Portal's desktopLogoImage.
data
string
Represented as base 64 encoded string of the image byte array.
footerElement
string
Byod Portal's footerElement.
mobileLogoImage
dictionary
Byod Portal's mobileLogoImage.
data
string
Represented as base 64 encoded string of the image byte array.
language
dictionary
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported.
viewLanguage
string
Byod Portal's viewLanguage.
pageCustomizations
dictionary
Represent the entire page customization as a giant dictionary.
data
list / elements=string
The Dictionary will be exposed here as key value pair.
key
string
Byod Portal's key.
value
string
Byod Portal's value.
portalTheme
dictionary
Defines the configuration for portal theme.
id
string
The unique internal identifier of the portal theme.
name
string
The system- or user-assigned name of the portal theme.
themeData
string
A CSS file, represented as a Base64-encoded byte array.
portalTweakSettings
dictionary
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.
bannerColor
string
Hex value of color.
bannerTextColor
string
Byod Portal's bannerTextColor.
pageBackgroundColor
string
Byod Portal's pageBackgroundColor.
pageLabelAndTextColor
string
Byod Portal's pageLabelAndTextColor.
description
string
Byod Portal's description.
id
string
Resource UUID, mandatory for update.
ise_debug
boolean
    Choices:
  • no ←
  • yes
Flag for Identity Services Engine SDK to enable debugging.
ise_hostname
string / required
The Identity Services Engine hostname.
ise_password
string / required
The Identity Services Engine password to authenticate.
ise_username
string / required
The Identity Services Engine username to authenticate.
ise_uses_api_gateway
boolean
added in 1.1.0 of cisco.ise
    Choices:
  • no
  • yes ←
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).
ise_verify
boolean
    Choices:
  • no
  • yes ←
Flag to enable or disable SSL certificate verification.
ise_version
string
Default:
"3.1.0"
Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit
boolean
    Choices:
  • no
  • yes ←
Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
name
string
Resource Name.
portalTestUrl
string
URL to bring up a test page for this portal.
portalType
string
Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.
settings
dictionary
Defines all of the settings groups available for a BYOD.
byodSettings
dictionary
Configuration of BYOD Device Welcome, Registration and Success steps.
byodRegistrationSettings
dictionary
Byod Portal's byodRegistrationSettings.
endPointIdentityGroupId
string
Byod Portal's endPointIdentityGroupId.
showDeviceID
boolean
    Choices:
  • no
  • yes
ShowDeviceID flag.
byodRegistrationSuccessSettings
dictionary
Byod Portal's byodRegistrationSuccessSettings.
redirectUrl
string
Target URL for redirection, used when successRedirect = URL.
successRedirect
string
After an Authentication Success where should device be redirected. Allowed values.
byodWelcomeSettings
dictionary
Configuration of BYOD endpoint welcome step configuration.
aupDisplay
string
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
enableBYOD
boolean
    Choices:
  • no
  • yes
EnableBYOD flag.
enableGuestAccess
boolean
    Choices:
  • no
  • yes
EnableGuestAccess flag.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
requireAupAcceptance
boolean
    Choices:
  • no
  • yes
RequireAupAcceptance flag.
requireMDM
boolean
    Choices:
  • no
  • yes
RequireMDM flag.
requireScrolling
boolean
    Choices:
  • no
  • yes
Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true.
portalSettings
dictionary
The port, interface, certificate, and other basic settings of a portal.
allowedInterfaces
list / elements=string
Interfaces that the portal will be reachable on. Allowed values - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
alwaysUsedLanguage
string
Used when displayLang = ALWAYSUSE.
certificateGroupTag
string
Logical name of the x.509 server certificate that will be used for the portal.
displayLang
string
Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
endpointIdentityGroup
string
Unique Id of the endpoint identity group where user's devices will be added. Used only in Hotspot Portal.
fallbackLanguage
string
Used when displayLang = USEBROWSERLOCALE.
httpsPort
integer
The port number that the allowed interfaces will listen on. Range from 8000 to 8999.
supportInfoSettings
dictionary
Byod Portal's supportInfoSettings.
defaultEmptyFieldValue
string
The default value displayed for an empty field. Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
emptyFieldDisplay
string
Specifies how empty fields are handled on the Support Information Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
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.

.. Attributes .. Notes Notes ----- .. note:: - Does not support ``check_mode`` - The 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 .. Seealso See Also -------- .. seealso:: `Byod Portal reference `_ Complete reference of the Byod Portal object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. 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:
{ "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
dictionary
added in 1.1.0 of cisco.ise
 always
A dictionary or list with the response returned by the Cisco ISE Python SDK

Sample:
{ "UpdatedFieldsList": { "updatedField": [ { "field": "string", "oldValue": "string", "newValue": "string" } ], "field": "string", "oldValue": "string", "newValue": "string" } }


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