модуль cisco.meraki.networks_wireless_ssids_splash_settings – модуль ресурсов для networks _wireless _ssids _splash _settings

Примечание

Этот модуль входит в коллекцию cisco.meraki (версия 2.23.2).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_wireless_ssids_splash_settings.

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

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

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

Управление операцией обновления ресурса networks _wireless _ssids _splash _settings.
Изменение настроек страницы-заставки для указанного SSID.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
allowSimultaneousLogins boolean	Разрешить ли одновременный вход с разных устройств. Варианты: `false` `true`
billing dictionary	Сведения, связанные с платной заставкой.
freeAccess dictionary	Сведения о бесплатном тарифном плане с ограничениями.
durationInMinutes integer	Как долго устройство может бесплатно пользоваться сетью.
enabled boolean	Включён ли бесплатный доступ. Варианты: `false` `true`
prepaidAccessFastLoginEnabled boolean	Использует ли оплата предоплаченного доступа с быстрым входом. Варианты: `false` `true`
replyToEmailAddress string	Адрес электронной почты, на который поступают ответы клиентов.
blockAllTrafficBeforeSignOn boolean	Насколько строгими должны быть ограничения на передачу трафика. Если значение равно true, блокируются все типы трафика, пока пользователь не подтвердит страницу-заставку. Если значение равно false, до подтверждения страницы-заставки разрешён весь трафик, кроме HTTP. Варианты: `false` `true`
controllerDisconnectionBehavior string	Как обрабатывать попытки входа, если контроллер недоступен. Допустимые значения: ‘open’, ‘restricted’ или ‘default’.
guestSponsorship dictionary	Сведения о заставке с авторизацией гостя спонсором.
durationInMinutes integer	Продолжительность авторизации гостя спонсором в минутах. Значение должно быть в диапазоне от 1 до 60480 (6 недель).
guestCanRequestTimeframe boolean	Могут ли гости указывать, на какой период они запрашивают доступ. Варианты: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный на панели управления; также можно задать как переменную среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), добавляется перед ресурсами всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также можно задать как переменную среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), использовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), к имени файла журнала добавляются дата и время По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для записи журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при других ошибках 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повтором при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все журналы? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с отдельными объектами вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты 429? Варианты: `false` `true` ← (по умолчанию)
networkId string	Параметр пути NetworkId. Идентификатор сети.
number string	Параметр пути Number.
redirectUrl string	Пользовательский URL перенаправления, на который перейдут пользователи после страницы-заставки.
selfRegistration dictionary	Параметры самостоятельной регистрации на странице-заставке с аутентификацией Meraki.
authorizationType string	Способ авторизации созданных учётных записей пользователей. Допустимые значения: admin, auto, self_email.
enabled boolean	Разрешить ли пользователям самостоятельно создавать учётные записи в сети. Варианты: `false` `true`
sentryEnrollment dictionary	Параметры регистрации Sentry в Systems Manager на странице-заставке.
enforcedSystems list / elements=string	Типы систем, для которых Sentry обеспечивает соблюдение политик. Допустимые значения: ‘iOS’, ‘Android’, ‘macOS’ и ‘Windows’.
strength string	Степень принудительного применения политик к выбранным типам систем. Допустимые значения: ‘focused’, ‘click-through’ и ‘strict’.
systemsManagerNetwork dictionary	Сеть Systems Manager, предназначенная для регистрации Sentry.
id string	Идентификатор сети Systems Manager.
splashImage dictionary	Изображение, используемое на странице-заставке.
extension string	Расширение файла изображения.
image dictionary	Свойства для задания нового изображения.
contents string	Содержимое файла нового изображения (строка в кодировке Base64).
format string	Формат закодированного содержимого. Поддерживаются форматы ‘png’, ‘gif’ и ‘jpg’.
md5 string	Значение MD5 файла изображения. Если задать null, изображение будет удалено со страницы-заставки.
splashLogo dictionary	Логотип, используемый на странице-заставке.
extension string	Расширение файла логотипа.
image dictionary	Свойства для задания нового изображения.
contents string	Содержимое файла нового логотипа (строка в кодировке Base64).
format string	Формат закодированного содержимого. Поддерживаются форматы ‘png’, ‘gif’ и ‘jpg’.
md5 string	Значение MD5 файла логотипа. Если задать null, логотип будет удалён со страницы-заставки.
splashPrepaidFront dictionary	Изображение лицевой стороны предоплаченной карты, используемое на странице-заставке.
extension string	Расширение файла изображения лицевой стороны предоплаченной карты.

