cisco.meraki.organizations_devices_boots_history_info модуль — Модуль информации об истории загрузки устройств организаций

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.organizations_devices_boots_history_info.

Новая версия в cisco.meraki 2.18.0

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

Описание

Получение всей истории загрузки устройств организаций.
Возвращает историю загрузки устройств в обратном хронологическом порядке, начиная с последней.
В настоящее время поддерживается только для устройств MS.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “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 (целое число), время ожидания повтора попытки при ошибке параллельной обработки действий По умолчанию: `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 integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора других ошибок 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Choices: `false` `true` ← (default)
mostRecentPerDevice boolean	Параметр запроса MostRecentPerDevice. Если true, возвращается только самая последняя загрузка для каждого устройства. Choices: `false` `true`
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон — от 3 до 1000. По умолчанию — 1000.
serials list / elements=string	Параметр запроса Serials. Необязательный параметр для фильтрации устройств по серийным номерам. Этот фильтр использует несколько точных совпадений.
sortOrder string	Параметр запроса SortOrder. Отсортированный порядок записей. Варианты порядка: «ascending» и «descending». По умолчанию — «descending».
startingAfter string	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
t0 string	Параметр запроса T0. Начало временного интервала для данных.
t1 string	Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 730 дней позже t0.
timespan float	Параметр запроса Timespan. Временной интервал, для которого будет извлечена информация. При указании timespan не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 730 дням.
total_pages string / required	total_pages(int), использовать с perPage для получения всех результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices _boots _history
  cisco.meraki.organizations_devices_boots_history_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}}"
    t0: string
    t1: string
    timespan: 0
    serials: []
    mostRecentPerDevice: True
    perPage: 0
    startingAfter: string
    endingBefore: string
    sortOrder: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `"[\n {\n \"network\": {\n \"id\": \"string\"\n },\n \"serial\": \"string\",\n \"start\": {\n \"bootedAt\": \"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_devices_boots_history_info_module.html