Модуль cisco.meraki.organizations_wireless_mqtt_settings — модуль ресурсов для organizations _wireless _mqtt _settings

Примечание

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

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

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

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

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

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

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

Управление операцией обновления ресурса organizations _wireless _mqtt _settings.
Добавление конфигурации нового брокера для беспроводного MQTT.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
ble словарь	Параметры BLE MQTT для сети.
allowLists словарь	Список разрешений для MAC-адресов и UUID.
macs список / элементы=строка	Список разрешённых MAC-адресов.
uuids список / элементы=строка	Список разрешённых UUID.
enabled логическое значение	Включение BLE. Варианты: `false` `true`
flush словарь	Частота сброса BLE.
frequency целое число	Частота сброса BLE в секундах. Значение должно быть в диапазоне от 1 до 2147483647. Значение по умолчанию — 60 секунд.
hysteresis словарь	Параметры гистерезиса BLE для сети.
enabled логическое значение	Включение гистерезиса BLE. Варианты: `false` `true`
threshold целое число	Порог BLE. Значение должно быть в диапазоне от 1 до 2147483647. Значение по умолчанию — 1 секунда.
type строка	Тип клиентов BLE, телеметрия которых публикуется. Допустимые типы: all, ibeacon, eddystone, unknown.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также его можно задать в переменной окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL для всех ресурсов конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также его можно задать в переменной окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; по умолчанию используется рабочий каталог скрипта, если параметр не задан По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой после ошибки 429 от Nginx По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой после другой ошибки 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить ведение журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с отдельными объектами вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять запрос при возникновении ошибки ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
mqtt словарь	Параметры MQTT для сети.
broker словарь	Параметры брокера MQTT для сети.
name строка	Имя конфигурации брокера.
enabled логическое значение	Включение MQTT. Варианты: `false` `true`
messageFields список / элементы=строка	Выбор полей для включения в сообщения MQTT. Допустимые типы: RSSI, MAC-адрес точки доступа, MAC-адрес клиента, метка времени, радиомодуль, идентификатор сети, тип маяка, необработанные данные, UUID клиента, старшее значение клиента, младшее значение клиента, мощность сигнала, диапазон, идентификатор слота.
publishing словарь	Параметры публикации MQTT.
frequency целое число	Частота публикации MQTT в секундах. Значение должно быть в диапазоне от 1 до 2147483647. Значение по умолчанию — 1 секунда.
qos целое число	Уровень QoS для публикации MQTT. Допустимые значения: 0, 1, 2.
topic строка	Тема MQTT.
network словарь	Добавление параметров MQTT для сети.
id строка	Идентификатор сети.
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.
wifi словарь	Параметры Wi-Fi MQTT для сети.
allowLists словарь	Список разрешений для MAC-адресов и UUID.
macs список / элементы=строка	Список разрешённых MAC-адресов.
enabled логическое значение	Включение Wi-Fi. Варианты: `false` `true`
flush словарь	Частота сброса BLE.
frequency целое число	Частота сброса Wi-Fi в секундах. Значение должно быть в диапазоне от 1 до 2147483647. Значение по умолчанию — 60 секунд.
hysteresis словарь	Параметры гистерезиса Wi-Fi для сети.
enabled логическое значение	Включение гистерезиса Wi-Fi. Варианты: `false` `true`
threshold целое число	Порог Wi-Fi. Значение должно быть в диапазоне от 1 до 2147483647. Значение по умолчанию — 1 секунда.
type строка	Тип клиента Wi-Fi. Допустимые типы: visible, associated.

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.meraki.organizations_wireless_mqtt_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
    ble:
      allowLists:
        macs: []
        uuids: []
      enabled: false
      flush:
        frequency: 60
      hysteresis:
        enabled: true
        threshold: 1
      type: ibeacon
    mqtt:
      broker:
        name: My Broker
      enabled: true
      messageFields:
        - RSSI
        - AP MAC address
        - Client MAC address
        - Timestamp
        - Radio
        - Network ID
        - Beacon type
        - Raw payload
        - Client UUID
        - Client major value
        - Client minor value
        - Signal power
        - Band
        - Slot ID
      publishing:
        frequency: 1
        qos: 1
      topic: Test Topic
    network:
      id: L_1234
    organizationId: string
    wifi:
      allowLists:
        macs: []
      enabled: false
      flush:
        frequency: 60
      hysteresis:
        enabled: false
        threshold: 1
      type: associated

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: {"ble": {"allowLists": {"macs": ["string"], "uuids": ["string"]}, "enabled": true, "flush": {"frequency": 0}, "hysteresis": {"enabled": true, "threshold": 0}, "type": "string"}, "mqtt": {"broker": {"id": "string", "name": "string"}, "enabled": true, "messageFields": ["string"], "publishing": {"frequency": 0, "qos": 0}, "settingsId": "string", "topic": "string"}, "network": {"id": "string", "name": "string"}, "wifi": {"allowLists": {"macs": ["string"]}, "enabled": true, "flush": {"frequency": 0}, "hysteresis": {"enabled": true, "threshold": 0}, "type": "string"}}

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"ble": {"allowLists": {"macs": ["string"], "uuids": ["string"]}, "enabled": true, "flush": {"frequency": 0}, "hysteresis": {"enabled": true, "threshold": 0}, "type": "string"}, "mqtt": {"broker": {"id": "string", "name": "string"}, "enabled": true, "messageFields": ["string"], "publishing": {"frequency": 0, "qos": 0}, "settingsId": "string", "topic": "string"}, "network": {"id": "string", "name": "string"}, "wifi": {"allowLists": {"macs": ["string"]}, "enabled": true, "flush": {"frequency": 0}, "hysteresis": {"enabled": true, "threshold": 0}, "type": "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/organizations_wireless_mqtt_settings_module.html