модуль cisco.meraki.organizations_wireless_zigbee_devices_info — информационный модуль для организаций _wireless _zigbee _devices

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации.
Получение всех устройств _wireless _zigbee _devices организации.
Вывод списка беспроводных устройств Zigbee организации или указанных сетей.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует задавать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
isEnrolled boolean	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса IsEnrolled. Фильтрация устройств по признаку регистрации. Варианты: `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), время ожидания перед повторной попыткой при ошибке 429 Nginx По умолчанию: `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` ← (по умолчанию)
networkIds list / элементы=string	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса NetworkIds. Идентификаторы сетей, для которых нужно получить устройства Zigbee. Например: NetworkIds=N_12345678&networkIds=N_3456.
organizationId string	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 10.
search string	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса Search. Фильтрация устройств по имени, тегу или серийному номеру.
startingAfter string	Информационный модуль для сведений об устройствах Zigbee в беспроводных сетях организации. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует задавать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 — все страницы

Примечания

Примечание

Используемый метод SDK: wireless.Wireless.get_organization_wireless_zigbee_devices,
Используемый путь: get /organizations/{organizationId}/wireless/zigbee/devices,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо них использует встроенный менеджер подключений Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

Документация Cisco Meraki по wireless getOrganizationWirelessZigbeeDevices: Полный справочник по API getOrganizationWirelessZigbeeDevices.

Примеры

- name: Get all organizations _wireless _zigbee _devices
  cisco.meraki.organizations_wireless_zigbee_devices_info:
    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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    isEnrolled: true
    search: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"panId\": \"string\",\n \"channel\": \"string\",\n \"transmitPowerLevel\": 0,\n \"enrolled\": true,\n \"status\": \"string\",\n \"gateway\": {\n \"name\": \"string\",\n \"mac\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ]\n },\n \"counts\": {\n \"doorLocks\": {\n \"byStatus\": {\n \"online\": 0,\n \"offline\": 0,\n \"dormant\": 0\n }\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n {\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"panId\": \"string\",\n \"channel\": \"string\",\n \"transmitPowerLevel\": 0,\n \"enrolled\": true,\n \"status\": \"string\",\n \"gateway\": {\n \"name\": \"string\",\n \"mac\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ]\n },\n \"counts\": {\n \"doorLocks\": {\n \"byStatus\": {\n \"online\": 0,\n \"offline\": 0,\n \"dormant\": 0\n }\n }\n }\n }\n]\n"

Авторы

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