Spec-Zone.ru › Ansible

Модуль cisco.ise.sponsor_portal – Модуль ресурсов для портала спонсоров

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробнее см. раздел Требования.

Для использования в плейбуке укажите: cisco.ise.sponsor_portal.

Новое в cisco.ise 1.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Управление операциями создания, обновления и удаления ресурса «Портал спонсоров».
  • Этот API создаёт портал спонсоров.
  • Этот API удаляет портал спонсоров по ID.
  • Этот API позволяет клиенту обновить портал спонсоров по ID.

Примечание

Для этого модуля существует соответствующий плагин действий.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

customizations

словарь

Настройки Портала спонсоров.

globalCustomizations

словарь

Глобальные настройки Портала спонсоров.

backgroundImage

словарь

Фон Портала спонсоров.

data

строка

Представлено как строка, закодированная в base64, массива байтов изображения.

bannerImage

словарь

Баннер Портала спонсоров.

data

строка

Представлено как строка, закодированная в base64, массива байтов изображения.

bannerTitle

строка

Заголовок баннера Портала спонсоров.

contactText

строка

Текст контактов Портала спонсоров.

desktopLogoImage

словарь

Логотип для десктопа Портала спонсоров.

data

строка

Представлено как строка, закодированная в base64, массива байтов изображения.

footerElement

строка

Футтер Портала спонсоров.

mobileLogoImage

словарь

Логотип для мобильных устройств Портала спонсоров.

data

строка

Представлено как строка, закодированная в base64, массива байтов изображения.

language

словарь

Этот параметр поддерживается только для чтения и позволяет отобразить настройки в английском языке. Другие языки не поддерживаются.

viewLanguage

строка

Язык отображения Портала спонсоров.

pageCustomizations

словарь

Настройки страниц Портала спонсоров.

data

список / элементы=словарь

Словарь будет представлен здесь как пара ключ-значение.

key

строка

Ключ Портала спонсоров.

value

строка

Значение Портала спонсоров.

portalTheme

словарь

Тема Портала спонсоров.

id

строка

Идентификатор Портала спонсоров.

name

строка

Имя темы портала, заданное системой или пользователем.

themeData

строка

Файл CSS, представленный в формате Base64.

portalTweakSettings

словарь

Настройки доработки Портала. Они являются настраиваемым элементом выбранной темы портала. При смене темы портала, настройки доработки перезаписываются значениями, указанными в теме. В дальнейшем, настройки доработки могут быть изменены пользователем.

bannerColor

строка

Шестнадцатеричное значение цвета.

bannerTextColor

строка

Цвет текста баннера Портала спонсоров.

pageBackgroundColor

string

Цвет фона страницы портала спонсора.

pageLabelAndTextColor

string

Цвет текста и меток на странице портала спонсора.

description

string

Описание портала спонсора.

id

string

Идентификатор портала спонсора.

ise_debug

boolean

Флаг для включения отладки в SDK Identity Services Engine.

Варианты:

  • false ← (по умолчанию)
  • true

ise_hostname

string / обязательно

Имя хоста Identity Services Engine.

ise_password

string / обязательно

Пароль для аутентификации в Identity Services Engine.

ise_single_request_timeout

integer

добавлен в cisco.ise 3.0.0

Таймаут (в секундах) для RESTful HTTP запросов.

По умолчанию: 60

ise_username

string / обязательно

Имя пользователя для аутентификации в Identity Services Engine.

ise_uses_api_gateway

boolean

добавлен в cisco.ise 1.1.0

Флаг, указывающий SDK использовать ли API шлюз Identity Services Engine для отправки запросов.

Если true, используется API шлюз ISE и отправляет запросы по https://{{ise_hostname}}.

Если false, отправляет запросы по https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

  • false
  • true ← (по умолчанию)

ise_uses_csrf_token

boolean

добавлен в cisco.ise 3.0.0

Флаг, указывающий SDK, нужно ли отправлять токен CSRF в API ERS ISE.

Если True, SDK предполагает, что проверка CSRF в вашем ISE включена.

Если True, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

  • false ← (по умолчанию)
  • true

ise_verify

boolean

Флаг для включения или отключения проверки SSL сертификатов.

Варианты:

  • false
  • true ← (по умолчанию)

ise_version

string

Указывает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

boolean

Флаг для Identity Services Engine SDK, чтобы включить автоматическое управление ограничениями скорости.

Варианты:

  • false
  • true ← (по умолчанию)

name

string

Имя портала спонсора.

portalTestUrl

string

URL для открытия тестовой страницы портала.

portalType

string

Допустимые значения - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.

settings

dictionary

Определяет все группы настроек, доступные для портала.

aupSettings

dictionary

Настройки AUP портала спонсора.

displayFrequency

string

Как отображать AUP, либо на странице, либо как ссылку. Действительно только если includeAup = true. Доступные значения - FIRSTLOGIN, - EVERYLOGIN, - RECURRING.

displayFrequencyIntervalDays

integer

Количество дней между подтверждениями AUP (если displayFrequency = recurring).

includeAup

boolean

Флаг IncludeAup.

Choices:

  • false
  • true

requireScrolling

boolean

Флаг RequireScrolling.

Choices:

  • false
  • true

loginPageSettings

dictionary

Далее следуют группы параметров страницы входа в портал.

aupDisplay

string

Как должен отображаться документ AUP: на странице или как ссылка. Допустимо только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK.

includeAup

boolean

Включить политику приемлемого использования (AUP), которая должна отображаться во время входа.

Choices:

  • false
  • true

maxFailedAttemptsBeforeRateLimit

integer

Максимальное количество неудачных попыток входа до ограничения скорости.

