.. 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 .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.ise.my_device_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.my_device_portal module -- Resource module for My Device Portal +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 2.10.0). To install it, use: :code:`ansible-galaxy collection install cisco.ise`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.ise.my_device_portal`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource My Device Portal. - This API creates a my device portal. - This API deletes a my device portal by ID. - This API allows the client to update a my device portal by ID. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.my_device_portal_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.2.3 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations: .. rst-class:: ansible-option-title **customizations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Defines all of the Portal Customizations available. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations: .. rst-class:: ansible-option-title **globalCustomizations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's globalCustomizations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/backgroundimage: .. rst-class:: ansible-option-title **backgroundImage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's backgroundImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/backgroundimage/data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Represented as base 64 encoded string of the image byte array. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/bannerimage: .. rst-class:: ansible-option-title **bannerImage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's bannerImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/bannerimage/data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Represented as base 64 encoded string of the image byte array. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/bannertitle: .. rst-class:: ansible-option-title **bannerTitle** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's bannerTitle. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/contacttext: .. rst-class:: ansible-option-title **contactText** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's contactText. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/desktoplogoimage: .. rst-class:: ansible-option-title **desktopLogoImage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's desktopLogoImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/desktoplogoimage/data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Represented as base 64 encoded string of the image byte array. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/footerelement: .. rst-class:: ansible-option-title **footerElement** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's footerElement. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/mobilelogoimage: .. rst-class:: ansible-option-title **mobileLogoImage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's mobileLogoImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/globalcustomizations/mobilelogoimage/data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Represented as base 64 encoded string of the image byte array. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/language: .. rst-class:: ansible-option-title **language** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/language/viewlanguage: .. rst-class:: ansible-option-title **viewLanguage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's viewLanguage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/pagecustomizations: .. rst-class:: ansible-option-title **pageCustomizations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Represent the entire page customization as a giant dictionary. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/pagecustomizations/data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
The Dictionary will be exposed here as key value pair. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/pagecustomizations/data/key: .. rst-class:: ansible-option-title **key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/pagecustomizations/data/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltheme: .. rst-class:: ansible-option-title **portalTheme** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's portalTheme. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltheme/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltheme/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The system- or user-assigned name of the portal theme. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltheme/themedata: .. rst-class:: ansible-option-title **themeData** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
A CSS file, represented as a Base64-encoded byte array. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltweaksettings: .. rst-class:: ansible-option-title **portalTweakSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltweaksettings/bannercolor: .. rst-class:: ansible-option-title **bannerColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hex value of color. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltweaksettings/bannertextcolor: .. rst-class:: ansible-option-title **bannerTextColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's bannerTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltweaksettings/pagebackgroundcolor: .. rst-class:: ansible-option-title **pageBackgroundColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's pageBackgroundColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-customizations/portaltweaksettings/pagelabelandtextcolor: .. rst-class:: ansible-option-title **pageLabelAndTextColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's pageLabelAndTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_debug: .. rst-class:: ansible-option-title **ise_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_hostname: .. rst-class:: ansible-option-title **ise_hostname** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_password: .. rst-class:: ansible-option-title **ise_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_single_request_timeout: .. rst-class:: ansible-option-title **ise_single_request_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
Timeout (in seconds) for RESTful HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_username: .. rst-class:: ansible-option-title **ise_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Identity Services Engine username to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_uses_api_gateway: .. rst-class:: ansible-option-title **ise_uses_api_gateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
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). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_uses_csrf_token: .. rst-class:: ansible-option-title **ise_uses_csrf_token** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` :ansible-option-versionadded:`added in cisco.ise 3.0.0` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_verify: .. rst-class:: ansible-option-title **ise_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_version: .. rst-class:: ansible-option-title **ise_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Identity Services Engine to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1\_Patch\_1"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-ise_wait_on_rate_limit: .. rst-class:: ansible-option-title **ise_wait_on_rate_limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Identity Services Engine SDK to enable automatic rate-limit handling. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-portaltesturl: .. rst-class:: ansible-option-title **portalTestUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
URL to bring up a test page for this portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-portaltype: .. rst-class:: ansible-option-title **portalType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings: .. rst-class:: ansible-option-title **settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Defines all of the settings groups available for a Mydevice portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/aupsettings: .. rst-class:: ansible-option-title **aupSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration of the Acceptable Use Policy (AUP) for a portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/aupsettings/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values - FIRSTLOGIN, - EVERYLOGIN, - RECURRING. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/aupsettings/displayfrequencyintervaldays: .. rst-class:: ansible-option-title **displayFrequencyIntervalDays** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of days between AUP confirmations (when displayFrequency = recurring). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/aupsettings/includeaup: .. rst-class:: ansible-option-title **includeAup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to read and accept an AUP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/aupsettings/requirescrolling: .. rst-class:: ansible-option-title **requireScrolling** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/employeechangepasswordsettings: .. rst-class:: ansible-option-title **employeeChangePasswordSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's employeeChangePasswordSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/employeechangepasswordsettings/allowemployeetochangepwd: .. rst-class:: ansible-option-title **allowEmployeeToChangePwd** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowEmployeeToChangePwd flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings: .. rst-class:: ansible-option-title **loginPageSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's loginPageSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/aupdisplay: .. rst-class:: ansible-option-title **aupDisplay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/includeaup: .. rst-class:: ansible-option-title **includeAup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include an Acceptable Use Policy (AUP) that should be displayed during login. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/maxfailedattemptsbeforeratelimit: .. rst-class:: ansible-option-title **maxFailedAttemptsBeforeRateLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Maximum failed login attempts before rate limiting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/requireaupacceptance: .. rst-class:: ansible-option-title **requireAupAcceptance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to accept the AUP. Only valid if includeAup = true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/requirescrolling: .. rst-class:: ansible-option-title **requireScrolling** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/socialconfigs: .. rst-class:: ansible-option-title **socialConfigs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
My Device Portal's socialConfigs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/loginpagesettings/timebetweenloginsduringratelimit: .. rst-class:: ansible-option-title **timeBetweenLoginsDuringRateLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time between login attempts when rate limiting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings: .. rst-class:: ansible-option-title **portalSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
The port, interface, certificate, and other basic settings of a portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/allowedinterfaces: .. rst-class:: ansible-option-title **allowedInterfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Interfaces that the portal will be reachable on. Allowed values - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/alwaysusedlanguage: .. rst-class:: ansible-option-title **alwaysUsedLanguage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
My Device Portal's alwaysUsedLanguage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/certificategrouptag: .. rst-class:: ansible-option-title **certificateGroupTag** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Logical name of the x.509 server certificate that will be used for the portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/displaylang: .. rst-class:: ansible-option-title **displayLang** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Allowed values - USEBROWSERLOCALE, - ALWAYSUSE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/endpointidentitygroup: .. rst-class:: ansible-option-title **endpointIdentityGroup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique Id of the endpoint identity group where user's devices will be added. Used only in Hotspot Portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/fallbacklanguage: .. rst-class:: ansible-option-title **fallbackLanguage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Used when displayLang = USEBROWSERLOCALE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/portalsettings/httpsport: .. rst-class:: ansible-option-title **httpsPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The port number that the allowed interfaces will listen on. Range from 8000 to 8999. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/postaccessbannersettings: .. rst-class:: ansible-option-title **postAccessBannerSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's postAccessBannerSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/postaccessbannersettings/includepostaccessbanner: .. rst-class:: ansible-option-title **includePostAccessBanner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludePostAccessBanner flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/postloginbannersettings: .. rst-class:: ansible-option-title **postLoginBannerSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's postLoginBannerSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/postloginbannersettings/includepostaccessbanner: .. rst-class:: ansible-option-title **includePostAccessBanner** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include a Post-Login Banner page. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings: .. rst-class:: ansible-option-title **supportInfoSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
My Device Portal's supportInfoSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/defaultemptyfieldvalue: .. rst-class:: ansible-option-title **defaultEmptyFieldValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The default value displayed for an empty field. Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/emptyfielddisplay: .. rst-class:: ansible-option-title **emptyFieldDisplay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies how empty fields are handled on the Support Information Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includebrowseruseragent: .. rst-class:: ansible-option-title **includeBrowserUserAgent** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeBrowserUserAgent flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includefailurecode: .. rst-class:: ansible-option-title **includeFailureCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeFailureCode flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includeipaddress: .. rst-class:: ansible-option-title **includeIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeIpAddress flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includemacaddr: .. rst-class:: ansible-option-title **includeMacAddr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeMacAddr flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includepolicyserver: .. rst-class:: ansible-option-title **includePolicyServer** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludePolicyServer flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__parameter-settings/supportinfosettings/includesupportinfopage: .. rst-class:: ansible-option-title **includeSupportInfoPage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeSupportInfoPage flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are my\_device\_portal.MyDevicePortal.create\_my\_device\_portal, my\_device\_portal.MyDevicePortal.delete\_my\_device\_portal\_by\_id, my\_device\_portal.MyDevicePortal.update\_my\_device\_portal\_by\_id, - Paths used are post /ers/config/mydeviceportal, delete /ers/config/mydeviceportal/{id}, put /ers/config/mydeviceportal/{id}, - Does not support \ :literal:`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 .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by id cisco.ise.my_device_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: aupSettings: displayFrequency: string displayFrequencyIntervalDays: 0 includeAup: true requireScrolling: true employeeChangePasswordSettings: allowEmployeeToChangePwd: true loginPageSettings: aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAupAcceptance: true requireScrolling: true socialConfigs: - {} timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string certificateGroupTag: string displayLang: string endpointIdentityGroup: string fallbackLanguage: string httpsPort: 0 postAccessBannerSettings: includePostAccessBanner: true postLoginBannerSettings: includePostAccessBanner: true supportInfoSettings: defaultEmptyFieldValue: string emptyFieldDisplay: string includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: true - name: Delete by id cisco.ise.my_device_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.my_device_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 name: string portalTestUrl: string portalType: string settings: aupSettings: displayFrequency: string displayFrequencyIntervalDays: 0 includeAup: true requireScrolling: true employeeChangePasswordSettings: allowEmployeeToChangePwd: true loginPageSettings: aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAupAcceptance: true requireScrolling: true socialConfigs: - {} timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string certificateGroupTag: string displayLang: string endpointIdentityGroup: string fallbackLanguage: string httpsPort: 0 postAccessBannerSettings: includePostAccessBanner: true postLoginBannerSettings: includePostAccessBanner: true 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: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"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", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "portalTestUrl": "string", "portalType": "string", "settings": {"aupSettings": {"displayFrequency": "string", "displayFrequencyIntervalDays": 0, "includeAup": true, "requireScrolling": true}, "employeeChangePasswordSettings": {"allowEmployeeToChangePwd": true}, "loginPageSettings": {"aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAupAcceptance": true, "requireScrolling": true, "socialConfigs": [{}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "string", "displayLang": "string", "endpointIdentityGroup": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "supportInfoSettings": {"defaultEmptyFieldValue": "string", "emptyFieldDisplay": "string", "includeBrowserUserAgent": true, "includeFailureCode": true, "includeIpAddress": true, "includeMacAddr": true, "includePolicyServer": true, "includeSupportInfoPage": true}}}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.my_device_portal_module__return-ise_update_response: .. rst-class:: ansible-option-title **ise_update_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` :ansible-option-versionadded:`added in cisco.ise 1.1.0` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco ISE Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors