cisco.ise.sponsor_portal_info – Information module for Sponsor Portal

Note

This plugin is part of the cisco.ise collection (version 0.0.9).

To install it use: ansible-galaxy collection install cisco.ise.

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Get all Sponsor Portal.

  • Get Sponsor Portal by id.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk

Parameters

Parameter Choices/Defaults Comments
id
string
Id path parameter.
page
integer
Page query parameter. Page number.
size
integer
Size query parameter. Number of objects returned per page.

See Also

See also

cisco.ise.plugins.module_utils.definitions.sponsor_portal

The official documentation on the cisco.ise.plugins.module_utils.definitions.sponsor_portal module.

Sponsor Portal reference

Complete reference of the Sponsor Portal object model.

Examples

- name: Get all Sponsor Portal
  cisco.ise.sponsor_portal_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Sponsor Portal by id
  cisco.ise.sponsor_portal_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

Return Values

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

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", "portalTestUrl": "string", "portalType": "string", "settings": { "portalSettings": { "httpsPort": 0, "allowedInterfaces": [ "string" ], "certificateGroupTag": "string", "fqdn": "string", "authenticationMethod": "string", "idleTimeout": 0, "displayLang": "string", "fallbackLanguage": "string", "alwaysUsedLanguage": "string", "availableSsids": [ "string" ] }, "loginPageSettings": { "requireAccessCode": true, "maxFailedAttemptsBeforeRateLimit": 0, "timeBetweenLoginsDuringRateLimit": 0, "includeAup": true, "aupDisplay": "string", "requireAupAcceptance": true, "requireAupScrolling": true, "allowGuestToCreateAccounts": true, "allowGuestToChangePassword": true, "allowAlternateGuestPortal": true, "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "socialConfigs": [] }, "aupSettings": { "includeAup": true, "useDiffAupForEmployees": true, "skipAupForEmployees": true, "requireAccessCode": true, "requireScrolling": true, "displayFrequency": "string" }, "sponsorChangePasswordSettings": { "allowSponsorToChangePwd": true }, "postLoginBannerSettings": { "includePostAccessBanner": true }, "supportInfoSettings": { "includeSupportInfoPage": true, "includeMacAddr": true, "includeIpAddress": true, "includeBrowserUserAgent": true, "includePolicyServer": true, "includeFailureCode": true, "emptyFieldDisplay": "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" }, "bannerTitle": "string", "contactText": "string", "footerElement": "string" }, "pageCustomizations": { "data": [ { "key": "string", "value": "string" } ] } } }


Authors

  • Rafael Campos (@racampos)