модуль cisco.meraki.organizations_wireless_zigbee_door_locks_info — модуль сведений об организациях _wireless _zigbee _door _locks

Примечание

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

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

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

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

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

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

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

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

Примечание

Этому модулю соответствует модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление постраничной навигации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр запроса EndingBefore. Токен, с помощью которого сервер обозначает конец страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый URL, добавляемый перед всеми ресурсами конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать как переменную окружения BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение), наследовать собственный экземпляр средства ведения журнала Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и время По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь к выходному файлу журнала; по умолчанию — рабочий каталог скрипта, если путь не указан По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке 429 от Nginx По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение), создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), адрес и порт прокси-сервера, если он требуется для HTTPS По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторять попытку при получении другой ошибки 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой при другой ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять попытку при получении ошибки ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkIds list / elements=string	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр запроса NetworkIds. Фильтрация по указанным идентификаторам сетей.
organizationId string	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон — от 3 до 500. Значение по умолчанию — 50.
serial string	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр запроса Serial. Фильтрация по серийному номеру устройства.
startingAfter string	Модуль сведений об организациях — информация о Zigbee-замках на дверях. Параметр запроса StartingAfter. Токен, с помощью которого сервер обозначает начало страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages (целое число), используется вместе с perPage для получения общего числа результатов в пределах total_pages*perPage; -1 — все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _zigbee _door _locks
  cisco.meraki.organizations_wireless_zigbee_door_locks_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 }}"
    networkIds: []
    serial: string
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"doorLockId\": \"string\",\n \"name\": \"string\",\n \"shortId\": \"string\",\n \"lqi\": \"string\",\n \"rssi\": \"string\",\n \"status\": \"string\",\n \"eui64\": \"string\",\n \"enrolledAt\": \"string\",\n \"lastSeenAt\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"gateway\": {\n \"name\": \"string\",\n \"serial\": \"string\"\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"doorLockId\": \"string\",\n \"name\": \"string\",\n \"shortId\": \"string\",\n \"lqi\": \"string\",\n \"rssi\": \"string\",\n \"status\": \"string\",\n \"eui64\": \"string\",\n \"enrolledAt\": \"string\",\n \"lastSeenAt\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"gateway\": {\n \"name\": \"string\",\n \"serial\": \"string\"\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_door_locks_info_module.html