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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.meraki.organizations_firmware_upgrades_info.

Новое в cisco.meraki 2.16.0

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в HTTP заголовке Link должна определять его.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке параллельной обработки пакета действий По умолчанию: `60`
meraki_api_key string / required	meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), предшествует всем конечным точкам ресурсов По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная окружения BE_GEO_ID По умолчанию: `""`
meraki_caller string	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная окружения MERAKI_PYTHON_SDK_CALLER По умолчанию: `""`
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 целое число	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` ← (по умолчанию)
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Параметр запроса PerPage. Количество записей на страницу, возвращаемых результатом. Допустимый диапазон: 3 - 1000. По умолчанию 1000.
productTypes список / элементы=строка	Параметр запроса ProductTypes. Дополнительный параметр для фильтрации обновлений по типу продукта.
startingAfter строка	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницы в заголовке HTTP Link должна его определять.
status список / элементы=строка	Параметр запроса Status. Дополнительный параметр для фильтрации обновлений по статусу.
total_pages строка / обязательный	total_pages(целое число), используется с perPage для получения всех результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

Документация Cisco Meraki по API 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_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 список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"completedAt\": \"string\",\n \"fromVersion\": {\n \"firmware\": \"string\",\n \"id\": \"string\",\n \"releaseDate\": \"string\",\n \"releaseType\": \"string\",\n \"shortName\": \"string\"\n },\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"productTypes\": \"string\",\n \"status\": \"string\",\n \"time\": \"string\",\n \"toVersion\": {\n \"firmware\": \"string\",\n \"id\": \"string\",\n \"releaseDate\": \"string\",\n \"releaseType\": \"string\",\n \"shortName\": \"string\"\n },\n \"upgradeBatchId\": \"string\",\n \"upgradeId\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"completedAt\": \"string\",\n \"fromVersion\": {\n \"firmware\": \"string\",\n \"id\": \"string\",\n \"releaseDate\": \"string\",\n \"releaseType\": \"string\",\n \"shortName\": \"string\"\n },\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"productTypes\": \"string\",\n \"status\": \"string\",\n \"time\": \"string\",\n \"toVersion\": {\n \"firmware\": \"string\",\n \"id\": \"string\",\n \"releaseDate\": \"string\",\n \"releaseType\": \"string\",\n \"shortName\": \"string\"\n },\n \"upgradeBatchId\": \"string\",\n \"upgradeId\": \"string\"\n }\n]\n"

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/organizations_firmware_upgrades_info_module.html