requireAupAcceptance

boolean

Требовать от пользователя портала принятия AUP. Допустимо только если includeAup = true.

Choices:

  • false
  • true

requireAupScrolling

boolean

Флаг RequireAupScrolling.

Choices:

  • false
  • true

socialConfigs

list / elements=dictionary

socialConfigs портала Sponsor Portal.

timeBetweenLoginsDuringRateLimit

integer

Время между попытками входа при ограничении скорости.

portalSettings

dictionary

Порт, интерфейс, сертификат и другие основные параметры портала.

allowedInterfaces

list / elements=string

Интерфейсы, на которых портал будет доступен. Допустимые значения - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.

authenticationMethod

string

Уникальный идентификатор последовательности источника идентификации.

availableSSIDs

list / elements=string

Имена SSID, доступных для назначения гостевым пользователям спонсорами.

certificateGroupTag

string

Логическое имя серверного сертификата x.509, который будет использоваться для портала.

displayLang

string

Допустимые значения - USEBROWSERLOCALE, - ALWAYSUSE.

fallbackLanguage

string

Используется, когда displayLang = USEBROWSERLOCALE.

fqdn

string

Полностью квалифицированное доменное имя (FQDN), которое конечные пользователи будут использовать для доступа к этому порталу. Используется только в портале Sponsor.

httpsPort

integer

Номер порта, на котором будут прослушиваться разрешенные интерфейсы. Диапазон от 8000 до 8999.

idleTimeout

integer

idleTimeout портала Sponsor Portal.

postAccessBannerSettings

dictionary

postAccessBannerSettings портала Sponsor Portal.

includePostAccessBanner

boolean

Флаг IncludePostAccessBanner.

Choices:

  • false
  • true

postLoginBannerSettings

dictionary

postLoginBannerSettings портала Sponsor Portal.

includePostAccessBanner

boolean

Включить страницу баннера после входа.

Варианты:

  • false
  • true

sponsorChangePasswordSettings

dictionary

Настройки sponsorChangePasswordSettings для портала спонсоров.

allowSponsorToChangePwd

boolean

Разрешить спонсорам изменение собственных паролей.

Варианты:

  • false
  • true

supportInfoSettings

dictionary

Настройки supportInfoSettings для портала спонсоров.

defaultEmptyFieldValue

string

Значение по умолчанию для пустого поля. Действительно только когда emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.

emptyFieldDisplay

string

Указывает, как обрабатываются пустые поля на странице с информацией о поддержке. Допустимые значения - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.

includeBrowserUserAgent

boolean

Флаг includeBrowserUserAgent.

Варианты:

  • false
  • true

includeFailureCode

boolean

Флаг includeFailureCode.

Варианты:

  • false
  • true

includeIpAddress

boolean

Флаг IncludeIpAddress.

Варианты:

  • false
  • true

includeMacAddr

boolean

Флаг includeMacAddr.

Варианты:

  • false
  • true

includePolicyServer

boolean

Флаг includePolicyServer.

Варианты:

  • false
  • true

includeSupportInfoPage

boolean

Флаг includeSupportInfoPage.

Варианты:

  • false
  • true

Примечания

Примечание

  • Используемые методы SDK: sponsor_portal.SponsorPortal.create_sponsor_portal, sponsor_portal.SponsorPortal.delete_sponsor_portal_by_id, sponsor_portal.SponsorPortal.update_sponsor_portal_by_id,
  • Используемые пути: post /ers/config/sponsorportal, delete /ers/config/sponsorportal/{id}, put /ers/config/sponsorportal/{id},
  • Не поддерживает check_mode
  • Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный диспетчер подключения из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by id
  cisco.ise.sponsor_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
        requireScrolling: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireAupScrolling: true
        socialConfigs:
        - {}
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        authenticationMethod: string
        availableSsids:
        - string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        fqdn: string
        httpsPort: 0
        idleTimeout: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      sponsorChangePasswordSettings:
        allowSponsorToChangePwd: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.sponsor_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.sponsor_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
        requireScrolling: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireAupScrolling: true
        socialConfigs:
        - {}
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        authenticationMethod: string
        availableSsids:
        - string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        fqdn: string
        httpsPort: 0
        idleTimeout: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      sponsorChangePasswordSettings:
        allowSponsorToChangePwd: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ

Описание

ise_response

dictionary

Словарь или список с ответом, возвращаемым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"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", "link": {"href": "string", "rel": "string", "type": "string"}, "name": "string", "portalTestUrl": "string", "portalType": "string", "settings": {"aupSettings": {"displayFrequency": "string", "displayFrequencyIntervalDays": 0, "includeAup": true, "requireScrolling": true}, "loginPageSettings": {"aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAupAcceptance": true, "requireAupScrolling": true, "socialConfigs": [{}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "authenticationMethod": "string", "availableSsids": ["string"], "certificateGroupTag": "string", "displayLang": "string", "fallbackLanguage": "string", "fqdn": "string", "httpsPort": 0, "idleTimeout": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "sponsorChangePasswordSettings": {"allowSponsorToChangePwd": true}, "supportInfoSettings": {"defaultEmptyFieldValue": "string", "emptyFieldDisplay": "string", "includeBrowserUserAgent": true, "includeFailureCode": true, "includeIpAddress": true, "includeMacAddr": true, "includePolicyServer": true, "includeSupportInfoPage": true}}}

ise_update_response

dictionary

Добавлен в cisco.ise 1.1.0

Словарь или список с ответом, возвращаемым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}

Авторы

  • Rafael Campos (@racampos)

Ссылки на сборку

  • Система отслеживания ошибок
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/ise/sponsor_portal_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API