.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. Anchors .. _ansible_collections.cisco.ise.self_registered_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.self_registered_portal -- Resource module for Self Registered Portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 2.0.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.self_registered_portal`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Self Registered Portal. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - ciscoisesdk >= 1.2.0 - python >= 3.5 .. Options Parameters ---------- .. raw:: html

Parameter				Choices/Defaults	Comments
customizations dictionary					Defines all of the Portal Customizations available.
	globalCustomizations dictionary				Self Registered Portal's globalCustomizations.
		backgroundImage dictionary			Self Registered Portal's backgroundImage.
			data string		Represented as base 64 encoded string of the image byte array.
		bannerImage dictionary			Self Registered Portal's bannerImage.
			data string		Represented as base 64 encoded string of the image byte array.
		bannerTitle string			Self Registered Portal's bannerTitle.
		contactText string			Self Registered Portal's contactText.
		desktopLogoImage dictionary			Self Registered Portal's desktopLogoImage.
			data string		Represented as base 64 encoded string of the image byte array.
		footerElement string			Self Registered Portal's footerElement.
		mobileLogoImage dictionary			Self Registered Portal's mobileLogoImage.
			data string		Represented as base 64 encoded string of the image byte array.
	language dictionary				This property is supported only for Read operation and it allows to show the customizations in English. Other languages are not supported.
		viewLanguage string			Self Registered Portal's viewLanguage.
	pageCustomizations dictionary				Represent the entire page customization as a giant dictionary.
		data list / elements=string			The Dictionary will be exposed here as key value pair.
			key string		Self Registered Portal's key.
			value string		Self Registered Portal's value.
	portalTheme dictionary				Self Registered Portal's portalTheme.
		id string			Self Registered Portal's id.
		name string			The system- or user-assigned name of the portal theme.
		themeData string			A CSS file, represented as a Base64-encoded byte array.
	portalTweakSettings dictionary				The Tweak Settings are a customization of the Portal Theme that has been selected for the portal. When the Portal Theme selection is changed, the Tweak Settings are overwritten to match the values in the theme. The Tweak Settings can subsequently be changed by the user.
		bannerColor string			Hex value of color.
		bannerTextColor string			Self Registered Portal's bannerTextColor.
		pageBackgroundColor string			Self Registered Portal's pageBackgroundColor.
		pageLabelAndTextColor string			Self Registered Portal's pageLabelAndTextColor.
description string					Self Registered Portal's description.
id string					Self Registered Portal's id.
ise_debug boolean				Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
ise_hostname string / required					The Identity Services Engine hostname.
ise_password string / required					The Identity Services Engine password to authenticate.
ise_username string / required					The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise				Choices: no yes ←	Flag that informs the SDK whether to use the Identity Services Engine's API Gateway to send requests. If it is true, it uses the ISE's API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid).
ise_verify boolean				Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string				Default: "3.1.0"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean				Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
name string					Self Registered Portal's name.
portalTestUrl string					URL to bring up a test page for this portal.
portalType string					Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.
settings dictionary					Defines all of the settings groups available for a portal.
	aupSettings dictionary				Self Registered Portal's aupSettings.
		displayFrequency string			How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values - FIRSTLOGIN, - EVERYLOGIN, - RECURRING.
		displayFrequencyIntervalDays integer			Number of days between AUP confirmations (when displayFrequency = recurring).
		includeAup boolean		Choices: no yes	Require the portal user to read and accept an AUP.
		requireAupScrolling boolean		Choices: no yes	Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true.
		requireScrolling boolean		Choices: no yes	RequireScrolling flag.
		skipAupForEmployees boolean		Choices: no yes	Only valid if requireAupAcceptance = trueG.
		useDiffAupForEmployees boolean		Choices: no yes	Only valid if requireAupAcceptance = trueG.
	authSuccessSettings dictionary				Self Registered Portal's authSuccessSettings.
		redirectUrl string			Self Registered Portal's redirectUrl.
		successRedirect string			Self Registered Portal's successRedirect.
	byodSettings dictionary				Configuration of BYOD Device Welcome, Registration and Success steps.
		byodRegistrationSettings dictionary			Configuration of BYOD endpoint Registration step configuration.
			endPointIdentityGroupId string		Identity group id for which endpoint belongs.
			showDeviceID boolean	Choices: no yes	Display Device ID field during registration.
		byodRegistrationSuccessSettings dictionary			Configuration of BYOD endpoint Registration Success step configuration.
			redirectUrl string		Target URL for redirection, used when successRedirect = URL.
			successRedirect string		After an Authentication Success where should device be redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL.
		byodWelcomeSettings dictionary			Configuration of BYOD endpoint welcome step configuration.
			aupDisplay string		How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
			enableBYOD boolean	Choices: no yes	EnableBYOD flag.
			enableGuestAccess boolean	Choices: no yes	EnableGuestAccess flag.
			includeAup boolean	Choices: no yes	IncludeAup flag.
			requireAupAcceptance boolean	Choices: no yes	RequireAupAcceptance flag.
			requireMDM boolean	Choices: no yes	RequireMDM flag.
			requireScrolling boolean	Choices: no yes	Require BYOD devices to scroll down to the bottom of the AUP, Only valid if includeAup = true.
	guestChangePasswordSettings dictionary				Self Registered Portal's guestChangePasswordSettings.
		allowChangePasswdAtFirstLogin boolean		Choices: no yes	Allow guest to change their own passwords.
	guestDeviceRegistrationSettings dictionary				Self Registered Portal's guestDeviceRegistrationSettings.
		allowGuestsToRegisterDevices boolean		Choices: no yes	Allow guests to register devices.
		autoRegisterGuestDevices boolean		Choices: no yes	Automatically register guest devices.
	loginPageSettings dictionary				Portal Login Page settings groups follow.
		accessCode string			Access code that must be entered by the portal user (only valid if requireAccessCode = true).
		allowAlternateGuestPortal boolean		Choices: no yes	AllowAlternateGuestPortal flag.
		allowForgotPassword boolean		Choices: no yes	AllowForgotPassword flag.
		allowGuestToChangePassword boolean		Choices: no yes	Require the portal user to enter an access code.
		allowGuestToCreateAccounts boolean		Choices: no yes	AllowGuestToCreateAccounts flag.
		allowGuestToUseSocialAccounts boolean		Choices: no yes	AllowGuestToUseSocialAccounts flag.
		allowShowGuestForm boolean		Choices: no yes	AllowShowGuestForm flag.
		alternateGuestPortal string			Self Registered Portal's alternateGuestPortal.
		aupDisplay string			How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
		includeAup boolean		Choices: no yes	Include an Acceptable Use Policy (AUP) that should be displayed during login.
		maxFailedAttemptsBeforeRateLimit integer			Maximum failed login attempts before rate limiting.
		requireAccessCode boolean		Choices: no yes	Require the portal user to enter an access code.
		requireAupAcceptance boolean		Choices: no yes	Require the portal user to accept the AUP. Only valid if includeAup = true.
		socialConfigs list / elements=string			Self Registered Portal's socialConfigs.
			socialMediaType string		Self Registered Portal's socialMediaType.
			socialMediaValue string		Self Registered Portal's socialMediaValue.
		timeBetweenLoginsDuringRateLimit integer			Time between login attempts when rate limiting.
	portalSettings dictionary				The port, interface, certificate, and other basic settings of a portal.
		allowedInterfaces list / elements=string			Interfaces that the portal will be reachable on. Allowed values - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
		alwaysUsedLanguage string			Self Registered Portal's alwaysUsedLanguage.
		assignedGuestTypeForEmployee string			Unique Id of a guest type. Employees using this portal as a guest inherit login options from the guest type.
		authenticationMethod string			Unique Id of the identity source sequence.
		certificateGroupTag string			Logical name of the x.509 server certificate that will be used for the portal.
		displayLang string			Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
		fallbackLanguage string			Used when displayLang = USEBROWSERLOCALE.
		httpsPort integer			The port number that the allowed interfaces will listen on. Range from 8000 to 8999.
	postAccessBannerSettings dictionary				Self Registered Portal's postAccessBannerSettings.
		includePostAccessBanner boolean		Choices: no yes	IncludePostAccessBanner flag.
	postLoginBannerSettings dictionary				Self Registered Portal's postLoginBannerSettings.
		includePostAccessBanner boolean		Choices: no yes	Include a Post-Login Banner page.
	selfRegPageSettings dictionary				Self Registered Portal's selfRegPageSettings.
		accountValidityDuration integer			Self-registered guest account is valid for this many account_validity_time_units.
		accountValidityTimeUnits string			Time units for account_validity_duration. Allowed Values - DAYS, - HOURS, - MINUTES.
		allowGraceAccess boolean		Choices: no yes	AllowGraceAccess flag.
		approvalEmailAddresses string			Only valid if requireGuestApproval = true and sendApprovalRequestTo = SELECTEDEMAILADDRESSES.
		approveDenyLinksTimeUnits string			This attribute, along with approveDenyLinksValidFor, specifies how long the link can be used. Only valid if requireGuestApproval = true. Allowed Values - DAYS, - HOURS, - MINUTES.
		approveDenyLinksValidFor integer			This attribute, along with approveDenyLinksTimeUnits, specifies how long the link can be used. Only valid if requireGuestApproval = true.
		assignGuestsToGuestType string			Guests are assigned to this guest type.
		aupDisplay string			How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
		authenticateSponsorsUsingPortalList boolean		Choices: no yes	AuthenticateSponsorsUsingPortalList flag.
		autoLoginSelfWait boolean		Choices: no yes	Allow guests to login automatically from self-registration after sponsor's approval. No need to provide the credentials by guest to login.
		autoLoginTimePeriod integer			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.
		credentialNotificationUsingEmail boolean		Choices: no yes	If true, send credential notification upon approval using email. Only valid if requireGuestApproval = true.
		credentialNotificationUsingSms boolean		Choices: no yes	If true, send credential notification upon approval using SMS. Only valid if requireGuestApproval = true.
		enableGuestEmailBlacklist boolean		Choices: no yes	Disallow guests with an e-mail address from selected domains.
		enableGuestEmailWhitelist boolean		Choices: no yes	Allow guests with an e-mail address from selected domains.
		fieldCompany dictionary			Self Registered Portal's fieldCompany.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldEmailAddr dictionary			Self Registered Portal's fieldEmailAddr.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldFirstName dictionary			Self Registered Portal's fieldFirstName.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldLastName dictionary			Self Registered Portal's fieldLastName.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldLocation dictionary			Self Registered Portal's fieldLocation.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldPersonBeingVisited dictionary			Self Registered Portal's fieldPersonBeingVisited.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldPhoneNo dictionary			Self Registered Portal's fieldPhoneNo.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldReasonForVisit dictionary			Self Registered Portal's fieldReasonForVisit.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldSmsProvider dictionary			Self Registered Portal's fieldSmsProvider.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		fieldUserName dictionary			Self Registered Portal's fieldUserName.
			include boolean	Choices: no yes	Include flag.
			require boolean	Choices: no yes	Only applicable if include = true.
		graceAccessExpireInterval integer			Self Registered Portal's graceAccessExpireInterval.
		graceAccessSendAccountExpiration boolean		Choices: no yes	GraceAccessSendAccountExpiration flag.
		guestEmailBlacklistDomains list / elements=string			Disallow guests with an e-mail address from selected domains.
		guestEmailWhitelistDomains list / elements=string			Self-registered guests whose e-mail address is in one of these domains will be allowed. Only valid if enableGuestEmailWhitelist = true.
		includeAup boolean		Choices: no yes	Include an Acceptable Use Policy (AUP) that should be displayed during login.
		postRegistrationRedirect string			After the registration submission direct the guest user to one of the following pages. Only valid if requireGuestApproval = true. Allowed Values - SELFREGISTRATIONSUCCESS, - LOGINPAGEWITHINSTRUCTIONS - URL.
		postRegistrationRedirectUrl string			URL where guest user is redirected after registration. Only valid if requireGuestApproval = true and postRegistrationRedirect = URL.
		registrationCode string			The registration code that the guest user must enter.
		requireApproverToAuthenticate boolean		Choices: no yes	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.
		requireAupAcceptance boolean		Choices: no yes	Require the portal user to accept the AUP. Only valid if includeAup = true.
		requireGuestApproval boolean		Choices: no yes	Require self-registered guests to be approved if true.
		requireRegistrationCode boolean		Choices: no yes	Self-registered guests are required to enter a registration code.
		selectableLocations list / elements=string			Guests can choose from these locations to set their time zone.
		selectableSmsProviders list / elements=string			This attribute is an array of SMS provider names.
		sendApprovalRequestTo string			Specifies where approval requests are sent. Only valid if requireGuestApproval = true. Allowed Values - SELECTEDEMAILADDRESSES, - PERSONBEINGVISITED.
		sponsorPortalList list / elements=string			Self Registered Portal's sponsorPortalList.
	selfRegSuccessSettings dictionary				Self Registered Portal's selfRegSuccessSettings.
		allowGuestLoginFromSelfregSuccessPage boolean		Choices: no yes	AllowGuestLoginFromSelfregSuccessPage flag.
		allowGuestSendSelfUsingEmail boolean		Choices: no yes	AllowGuestSendSelfUsingEmail flag.
		allowGuestSendSelfUsingPrint boolean		Choices: no yes	AllowGuestSendSelfUsingPrint flag.
		allowGuestSendSelfUsingSms boolean		Choices: no yes	AllowGuestSendSelfUsingSms flag.
		aupOnPage boolean		Choices: no yes	AupOnPage flag.
		includeAup boolean		Choices: no yes	IncludeAup flag.
		includeCompany boolean		Choices: no yes	IncludeCompany flag.
		includeEmailAddr boolean		Choices: no yes	IncludeEmailAddr flag.
		includeFirstName boolean		Choices: no yes	IncludeFirstName flag.
		includeLastName boolean		Choices: no yes	IncludeLastName flag.
		includeLocation boolean		Choices: no yes	IncludeLocation flag.
		includePassword boolean		Choices: no yes	IncludePassword flag.
		includePersonBeingVisited boolean		Choices: no yes	IncludePersonBeingVisited flag.
		includePhoneNo boolean		Choices: no yes	IncludePhoneNo flag.
		includeReasonForVisit boolean		Choices: no yes	IncludeReasonForVisit flag.
		includeSmsProvider boolean		Choices: no yes	IncludeSmsProvider flag.
		includeUserName boolean		Choices: no yes	IncludeUserName flag.
		requireAupAcceptance boolean		Choices: no yes	RequireAupAcceptance flag.
		requireAupScrolling boolean		Choices: no yes	RequireAupScrolling flag.
	supportInfoSettings dictionary				Self Registered Portal's supportInfoSettings.
		defaultEmptyFieldValue string			The default value displayed for an empty field. Only valid when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
		emptyFieldDisplay string			Specifies how empty fields are handled on the Support Information Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
		includeBrowserUserAgent boolean		Choices: no yes	IncludeBrowserUserAgent flag.
		includeFailureCode boolean		Choices: no yes	IncludeFailureCode flag.
		includeIpAddress boolean		Choices: no yes	IncludeIpAddress flag.
		includeMacAddr boolean		Choices: no yes	IncludeMacAddr flag.
		includePolicyServer boolean		Choices: no yes	IncludePolicyServer flag.
		includeSupportInfoPage boolean		Choices: no yes	IncludeSupportInfoPage flag.

.. Attributes .. Notes Notes ----- .. note:: - Does not support ``check_mode`` - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK - The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Self Registered Portal reference `_ Complete reference of the Self Registered Portal object model. .. 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: [] 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: [] 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: .. raw:: html

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "id": "string", "name": "string", "description": "string", "portalType": "string", "portalTestUrl": "string", "settings": { "portalSettings": { "httpsPort": 0, "allowedInterfaces": [ "string" ], "certificateGroupTag": "string", "authenticationMethod": "string", "assignedGuestTypeForEmployee": "string", "displayLang": "string", "fallbackLanguage": "string", "alwaysUsedLanguage": "string" }, "loginPageSettings": { "requireAccessCode": true, "maxFailedAttemptsBeforeRateLimit": 0, "timeBetweenLoginsDuringRateLimit": 0, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "accessCode": "string", "allowGuestToCreateAccounts": true, "allowForgotPassword": true, "allowGuestToChangePassword": true, "allowAlternateGuestPortal": true, "alternateGuestPortal": "string", "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "socialConfigs": [ { "socialMediaType": "string", "socialMediaValue": "string" } ] }, "selfRegPageSettings": { "assignGuestsToGuestType": "string", "accountValidityDuration": 0, "accountValidityTimeUnits": "string", "requireRegistrationCode": true, "registrationCode": "string", "fieldUserName": { "include": true, "require": true }, "fieldFirstName": { "include": true, "require": true }, "fieldLastName": { "include": true, "require": true }, "fieldEmailAddr": { "include": true, "require": true }, "fieldPhoneNo": { "include": true, "require": true }, "fieldCompany": { "include": true, "require": true }, "fieldLocation": { "include": true, "require": true }, "selectableLocations": [ "string" ], "fieldSmsProvider": { "include": true, "require": true }, "selectableSmsProviders": [ "string" ], "fieldPersonBeingVisited": { "include": true, "require": true }, "fieldReasonForVisit": { "include": true, "require": true }, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "enableGuestEmailWhitelist": true, "guestEmailWhitelistDomains": [ "string" ], "enableGuestEmailBlacklist": true, "guestEmailBlacklistDomains": [ "string" ], "requireGuestApproval": true, "autoLoginSelfWait": true, "autoLoginTimePeriod": 0, "allowGraceAccess": true, "graceAccessExpireInterval": 0, "graceAccessSendAccountExpiration": true, "sendApprovalRequestTo": "string", "approvalEmailAddresses": "string", "postRegistrationRedirect": "string", "postRegistrationRedirectUrl": "string", "credentialNotificationUsingEmail": true, "credentialNotificationUsingSms": true, "approveDenyLinksValidFor": 0, "approveDenyLinksTimeUnits": "string", "requireApproverToAuthenticate": true, "authenticateSponsorsUsingPortalList": true, "sponsorPortalList": [] }, "selfRegSuccessSettings": { "includeUserName": true, "includePassword": true, "includeFirstName": true, "includeLastName": true, "includeEmailAddr": true, "includePhoneNo": true, "includeCompany": true, "includeLocation": true, "includeSmsProvider": true, "includePersonBeingVisited": true, "includeReasonForVisit": true, "allowGuestSendSelfUsingPrint": true, "allowGuestSendSelfUsingEmail": true, "allowGuestSendSelfUsingSms": true, "includeAup": true, "aupOnPage": true, "requireAupAcceptance": true, "requireAupScrolling": true, "allowGuestLoginFromSelfregSuccessPage": true }, "aupSettings": { "includeAup": true, "useDiffAupForEmployees": true, "skipAupForEmployees": true, "requireScrolling": true, "requireAupScrolling": true, "displayFrequency": "string", "displayFrequencyIntervalDays": 0 }, "guestChangePasswordSettings": { "allowChangePasswdAtFirstLogin": true }, "guestDeviceRegistrationSettings": { "autoRegisterGuestDevices": true, "allowGuestsToRegisterDevices": true }, "byodSettings": { "byodWelcomeSettings": { "enableBYOD": true, "enableGuestAccess": true, "requireMDM": true, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "requireScrolling": true }, "byodRegistrationSettings": { "showDeviceID": true, "endPointIdentityGroupId": "string" }, "byodRegistrationSuccessSettings": { "successRedirect": "string", "redirectUrl": "string" } }, "postLoginBannerSettings": { "includePostAccessBanner": true }, "postAccessBannerSettings": { "includePostAccessBanner": true }, "authSuccessSettings": { "successRedirect": "string", "redirectUrl": "string" }, "supportInfoSettings": { "includeSupportInfoPage": true, "includeMacAddr": true, "includeIpAddress": true, "includeBrowserUserAgent": true, "includePolicyServer": true, "includeFailureCode": true, "emptyFieldDisplay": "string", "defaultEmptyFieldValue": "string" } }, "customizations": { "portalTheme": { "id": "string", "name": "string", "themeData": "string" }, "portalTweakSettings": { "bannerColor": "string", "bannerTextColor": "string", "pageBackgroundColor": "string", "pageLabelAndTextColor": "string" }, "language": { "viewLanguage": "string" }, "globalCustomizations": { "mobileLogoImage": { "data": "string" }, "desktopLogoImage": { "data": "string" }, "bannerImage": { "data": "string" }, "backgroundImage": { "data": "string" }, "bannerTitle": "string", "contactText": "string", "footerElement": "string" }, "pageCustomizations": { "data": [ { "key": "string", "value": "string" } ] } }, "link": { "rel": "string", "href": "string", "type": "string" } }
ise_update_response dictionary added in 1.1.0 of cisco.ise	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "UpdatedFieldsList": { "updatedField": [ { "field": "string", "oldValue": "string", "newValue": "string" } ], "field": "string", "oldValue": "string", "newValue": "string" } }

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