Модуль cisco.ise.hotspot_portal — Модуль ресурсов для портала Hotspot

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.hotspot_portal.

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

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

Обзор

Управление операциями создания, обновления и удаления ресурсов портала Hotspot.
Этот API создаёт портал hotspot.
Этот API удаляет портал hotspot по его ID.
Этот API позволяет клиенту обновить портал hotspot по его ID.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
customizations dictionary	Определяет все доступные настройки портала.
globalCustomizations dictionary	Глобальные настройки портала Hotspot.
backgroundImage dictionary	Фон портала Hotspot.
data string	Представлено в виде кодированной строки base64 массива байтов изображения.
bannerImage dictionary	Баннер портала Hotspot.
data string	Представлено в виде кодированной строки base64 массива байтов изображения.
bannerTitle string	Заголовок баннера портала Hotspot.
contactText string	Контактная информация портала Hotspot.
desktopLogoImage dictionary	Логотип для настольных компьютеров портала Hotspot.
data string	Представлено в виде кодированной строки base64 массива байтов изображения.
footerElement string	Подвал портала Hotspot.
mobileLogoImage dictionary	Логотип для мобильных устройств портала Hotspot.
data string	Представлено в виде кодированной строки base64 массива байтов изображения.
language dictionary	Это свойство поддерживается только для операции чтения и позволяет отображать настройки на английском языке. Другие языки не поддерживаются.
viewLanguage string	Язык отображения портала Hotspot.
pageCustomizations dictionary	Настройки страниц портала Hotspot.
data list / elements=dictionary	Данные портала Hotspot.
key string	Ключ портала Hotspot.
value string	Значение портала Hotspot.
portalTheme dictionary	Определяет конфигурацию темы портала.
id string	Уникальный внутренний идентификатор темы портала.
name string	Системное или назначенное пользователем имя темы портала.
themeData string	CSS-файл, представленный как кодированный в Base64 массив байтов.
portalTweakSettings dictionary	Настройки Tweak — это настройка выбранной для портала темы портала. При изменении выбора темы портала настройки Tweak перезаписываются, чтобы соответствовать значениям в теме. Настройки Tweak могут быть изменены пользователем позже.
bannerColor string	Шестнадцатеричное значение цвета.
bannerTextColor string	Цвет текста баннера портала Hotspot.

