cisco.ise.mydeviceportal module – Resource module for Mydeviceportal

Note

This module is part of the cisco.ise collection (version 3.0.0).

To install it, use: ansible-galaxy collection install cisco.ise. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.ise.mydeviceportal.

New in cisco.ise 1.0.0

Synopsis 

Manage operation create of the resource Mydeviceportal.

Note

This module has a corresponding action plugin.

Requirements 

The below requirements are needed on the host that executes this module.

ciscoisesdk >= 2.0.1
python >= 3.5

Parameters 

Parameter	Comments
customizations dictionary	Mydeviceportal’s customizations.
globalCustomizations dictionary	Mydeviceportal’s globalCustomizations.
backgroundImage dictionary	Mydeviceportal’s backgroundImage.
data string	Represented as base 64 encoded string of the image byte array.
bannerImage dictionary	Mydeviceportal’s bannerImage.
data string	Represented as base 64 encoded string of the image byte array.
bannerTitle string	Mydeviceportal’s bannerTitle.
contactText string	Mydeviceportal’s contactText.
footerElement string	Mydeviceportal’s footerElement.
mobileLogoImage dictionary	Mydeviceportal’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.
pageCustomizations dictionary	Mydeviceportal’s pageCustomizations.
data list / elements=dictionary	The Dictionary will be exposed here as key value pair.
portalTheme dictionary	Mydeviceportal’s portalTheme.
id string	The unique internal identifier of the portal theme.
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	Mydeviceportal’s portalTweakSettings.
banneColor string	Mydeviceportal’s banneColor.
bannerTextColor string	Mydeviceportal’s bannerTextColor.
pageBackgroundColor string	Mydeviceportal’s pageBackgroundColor.
pageLabelAndTextColor string	Mydeviceportal’s pageLabelAndTextColor.
description string	Description.
id string	Id.
ise_debug boolean	Flag for Identity Services Engine SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
ise_hostname string / required	The Identity Services Engine hostname.
ise_password string / required	The Identity Services Engine password to authenticate.
ise_single_request_timeout integer added in cisco.ise 3.0.0	Timeout (in seconds) for RESTful HTTP requests. Default: :ansible-option-default:`60`
ise_username string / required	The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in cisco.ise 1.1.0	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). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
ise_uses_csrf_token boolean added in cisco.ise 3.0.0	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. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
ise_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
ise_version string	Informs the SDK which version of Identity Services Engine to use. Default: :ansible-option-default:`"3.1\_Patch\_1"`
ise_wait_on_rate_limit boolean	Flag for Identity Services Engine SDK to enable automatic rate-limit handling. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
name string	Name.
portalTestUrl string	URL to bring up a test page for this portal.
portalType string	Allowed values byod, hotspotGuest, mydevice, selfRegGuest, sponsor and sponsoredGuest.
settings dictionary	Mydeviceportal’s settings.
aupSettings dictionary	Mydeviceportal’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 and recurring.
displayFrequencyIntervalDays float	Number of days between AUP confirmations (when displayFrequency = recurring).
includeAup boolean	Require the portal user to read and accept an AUP. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
requireAupScrolling boolean	Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
employeeChangePasswordSettings dictionary	Mydeviceportal’s employeeChangePasswordSettings.
allowEmployeeToChangePwd boolean	Allow employees to change their own passwords. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
loginPageSettings dictionary	Mydeviceportal’s loginPageSettings.
aupDisplay string	How the AUP should be displayed, either on page or as a link. Only valid if includeAup = true. Allowed Values onPage and asLink.
includeAup boolean	Include an Acceptable Use Policy (AUP) that should be displayed during login. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
maxFailedAttemptsBeforeRateLimit float	Maximum failed login attempts before rate limiting.
requireAupAcceptance boolean	Require the portal user to accept the AUP. Only valid if includeAup = true. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
requireAupScrolling boolean	Require the portal user to scroll to the end of the AUP. Only valid if requireAupAcceptance = true. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
timeBetweenLoginsDuringRateLimit float	Mydeviceportal’s timeBetweenLoginsDuringRateLimit.
portalSettings dictionary	Mydeviceportal’s portalSettings.
allowedInterfaces string	Interfaces that the portal will be reachable on. Allowed values eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1 and bond2.
alwaysUsedLanguage string	Used when displayLang = alwaysUse.
certificateGroupTag string	Logical name of the x.509 server certificate that will be used for the portal.
displayLang string	Allowed values useBrowserLocale and alwaysUse.
endpointIdentityGroup string	Unique Id of the endpoint identity group where user’s devices will be added. Used only in Hotspot Portal.
fallbackLanguage string	Used when displayLang = useBrowserLocale.
httpsPort float	The port number that the allowed interfaces will listen on. Range from 8000 to 8999.
postLoginBannerSettings dictionary	Mydeviceportal’s postLoginBannerSettings.
includePostAccessBanner boolean	Include a Post-Login Banner page. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
supportInfoSettings dictionary	Mydeviceportal’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. AllowedValues hide, displayWithNoValue and displayWithDefaultValue.
includeBrowserUserAgent boolean	IncludeBrowserUserAgent flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
includeFailureCode boolean	IncludeFailureCode flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
includeIpAddress boolean	IncludeIpAddress flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
includeMacAddr boolean	IncludeMacAddr flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
includePolicyServer boolean	IncludePolicyServer flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
includeSupportInfoPage boolean	IncludeSupportInfoPage flag. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`

Notes 

Note

SDK Method used are mydeviceportal.Mydeviceportal.create_mydeviceportal,
Paths used are post /mydeviceportal/,
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

Examples 

---
- name: Create
  cisco.ise.mydeviceportal:
    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: MYDEVICE
    settings:
      aupSettings:
        displayFrequency: FIRSTLOGIN
        includeAup: false
        requireAccessCode: false
        requireScrolling: true
        skipAupForEmployees: false
        useDiffAupForEmployees: false
      employeeChangePasswordSettings:
        allowEmployeeToChangePwd: false
      loginPageSettings:
        allowAlternateGuestPortal: false
        allowForgotPassword: true
        allowGuestToChangePassword: false
        allowGuestToCreateAccounts: true
        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
        authenticationMethod: Identity Source
        availableSsids: []
        certificateGroupTag: Default Portal Certificate Group
        displayLang: USEBROWSERLOCALE
        endpointIdentityGroup: Identity Group
        fallbackLanguage: English
        fqdn: Fully Qualified Domain Name
        httpsPort: 8443
        idleTimeout: 10
      postLoginBannerSettings:
        includePostAccessBanner: true
      supportInfoSettings:
        emptyFieldDisplay: HIDE
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: false

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ise_response list / elements=dictionary	A dictionary or list with the response returned by the Cisco ISE Python SDK Returned: always 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"`

Authors

Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)

cisco.ise.mydeviceportal module – Resource module for Mydeviceportal

Synopsis

Requirements

Parameters

Notes

Examples

Return Values

Authors

Collection links

Synopsis 

Requirements 

Parameters 

Notes 

Examples 

Return Values 