image dictionary	Свойства для настройки нового изображения.
contents string	Содержимое файла (строка в кодировке base64) новой предоплаченной заставки.
format string	Формат закодированного содержимого. Поддерживаются форматы ‘png’, ‘gif’ и ‘jpg’.
md5 string	Значение MD5 файла изображения предоплаченной заставки. Если задать null, предоплаченная заставка будет удалена со страницы заставки.
splashTimeout integer	Тайм-аут заставки в минутах. Определяет, как часто пользователи будут видеть страницу заставки.
splashUrl string	Необязательный пользовательский URL страницы заставки с переходом по ссылке. Обратите внимание, что URL можно настроить, даже если он не используется. Чтобы включить пользовательский URL, см. ‘useSplashUrl’.
themeId string	Идентификатор выбранной темы заставки.
useRedirectUrl boolean	Логическое значение, указывающее, будет ли пользователь перенаправлен на пользовательский URL перенаправления после страницы заставки. Если задано значение true, необходимо указать пользовательский URL перенаправления. Варианты: `false` `true`
useSplashUrl boolean	Необязательное логическое значение, указывающее, будут ли пользователи перенаправляться на пользовательский URL заставки. Если задано значение true, необходимо указать пользовательский URL заставки. Обратите внимание, что в зависимости от настроек контроля доступа SSID использование пользовательского URL заставки может быть недоступно. Варианты: `false` `true`
welcomeMessage string	Приветственное сообщение для пользователей на странице заставки.

Примечания

Примечание

Используемый метод SDK: wireless.Wireless.update_network_wireless_ssid_splash_settings,
Используемый путь: put /networks/{networkId}/wireless/ssids/{number}/splash/settings,
Не поддерживает check_mode
Плагин запускается на управляющем узле и не использует плагины подключения Ansible, а использует встроенный диспетчер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки соединения

См. также

Документация Cisco Meraki по wireless updateNetworkWirelessSsidSplashSettings: Полное описание API updateNetworkWirelessSsidSplashSettings.

Примеры

- name: Update all
  cisco.meraki.networks_wireless_ssids_splash_settings:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    state: present
    allowSimultaneousLogins: false
    billing:
      freeAccess:
        durationInMinutes: 120
        enabled: true
      prepaidAccessFastLoginEnabled: true
      replyToEmailAddress: user@email.com
    blockAllTrafficBeforeSignOn: false
    controllerDisconnectionBehavior: default
    guestSponsorship:
      durationInMinutes: 30
      guestCanRequestTimeframe: false
    networkId: string
    number: string
    redirectUrl: https://example.com
    selfRegistration:
      authorizationType: admin
      enabled: true
    sentryEnrollment:
      enforcedSystems:
        - iOS
      strength: focused
      systemsManagerNetwork:
        id: N_1234
    splashImage:
      extension: jpg
      image:
        contents: Q2lzY28gTWVyYWtp
        format: jpg
      md5: 542cccac8d7dedee0f185311d154d194
    splashLogo:
      extension: jpg
      image:
        contents: Q2lzY28gTWVyYWtp
        format: jpg
      md5: abcd1234
    splashPrepaidFront:
      extension: jpg
      image:
        contents: Q2lzY28gTWVyYWtp
        format: jpg
      md5: 542cccac8d7dedee0f185311d154d194
    splashTimeout: 1440
    splashUrl: https://www.custom_splash_url.com
    themeId: c3ddcb4f16785ee747ab5ffc10867d6c8ea704be
    useRedirectUrl: true
    useSplashUrl: true
    welcomeMessage: Welcome!

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: {"allowSimultaneousLogins": true, "billing": {"freeAccess": {"durationInMinutes": 0, "enabled": true}, "prepaidAccessFastLoginEnabled": true, "replyToEmailAddress": "string"}, "blockAllTrafficBeforeSignOn": true, "controllerDisconnectionBehavior": "string", "guestSponsorship": {"durationInMinutes": 0, "guestCanRequestTimeframe": true}, "redirectUrl": "string", "selfRegistration": {"authorizationType": "string", "enabled": true}, "sentryEnrollment": {"enforcedSystems": ["string"], "strength": "string", "systemsManagerNetwork": {"id": "string"}}, "splashImage": {"extension": "string", "md5": "string"}, "splashLogo": {"extension": "string", "md5": "string"}, "splashPage": "string", "splashPrepaidFront": {"extension": "string", "md5": "string"}, "splashTimeout": 0, "splashUrl": "string", "ssidNumber": 0, "themeId": "string", "useRedirectUrl": true, "useSplashUrl": true, "welcomeMessage": "string"}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"allowSimultaneousLogins": true, "billing": {"freeAccess": {"durationInMinutes": 0, "enabled": true}, "prepaidAccessFastLoginEnabled": true, "replyToEmailAddress": "string"}, "blockAllTrafficBeforeSignOn": true, "controllerDisconnectionBehavior": "string", "guestSponsorship": {"durationInMinutes": 0, "guestCanRequestTimeframe": true}, "redirectUrl": "string", "selfRegistration": {"authorizationType": "string", "enabled": true}, "sentryEnrollment": {"enforcedSystems": ["string"], "strength": "string", "systemsManagerNetwork": {"id": "string"}}, "splashImage": {"extension": "string", "md5": "string"}, "splashLogo": {"extension": "string", "md5": "string"}, "splashPage": "string", "splashPrepaidFront": {"extension": "string", "md5": "string"}, "splashTimeout": 0, "splashUrl": "string", "ssidNumber": 0, "themeId": "string", "useRedirectUrl": true, "useSplashUrl": true, "welcomeMessage": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

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