модуль cisco.meraki.organizations_firmware_upgrades_by_device_info — информационный модуль для organizations _firmware _upgrades _bydevice

Примечание

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

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

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

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

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

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

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

Информационный модуль для Organizations Firmware Upgrades Bydevice Info.
Получение всех organizations _firmware _upgrades _bydevice.
Получение статуса обновления прошивки для отфильтрованных устройств. В настоящее время эта конечная точка поддерживает только коммутаторы и точки доступа Meraki.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
currentUpgradesOnly логический	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса CurrentUpgradesOnly. Необязательный параметр для фильтрации только по текущим или ожидающим обновления статусам. Варианты: `false` `true`
direction строка	direction (строка), направление постраничной навигации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
firmwareUpgradeBatchIds список / элементы=строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса FirmwareUpgradeBatchIds. Необязательный параметр для фильтрации по идентификаторам пакетов обновления прошивки.
headers словарь	Дополнительные заголовки.
limitPerDevice целое число	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса LimitPerDevice. Необязательный параметр для ограничения количества возвращаемых статусов обновления для каждого устройства. Если параметр не указан, используется значение 5.
macs список / элементы=строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса Macs. Необязательный параметр для фильтрации по одному или нескольким MAC-адресам устройств. Возвращаются все устройства, MAC-адреса которых точно совпадают с указанными.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать как переменную среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL, предшествующий ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать как переменную среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логический	meraki_inherit_logging_config (логический), использовать собственный экземпляр средства ведения журнала Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для выходного журнала; по умолчанию используется рабочий каталог скрипта, если путь не указан По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибки 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке Nginx 429 По умолчанию: `60`
meraki_output_log логический	meraki_output_log (логический), создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логический	meraki_print_console (логический), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error логический	meraki_retry_4xx_error (логический), повторять запрос при получении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate логический	meraki_simulate (логический), имитировать вызовы POST/PUT/DELETE, чтобы избежать внесения изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логический	meraki_suppress_logging (логический), отключить ведение всех журналов? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логический	meraki_use_iterator_for_get_pages (логический), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логический	meraki_wait_on_rate_limit (логический), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkIds список / элементы=строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса NetworkIds. Необязательный параметр для фильтрации по сети.
organizationId строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 50.
serials список / элементы=строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса Serials. Необязательный параметр для фильтрации по серийному номеру. Серийные номера всех возвращаемых устройств будут точно совпадать с указанными.
startingAfter строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages строка / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить не более total_pages*perPage результатов; -1 — все страницы
upgradeStatuses список / элементы=строка	Информационный модуль для Organizations Firmware Upgrades Bydevice Info. Параметр запроса UpgradeStatuses. Необязательный параметр для фильтрации по статусам обновления прошивки.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _firmware _upgrades _bydevice
  cisco.meraki.organizations_firmware_upgrades_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkIds: []
    serials: []
    macs: []
    firmwareUpgradeBatchIds: []
    upgradeStatuses: []
    currentUpgradesOnly: true
    limitPerDevice: 0
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"deviceStatus\": \"string\",\n \"checkinFinishedAt\": {},\n \"checkinStartedAt\": {},\n \"detailedStatus\": {},\n \"downloadFinishedAt\": {},\n \"downloadStartedAt\": {},\n \"downloadStatus\": {},\n \"installFinishedAt\": {},\n \"installStartedAt\": {},\n \"installStatus\": {},\n \"verifyFinishedAt\": {},\n \"verifyStartedAt\": {},\n \"verifyStatus\": {},\n \"upgrade\": {\n \"time\": \"string\",\n \"fromVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"toVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"status\": \"string\",\n \"id\": \"string\",\n \"upgradeBatchId\": \"string\",\n \"staged\": {\n \"group\": {\n \"id\": \"string\"\n }\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"deviceStatus\": \"string\",\n \"checkinFinishedAt\": {},\n \"checkinStartedAt\": {},\n \"detailedStatus\": {},\n \"downloadFinishedAt\": {},\n \"downloadStartedAt\": {},\n \"downloadStatus\": {},\n \"installFinishedAt\": {},\n \"installStartedAt\": {},\n \"installStatus\": {},\n \"verifyFinishedAt\": {},\n \"verifyStartedAt\": {},\n \"verifyStatus\": {},\n \"upgrade\": {\n \"time\": \"string\",\n \"fromVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"toVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"status\": \"string\",\n \"id\": \"string\",\n \"upgradeBatchId\": \"string\",\n \"staged\": {\n \"group\": {\n \"id\": \"string\"\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_firmware_upgrades_by_device_info_module.html