Модуль cisco.meraki.networks_clients_splash_authorization_status — модуль ресурсов для networks _clients _splashauthorizationstatus

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса networks _clients _splashauthorizationstatus.
Обновление авторизации клиента на странице splash. Клиентов можно идентифицировать по ключу клиента, MAC-адресу или IP-адресу — в зависимости от того, использует ли сеть отслеживание по IP-адресу (Track-by-IP).

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clientId string	Параметр пути ClientId. Идентификатор клиента.
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. Идентификатор сети.
ssids dictionary	Целевые SSID. Каждый SSID должен быть включён, а для него должна быть включена заставка Click-through. Для каждого SSID, у которого isAuthorized имеет значение true, время истечения срока действия будет автоматически установлено в соответствии с частотой показа заставки для этого SSID. Не все сети поддерживают настройку всех SSID.
0 dictionary	Авторизация через заставку для SSID 0.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
1 dictionary	Авторизация через заставку для SSID 1.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
10 dictionary	Авторизация через заставку для SSID 10.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
11 dictionary	Авторизация через заставку для SSID 11.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
12 dictionary	Авторизация через заставку для SSID 12.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
13 dictionary	Авторизация через заставку для SSID 13.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
14 dictionary	Авторизация через заставку для SSID 14.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
2 dictionary	Авторизация через заставку для SSID 2.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
3 dictionary	Авторизация через заставку для SSID 3.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
4 dictionary	Авторизация через заставку для SSID 4.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
5 dictionary	Авторизация через заставку для SSID 5.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
6 dictionary	Авторизация через заставку для SSID 6.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
7 dictionary	Авторизация через заставку для SSID 7.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
8 dictionary	Авторизация через заставку для SSID 8.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`
9 dictionary	Авторизация через заставку для SSID 9.
isAuthorized boolean	Новый статус авторизации для SSID (true, false). Варианты: `false` `true`

Примечания

Примечание

Используемый метод SDK: networks.Networks.update_network_client_splash_authorization_status,
Используемые пути: put /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus,
Не поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений
из Cisco Dashboard API Python(SDK)
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установки подключения

См. также

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

Примеры

- name: Update all
  cisco.meraki.networks_clients_splash_authorization_status:
    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
    clientId: string
    networkId: string
    ssids:
      '0':
        isAuthorized: true
      '2':
        isAuthorized: false

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{}`

Авторы

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_clients_splash_authorization_status_module.html