Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новый в cisco.meraki 2.16.0

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

Обзор

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

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

direction

string

direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница

Default: "https://api.meraki.com/api/v1"

endingBefore

string

Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.

firmwareUpgradeBatchIds

list / elements=string

Параметр запроса FirmwareUpgradeBatchIds. Необязательный параметр для фильтрации по идентификаторам пакетов обновления прошивки.

headers

dictionary

Дополнительные заголовки.

macs

list / elements=string

Параметр запроса Macs. Необязательный параметр для фильтрации по одному или нескольким MAC-адресам, принадлежащим устройствам. Все возвращаемые устройства принадлежат к MAC-адресам, которые являются точным совпадением.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке параллельной обработки пакета действий

Default: 60

meraki_api_key

string / required

meraki_api_key (строка), ключ API, сгенерированный на панели управления; также может быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (строка), предшествует всем конечным точкам ресурсов

Default: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также может быть установлен как переменная среды BE_GEO_ID

Default: ""

meraki_caller

string

meraki_caller (строка), необязательный идентификатор для отслеживания использования API; также может быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER

Default: ""

meraki_certificate_path

string

meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер

Default: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (логическое значение), наследует собственный экземпляр регистратора

Choices:

  • false ← (default)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (строка), имя файла журнала с добавленной датой и меткой времени

Default: "meraki_api_"

meraki_log_path

string

log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указан

Default: ""

meraki_maximum_retries

integer

meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера

Default: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (целое число), время ожидания повторной попытки Nginx 429

Default: 60

meraki_output_log

boolean

meraki_output_log (логическое значение), создать файл выходного журнала?

Choices:

  • false
  • true ← (default)

meraki_print_console

boolean

meraki_print_console (логическое значение), выводить сообщения журнала в консоль?

Choices:

  • false
  • true ← (default)

meraki_requests_proxy

string

meraki_requests_proxy (строка), прокси-сервер и порт, если необходимо, для 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 (целое число), время ожидания при повторной попытке других ошибок 4XX

По умолчанию: 60

meraki_simulate

boolean

meraki_simulate (boolean), симулировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова 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

Параметр запроса NetworkIds. Необязательный параметр для фильтрации по сети.

organizationId

string

Параметр пути OrganizationId. Идентификатор организации.

perPage

integer

Параметр запроса PerPage. Количество записей на страницу, возвращаемых. Допустимый диапазон 3 - 1000. По умолчанию 50.

serials

list / elements=string

Параметр запроса Serials. Необязательный параметр для фильтрации по серийному номеру. Все возвращаемые устройства будут иметь серийный номер, который является точным совпадением.

startingAfter

string

Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это отметка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определять.

total_pages

string / обязательно

total_pages(int), использовать с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

upgradeStatuses

list / elements=string

Параметр запроса UpgradeStatuses. Необязательный параметр для фильтрации по статусам обновления прошивки.

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki по организации 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_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: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Значения возврата

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

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n  {\n    \"deviceStatus\": \"string\",\n    \"name\": \"string\",\n    \"serial\": \"string\",\n    \"upgrade\": {\n      \"fromVersion\": {\n        \"id\": \"string\",\n        \"releaseDate\": \"string\",\n        \"releaseType\": \"string\",\n        \"shortName\": \"string\"\n      },\n      \"id\": \"string\",\n      \"staged\": {\n        \"group\": {\n          \"id\": \"string\"\n        }\n      },\n      \"status\": \"string\",\n      \"time\": \"string\",\n      \"toVersion\": {\n        \"id\": \"string\",\n        \"releaseDate\": \"string\",\n        \"releaseType\": \"string\",\n        \"shortName\": \"string\"\n      },\n      \"upgradeBatchId\": \"string\"\n    }\n  }\n]\n"

Авторы

  • Франциско Муньос (@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_by_device_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API