Модуль cisco.meraki.organizations_firmware_upgrades_info — информационный модуль для обновлений прошивки организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об обновлениях прошивки организаций.
Получение всех обновлений прошивки организаций.
Получение сведений об обновлениях прошивки для организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (string), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр запроса 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` ← (по умолчанию)
organizationId string	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр запроса PerPage. Число записей на странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр запроса ProductTypes. Необязательный параметр для фильтрации обновлений по типу продукта.
startingAfter string	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
status list / elements=string	Информационный модуль для получения сведений об обновлениях прошивки организаций. Параметр запроса Status. Необязательный параметр для фильтрации обновлений по статусу.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее число результатов, равное не более total_pages*perPage; -1 — все страницы

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу organizations getOrganizationFirmwareUpgrades: Полное описание API getOrganizationFirmwareUpgrades.

Примеры

- name: Get all organizations _firmware _upgrades
  cisco.meraki.organizations_firmware_upgrades_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
    status: []
    productTypes: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"upgradeId\": \"string\",\n \"upgradeBatchId\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"status\": \"string\",\n \"time\": \"string\",\n \"completedAt\": \"string\",\n \"productTypes\": \"string\",\n \"toVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"firmware\": \"string\",\n \"releaseType\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"fromVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"firmware\": \"string\",\n \"releaseType\": \"string\",\n \"releaseDate\": \"string\"\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"upgradeId\": \"string\",\n \"upgradeBatchId\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"status\": \"string\",\n \"time\": \"string\",\n \"completedAt\": \"string\",\n \"productTypes\": \"string\",\n \"toVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"firmware\": \"string\",\n \"releaseType\": \"string\",\n \"releaseDate\": \"string\"\n },\n \"fromVersion\": {\n \"id\": \"string\",\n \"shortName\": \"string\",\n \"firmware\": \"string\",\n \"releaseType\": \"string\",\n \"releaseDate\": \"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_firmware_upgrades_info_module.html