Модуль cisco.meraki.networks_wireless_settings — Модуль ресурсов для параметров беспроводной сети

Примечание

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

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

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

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

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

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
ipv6BridgeEnabled boolean	Переключатель для включения или отключения моста IPv6 в сети (Примечание: если включен, SSID также должны быть настроены на использование мостового режима). Варианты: `false` `true`
ledLightsOn boolean	Переключатель для включения или отключения светодиодов на всех точках доступа в сети (чтобы они работали в темном режиме). Варианты: `false` `true`
locationAnalyticsEnabled boolean	Переключатель для включения или отключения аналитики местоположения для вашей сети. Варианты: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повторной попытки при ошибке параллельной обработки действий По умолчанию: `60`
meraki_api_key string / required	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_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
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` ← (по умолчанию)
meshingEnabled boolean	Переключатель для включения или выключения мешинга в сети. Варианты: `false` `true`
namedVlans dictionary	Настройки именованных VLAN для беспроводных сетей.
poolDhcpMonitoring dictionary	Настройки мониторинга DHCP пула именованных VLAN.
duration integer	Длительность в минутах, в течение которой устройства воздерживаются от использования грязных VLAN перед добавлением их обратно в пул.
enabled boolean	Включить или отключить удаление грязных VLAN из пула для устройств, использующих именованные VLAN пулы, тем самым предотвращая назначение клиентам VLAN, где они не смогут получить IP-адрес через DHCP. Варианты: `false` `true`
networkId string	Параметр пути networkId. Идентификатор сети.
upgradeStrategy string	Стратегия обновления, применяемая к сети. Должно быть одно из 'minimizeUpgradeTime' или 'minimizeClientDowntime'. Требуется версия прошивки MR 26.8 или выше.

Примечания

Примечание

Используемый метод SDK - wireless.Wireless.update_network_wireless_settings,
Используемые пути - put /networks/{networkId}/wireless/settings,
Не поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco Meraki по беспроводному обновлению updateNetworkWirelessSettings: Полное описание API updateNetworkWirelessSettings.

Примеры

- name: Update all
  cisco.meraki.networks_wireless_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
    ipv6BridgeEnabled: false
    ledLightsOn: false
    locationAnalyticsEnabled: false
    meshingEnabled: true
    namedVlans:
      poolDhcpMonitoring:
        duration: 5
        enabled: true
    networkId: string
    upgradeStrategy: minimizeUpgradeTime

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `{"ipv6BridgeEnabled": true, "ledLightsOn": true, "locationAnalyticsEnabled": true, "meshingEnabled": true, "namedVlans": {"poolDhcpMonitoring": {"duration": 0, "enabled": true}}, "regulatoryDomain": {"countryCode": "string", "name": "string", "permits6e": true}, "upgradeStrategy": "string"}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"ipv6BridgeEnabled": true, "ledLightsOn": true, "locationAnalyticsEnabled": true, "meshingEnabled": true, "namedVlans": {"poolDhcpMonitoring": {"duration": 0, "enabled": true}}, "regulatoryDomain": {"countryCode": "string", "name": "string", "permits6e": true}, "upgradeStrategy": "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_settings_module.html