модуль cisco.meraki.organizations_wireless_ssids_statuses_by_device_info — информационный модуль для organizations _wireless _ssids _statuses _by _device

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для Organizations Wireless Ssids Statuses By Device Info.
Получить все organizations _wireless _ssids _statuses _by _device.
Вывести сведения о состоянии всех BSSID в вашей организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
bssids list / elements=string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса Bssids. Список BSSID. Возвращаемые устройства будут отфильтрованы: в результат войдут только указанные BSSID.
direction string	direction (string): направление пагинации — страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
headers dictionary	Дополнительные заголовки.
hideDisabled boolean	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса HideDisabled. Если значение равно true, возвращаемые устройства не будут включать отключенные SSID. (по умолчанию true). Варианты: `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): время ожидания перед повтором запроса при ответе 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 / elements=string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса NetworkIds. Необязательный параметр для фильтрации результатов по указанному набору идентификаторов сетей.
organizationId string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–500. Значение по умолчанию — 100.
serials list / elements=string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса Serials. Список серийных номеров. Возвращаемые устройства будут отфильтрованы: в результат войдут только указанные серийные номера.
startingAfter string	Информационный модуль для Organizations Wireless Ssids Statuses By Device Info. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages(int): используется вместе с perPage для получения общего количества результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _ssids _statuses _by _device
  cisco.meraki.organizations_wireless_ssids_statuses_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: []
    bssids: []
    hideDisabled: true
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"basicServiceSets": [{"bssid": "string", "radio": {"band": "string", "channel": 0, "channelWidth": 0, "index": "string", "isBroadcasting": true, "power": 0}, "ssid": {"advertised": true, "enabled": true, "name": "string", "number": 0}}], "name": "string", "network": {"id": "string", "name": "string"}, "serial": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"items": [{"basicServiceSets": [{"bssid": "string", "radio": {"band": "string", "channel": 0, "channelWidth": 0, "index": "string", "isBroadcasting": true, "power": 0}, "ssid": {"advertised": true, "enabled": true, "name": "string", "number": 0}}], "name": "string", "network": {"id": "string", "name": "string"}, "serial": "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_ssids_statuses_by_device_info_module.html