модуль cisco.meraki.organizations_wireless_zigbee_by_network_info – информационный модуль для organizations _wireless _zigbee _by _network

Примечание

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

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

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

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

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

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

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

Информационный модуль для Organizations Wireless Zigbee By Network Info.
Получение всех organizations _wireless _zigbee _by _network.
Возвращает список конфигураций Zigbee.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление постраничной навигации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Wireless Zigbee By Network Info. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
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), базовый URL для всех ресурсов конечных точек По умолчанию: `"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` ← (по умолчанию)
networkIds list / элементы=string	Информационный модуль для Organizations Wireless Zigbee By Network Info. Параметр запроса NetworkIds. Фильтрация по указанным идентификаторам сети.
organizationId string	Информационный модуль для Organizations Wireless Zigbee By Network Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Wireless Zigbee By Network Info. Параметр запроса PerPage. Число возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 50.
startingAfter string	Информационный модуль для Organizations Wireless Zigbee By Network Info. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить все результаты в пределах total_pages*perPage; -1 — все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _zigbee _by _network
  cisco.meraki.organizations_wireless_zigbee_by_network_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: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"network\": {\n \"id\": \"string\"\n },\n \"enabled\": true,\n \"iotController\": {\n \"name\": \"string\",\n \"mac\": \"string\",\n \"serial\": \"string\",\n \"status\": \"string\"\n },\n \"lockManagement\": {\n \"address\": \"string\",\n \"username\": \"string\",\n \"status\": \"string\"\n },\n \"defaults\": {\n \"transmitPowerLevel\": 0,\n \"channel\": \"string\"\n }\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"network\": {\n \"id\": \"string\"\n },\n \"enabled\": true,\n \"iotController\": {\n \"name\": \"string\",\n \"mac\": \"string\",\n \"serial\": \"string\",\n \"status\": \"string\"\n },\n \"lockManagement\": {\n \"address\": \"string\",\n \"username\": \"string\",\n \"status\": \"string\"\n },\n \"defaults\": {\n \"transmitPowerLevel\": 0,\n \"channel\": \"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_by_network_info_module.html