cisco.ise.self_registered_portal – Resource module for Self Registered Portal
Note
This plugin is part of the cisco.ise collection (version 1.1.0).
To install it use: ansible-galaxy collection install cisco.ise.
To use it in a playbook, specify: cisco.ise.self_registered_portal.
New in version 1.0.0: of cisco.ise
Synopsis
Manage operations create, update and delete of the resource Self Registered Portal.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
ciscoisesdk >= 1.0.0
python >= 3.5
Parameters
Notes
Note
Does not support
check_mode
See Also
See also
- Self Registered Portal reference
Complete reference of the Self Registered Portal object model.
Examples
- 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: string
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: string
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
Return Values
Common return values are documented here, the following are the fields unique to this module: