.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.ise.my_device_portal_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.ise.my_device_portal -- Resource module for My Device 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.my_device_portal`. .. version_added .. versionadded:: 1.0.0 of cisco.ise .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and update of the resource My Device 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
My Device Portal's customizations.
globalCustomizations
dictionary
My Device Portal's globalCustomizations.
bannerImage
dictionary
My Device Portal's bannerImage.
data
string
My Device Portal's data.
bannerTitle
string
My Device Portal's bannerTitle.
contactText
string
My Device Portal's contactText.
desktopLogoImage
dictionary
My Device Portal's desktopLogoImage.
data
string
My Device Portal's data.
footerElement
string
My Device Portal's footerElement.
mobileLogoImage
dictionary
My Device Portal's mobileLogoImage.
data
string
My Device Portal's data.
language
dictionary
My Device Portal's language.
viewLanguage
string
My Device Portal's viewLanguage.
pageCustomizations
dictionary
My Device Portal's pageCustomizations.
data
list / elements=string
My Device Portal's data.
key
string
My Device Portal's key.
value
string
My Device Portal's value.
portalTheme
dictionary
My Device Portal's portalTheme.
id
string
My Device Portal's id.
name
string
My Device Portal's name.
themeData
string
My Device Portal's themeData.
portalTweakSettings
dictionary
My Device Portal's portalTweakSettings.
bannerColor
string
My Device Portal's bannerColor.
bannerTextColor
string
My Device Portal's bannerTextColor.
pageBackgroundColor
string
My Device Portal's pageBackgroundColor.
pageLabelAndTextColor
string
My Device Portal's pageLabelAndTextColor.
description
string
My Device Portal's description.
id
string
My Device Portal's id.
name
string
My Device Portal's name.
portalType
string
My Device Portal's portalType.
settings
dictionary
My Device Portal's settings.
aupSettings
dictionary
My Device Portal's aupSettings.
displayFrequency
string
My Device Portal's displayFrequency.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
requireAccessCode
boolean
    Choices:
  • no
  • yes
RequireAccessCode flag.
requireScrolling
boolean
    Choices:
  • no
  • yes
RequireScrolling flag.
skipAupForEmployees
boolean
    Choices:
  • no
  • yes
SkipAupForEmployees flag.
useDiffAupForEmployees
boolean
    Choices:
  • no
  • yes
UseDiffAupForEmployees flag.
employeeChangePasswordSettings
dictionary
My Device Portal's employeeChangePasswordSettings.
allowEmployeeToChangePwd
boolean
    Choices:
  • no
  • yes
AllowEmployeeToChangePwd flag.
loginPageSettings
dictionary
My Device Portal's loginPageSettings.
allowAlternateGuestPortal
boolean
    Choices:
  • no
  • yes
AllowAlternateGuestPortal flag.
allowGuestToChangePassword
boolean
    Choices:
  • no
  • yes
AllowGuestToChangePassword flag.
allowGuestToCreateAccounts
boolean
    Choices:
  • no
  • yes
AllowGuestToCreateAccounts flag.
allowGuestToUseSocialAccounts
boolean
    Choices:
  • no
  • yes
AllowGuestToUseSocialAccounts flag.
allowShowGuestForm
boolean
    Choices:
  • no
  • yes
AllowShowGuestForm flag.
aupDisplay
string
My Device Portal's aupDisplay.
includeAup
boolean
    Choices:
  • no
  • yes
IncludeAup flag.
maxFailedAttemptsBeforeRateLimit
integer
My Device Portal's maxFailedAttemptsBeforeRateLimit.
requireAccessCode
boolean
    Choices:
  • no
  • yes
RequireAccessCode flag.
requireAupAcceptance
boolean
    Choices:
  • no
  • yes
RequireAupAcceptance flag.
requireAupScrolling
boolean
    Choices:
  • no
  • yes
RequireAupScrolling flag.
socialConfigs
list / elements=string
My Device Portal's socialConfigs.
timeBetweenLoginsDuringRateLimit
integer
My Device Portal's timeBetweenLoginsDuringRateLimit.
portalSettings
dictionary
My Device Portal's portalSettings.
allowedInterfaces
list / elements=string
My Device Portal's allowedInterfaces.
alwaysUsedLanguage
string
My Device Portal's alwaysUsedLanguage.
authenticationMethod
string
My Device Portal's authenticationMethod.
availableSsids
list / elements=string
My Device Portal's availableSsids.
certificateGroupTag
string
My Device Portal's certificateGroupTag.
displayLang
string
My Device Portal's displayLang.
endpointIdentityGroup
string
My Device Portal's endpointIdentityGroup.
fallbackLanguage
string
My Device Portal's fallbackLanguage.
fqdn
string
My Device Portal's fqdn.
httpsPort
integer
My Device Portal's httpsPort.
idleTimeout
integer
My Device Portal's idleTimeout.
postLoginBannerSettings
dictionary
My Device Portal's postLoginBannerSettings.
includePostAccessBanner
boolean
    Choices:
  • no
  • yes
IncludePostAccessBanner flag.
supportInfoSettings
dictionary
My Device Portal's supportInfoSettings.
emptyFieldDisplay
string
My Device 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.my_device_portal ` The official documentation on the **cisco.ise.plugins.module_utils.definitions.my_device_portal** module. `My Device Portal reference `_ Complete reference of the My Device Portal object model. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.ise.my_device_portal: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present customizations: globalCustomizations: 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 portalType: string settings: aupSettings: displayFrequency: string includeAup: true requireAccessCode: true requireScrolling: true skipAupForEmployees: true useDiffAupForEmployees: true employeeChangePasswordSettings: allowEmployeeToChangePwd: true loginPageSettings: allowAlternateGuestPortal: true allowGuestToChangePassword: true allowGuestToCreateAccounts: true allowGuestToUseSocialAccounts: true allowShowGuestForm: true aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAccessCode: true requireAupAcceptance: true requireAupScrolling: true socialConfigs: [] timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string authenticationMethod: string availableSsids: [] certificateGroupTag: string displayLang: string endpointIdentityGroup: string fallbackLanguage: string fqdn: string httpsPort: 0 idleTimeout: 0 postLoginBannerSettings: includePostAccessBanner: true supportInfoSettings: emptyFieldDisplay: string includeBrowserUserAgent: true includeFailureCode: true includeIpAddress: true includeMacAddr: true includePolicyServer: true includeSupportInfoPage: true - name: Update by id cisco.ise.my_device_portal: ise_hostname: "{{ise_hostname}}" ise_username: "{{ise_username}}" ise_password: "{{ise_password}}" ise_verify: "{{ise_verify}}" state: present customizations: globalCustomizations: 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 portalType: string settings: aupSettings: displayFrequency: string includeAup: true requireAccessCode: true requireScrolling: true skipAupForEmployees: true useDiffAupForEmployees: true employeeChangePasswordSettings: allowEmployeeToChangePwd: true loginPageSettings: allowAlternateGuestPortal: true allowGuestToChangePassword: true allowGuestToCreateAccounts: true allowGuestToUseSocialAccounts: true allowShowGuestForm: true aupDisplay: string includeAup: true maxFailedAttemptsBeforeRateLimit: 0 requireAccessCode: true requireAupAcceptance: true requireAupScrolling: true socialConfigs: [] timeBetweenLoginsDuringRateLimit: 0 portalSettings: allowedInterfaces: - string alwaysUsedLanguage: string authenticationMethod: string availableSsids: [] certificateGroupTag: string displayLang: string endpointIdentityGroup: string fallbackLanguage: string fqdn: string httpsPort: 0 idleTimeout: 0 postLoginBannerSettings: includePostAccessBanner: true supportInfoSettings: 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:
{}


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