Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_wireless_ssids_splash_settings – Модуль ресурса для настроек сетей _wireless _ssids _splash _settings

Примечание

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

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

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

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

Новый в cisco.meraki 2.16.0

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

Обзор

  • Управляет обновлением операций ресурса networks _wireless _ssids _splash _settings.
  • Изменяет настройки страницы splash для заданного 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 (строка), ключ API, сгенерированный в панели управления; также может быть задан как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), предшествующая всем ресурсам конечных точек

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть задан как переменная среды BE_GEO_ID

По умолчанию: ""

meraki_caller

string

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть задан как переменная среды MERAKI_PYTHON_SDK_CALLER

По умолчанию: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси

По умолчанию: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследует свой собственный экземпляр логгера

Варианты:

  • false ← (по умолчанию)
  • true
END_OF_DOCUMENT_MARKER

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала с добавлением даты и времени

Default: "meraki_api_"

meraki_log_path

string

log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (boolean), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (boolean), выводить выходные данные журнала на консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS

Default: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторить попытку, если возникла другая ошибка 4XX (кроме 429)?

Choices:

  • false ← (default)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания повторной попытки при другой ошибке 4XX

Default: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Choices:

  • false ← (default)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

Default: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя!

Choices:

  • false ← (default)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами

Choices:

  • false ← (default)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429?

Choices:

  • false
  • true ← (default)

networkId

string

Параметр пути NetworkId. Идентификатор сети.

number

string

Параметр пути Number.

redirectUrl

string

Пользовательский URL-адрес перенаправления, на который пользователи будут переходить после страницы приветствия.

sentryEnrollment

dictionary

Параметры страницы приветствия регистрации Sentry в System Manager.

enforcedSystems

список / элементы=строка

Типы систем, которые Sentry применяет к принудительному использованию. Должны быть включены в ‘iOS, ‘Android’, ‘macOS’ и ‘Windows’.

strength

строка

Уровень принудительного применения выбранных типов систем. Должно быть одно из ‘focused’, ‘click-through’ и ‘strict’.

systemsManagerNetwork

словарь

Сеть Systems Manager, нацеленная на регистрацию Sentry.

id

строка

Идентификатор сети Systems Manager.

splashImage

словарь

Изображение, используемое на странице авторизации.

extension

строка

Расширение файла изображения.

image

словарь

Свойства для задания нового изображения.

contents

строка

Содержимое файла (строка в кодировке base 64) нового изображения.

format

строка

Формат закодированного содержимого. Поддерживаемые форматы: ‘png’, ‘gif’ и ‘jpg’.

md5

строка

Значение MD5 файла изображения. Установка в null удалит изображение со страницы авторизации.

splashLogo

словарь

Логотип, используемый на странице авторизации.

extension

строка

Расширение файла логотипа.

image

словарь

Свойства для задания нового изображения.

contents

строка

Содержимое файла (строка в кодировке base 64) нового логотипа.

format

строка

Формат закодированного содержимого. Поддерживаемые форматы: ‘png’, ‘gif’ и ‘jpg’.

md5

строка

Значение MD5 файла логотипа. Установка в null удалит логотип со страницы авторизации.

splashPrepaidFront

словарь

Изображение prepaid front, используемое на странице авторизации.

extension

строка

Расширение файла изображения prepaid front.

image

словарь

Свойства для задания нового изображения.

contents

строка

Содержимое файла (строка в кодировке base 64) нового prepaid front.

format

строка

Формат закодированного содержимого. Поддерживаемые форматы: ‘png’, ‘gif’ и ‘jpg’.

md5

строка

Значение MD5 файла изображения prepaid front. Установка в null удалит prepaid front со страницы авторизации.

splashTimeout

целое число

Таймаут страницы авторизации в минутах. Это определяет, как часто пользователи будут видеть страницу авторизации.

splashUrl

строка

Необязательно. Пользовательский URL страницы авторизации с переходом по клику. Обратите внимание, что URL можно настроить, не обязательно использовать. Для включения пользовательского URL см. «useSplashUrl».

themeId

строка

Идентификатор выбранной темы splash страницы.

useRedirectUrl

boolean

Булево значение, указывающее, будет ли пользователь перенаправлен на пользовательский URL-адрес перенаправления после страницы приветствия. Если значение равно true, необходимо указать пользовательский URL-адрес перенаправления.

Варианты:

  • false
  • true

useSplashUrl

boolean

Необязательное булево значение, указывающее, будут ли пользователи перенаправлены на пользовательский URL-адрес страницы приветствия. Если значение равно true, необходимо указать пользовательский URL-адрес страницы приветствия. Обратите внимание, что в зависимости от настроек управления доступом вашей точки доступа Wi-Fi может быть невозможно использовать пользовательский 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 DNAC 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_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
    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

словарь

Словарь или список с ответом, возвращенным 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_wireless_ssids_splash_settings_module.html

Spec-Zone.ru

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