Модуль cisco.ise.self_registered_portal – Ресурсный модуль для портала самостоятельной регистрации

Примечание

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

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

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

Для использования в playbook, укажите: cisco.ise.self_registered_portal.

Новое в cisco.ise 1.0.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

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

bannerTextColor string	Цвет баннера портала саморегистрации.
pageBackgroundColor string	Цвет фона страницы портала саморегистрации.
pageLabelAndTextColor string	Цвет подписей и текста на странице портала саморегистрации.
description string	Описание портала саморегистрации.
id string	Идентификатор портала саморегистрации.
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (default) `true`
ise_hostname string / required	Имя хоста Identity Services Engine.
ise_password string / required	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Время ожидания (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя 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` ← (default)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, который информирует SDK о необходимости отправки маркера CSRF в API ERS ISE. Если он имеет значение True, SDK предполагает, что проверка CSRF вашего ISE включена. Если он имеет значение True, предполагается, что вам необходимо, чтобы SDK автоматически управлял маркером CSRF. Варианты: `false` ← (default) `true`
ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
ise_version string	Информирует SDK о версии Identity Services Engine, которую нужно использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK для включения автоматической обработки ограничения скорости. Варианты: `false` `true` ← (default)
name string	Название портала саморегистрации.
portalTestUrl string	URL для вызова тестовой страницы для этого портала.
portalType string	Допустимые значения - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST, - SPONSOR, - SPONSOREDGUEST.
settings dictionary	Определяет все группы настроек, доступные для портала.
aupSettings dictionary	aupSettings портала саморегистрации.
displayFrequency string	Как должен отображаться AUP, на странице или как ссылка. Действительно только если includeAup = true. Допустимые значения - FIRSTLOGIN, - EVERYLOGIN, - RECURRING.

displayFrequencyIntervalDays integer	Количество дней между подтверждениями AUP (при displayFrequency = recurring).
includeAup boolean	Требовать от пользователя портала прочитать и принять AUP. Choices: `false` `true`
requireAupScrolling boolean	Требовать от пользователя портала прокрутить AUP до конца. Действительно только если requireAupAcceptance = true. Choices: `false` `true`
requireScrolling boolean	Флаг RequireScrolling. Choices: `false` `true`
skipAupForEmployees boolean	Действительно только если requireAupAcceptance = trueG. Choices: `false` `true`
useDiffAupForEmployees boolean	Действительно только если requireAupAcceptance = trueG. Choices: `false` `true`
authSuccessSettings dictionary	authSuccessSettings портала саморегистрации.
redirectUrl string	redirectUrl портала саморегистрации.
successRedirect string	successRedirect портала саморегистрации.
byodSettings dictionary	Конфигурация шагов приветствия, регистрации и успешного завершения для BYOD-устройств.
byodRegistrationSettings dictionary	Конфигурация шага регистрации конечной точки BYOD.
endPointIdentityGroupId string	Идентификатор группы идентификаторов, к которой принадлежит конечная точка.
showDeviceID boolean	Отображать поле Device ID во время регистрации. Choices: `false` `true`
byodRegistrationSuccessSettings dictionary	Конфигурация шага успешного завершения регистрации конечной точки BYOD.
redirectUrl string	Целевой URL для перенаправления, используется, когда successRedirect = URL.
successRedirect string	Куда должно быть перенаправлено устройство после успешной аутентификации. Допустимые значения - AUTHSUCCESSPAGE, - ORIGINATINGURL, - URL.
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`
guestChangePasswordSettings dictionary	guestChangePasswordSettings портала самообслуживания.
allowChangePasswdAtFirstLogin boolean	Разрешить гостю изменять свои пароли. Choices: `false` `true`
guestDeviceRegistrationSettings dictionary	guestDeviceRegistrationSettings портала самообслуживания.
allowGuestsToRegisterDevices boolean	Разрешить гостям регистрировать устройства. Choices: `false` `true`
autoRegisterGuestDevices boolean	Автоматически регистрировать устройства гостей. Choices: `false` `true`
loginPageSettings dictionary	Далее следуют группы настроек страницы входа в портал.
accessCode string	Код доступа, который должен быть введен пользователем портала (действительно только если requireAccessCode = true).
allowAlternateGuestPortal boolean	Флаг AllowAlternateGuestPortal. Choices: `false` `true`
allowForgotPassword boolean	Флаг AllowForgotPassword. Choices: `false` `true`
allowGuestToChangePassword boolean	Требуется ввод кода доступа пользователем портала. Choices: `false` `true`
allowGuestToCreateAccounts boolean	Флаг AllowGuestToCreateAccounts. Choices: `false` `true`
allowGuestToUseSocialAccounts boolean	Флаг AllowGuestToUseSocialAccounts. Choices: `false` `true`
allowShowGuestForm boolean	Флаг AllowShowGuestForm. Choices: `false` `true`
alternateGuestPortal string	alternateGuestPortal портала самообслуживания.
aupDisplay string	Как должен отображаться AUP: на странице или как ссылка. Действительно только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK.
includeAup boolean	Включить политику допустимого использования (AUP), которая должна отображаться во время входа в систему. Choices: `false` `true`
maxFailedAttemptsBeforeRateLimit integer	Максимальное количество неудачных попыток входа перед ограничением скорости.

requireAccessCode boolean	Требовать от пользователя портала ввода кода доступа. Choices: `false` `true`
requireAupAcceptance boolean	Требовать от пользователя портала принятия соглашения об использовании (AUP). Действительно только если includeAup = true. Choices: `false` `true`
socialConfigs list / elements=dictionary	Параметры социальных сетей для саморегистрируемого портала.
socialMediaType string	Тип социальной сети для саморегистрируемого портала.
socialMediaValue string	Значение социальной сети для саморегистрируемого портала.
timeBetweenLoginsDuringRateLimit integer	Время между попытками входа при ограничении скорости.
portalSettings dictionary	Порт, интерфейс, сертификат и другие основные настройки портала.
allowedInterfaces list / elements=string	Интерфейсы, на которых будет доступен портал. Допустимые значения: eth0, eth1, eth2, eth3, eth4, eth5, bond0, bond1, bond2.
alwaysUsedLanguage string	Язык, всегда используемый саморегистрируемым порталом.
assignedGuestTypeForEmployee string	Уникальный идентификатор типа гостя. Сотрудники, использующие этот портал как гость, наследуют параметры входа от этого типа гостя.
authenticationMethod string	Уникальный идентификатор последовательности источников идентификации.
certificateGroupTag string	Логическое имя серверного сертификата x.509, который будет использоваться для портала.
displayLang string	Допустимые значения: USEBROWSERLOCALE, ALWAYSUSE.
fallbackLanguage string	Используется, когда displayLang = USEBROWSERLOCALE.
httpsPort integer	Номер порта, который будут прослушивать разрешенные интерфейсы. Диапазон от 8000 до 8999.
postAccessBannerSettings dictionary	Параметры баннера после доступа для саморегистрируемого портала.
includePostAccessBanner boolean	Флаг IncludePostAccessBanner. Choices: `false` `true`
postLoginBannerSettings dictionary	Параметры баннера после входа для саморегистрируемого портала.
includePostAccessBanner boolean	Включить страницу баннера после входа. Choices: `false` `true`
selfRegPageSettings dictionary	Параметры страницы саморегистрации для саморегистрируемого портала.
accountValidityDuration integer	Гостевой аккаунт, созданный при саморегистрации, действителен в течение указанного количества account_validity_time_units.
accountValidityTimeUnits string	Единицы времени для account_validity_duration. Допустимые значения: DAYS, HOURS, MINUTES.
allowGraceAccess boolean	Флаг AllowGraceAccess. Choices: `false` `true`

approvalEmailAddresses string	Только если requireGuestApproval = true и sendApprovalRequestTo = SELECTEDEMAILADDRESSES.
approveDenyLinksTimeUnits string	Этот атрибут, наряду с approveDenyLinksValidFor, указывает, как долго можно использовать ссылку. Только если requireGuestApproval = true. Допустимые значения - DAYS, - HOURS, - MINUTES.
approveDenyLinksValidFor integer	Этот атрибут, наряду с approveDenyLinksTimeUnits, указывает, как долго можно использовать ссылку. Только если requireGuestApproval = true.
assignGuestsToGuestType string	Гости назначены этому типу гостя.
aupDisplay string	Как отображать AUP, на странице или как ссылку. Только если includeAup = true. Допустимые значения - ONPAGE, - ASLINK.
authenticateSponsorsUsingPortalList boolean	Флаг AuthenticateSponsorsUsingPortalList. Choices: `false` `true`
autoLoginSelfWait boolean	Разрешить гостям автоматический вход в систему после саморегистрации после одобрения спонсора. Гостю не нужно предоставлять учетные данные для входа. Choices: `false` `true`
autoLoginTimePeriod integer	Период ожидания для автоматического входа до одобрения спонсора. Если время истекло, гость должен войти в систему вручную, предоставив учетные данные. Значение по умолчанию - 5 минут.
credentialNotificationUsingEmail boolean	Если true, отправлять уведомление об учетных данных после одобрения по электронной почте. Только если requireGuestApproval = true. Choices: `false` `true`
credentialNotificationUsingSMS boolean	Если true, отправлять уведомление об учетных данных после одобрения с помощью SMS. Только если requireGuestApproval = true. Choices: `false` `true`
enableGuestEmailBlacklist boolean	Запретить гостям с адресом электронной почты из выбранных доменов. Choices: `false` `true`
enableGuestEmailWhitelist boolean	Разрешить гостям с адресом электронной почты из выбранных доменов. Choices: `false` `true`
fieldCompany dictionary	fieldCompany портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Только если include = true. Choices: `false` `true`
fieldEmailAddr dictionary	fieldEmailAddr портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Только если include = true. Choices: `false` `true`
fieldFirstName dictionary	fieldFirstName портала саморегистрации.

include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldLastName dictionary	Поле fieldLastName портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldLocation dictionary	Поле fieldLocation портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldPersonBeingVisited dictionary	Поле fieldPersonBeingVisited портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldPhoneNo dictionary	Поле fieldPhoneNo портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldReasonForVisit dictionary	Поле fieldReasonForVisit портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldSMSProvider dictionary	Поле fieldSMSProvider портала саморегистрации.
include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
fieldUserName dictionary	Поле fieldUserName портала саморегистрации.

include boolean	Флаг включения. Choices: `false` `true`
require boolean	Применимо только если include = true. Choices: `false` `true`
graceAccessExpireInterval integer	graceAccessExpireInterval портала саморегистрации.
graceAccessSendAccountExpiration boolean	Флаг GraceAccessSendAccountExpiration. Choices: `false` `true`
guestEmailBlacklistDomains list / elements=string	Запретить гостям с адресом электронной почты из выбранных доменов.
guestEmailWhitelistDomains list / elements=string	Самозарегистрированные гости, чей адрес электронной почты находится в одном из этих доменов, будут разрешены. Действительно только если enableGuestEmailWhitelist = true.
includeAup boolean	Включить политику приемлемого использования (AUP), которая должна отображаться во время входа в систему. Choices: `false` `true`
postRegistrationRedirect string	После отправки регистрации перенаправить пользователя-гостя на одну из следующих страниц. Действительно только если requireGuestApproval = true. Допустимые значения - SELFREGISTRATIONSUCCESS, - LOGINPAGEWITHINSTRUCTIONS - URL.
postRegistrationRedirectUrl string	URL, на который перенаправляется пользователь-гость после регистрации. Действительно только если requireGuestApproval = true и postRegistrationRedirect = URL.
registrationCode string	Регистрационный код, который должен ввести пользователь-гость.
requireApproverToAuthenticate boolean	Когда самозарегистрированные гости требуют утверждения, запрос на утверждение отправляется по электронной почте одному или нескольким пользователям-спонсорам. Если администратор Cisco ISE решит включить ссылку на утверждение в электронное письмо, пользователь-спонсор, который щелкнет ссылку, должен будет ввести свое имя пользователя и пароль, если этот атрибут имеет значение true. Действительно только если requireGuestApproval = true. Choices: `false` `true`
requireAupAcceptance boolean	Требовать от пользователя портала принятия AUP. Действительно только если includeAup = true. Choices: `false` `true`
requireGuestApproval boolean	Требовать утверждения самозарегистрированных гостей, если true. Choices: `false` `true`
requireRegistrationCode boolean	Самозарегистрированные гости должны ввести регистрационный код. Choices: `false` `true`
selectableLocations list / elements=string	Гости могут выбирать из этих мест для установки своего часового пояса.
selectableSMSProviders list / elements=string	Этот атрибут представляет собой массив имен поставщиков SMS.
sendApprovalRequestTo string	Указывает, куда отправляются запросы на утверждение. Действительно только если requireGuestApproval = true. Допустимые значения - SELECTEDEMAILADDRESSES, - PERSONBEINGVISITED.
sponsorPortalList list / elements=string	sponsorPortalList портала саморегистрации.
selfRegSuccessSettings dictionary	selfRegSuccessSettings портала саморегистрации.

allowGuestLoginFromSelfregSuccessPage boolean	Флаг AllowGuestLoginFromSelfregSuccessPage. Choices: `false` `true`
allowGuestSendSelfUsingEmail boolean	Флаг AllowGuestSendSelfUsingEmail. Choices: `false` `true`
allowGuestSendSelfUsingPrint boolean	Флаг AllowGuestSendSelfUsingPrint. Choices: `false` `true`
allowGuestSendSelfUsingSMS boolean	Флаг AllowGuestSendSelfUsingSMS. Choices: `false` `true`
aupOnPage boolean	Флаг AupOnPage. Choices: `false` `true`
includeAup boolean	Флаг IncludeAup. Choices: `false` `true`
includeCompany boolean	Флаг IncludeCompany. Choices: `false` `true`
includeEmailAddr boolean	Флаг IncludeEmailAddr. Choices: `false` `true`
includeFirstName boolean	Флаг IncludeFirstName. Choices: `false` `true`
includeLastName boolean	Флаг IncludeLastName. Choices: `false` `true`
includeLocation boolean	Флаг IncludeLocation. Choices: `false` `true`
includePassword boolean	Флаг IncludePassword. Choices: `false` `true`
includePersonBeingVisited boolean	Флаг IncludePersonBeingVisited. Choices: `false` `true`
includePhoneNo boolean	Флаг IncludePhoneNo. Choices: `false` `true`
includeReasonForVisit boolean	Флаг IncludeReasonForVisit. Choices: `false` `true`
includeSMSProvider boolean	Флаг IncludeSMSProvider. Choices: `false` `true`
includeUserName boolean	Флаг IncludeUserName. Choices: `false` `true`
requireAupAcceptance boolean	Флаг RequireAupAcceptance. Choices: `false` `true`

requireAupScrolling boolean	Флаг RequireAupScrolling. Варианты: `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: self_registered_portal.SelfRegisteredPortal.create_self_registered_portal, self_registered_portal.SelfRegisteredPortal.delete_self_registered_portal_by_id, self_registered_portal.SelfRegisteredPortal.update_self_registered_portal_by_id,
Используемые пути: post /ers/config/selfregportal, delete /ers/config/selfregportal/{id}, put /ers/config/selfregportal/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE для SelfRegisteredPortal: Полная справка по API SelfRegisteredPortal.

Примеры

- name: Update by id
  cisco.ise.self_registered_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
        requireAupScrolling: true
        requireScrolling: true
        skipAupForEmployees: true
        useDiffAupForEmployees: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      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
      guestChangePasswordSettings:
        allowChangePasswdAtFirstLogin: true
      guestDeviceRegistrationSettings:
        allowGuestsToRegisterDevices: true
        autoRegisterGuestDevices: true
      loginPageSettings:
        accessCode: string
        allowAlternateGuestPortal: true
        allowForgotPassword: true
        allowGuestToChangePassword: true
        allowGuestToCreateAccounts: true
        allowGuestToUseSocialAccounts: true
        allowShowGuestForm: true
        alternateGuestPortal: string
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAccessCode: true
        requireAupAcceptance: true
        socialConfigs:
        - socialMediaType: string
          socialMediaValue: string
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        assignedGuestTypeForEmployee: string
        authenticationMethod: string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        httpsPort: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      selfRegPageSettings:
        accountValidityDuration: 0
        accountValidityTimeUnits: string
        allowGraceAccess: true
        approvalEmailAddresses: string
        approveDenyLinksTimeUnits: string
        approveDenyLinksValidFor: 0
        assignGuestsToGuestType: string
        aupDisplay: string
        authenticateSponsorsUsingPortalList: true
        autoLoginSelfWait: true
        autoLoginTimePeriod: 0
        credentialNotificationUsingEmail: true
        credentialNotificationUsingSms: true
        enableGuestEmailBlacklist: true
        enableGuestEmailWhitelist: true
        fieldCompany:
          include: true
          require: true
        fieldEmailAddr:
          include: true
          require: true
        fieldFirstName:
          include: true
          require: true
        fieldLastName:
          include: true
          require: true
        fieldLocation:
          include: true
          require: true
        fieldPersonBeingVisited:
          include: true
          require: true
        fieldPhoneNo:
          include: true
          require: true
        fieldReasonForVisit:
          include: true
          require: true
        fieldSmsProvider:
          include: true
          require: true
        fieldUserName:
          include: true
          require: true
        graceAccessExpireInterval: 0
        graceAccessSendAccountExpiration: true
        guestEmailBlacklistDomains:
        - string
        guestEmailWhitelistDomains:
        - string
        includeAup: true
        postRegistrationRedirect: string
        postRegistrationRedirectUrl: string
        registrationCode: string
        requireApproverToAuthenticate: true
        requireAupAcceptance: true
        requireGuestApproval: true
        requireRegistrationCode: true
        selectableLocations:
        - string
        selectableSmsProviders:
        - string
        sendApprovalRequestTo: string
        sponsorPortalList:
        - string
      selfRegSuccessSettings:
        allowGuestLoginFromSelfregSuccessPage: true
        allowGuestSendSelfUsingEmail: true
        allowGuestSendSelfUsingPrint: true
        allowGuestSendSelfUsingSms: true
        aupOnPage: true
        includeAup: true
        includeCompany: true
        includeEmailAddr: true
        includeFirstName: true
        includeLastName: true
        includeLocation: true
        includePassword: true
        includePersonBeingVisited: true
        includePhoneNo: true
        includeReasonForVisit: true
        includeSmsProvider: true
        includeUserName: true
        requireAupAcceptance: true
        requireAupScrolling: true
      supportInfoSettings:
        defaultEmptyFieldValue: string
        emptyFieldDisplay: string
        includeBrowserUserAgent: true
        includeFailureCode: true
        includeIpAddress: true
        includeMacAddr: true
        includePolicyServer: true
        includeSupportInfoPage: true

- name: Delete by id
  cisco.ise.self_registered_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.self_registered_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
        requireAupScrolling: true
        requireScrolling: true
        skipAupForEmployees: true
        useDiffAupForEmployees: true
      authSuccessSettings:
        redirectUrl: string
        successRedirect: string
      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
      guestChangePasswordSettings:
        allowChangePasswdAtFirstLogin: true
      guestDeviceRegistrationSettings:
        allowGuestsToRegisterDevices: true
        autoRegisterGuestDevices: true
      loginPageSettings:
        accessCode: string
        allowAlternateGuestPortal: true
        allowForgotPassword: true
        allowGuestToChangePassword: true
        allowGuestToCreateAccounts: true
        allowGuestToUseSocialAccounts: true
        allowShowGuestForm: true
        alternateGuestPortal: string
        aupDisplay: string
        includeAup: true
        maxFailedAttemptsBeforeRateLimit: 0
        requireAccessCode: true
        requireAupAcceptance: true
        socialConfigs:
        - socialMediaType: string
          socialMediaValue: string
        timeBetweenLoginsDuringRateLimit: 0
      portalSettings:
        allowedInterfaces:
        - string
        alwaysUsedLanguage: string
        assignedGuestTypeForEmployee: string
        authenticationMethod: string
        certificateGroupTag: string
        displayLang: string
        fallbackLanguage: string
        httpsPort: 0
      postAccessBannerSettings:
        includePostAccessBanner: true
      postLoginBannerSettings:
        includePostAccessBanner: true
      selfRegPageSettings:
        accountValidityDuration: 0
        accountValidityTimeUnits: string
        allowGraceAccess: true
        approvalEmailAddresses: string
        approveDenyLinksTimeUnits: string
        approveDenyLinksValidFor: 0
        assignGuestsToGuestType: string
        aupDisplay: string
        authenticateSponsorsUsingPortalList: true
        autoLoginSelfWait: true
        autoLoginTimePeriod: 0
        credentialNotificationUsingEmail: true
        credentialNotificationUsingSms: true
        enableGuestEmailBlacklist: true
        enableGuestEmailWhitelist: true
        fieldCompany:
          include: true
          require: true
        fieldEmailAddr:
          include: true
          require: true
        fieldFirstName:
          include: true
          require: true
        fieldLastName:
          include: true
          require: true
        fieldLocation:
          include: true
          require: true
        fieldPersonBeingVisited:
          include: true
          require: true
        fieldPhoneNo:
          include: true
          require: true
        fieldReasonForVisit:
          include: true
          require: true
        fieldSmsProvider:
          include: true
          require: true
        fieldUserName:
          include: true
          require: true
        graceAccessExpireInterval: 0
        graceAccessSendAccountExpiration: true
        guestEmailBlacklistDomains:
        - string
        guestEmailWhitelistDomains:
        - string
        includeAup: true
        postRegistrationRedirect: string
        postRegistrationRedirectUrl: string
        registrationCode: string
        requireApproverToAuthenticate: true
        requireAupAcceptance: true
        requireGuestApproval: true
        requireRegistrationCode: true
        selectableLocations:
        - string
        selectableSmsProviders:
        - string
        sendApprovalRequestTo: string
        sponsorPortalList:
        - string
      selfRegSuccessSettings:
        allowGuestLoginFromSelfregSuccessPage: true
        allowGuestSendSelfUsingEmail: true
        allowGuestSendSelfUsingPrint: true
        allowGuestSendSelfUsingSms: true
        aupOnPage: true
        includeAup: true
        includeCompany: true
        includeEmailAddr: true
        includeFirstName: true
        includeLastName: true
        includeLocation: true
        includePassword: true
        includePersonBeingVisited: true
        includePhoneNo: true
        includeReasonForVisit: true
        includeSmsProvider: true
        includeUserName: true
        requireAupAcceptance: true
        requireAupScrolling: 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, "requireAupScrolling": true, "requireScrolling": true, "skipAupForEmployees": true, "useDiffAupForEmployees": true}, "authSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "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}}, "guestChangePasswordSettings": {"allowChangePasswdAtFirstLogin": true}, "guestDeviceRegistrationSettings": {"allowGuestsToRegisterDevices": true, "autoRegisterGuestDevices": true}, "loginPageSettings": {"accessCode": "string", "allowAlternateGuestPortal": true, "allowForgotPassword": true, "allowGuestToChangePassword": true, "allowGuestToCreateAccounts": true, "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "alternateGuestPortal": "string", "aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAccessCode": true, "requireAupAcceptance": true, "socialConfigs": [{"socialMediaType": "string", "socialMediaValue": "string"}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "assignedGuestTypeForEmployee": "string", "authenticationMethod": "string", "certificateGroupTag": "string", "displayLang": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "selfRegPageSettings": {"accountValidityDuration": 0, "accountValidityTimeUnits": "string", "allowGraceAccess": true, "approvalEmailAddresses": "string", "approveDenyLinksTimeUnits": "string", "approveDenyLinksValidFor": 0, "assignGuestsToGuestType": "string", "aupDisplay": "string", "authenticateSponsorsUsingPortalList": true, "autoLoginSelfWait": true, "autoLoginTimePeriod": 0, "credentialNotificationUsingEmail": true, "credentialNotificationUsingSms": true, "enableGuestEmailBlacklist": true, "enableGuestEmailWhitelist": true, "fieldCompany": {"include": true, "require": true}, "fieldEmailAddr": {"include": true, "require": true}, "fieldFirstName": {"include": true, "require": true}, "fieldLastName": {"include": true, "require": true}, "fieldLocation": {"include": true, "require": true}, "fieldPersonBeingVisited": {"include": true, "require": true}, "fieldPhoneNo": {"include": true, "require": true}, "fieldReasonForVisit": {"include": true, "require": true}, "fieldSmsProvider": {"include": true, "require": true}, "fieldUserName": {"include": true, "require": true}, "graceAccessExpireInterval": 0, "graceAccessSendAccountExpiration": true, "guestEmailBlacklistDomains": ["string"], "guestEmailWhitelistDomains": ["string"], "includeAup": true, "postRegistrationRedirect": "string", "postRegistrationRedirectUrl": "string", "registrationCode": "string", "requireApproverToAuthenticate": true, "requireAupAcceptance": true, "requireGuestApproval": true, "requireRegistrationCode": true, "selectableLocations": ["string"], "selectableSmsProviders": ["string"], "sendApprovalRequestTo": "string", "sponsorPortalList": ["string"]}, "selfRegSuccessSettings": {"allowGuestLoginFromSelfregSuccessPage": true, "allowGuestSendSelfUsingEmail": true, "allowGuestSendSelfUsingPrint": true, "allowGuestSendSelfUsingSms": true, "aupOnPage": true, "includeAup": true, "includeCompany": true, "includeEmailAddr": true, "includeFirstName": true, "includeLastName": true, "includeLocation": true, "includePassword": true, "includePersonBeingVisited": true, "includePhoneNo": true, "includeReasonForVisit": true, "includeSmsProvider": true, "includeUserName": true, "requireAupAcceptance": true, "requireAupScrolling": 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"}]}}`

Ключ

Описание

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, "requireAupScrolling": true, "requireScrolling": true, "skipAupForEmployees": true, "useDiffAupForEmployees": true}, "authSuccessSettings": {"redirectUrl": "string", "successRedirect": "string"}, "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}}, "guestChangePasswordSettings": {"allowChangePasswdAtFirstLogin": true}, "guestDeviceRegistrationSettings": {"allowGuestsToRegisterDevices": true, "autoRegisterGuestDevices": true}, "loginPageSettings": {"accessCode": "string", "allowAlternateGuestPortal": true, "allowForgotPassword": true, "allowGuestToChangePassword": true, "allowGuestToCreateAccounts": true, "allowGuestToUseSocialAccounts": true, "allowShowGuestForm": true, "alternateGuestPortal": "string", "aupDisplay": "string", "includeAup": true, "maxFailedAttemptsBeforeRateLimit": 0, "requireAccessCode": true, "requireAupAcceptance": true, "socialConfigs": [{"socialMediaType": "string", "socialMediaValue": "string"}], "timeBetweenLoginsDuringRateLimit": 0}, "portalSettings": {"allowedInterfaces": ["string"], "alwaysUsedLanguage": "string", "assignedGuestTypeForEmployee": "string", "authenticationMethod": "string", "certificateGroupTag": "string", "displayLang": "string", "fallbackLanguage": "string", "httpsPort": 0}, "postAccessBannerSettings": {"includePostAccessBanner": true}, "postLoginBannerSettings": {"includePostAccessBanner": true}, "selfRegPageSettings": {"accountValidityDuration": 0, "accountValidityTimeUnits": "string", "allowGraceAccess": true, "approvalEmailAddresses": "string", "approveDenyLinksTimeUnits": "string", "approveDenyLinksValidFor": 0, "assignGuestsToGuestType": "string", "aupDisplay": "string", "authenticateSponsorsUsingPortalList": true, "autoLoginSelfWait": true, "autoLoginTimePeriod": 0, "credentialNotificationUsingEmail": true, "credentialNotificationUsingSms": true, "enableGuestEmailBlacklist": true, "enableGuestEmailWhitelist": true, "fieldCompany": {"include": true, "require": true}, "fieldEmailAddr": {"include": true, "require": true}, "fieldFirstName": {"include": true, "require": true}, "fieldLastName": {"include": true, "require": true}, "fieldLocation": {"include": true, "require": true}, "fieldPersonBeingVisited": {"include": true, "require": true}, "fieldPhoneNo": {"include": true, "require": true}, "fieldReasonForVisit": {"include": true, "require": true}, "fieldSmsProvider": {"include": true, "require": true}, "fieldUserName": {"include": true, "require": true}, "graceAccessExpireInterval": 0, "graceAccessSendAccountExpiration": true, "guestEmailBlacklistDomains": ["string"], "guestEmailWhitelistDomains": ["string"], "includeAup": true, "postRegistrationRedirect": "string", "postRegistrationRedirectUrl": "string", "registrationCode": "string", "requireApproverToAuthenticate": true, "requireAupAcceptance": true, "requireGuestApproval": true, "requireRegistrationCode": true, "selectableLocations": ["string"], "selectableSmsProviders": ["string"], "sendApprovalRequestTo": "string", "sponsorPortalList": ["string"]}, "selfRegSuccessSettings": {"allowGuestLoginFromSelfregSuccessPage": true, "allowGuestSendSelfUsingEmail": true, "allowGuestSendSelfUsingPrint": true, "allowGuestSendSelfUsingSms": true, "aupOnPage": true, "includeAup": true, "includeCompany": true, "includeEmailAddr": true, "includeFirstName": true, "includeLastName": true, "includeLocation": true, "includePassword": true, "includePersonBeingVisited": true, "includePhoneNo": true, "includeReasonForVisit": true, "includeSmsProvider": true, "includeUserName": true, "requireAupAcceptance": true, "requireAupScrolling": 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/self_registered_portal_module.html