cisco.meraki.organizations_wireless_devices_wireless_controllers_by_device_info module – Информационный модуль для organizations _wireless _devices _wireless _controllers _by _device

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info.
Получить все organizations _wireless _devices _wireless _controllers _by _device.
Список сведений о точках доступа Catalyst.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
controllerSerials list / elements=string	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса ControllerSerials. Необязательный параметр для фильтрации точек доступа по идентификатору облака контроллера беспроводной локальной сети. Этот фильтр использует несколько точных совпадений.
direction string	direction (строка): направление перехода по страницам — «next» (по умолчанию) или страница «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса 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 (целое число): время ожидания перед повтором при ответе Nginx 429 По умолчанию: `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	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса NetworkIds. Необязательный параметр для фильтрации точек доступа по идентификатору сети. Этот фильтр использует несколько точных совпадений.
organizationId string	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. По умолчанию — 100.
serials list / elements=string	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса Serials. Необязательный параметр для фильтрации точек доступа по их идентификатору в облаке. Этот фильтр использует несколько точных совпадений.
startingAfter string	Информационный модуль для Organizations Wireless Devices Wireless Controllers By Device Info. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но допустимы и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages (целое число): используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 — все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _devices _wireless _controllers _by _device
  cisco.meraki.organizations_wireless_devices_wireless_controllers_by_device_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: []
    serials: []
    controllerSerials: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"controller": {"serial": "string"}, "countryCode": "string", "details": [{"name": "string", "value": "string"}], "joinedAt": "string", "mode": "string", "model": "string", "network": {"id": "string"}, "serial": "string", "tags": [{"policy": "string", "rf": "string", "site": "string"}]}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"items": [{"controller": {"serial": "string"}, "countryCode": "string", "details": [{"name": "string", "value": "string"}], "joinedAt": "string", "mode": "string", "model": "string", "network": {"id": "string"}, "serial": "string", "tags": [{"policy": "string", "rf": "string", "site": "string"}]}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Авторы

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