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

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.byod_portal.

Новая в cisco.ise 1.0.0

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

Описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

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

pageBackgroundColor string	Цвет фона страницы портала BYOD.
pageLabelAndTextColor string	Цвет текста и меток на странице портала BYOD.
description string	Описание портала BYOD.
id string	Уникальный идентификатор ресурса (UUID), обязателен для обновления.
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 ISE ERS. Если значение 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	Определяет все группы настроек, доступные для BYOD.
byodSettings dictionary	Настройки для шагов приветствия, регистрации и успеха устройства BYOD.
byodRegistrationSettings dictionary	Настройки регистрации устройства BYOD на портале.
endPointIdentityGroupId string	Идентификатор группы идентификации конечной точки портала BYOD.

showDeviceID boolean	Флаг ShowDeviceID. Choices: `false` `true`
byodRegistrationSuccessSettings dictionary	Параметр byodRegistrationSuccessSettings портала BYOD.
redirectUrl string	Целевой URL для перенаправления, используется, когда successRedirect = URL.
successRedirect string	Куда должно быть перенаправлено устройство после успешной аутентификации. Допустимые значения.
byodWelcomeSettings dictionary	Конфигурация приветственного шага конечной точки BYOD.
aupDisplay string	Как следует отображать AUP, на странице или как ссылку. Действительно только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK.
enableBYOD boolean	Флаг EnableBYOD. Choices: `false` `true`
enableGuestAccess boolean	Флаг EnableGuestAccess. Choices: `false` `true`
includeAup boolean	Флаг IncludeAup. Choices: `false` `true`
requireAupAcceptance boolean	Флаг RequireAupAcceptance. Choices: `false` `true`
requireMDM boolean	Флаг RequireMDM. Choices: `false` `true`
requireScrolling boolean	Требуется, чтобы устройства BYOD прокрутили AUP до конца. Действительно только если includeAup = true. Choices: `false` `true`
portalSettings dictionary	Порт, интерфейс, сертификат и другие основные настройки портала.
allowedInterfaces list / elements=string	Интерфейсы, на которых будет доступен портал. Допустимые значения - eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
alwaysUsedLanguage string	Используется, когда displayLang = ALWAYSUSE.
certificateGroupTag string	Логическое имя серверного сертификата x.509, который будет использоваться для портала.
displayLang string	Допустимые значения - USEBROWSERLOCALE, - ALWAYSUSE.
endpointIdentityGroup string	Уникальный идентификатор группы идентификаторов конечных точек, куда будут добавлены устройства пользователей. Используется только в портале Hotspot.
fallbackLanguage string	Используется, когда displayLang = USEBROWSERLOCALE.
httpsPort integer	Номер порта, на котором будут прослушиваться разрешенные интерфейсы. Диапазон от 8000 до 8999.
supportInfoSettings dictionary	Параметр supportInfoSettings портала BYOD.
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: byod_portal.ByodPortal.create_byod_portal, byod_portal.ByodPortal.delete_byod_portal_by_id, byod_portal.ByodPortal.update_byod_portal_by_id,
Используемые пути: post /ers/config/byodportal, delete /ers/config/byodportal/{id}, put /ers/config/byodportal/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

Примеры

- name: Update by id
  cisco.ise.byod_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:
      byodSettings:
        byodRegistrationSettings:
          endPointIdentityGroupId: string
          showDeviceID: true
        byodRegistrationSuccessSettings:
          redirectUrl: string
          successRedirect: string
        byodWelcomeSettings:
          aupDisplay: string
          enableBYOD: true
          enableGuestAccess: true
          includeAup: true
          requireAupAcceptance: true
          requireMDM: true
          requireScrolling: true
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        displayLang: string
        endpointIdentityGroup: string
        fallbackLanguage: string
        httpsPort: 0
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.byod_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.byod_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:
      byodSettings:
        byodRegistrationSettings:
          endPointIdentityGroupId: string
          showDeviceID: true
        byodRegistrationSuccessSettings:
          redirectUrl: string
          successRedirect: string
        byodWelcomeSettings:
          aupDisplay: string
          enableBYOD: true
          enableGuestAccess: true
          includeAup: true
          requireAupAcceptance: true
          requireMDM: true
          requireScrolling: true
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: string
        displayLang: string
        endpointIdentityGroup: string
        fallbackLanguage: string
        httpsPort: 0
      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": {"byodSettings": {"byodRegistrationSettings": {"endPointIdentityGroupId": "string", "showDeviceID": true}, "byodRegistrationSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "byodWelcomeSettings": {"aupDisplay": "string", "enableBYOD": true, "enableGuestAccess": true, "includeAup": true, "requireAupAcceptance": true, "requireMDM": true, "requireScrolling": true}}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "string", "displayLang": "string", "endpointIdentityGroup": "string", "fallbackLanguage": "string", "httpsPort": 0}, "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": {"byodSettings": {"byodRegistrationSettings": {"endPointIdentityGroupId": "string", "showDeviceID": true}, "byodRegistrationSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "byodWelcomeSettings": {"aupDisplay": "string", "enableBYOD": true, "enableGuestAccess": true, "includeAup": true, "requireAupAcceptance": true, "requireMDM": true, "requireScrolling": true}}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "string", "displayLang": "string", "endpointIdentityGroup": "string", "fallbackLanguage": "string", "httpsPort": 0}, "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/byod_portal_module.html