.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.byod_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.byod_portal -- Resource module for Byod Portal ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.ise collection `_ (version 0.0.9). To install it use: :code:`ansible-galaxy collection install cisco.ise`. To use it in a playbook, specify: :code:`cisco.ise.byod_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 Byod 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 .. Options Parameters ---------- .. raw:: html

Parameter				Choices/Defaults	Comments
customizations dictionary					Byod Portal's customizations.
	globalCustomizations dictionary				Byod Portal's globalCustomizations.
		bannerImage dictionary			Byod Portal's bannerImage.
			data string		Byod Portal's data.
		bannerTitle string			Byod Portal's bannerTitle.
		contactText string			Byod Portal's contactText.
		desktopLogoImage dictionary			Byod Portal's desktopLogoImage.
			data string		Byod Portal's data.
		footerElement string			Byod Portal's footerElement.
		mobileLogoImage dictionary			Byod Portal's mobileLogoImage.
			data string		Byod Portal's data.
	language dictionary				Byod Portal's language.
		viewLanguage string			Byod Portal's viewLanguage.
	pageCustomizations dictionary				Byod Portal's pageCustomizations.
		data list / elements=string			Byod Portal's data.
			key string		Byod Portal's key.
			value string		Byod Portal's value.
	portalTheme dictionary				Byod Portal's portalTheme.
		id string			Byod Portal's id.
		name string			Byod Portal's name.
		themeData string			Byod Portal's themeData.
	portalTweakSettings dictionary				Byod Portal's portalTweakSettings.
		bannerColor string			Byod Portal's bannerColor.
		bannerTextColor string			Byod Portal's bannerTextColor.
		pageBackgroundColor string			Byod Portal's pageBackgroundColor.
		pageLabelAndTextColor string			Byod Portal's pageLabelAndTextColor.
description string					Byod Portal's description.
id string					Byod Portal's id.
name string					Byod Portal's name.
portalType string					Byod Portal's portalType.
settings dictionary					Byod Portal's settings.
	byodSettings dictionary				Byod Portal's byodSettings.
		byodRegistrationSettings dictionary			Byod Portal's byodRegistrationSettings.
			endPointIdentityGroupId string		Byod Portal's endPointIdentityGroupId.
			showDeviceID boolean	Choices: no yes	ShowDeviceID flag.
		byodRegistrationSuccessSettings dictionary			Byod Portal's byodRegistrationSuccessSettings.
			redirectUrl string		Byod Portal's redirectUrl.
			successRedirect string		Byod Portal's successRedirect.
		byodWelcomeSettings dictionary			Byod Portal's byodWelcomeSettings.
			aupDisplay string		Byod Portal's aupDisplay.
			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	RequireScrolling flag.
	portalSettings dictionary				Byod Portal's portalSettings.
		allowedInterfaces list / elements=string			Byod Portal's allowedInterfaces.
		alwaysUsedLanguage string			Byod Portal's alwaysUsedLanguage.
		availableSsids list / elements=string			Byod Portal's availableSsids.
		certificateGroupTag string			Byod Portal's certificateGroupTag.
		displayLang string			Byod Portal's displayLang.
		fallbackLanguage string			Byod Portal's fallbackLanguage.
		httpsPort integer			Byod Portal's httpsPort.
	supportInfoSettings dictionary				Byod Portal's supportInfoSettings.
		emptyFieldDisplay string			Byod Portal's emptyFieldDisplay.
		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.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.ise.plugins.module_utils.definitions.byod_portal ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.byod_portal** module. `Byod Portal reference `_ Complete reference of the Byod Portal object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.byod_portal: 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: id name: name portalType: BYOD settings: byodSettings: byodRegistrationSettings: endPointIdentityGroupId: End Identity Group ID showDeviceID: true byodRegistrationSuccessSettings: redirectUrl: Redirect URL successRedirect: AUTHSUCCESSPAGE byodWelcomeSettings: aupDisplay: ASLINK enableBYOD: true enableGuestAccess: false includeAup: true requireAupAcceptance: false requireMDM: false requireScrolling: false portalSettings: allowedInterfaces: - eth0 - bond0 alwaysUsedLanguage: English availableSsids: [] certificateGroupTag: Default Portal Certificate Group displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 supportInfoSettings: emptyFieldDisplay: HIDE includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: false - name: Update by id cisco.ise.byod_portal: 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: id name: name portalType: BYOD settings: byodSettings: byodRegistrationSettings: endPointIdentityGroupId: End Identity Group ID showDeviceID: true byodRegistrationSuccessSettings: redirectUrl: Redirect URL successRedirect: AUTHSUCCESSPAGE byodWelcomeSettings: aupDisplay: ASLINK enableBYOD: true enableGuestAccess: false includeAup: true requireAupAcceptance: false requireMDM: false requireScrolling: false portalSettings: allowedInterfaces: - eth0 - bond0 alwaysUsedLanguage: English availableSsids: [] certificateGroupTag: Default Portal Certificate Group displayLang: USEBROWSERLOCALE fallbackLanguage: English httpsPort: 8443 supportInfoSettings: emptyFieldDisplay: HIDE includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: false - name: Delete by id cisco.ise.byod_portal: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: absent id: string .. 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: {}

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