.. 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.self_registered_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.self_registered_portal module -- Resource module for Self Registered 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.self_registered_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 Self Registered Portal. - This API creates a self registered portal. - This API deletes a self registered portal by ID. - This API allows the client to update a self registered portal by ID. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's globalCustomizations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's backgroundImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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
Self Registered Portal's bannerImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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
Self Registered Portal's bannerTitle. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's contactText. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's desktopLogoImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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
Self Registered Portal's footerElement. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's mobileLogoImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's viewLanguage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's key. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's value. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's portalTheme. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's bannerTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's pageBackgroundColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's pageLabelAndTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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 portal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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
Self Registered Portal's aupSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_portal_module__parameter-settings/aupsettings/requireaupscrolling: .. rst-class:: ansible-option-title **requireAupScrolling** .. 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.self_registered_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
RequireScrolling 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.self_registered_portal_module__parameter-settings/aupsettings/skipaupforemployees: .. rst-class:: ansible-option-title **skipAupForEmployees** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only valid if requireAupAcceptance = trueG. .. 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.self_registered_portal_module__parameter-settings/aupsettings/usediffaupforemployees: .. rst-class:: ansible-option-title **useDiffAupForEmployees** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only valid if requireAupAcceptance = trueG. .. 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.self_registered_portal_module__parameter-settings/authsuccesssettings: .. rst-class:: ansible-option-title **authSuccessSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's authSuccessSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/authsuccesssettings/redirecturl: .. rst-class:: ansible-option-title **redirectUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self Registered Portal's redirectUrl. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/authsuccesssettings/successredirect: .. rst-class:: ansible-option-title **successRedirect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self Registered Portal's successRedirect. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings: .. rst-class:: ansible-option-title **byodSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration of BYOD Device Welcome, Registration and Success steps. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsettings: .. rst-class:: ansible-option-title **byodRegistrationSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration of BYOD endpoint Registration step configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsettings/endpointidentitygroupid: .. rst-class:: ansible-option-title **endPointIdentityGroupId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Identity group id for which endpoint belongs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsettings/showdeviceid: .. rst-class:: ansible-option-title **showDeviceID** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Display Device ID field during registration. .. 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.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsuccesssettings: .. rst-class:: ansible-option-title **byodRegistrationSuccessSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration of BYOD endpoint Registration Success step configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsuccesssettings/redirecturl: .. rst-class:: ansible-option-title **redirectUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Target URL for redirection, used when successRedirect = URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodregistrationsuccesssettings/successredirect: .. rst-class:: ansible-option-title **successRedirect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings: .. rst-class:: ansible-option-title **byodWelcomeSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configuration of BYOD endpoint welcome step configuration. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/enablebyod: .. rst-class:: ansible-option-title **enableBYOD** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableBYOD 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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/enableguestaccess: .. rst-class:: ansible-option-title **enableGuestAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
EnableGuestAccess 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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/includeaup: .. rst-class:: ansible-option-title **includeAup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeAup 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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/requireaupacceptance: .. rst-class:: ansible-option-title **requireAupAcceptance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RequireAupAcceptance 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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/requiremdm: .. rst-class:: ansible-option-title **requireMDM** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RequireMDM 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.self_registered_portal_module__parameter-settings/byodsettings/byodwelcomesettings/requirescrolling: .. rst-class:: ansible-option-title **requireScrolling** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require BYOD devices to scroll down to the bottom of 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.self_registered_portal_module__parameter-settings/guestchangepasswordsettings: .. rst-class:: ansible-option-title **guestChangePasswordSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's guestChangePasswordSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/guestchangepasswordsettings/allowchangepasswdatfirstlogin: .. rst-class:: ansible-option-title **allowChangePasswdAtFirstLogin** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow guest to change their own passwords. .. 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.self_registered_portal_module__parameter-settings/guestdeviceregistrationsettings: .. rst-class:: ansible-option-title **guestDeviceRegistrationSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's guestDeviceRegistrationSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/guestdeviceregistrationsettings/allowgueststoregisterdevices: .. rst-class:: ansible-option-title **allowGuestsToRegisterDevices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow guests to register devices. .. 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.self_registered_portal_module__parameter-settings/guestdeviceregistrationsettings/autoregisterguestdevices: .. rst-class:: ansible-option-title **autoRegisterGuestDevices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Automatically register guest devices. .. 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.self_registered_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
Portal Login Page settings groups follow. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/loginpagesettings/accesscode: .. rst-class:: ansible-option-title **accessCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Access code that must be entered by the portal user (only valid if requireAccessCode = true). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/loginpagesettings/allowalternateguestportal: .. rst-class:: ansible-option-title **allowAlternateGuestPortal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowAlternateGuestPortal 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.self_registered_portal_module__parameter-settings/loginpagesettings/allowforgotpassword: .. rst-class:: ansible-option-title **allowForgotPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowForgotPassword 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.self_registered_portal_module__parameter-settings/loginpagesettings/allowguesttochangepassword: .. rst-class:: ansible-option-title **allowGuestToChangePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to enter an access code. .. 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.self_registered_portal_module__parameter-settings/loginpagesettings/allowguesttocreateaccounts: .. rst-class:: ansible-option-title **allowGuestToCreateAccounts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestToCreateAccounts 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.self_registered_portal_module__parameter-settings/loginpagesettings/allowguesttousesocialaccounts: .. rst-class:: ansible-option-title **allowGuestToUseSocialAccounts** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestToUseSocialAccounts 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.self_registered_portal_module__parameter-settings/loginpagesettings/allowshowguestform: .. rst-class:: ansible-option-title **allowShowGuestForm** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowShowGuestForm 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.self_registered_portal_module__parameter-settings/loginpagesettings/alternateguestportal: .. rst-class:: ansible-option-title **alternateGuestPortal** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self Registered Portal's alternateGuestPortal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_portal_module__parameter-settings/loginpagesettings/requireaccesscode: .. rst-class:: ansible-option-title **requireAccessCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require the portal user to enter an access code. .. 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.self_registered_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.self_registered_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
Self Registered Portal's socialConfigs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/loginpagesettings/socialconfigs/socialmediatype: .. rst-class:: ansible-option-title **socialMediaType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self Registered Portal's socialMediaType. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/loginpagesettings/socialconfigs/socialmediavalue: .. rst-class:: ansible-option-title **socialMediaValue** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self Registered Portal's socialMediaValue. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's alwaysUsedLanguage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/portalsettings/assignedguesttypeforemployee: .. rst-class:: ansible-option-title **assignedGuestTypeForEmployee** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/portalsettings/authenticationmethod: .. rst-class:: ansible-option-title **authenticationMethod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique Id of the identity source sequence. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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
Self Registered Portal's postAccessBannerSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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
Self Registered Portal's postLoginBannerSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_portal_module__parameter-settings/selfregpagesettings: .. rst-class:: ansible-option-title **selfRegPageSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's selfRegPageSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/accountvalidityduration: .. rst-class:: ansible-option-title **accountValidityDuration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Self-registered guest account is valid for this many account\_validity\_time\_units. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/accountvaliditytimeunits: .. rst-class:: ansible-option-title **accountValidityTimeUnits** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Time units for account\_validity\_duration. Allowed Values - DAYS, - HOURS, - MINUTES. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/allowgraceaccess: .. rst-class:: ansible-option-title **allowGraceAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGraceAccess 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.self_registered_portal_module__parameter-settings/selfregpagesettings/approvalemailaddresses: .. rst-class:: ansible-option-title **approvalEmailAddresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Only valid if requireGuestApproval = true and sendApprovalRequestTo = SELECTEDEMAILADDRESSES. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/approvedenylinkstimeunits: .. rst-class:: ansible-option-title **approveDenyLinksTimeUnits** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true. Allowed Values - DAYS, - HOURS, - MINUTES. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/approvedenylinksvalidfor: .. rst-class:: ansible-option-title **approveDenyLinksValidFor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/assigngueststoguesttype: .. rst-class:: ansible-option-title **assignGuestsToGuestType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Guests are assigned to this guest type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/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.self_registered_portal_module__parameter-settings/selfregpagesettings/authenticatesponsorsusingportallist: .. rst-class:: ansible-option-title **authenticateSponsorsUsingPortalList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AuthenticateSponsorsUsingPortalList 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.self_registered_portal_module__parameter-settings/selfregpagesettings/autologinselfwait: .. rst-class:: ansible-option-title **autoLoginSelfWait** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow guests to login automatically from self-registration after sponsor's approval. No need to provide the credentials by guest to 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.self_registered_portal_module__parameter-settings/selfregpagesettings/autologintimeperiod: .. rst-class:: ansible-option-title **autoLoginTimePeriod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Waiting period for auto login until sponsor's approval. If time exceeds, guest has to login manually by providing the credentials. Default value is 5 minutes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/credentialnotificationusingemail: .. rst-class:: ansible-option-title **credentialNotificationUsingEmail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, send credential notification upon approval using email. Only valid if requireGuestApproval = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/credentialnotificationusingsms: .. rst-class:: ansible-option-title **credentialNotificationUsingSMS** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/enableguestemailblacklist: .. rst-class:: ansible-option-title **enableGuestEmailBlacklist** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Disallow guests with an e-mail address from selected domains. .. 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.self_registered_portal_module__parameter-settings/selfregpagesettings/enableguestemailwhitelist: .. rst-class:: ansible-option-title **enableGuestEmailWhitelist** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Allow guests with an e-mail address from selected domains. .. 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldcompany: .. rst-class:: ansible-option-title **fieldCompany** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldCompany. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldcompany/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldcompany/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldemailaddr: .. rst-class:: ansible-option-title **fieldEmailAddr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldEmailAddr. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldemailaddr/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldemailaddr/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldfirstname: .. rst-class:: ansible-option-title **fieldFirstName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldFirstName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldfirstname/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldfirstname/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlastname: .. rst-class:: ansible-option-title **fieldLastName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldLastName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlastname/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlastname/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlocation: .. rst-class:: ansible-option-title **fieldLocation** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldLocation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlocation/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldlocation/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldpersonbeingvisited: .. rst-class:: ansible-option-title **fieldPersonBeingVisited** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldPersonBeingVisited. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldpersonbeingvisited/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldpersonbeingvisited/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldphoneno: .. rst-class:: ansible-option-title **fieldPhoneNo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldPhoneNo. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldphoneno/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldphoneno/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldreasonforvisit: .. rst-class:: ansible-option-title **fieldReasonForVisit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldReasonForVisit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldreasonforvisit/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldreasonforvisit/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldsmsprovider: .. rst-class:: ansible-option-title **fieldSMSProvider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldSMSProvider. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldsmsprovider/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldsmsprovider/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldusername: .. rst-class:: ansible-option-title **fieldUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's fieldUserName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldusername/include: .. rst-class:: ansible-option-title **include** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Include 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.self_registered_portal_module__parameter-settings/selfregpagesettings/fieldusername/require: .. rst-class:: ansible-option-title **require** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Only applicable if include = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/graceaccessexpireinterval: .. rst-class:: ansible-option-title **graceAccessExpireInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Self Registered Portal's graceAccessExpireInterval. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/graceaccesssendaccountexpiration: .. rst-class:: ansible-option-title **graceAccessSendAccountExpiration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
GraceAccessSendAccountExpiration 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.self_registered_portal_module__parameter-settings/selfregpagesettings/guestemailblacklistdomains: .. rst-class:: ansible-option-title **guestEmailBlacklistDomains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Disallow guests with an e-mail address from selected domains. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/guestemailwhitelistdomains: .. rst-class:: ansible-option-title **guestEmailWhitelistDomains** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/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.self_registered_portal_module__parameter-settings/selfregpagesettings/postregistrationredirect: .. rst-class:: ansible-option-title **postRegistrationRedirect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true. Allowed Values - SELFREGISTRATIONSUCCESS, - LOGINPAGEWITHINSTRUCTIONS - URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/postregistrationredirecturl: .. rst-class:: ansible-option-title **postRegistrationRedirectUrl** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/registrationcode: .. rst-class:: ansible-option-title **registrationCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The registration code that the guest user must enter. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/requireapprovertoauthenticate: .. rst-class:: ansible-option-title **requireApproverToAuthenticate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the Cisco ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be required to enter their username and password if this attribute is true. Only valid if requireGuestApproval = 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.self_registered_portal_module__parameter-settings/selfregpagesettings/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.self_registered_portal_module__parameter-settings/selfregpagesettings/requireguestapproval: .. rst-class:: ansible-option-title **requireGuestApproval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Require self-registered guests to be approved if 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.self_registered_portal_module__parameter-settings/selfregpagesettings/requireregistrationcode: .. rst-class:: ansible-option-title **requireRegistrationCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Self-registered guests are required to enter a registration code. .. 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.self_registered_portal_module__parameter-settings/selfregpagesettings/selectablelocations: .. rst-class:: ansible-option-title **selectableLocations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Guests can choose from these locations to set their time zone. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/selectablesmsproviders: .. rst-class:: ansible-option-title **selectableSMSProviders** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
This attribute is an array of SMS provider names. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/sendapprovalrequestto: .. rst-class:: ansible-option-title **sendApprovalRequestTo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies where approval requests are sent. Only valid if requireGuestApproval = true. Allowed Values - SELECTEDEMAILADDRESSES, - PERSONBEINGVISITED. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregpagesettings/sponsorportallist: .. rst-class:: ansible-option-title **sponsorPortalList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Self Registered Portal's sponsorPortalList. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregsuccesssettings: .. rst-class:: ansible-option-title **selfRegSuccessSettings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Self Registered Portal's selfRegSuccessSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_portal_module__parameter-settings/selfregsuccesssettings/allowguestloginfromselfregsuccesspage: .. rst-class:: ansible-option-title **allowGuestLoginFromSelfregSuccessPage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestLoginFromSelfregSuccessPage 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/allowguestsendselfusingemail: .. rst-class:: ansible-option-title **allowGuestSendSelfUsingEmail** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestSendSelfUsingEmail 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/allowguestsendselfusingprint: .. rst-class:: ansible-option-title **allowGuestSendSelfUsingPrint** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestSendSelfUsingPrint 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/allowguestsendselfusingsms: .. rst-class:: ansible-option-title **allowGuestSendSelfUsingSMS** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AllowGuestSendSelfUsingSMS 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/auponpage: .. rst-class:: ansible-option-title **aupOnPage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
AupOnPage 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includeaup: .. rst-class:: ansible-option-title **includeAup** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeAup 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includecompany: .. rst-class:: ansible-option-title **includeCompany** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeCompany 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includeemailaddr: .. rst-class:: ansible-option-title **includeEmailAddr** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeEmailAddr 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includefirstname: .. rst-class:: ansible-option-title **includeFirstName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeFirstName 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includelastname: .. rst-class:: ansible-option-title **includeLastName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeLastName 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includelocation: .. rst-class:: ansible-option-title **includeLocation** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeLocation 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includepassword: .. rst-class:: ansible-option-title **includePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludePassword 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includepersonbeingvisited: .. rst-class:: ansible-option-title **includePersonBeingVisited** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludePersonBeingVisited 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includephoneno: .. rst-class:: ansible-option-title **includePhoneNo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludePhoneNo 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includereasonforvisit: .. rst-class:: ansible-option-title **includeReasonForVisit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeReasonForVisit 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includesmsprovider: .. rst-class:: ansible-option-title **includeSMSProvider** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeSMSProvider 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/includeusername: .. rst-class:: ansible-option-title **includeUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
IncludeUserName 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/requireaupacceptance: .. rst-class:: ansible-option-title **requireAupAcceptance** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RequireAupAcceptance 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.self_registered_portal_module__parameter-settings/selfregsuccesssettings/requireaupscrolling: .. rst-class:: ansible-option-title **requireAupScrolling** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
RequireAupScrolling 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.self_registered_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
Self Registered Portal's supportInfoSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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.self_registered_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 self\_registered\_portal.SelfRegisteredPortal.create\_self\_registered\_portal, self\_registered\_portal.SelfRegisteredPortal.delete\_self\_registered\_portal\_by\_id, self\_registered\_portal.SelfRegisteredPortal.update\_self\_registered\_portal\_by\_id, - Paths used are post /ers/config/selfregportal, delete /ers/config/selfregportal/{id}, put /ers/config/selfregportal/{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 See Also -------- .. seealso:: `Cisco ISE documentation for SelfRegisteredPortal `_ Complete reference of the SelfRegisteredPortal API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Update by id cisco.ise.self_registered_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 requireAupScrolling: true requireScrolling: true skipAupForEmployees: true useDiffAupForEmployees: true authSuccessSettings: redirectUrl: string successRedirect: string 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 guestChangePasswordSettings: allowChangePasswdAtFirstLogin: true guestDeviceRegistrationSettings: allowGuestsToRegisterDevices: true autoRegisterGuestDevices: true loginPageSettings: accessCode: string allowAlternateGuestPortal: true allowForgotPassword: true allowGuestToChangePassword: true allowGuestToCreateAccounts: true allowGuestToUseSocialAccounts: true allowShowGuestForm: true alternateGuestPortal: string aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAccessCode: true requireAupAcceptance: true socialConfigs: - socialMediaType: string socialMediaValue: string timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string assignedGuestTypeForEmployee: string authenticationMethod: string certificateGroupTag: string displayLang: string fallbackLanguage: string httpsPort: 0 postAccessBannerSettings: includePostAccessBanner: true postLoginBannerSettings: includePostAccessBanner: true selfRegPageSettings: accountValidityDuration: 0 accountValidityTimeUnits: string allowGraceAccess: true approvalEmailAddresses: string approveDenyLinksTimeUnits: string approveDenyLinksValidFor: 0 assignGuestsToGuestType: string aupDisplay: string authenticateSponsorsUsingPortalList: true autoLoginSelfWait: true autoLoginTimePeriod: 0 credentialNotificationUsingEmail: true credentialNotificationUsingSms: true enableGuestEmailBlacklist: true enableGuestEmailWhitelist: true fieldCompany: include: true require: true fieldEmailAddr: include: true require: true fieldFirstName: include: true require: true fieldLastName: include: true require: true fieldLocation: include: true require: true fieldPersonBeingVisited: include: true require: true fieldPhoneNo: include: true require: true fieldReasonForVisit: include: true require: true fieldSmsProvider: include: true require: true fieldUserName: include: true require: true graceAccessExpireInterval: 0 graceAccessSendAccountExpiration: true guestEmailBlacklistDomains: - string guestEmailWhitelistDomains: - string includeAup: true postRegistrationRedirect: string postRegistrationRedirectUrl: string registrationCode: string requireApproverToAuthenticate: true requireAupAcceptance: true requireGuestApproval: true requireRegistrationCode: true selectableLocations: - string selectableSmsProviders: - string sendApprovalRequestTo: string sponsorPortalList: - string selfRegSuccessSettings: allowGuestLoginFromSelfregSuccessPage: true allowGuestSendSelfUsingEmail: true allowGuestSendSelfUsingPrint: true allowGuestSendSelfUsingSms: true aupOnPage: true includeAup: true includeCompany: true includeEmailAddr: true includeFirstName: true includeLastName: true includeLocation: true includePassword: true includePersonBeingVisited: true includePhoneNo: true includeReasonForVisit: true includeSmsProvider: true includeUserName: true requireAupAcceptance: true requireAupScrolling: true supportInfoSettings: defaultEmptyFieldValue: string emptyFieldDisplay: string includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: true - name: Delete by id cisco.ise.self_registered_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.self_registered_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 requireAupScrolling: true requireScrolling: true skipAupForEmployees: true useDiffAupForEmployees: true authSuccessSettings: redirectUrl: string successRedirect: string 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 guestChangePasswordSettings: allowChangePasswdAtFirstLogin: true guestDeviceRegistrationSettings: allowGuestsToRegisterDevices: true autoRegisterGuestDevices: true loginPageSettings: accessCode: string allowAlternateGuestPortal: true allowForgotPassword: true allowGuestToChangePassword: true allowGuestToCreateAccounts: true allowGuestToUseSocialAccounts: true allowShowGuestForm: true alternateGuestPortal: string aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAccessCode: true requireAupAcceptance: true socialConfigs: - socialMediaType: string socialMediaValue: string timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string assignedGuestTypeForEmployee: string authenticationMethod: string certificateGroupTag: string displayLang: string fallbackLanguage: string httpsPort: 0 postAccessBannerSettings: includePostAccessBanner: true postLoginBannerSettings: includePostAccessBanner: true selfRegPageSettings: accountValidityDuration: 0 accountValidityTimeUnits: string allowGraceAccess: true approvalEmailAddresses: string approveDenyLinksTimeUnits: string approveDenyLinksValidFor: 0 assignGuestsToGuestType: string aupDisplay: string authenticateSponsorsUsingPortalList: true autoLoginSelfWait: true autoLoginTimePeriod: 0 credentialNotificationUsingEmail: true credentialNotificationUsingSms: true enableGuestEmailBlacklist: true enableGuestEmailWhitelist: true fieldCompany: include: true require: true fieldEmailAddr: include: true require: true fieldFirstName: include: true require: true fieldLastName: include: true require: true fieldLocation: include: true require: true fieldPersonBeingVisited: include: true require: true fieldPhoneNo: include: true require: true fieldReasonForVisit: include: true require: true fieldSmsProvider: include: true require: true fieldUserName: include: true require: true graceAccessExpireInterval: 0 graceAccessSendAccountExpiration: true guestEmailBlacklistDomains: - string guestEmailWhitelistDomains: - string includeAup: true postRegistrationRedirect: string postRegistrationRedirectUrl: string registrationCode: string requireApproverToAuthenticate: true requireAupAcceptance: true requireGuestApproval: true requireRegistrationCode: true selectableLocations: - string selectableSmsProviders: - string sendApprovalRequestTo: string sponsorPortalList: - string selfRegSuccessSettings: allowGuestLoginFromSelfregSuccessPage: true allowGuestSendSelfUsingEmail: true allowGuestSendSelfUsingPrint: true allowGuestSendSelfUsingSms: true aupOnPage: true includeAup: true includeCompany: true includeEmailAddr: true includeFirstName: true includeLastName: true includeLocation: true includePassword: true includePersonBeingVisited: true includePhoneNo: true includeReasonForVisit: true includeSmsProvider: true includeUserName: true requireAupAcceptance: true requireAupScrolling: 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.self_registered_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, "requireAupScrolling": true, "requireScrolling": true, "skipAupForEmployees": true, "useDiffAupForEmployees": true}, "authSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "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}}, "guestChangePasswordSettings": {"allowChangePasswdAtFirstLogin": true}, "guestDeviceRegistrationSettings": {"allowGuestsToRegisterDevices": true, "autoRegisterGuestDevices": true}, "loginPageSettings": {"accessCode": "string", "allowAlternateGuestPortal": true, "allowForgotPassword": true, "allowGuestToChangePassword": true, "allowGuestToCreateAccounts": true, "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "alternateGuestPortal": "string", "aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAccessCode": true, "requireAupAcceptance": true, "socialConfigs": [{"socialMediaType": "string", "socialMediaValue": "string"}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "assignedGuestTypeForEmployee": "string", "authenticationMethod": "string", "certificateGroupTag": "string", "displayLang": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "selfRegPageSettings": {"accountValidityDuration": 0, "accountValidityTimeUnits": "string", "allowGraceAccess": true, "approvalEmailAddresses": "string", "approveDenyLinksTimeUnits": "string", "approveDenyLinksValidFor": 0, "assignGuestsToGuestType": "string", "aupDisplay": "string", "authenticateSponsorsUsingPortalList": true, "autoLoginSelfWait": true, "autoLoginTimePeriod": 0, "credentialNotificationUsingEmail": true, "credentialNotificationUsingSms": true, "enableGuestEmailBlacklist": true, "enableGuestEmailWhitelist": true, "fieldCompany": {"include": true, "require": true}, "fieldEmailAddr": {"include": true, "require": true}, "fieldFirstName": {"include": true, "require": true}, "fieldLastName": {"include": true, "require": true}, "fieldLocation": {"include": true, "require": true}, "fieldPersonBeingVisited": {"include": true, "require": true}, "fieldPhoneNo": {"include": true, "require": true}, "fieldReasonForVisit": {"include": true, "require": true}, "fieldSmsProvider": {"include": true, "require": true}, "fieldUserName": {"include": true, "require": true}, "graceAccessExpireInterval": 0, "graceAccessSendAccountExpiration": true, "guestEmailBlacklistDomains": ["string"], "guestEmailWhitelistDomains": ["string"], "includeAup": true, "postRegistrationRedirect": "string", "postRegistrationRedirectUrl": "string", "registrationCode": "string", "requireApproverToAuthenticate": true, "requireAupAcceptance": true, "requireGuestApproval": true, "requireRegistrationCode": true, "selectableLocations": ["string"], "selectableSmsProviders": ["string"], "sendApprovalRequestTo": "string", "sponsorPortalList": ["string"]}, "selfRegSuccessSettings": {"allowGuestLoginFromSelfregSuccessPage": true, "allowGuestSendSelfUsingEmail": true, "allowGuestSendSelfUsingPrint": true, "allowGuestSendSelfUsingSms": true, "aupOnPage": true, "includeAup": true, "includeCompany": true, "includeEmailAddr": true, "includeFirstName": true, "includeLastName": true, "includeLocation": true, "includePassword": true, "includePersonBeingVisited": true, "includePhoneNo": true, "includeReasonForVisit": true, "includeSmsProvider": true, "includeUserName": true, "requireAupAcceptance": true, "requireAupScrolling": 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.self_registered_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