pageBackgroundColor string	Цвет фона страницы портала Hotspot.
pageLabelAndTextColor string	Цвет текста и меток на странице портала Hotspot.
description string	Описание портала Hotspot.
id string	Идентификатор портала Hotspot.
ise_debug boolean	Флаг для включения отладки в Identity Services Engine SDK. Варианты: `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-токен в ERS API 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	Имя портала Hotspot.
portalTestUrl string	URL для открытия тестовой страницы этого портала.
portalType string	Допустимые значения - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.
settings dictionary	Определяет все группы настроек, доступные для BYOD.
aupSettings dictionary	Настройки политики приемлемого использования (AUP) для портала.
accessCode string	Код доступа, который должен ввести пользователь портала (действителен только если requireAccessCode = true).
includeAup boolean	Требуется, чтобы пользователь портала прочитал и принял политику AUP. Варианты: `false` `true`

END_OF_DOCUMENT_MARKER

requireAccessCode boolean	Требовать от пользователя портала ввода кода доступа. Используется только в портале Hotspot. Choices: `false` `true`
requireScrolling boolean	Требовать от пользователя портала прокрутить до конца AUP. Действительно только если requireAupAcceptance = true. Choices: `false` `true`
authSuccessSettings dictionary	Параметры authSuccessSettings портала Hotspot.
redirectUrl string	Целевой URL для перенаправления, используется, когда successRedirect = URL.
successRedirect string	Куда следует перенаправить устройство после успешной аутентификации. Допустимые значения - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL.
portalSettings dictionary	Порт, интерфейс, сертификат и другие основные настройки портала.
allowedInterfaces list / elements=string	Интерфейсы, на которых портал будет доступен. Допустимые значения - eth0 - eth1 - eth2 - eth3 - eth4 - eth5 - bond0 - bond1 - bond2.
alwaysUsedLanguage string	Используется, когда displayLang = ALWAYSUSE.
certificateGroupTag string	Логическое имя серверного сертификата x.509, который будет использоваться для портала.
coaType string	Допустимые значения - COAREAUTHENTICATE, - COATERMINATE.
displayLang string	Допустимые значения - USEBROWSERLOCALE, - ALWAYSUSE.
endpointIdentityGroup string	Уникальный идентификатор группы идентификаторов конечных точек, куда будут добавлены устройства пользователей. Используется только в портале Hotspot.
fallbackLanguage string	Используется, когда displayLang = USEBROWSERLOCALE.
httpsPort integer	Номер порта, на котором будут прослушиваться разрешенные интерфейсы. Диапазон от 8000 до 8999.
postAccessBannerSettings dictionary	Параметры postAccessBannerSettings портала Hotspot.
includePostAccessBanner boolean	Флаг IncludePostAccessBanner. Choices: `false` `true`
postLoginBannerSettings dictionary	Параметры postLoginBannerSettings портала Hotspot.
includePostAccessBanner boolean	Включить страницу баннера после входа. Choices: `false` `true`
supportInfoSettings dictionary	Настройки информации о поддержке портала.
defaultEmptyFieldValue string	Значение по умолчанию, отображаемое для пустого поля. Действительно только когда emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
emptyFieldDisplay string	Указывает, как обрабатываются пустые поля на странице информации о поддержке. Допустимые значения - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
includeBrowserUserAgent boolean	Флаг IncludeBrowserUserAgent. Choices: `false` `true`
includeFailureCode boolean	Флаг IncludeFailureCode. Choices: `false` `true`

includeIpAddress boolean	Флаг includeIpAddress. Варианты: `false` `true`
includeMacAddr boolean	Флаг includeMacAddr. Варианты: `false` `true`
includePolicyServer boolean	Флаг includePolicyServer. Варианты: `false` `true`
includeSupportInfoPage boolean	Флаг includeSupportInfoPage. Варианты: `false` `true`

Примечания

Примечание

Используемые методы SDK: hotspot_portal.HotspotPortal.create_hotspot_portal, hotspot_portal.HotspotPortal.delete_hotspot_portal_by_id, hotspot_portal.HotspotPortal.update_hotspot_portal_by_id,
Используемые пути: post /ers/config/hotspotportal, delete /ers/config/hotspotportal/{id}, put /ers/config/hotspotportal/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.hotspot_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:
        accessCode: string
        includeAup: true
        requireAccessCode: true
        requireScrolling: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        coaType: string
        displayLang: string
        endpointIdentityGroup: string
        fallbackLanguage: string
        httpsPort: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.hotspot_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.hotspot_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:
        accessCode: string
        includeAup: true
        requireAccessCode: true
        requireScrolling: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        coaType: string
        displayLang: string
        endpointIdentityGroup: string
        fallbackLanguage: string
        httpsPort: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

Значения возврата

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращенным 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": {"accessCode": "string", "includeAup": true, "requireAccessCode": true, "requireScrolling": true}, "authSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "string", "coaType": "string", "displayLang": "string", "endpointIdentityGroup": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "supportInfoSettings": {"defaultEmptyFieldValue": "string", "emptyFieldDisplay": "string", "includeBrowserUserAgent": true, "includeFailureCode": true, "includeIpAddress": true, "includeMacAddr": true, "includePolicyServer": true, "includeSupportInfoPage": true}}}
ise_update_response словарь добавлен в cisco.ise 1.1.0	Словарь или список со значением, возвращенным Cisco ISE Python SDK Возвращается: всегда Пример: `{"UpdatedFieldsList": {"field": "string", "newValue": "string", "oldValue": "string", "updatedField": [{"field": "string", "newValue": "string", "oldValue": "string"}]}}`

Ключ

Описание

ise_response

словарь

Словарь или список со значением, возвращенным 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": {"accessCode": "string", "includeAup": true, "requireAccessCode": true, "requireScrolling": true}, "authSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "string", "coaType": "string", "displayLang": "string", "endpointIdentityGroup": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "supportInfoSettings": {"defaultEmptyFieldValue": "string", "emptyFieldDisplay": "string", "includeBrowserUserAgent": true, "includeFailureCode": true, "includeIpAddress": true, "includeMacAddr": true, "includePolicyServer": true, "includeSupportInfoPage": true}}}

ise_update_response

словарь

добавлен в 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/hotspot_portal_module.html