.. 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.selfregportal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.selfregportal module -- Resource module for Selfregportal +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.ise collection `_ (version 3.0.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.selfregportal`. .. version_added .. rst-class:: ansible-version-added New in cisco.ise 1.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Selfregportal. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.ise.selfregportal_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk \>= 2.0.1 - 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.selfregportal_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
Selfregportal's customizations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's globalCustomizations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's backgroundImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's bannerImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's bannerTitle. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's contactText. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's footerElement. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's mobileLogoImage. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's pageCustomizations. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's portalTheme. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
The unique internal identifier of the portal theme. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's portalTweakSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-customizations/portaltweaksettings/bannecolor: .. rst-class:: ansible-option-title **banneColor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Selfregportal's banneColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's bannerTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's pageBackgroundColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's pageLabelAndTextColor. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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
Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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 and sponsoredGuest. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's settings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's aupSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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 and recurring. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/aupsettings/displayfrequencyintervaldays: .. rst-class:: ansible-option-title **displayFrequencyIntervalDays** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Number of days between AUP confirmations (when displayFrequency = recurring). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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 = 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.selfregportal_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 = 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.selfregportal_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
Selfregportal's authSuccessSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Target URL for redirection, used when successRedirect = url. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
After an Authentication Success where should user be redirected. Allowed Values authSuccessPage, originatingURL and url. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's byodSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's byodRegistrationSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
TIdentity group id for which endpoint belongs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's byodRegistrationSuccessSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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, allowedValues authSuccessPage, originatingURL and url. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's byodWelcomeSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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. AllowedValues onPage, asLink. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's guestChangePasswordSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's guestDeviceRegistrationSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's loginPageSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's alternateGuestPortal. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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 and asLink. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_module__parameter-settings/loginpagesettings/maxfailedattemptsbeforeratelimit: .. rst-class:: ansible-option-title **maxFailedAttemptsBeforeRateLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Maximum failed login attempts before rate limiting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_module__parameter-settings/loginpagesettings/timebetweenloginsduringratelimit: .. rst-class:: ansible-option-title **timeBetweenLoginsDuringRateLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Time between login attempts when rate limiting. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's portalSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/portalsettings/allowedinterfaces: .. rst-class:: ansible-option-title **allowedInterfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interfaces that the portal will be reachable on. Allowed values eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Used when displayLang = alwaysUse. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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 and alwaysUse. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_module__parameter-settings/portalsettings/httpsport: .. rst-class:: ansible-option-title **httpsPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. 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.selfregportal_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
Selfregportal's postLoginBannerSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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
Selfregportal's selfRegPageSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/accountvalidityduration: .. rst-class:: ansible-option-title **accountValidityDuration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. 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.selfregportal_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 and minutes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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 and minutes. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/approvedenylinksvalidfor: .. rst-class:: ansible-option-title **approveDenyLinksValidFor** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. 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.selfregportal_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.selfregportal_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 and asLink. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_module__parameter-settings/selfregpagesettings/autologintimeperiod: .. rst-class:: ansible-option-title **autoLoginTimePeriod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. 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.selfregportal_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.selfregportal_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.selfregportal_module__parameter-settings/selfregpagesettings/enableguestemailallowlist: .. rst-class:: ansible-option-title **enableGuestEmailAllowlist** .. 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.selfregportal_module__parameter-settings/selfregpagesettings/enableguestemailblocklist: .. rst-class:: ansible-option-title **enableGuestEmailBlocklist** .. 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.selfregportal_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
Selfregportal's fieldCompany. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldcompany/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldEmailAddr. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldemailaddr/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldFirstName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldfirstname/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldLastName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldlastname/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldLocation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldlocation/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldPersonBeingVisited. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldpersonbeingvisited/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldPhoneNo. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldphoneno/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldReasonForVisit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldreasonforvisit/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldSMSProvider. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldsmsprovider/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_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
Selfregportal's fieldUserName. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_module__parameter-settings/selfregpagesettings/fieldusername/displayfrequency: .. rst-class:: ansible-option-title **displayFrequency** .. 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.selfregportal_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.selfregportal_module__parameter-settings/selfregpagesettings/guestemailallowlistdomains: .. rst-class:: ansible-option-title **guestEmailAllowlistDomains** .. 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.selfregportal_module__parameter-settings/selfregpagesettings/guestemailblocklistdomains: .. rst-class:: ansible-option-title **guestEmailBlocklistDomains** .. 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 disallowed. Only valid if enableGuestEmailBlacklist = true. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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 and url. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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 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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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 and personBeingVisited. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
When self-registered guests require approval, an approval request is e-mailed to one or more sponsor users. If the ISE Administrator chooses to include an approval link in the e-mail, a sponsor user who clicks the link will be authenticated against the selected sponsor portals in the order specified. Only valid if requireGuestApproval = true. The array should contain the names of the selected portals. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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
Selfregportal's selfRegSuccessSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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
Selfregportal's supportInfoSettings. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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. AllowedValues hide, displayWithNoValue and displayWithDefaultValue. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.ise.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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.selfregportal_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 selfregportal.Selfregportal.create\_selfregportal, - Paths used are post /selfregportal/, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK - The parameters starting with ise\_ are used by the Cisco ISE Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.ise.selfregportal: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present customizations: globalCustomizations: bannerImage: data: base 64 encoded value of image bannerTitle: Banner Title contactText: 'Contact Information ' desktopLogoImage: data: base 64 encoded value of image footerElement: Footer Element mobileLogoImage: data: base 64 encoded value of image language: viewLanguage: English pageCustomizations: data: - key: ui_contact_link value: Contact Support portalTheme: id: themeId name: ThemeName themeData: Base 64 encoded string of Theme CSS file portalTweakSettings: bannerColor: Banner Color from GUI bannerTextColor: Banner Text color code from GUI pageBackgroundColor: Color code from GUI pageLabelAndTextColor: Label and Text color from GUI description: description id: f75760e7-a4f9-40ef-93bb-88a97e9fb171 name: name portalType: SELFREGGUEST settings: aupSettings: displayFrequency: FIRSTLOGIN includeAup: false requireAccessCode: false requireScrolling: true skipAupForEmployees: true useDiffAupForEmployees: false authSuccessSettings: redirectUrl: www.cisco.com successRedirect: AUTHSUCCESSPAGE guestChangePasswordSettings: allowChangePasswdAtFirstLogin: false guestDeviceRegistrationSettings: allowGuestsToRegisterDevices: true autoRegisterGuestDevices: false loginPageSettings: accessCode: Access Code allowAlternateGuestPortal: false allowForgotPassword: false allowGuestToChangePassword: false allowGuestToCreateAccounts: false allowGuestToUseSocialAccounts: false allowShowGuestForm: false aupDisplay: ASLINK includeAup: false maxFailedAttemptsBeforeRateLimit: 5 requireAccessCode: false requireAupAcceptance: false requireAupScrolling: false socialConfigs: [] timeBetweenLoginsDuringRateLimit: 2 portalSettings: allowedInterfaces: - eth0 - bond0 alwaysUsedLanguage: English assignedGuestTypeForEmployee: Guest Type configured authenticationMethod: Identity Sequence availableSsids: [] certificateGroupTag: Default Portal Certificate Group displayLang: USEBROWSERLOCALE endpointIdentityGroup: f14227b0-6e5c-11e6-8f6a-005056873bd0 fallbackLanguage: English httpsPort: 8443 postLoginBannerSettings: includePostAccessBanner: true selfRegPageSettings: accountValidityDuration: 1 accountValidityTimeUnits: DAYS allowGraceAccess: false approveDenyLinksTimeUnits: DAYS assignGuestsToGuestType: Guest Type aupDisplay: ASLINK authenticateSponsorsUsingPortalList: false autoLoginSelfWait: false autoLoginTimePeriod: 1 credentialNotificationUsingEmail: false credentialNotificationUsingSms: false enableGuestEmailBlacklist: false enableGuestEmailWhitelist: false fieldCompany: include: true require: false fieldEmailAddr: include: true require: false fieldFirstName: include: true require: false fieldLastName: include: true require: false fieldLocation: include: true require: false fieldPhoneNo: include: true require: false fieldReasonForVisit: include: true require: false fieldSmsProvider: include: true require: false fieldUserName: include: true require: false graceAccessExpireInterval: 10 graceAccessSendAccountExpiration: false guestEmailBlacklistDomains: - test1@cisco.com guestEmailWhitelistDomains: - test@cisco.com includeAup: false postRegistrationRedirect: SELFREGISTRATIONSUCCESS registrationCode: Registration Code requireAupAcceptance: false requireGuestApproval: false requireRegistrationCode: false selectableLocations: - location1 - location2 selectableSmsProviders: - Sms1 sendApprovalRequestTo: SELECTEDEMAILADDRESSES sponsorPortalList: [] selfRegSuccessSettings: allowGuestLoginFromSelfregSuccessPage: true allowGuestSendSelfUsingEmail: true allowGuestSendSelfUsingPrint: true allowGuestSendSelfUsingSms: true aupOnPage: false includeAup: false includeCompany: true includeEmailAddr: true includeFirstName: true includeLastName: true includeLocation: true includePassword: true includePersonBeingVisited: true includePhoneNo: true includeReasonForVisit: true includeSmsProvider: true includeUserName: true requireAupAcceptance: false requireAupScrolling: false supportInfoSettings: emptyFieldDisplay: HIDE includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: false .. 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.selfregportal_module__return-ise_response: .. rst-class:: ansible-option-title **ise_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=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:`"[\\n {\\n \\"id\\": \\"string\\",\\n \\"name\\": \\"string\\",\\n \\"description\\": \\"string\\",\\n \\"link\\": {\\n \\"rel\\": \\"string\\",\\n \\"href\\": \\"string\\",\\n \\"type\\": \\"string\\"\\n }\\n }\\n]\\n"` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors