Spec-Zone.ru › Ansible

Модуль cisco.ise.my_device_portal – Модуль ресурсов для My Device Portal

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.my_device_portal.

Новая в cisco.ise 1.0.0

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

Описание

  • Управление операциями создания, обновления и удаления ресурса My Device Portal.
  • Этот API создаёт My Device Portal.
  • Этот API удаляет My Device Portal по идентификатору.
  • Этот API позволяет клиенту обновить My Device Portal по идентификатору.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

customizations

dictionary

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

globalCustomizations

dictionary

Глобальные настройки My Device Portal.

backgroundImage

dictionary

Фоновое изображение My Device Portal.

data

string

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

bannerImage

dictionary

Изображение баннера My Device Portal.

data

string

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

bannerTitle

string

Заголовок баннера My Device Portal.

contactText

string

Контактная информация My Device Portal.

desktopLogoImage

dictionary

Логотип для настольных систем My Device Portal.

data

string

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

footerElement

string

Подвал My Device Portal.

mobileLogoImage

dictionary

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

data

string

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

language

dictionary

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

viewLanguage

string

Язык отображения My Device Portal.

pageCustomizations

dictionary

Представляет полную настройку страницы как огромный словарь.

data

list / elements=dictionary

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

key

string

Ключ My Device Portal.

value

string

Значение My Device Portal.

portalTheme

dictionary

Тема портала My Device Portal.

id

string

Идентификатор My Device Portal.

name

string

Системное или назначенное пользователем имя темы портала.

themeData

string

CSS-файл, представленный как закодированный в Base64 массив байтов.

portalTweakSettings

dictionary

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

bannerColor

string

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

bannerTextColor

string

Цвет текста баннера My Device Portal.

pageBackgroundColor

string

Цвет фона страницы портала «Мой Устройство».

pageLabelAndTextColor

string

Цвет текста и меток страницы портала «Мой Устройство».

description

string

Описание портала «Мой Устройство».

id

string

Идентификатор портала «Мой Устройство».

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

Название портала «Мой Устройство».

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).
END_OF_DOCUMENT_MARKER

includeAup

boolean

Требовать от пользователя портала чтения и принятия AUP.

Choices:

  • false
  • true

requireScrolling

boolean

Требовать от пользователя портала прокрутки до конца AUP. Действительно только если requireAupAcceptance = true.

Choices:

  • false
  • true

employeeChangePasswordSettings

dictionary

employeeChangePasswordSettings портала My Device Portal.

allowEmployeeToChangePwd

boolean

Флаг AllowEmployeeToChangePwd.

Choices:

  • false
  • true

loginPageSettings

dictionary

loginPageSettings портала My Device Portal.

aupDisplay

string

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

includeAup

boolean

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

Choices:

  • false
  • true

maxFailedAttemptsBeforeRateLimit

integer

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

requireAupAcceptance

boolean

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

Choices:

  • false
  • true

requireScrolling

boolean

Требовать от пользователя портала прокрутки до конца AUP. Действительно только если requireAupAcceptance = true.

Choices:

  • false
  • true

socialConfigs

list / elements=dictionary

socialConfigs портала My Device Portal.

timeBetweenLoginsDuringRateLimit

integer

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

portalSettings

dictionary

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

allowedInterfaces

list / elements=string

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

alwaysUsedLanguage

string

alwaysUsedLanguage портала My Device Portal.

certificateGroupTag

string

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

displayLang

string

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

endpointIdentityGroup

string

Уникальный идентификатор группы идентификаторов конечных точек, куда будут добавлены устройства пользователей. Используется только в портале Hotspot.

fallbackLanguage

string

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

httpsPort

integer

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

postAccessBannerSettings

dictionary

postAccessBannerSettings портала My Device Portal.

includePostAccessBanner

boolean

Флаг IncludePostAccessBanner.

Choices:

  • false
  • true

postLoginBannerSettings

словарь

Настройки баннера после входа в My Device Portal.

includePostAccessBanner

логическое значение

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

Варианты:

  • false
  • true

supportInfoSettings

словарь

Настройки поддержки My Device Portal.

defaultEmptyFieldValue

строка

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

emptyFieldDisplay

строка

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

includeBrowserUserAgent

логическое значение

Флаг IncludeBrowserUserAgent.

Варианты:

  • false
  • true

includeFailureCode

логическое значение

Флаг IncludeFailureCode.

Варианты:

  • false
  • true

includeIpAddress

логическое значение

Флаг IncludeIpAddress.

Варианты:

  • false
  • true

includeMacAddr

логическое значение

Флаг IncludeMacAddr.

Варианты:

  • false
  • true

includePolicyServer

логическое значение

Флаг IncludePolicyServer.

Варианты:

  • false
  • true

includeSupportInfoPage

логическое значение

Флаг IncludeSupportInfoPage.

Варианты:

  • false
  • true

Примечания

Примечание

  • Используемые методы SDK: my_device_portal.MyDevicePortal.create_my_device_portal, my_device_portal.MyDevicePortal.delete_my_device_portal_by_id, my_device_portal.MyDevicePortal.update_my_device_portal_by_id,
  • Используемые пути: post /ers/config/mydeviceportal, delete /ers/config/mydeviceportal/{id}, put /ers/config/mydeviceportal/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Update by id
  cisco.ise.my_device_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
      employeeChangePasswordSettings:
        allowEmployeeToChangePwd: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireScrolling: true
        socialConfigs:
        - {}
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: 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.my_device_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.my_device_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
      employeeChangePasswordSettings:
        allowEmployeeToChangePwd: true
      loginPageSettings:
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAupAcceptance: true
        requireScrolling: true
        socialConfigs:
        - {}
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        certificateGroupTag: 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": {"displayFrequency": "string", "displayFrequencyIntervalDays": 0, "includeAup": true, "requireScrolling": true}, "employeeChangePasswordSettings": {"allowEmployeeToChangePwd": true}, "loginPageSettings": {"aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAupAcceptance": true, "requireScrolling": true, "socialConfigs": [{}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "certificateGroupTag": "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/my_device_portal_module.html

Spec-Zone.ru

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