модуль cisco.meraki.organizations_devices_availabilities_change_history_info – информационный модуль для organizations _devices _availabilities _changehistory

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.meraki.organizations_devices_availabilities_change_history_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` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации истории доступности устройств по идентификаторам сетей.
organizationId string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса ProductTypes. Необязательный параметр для фильтрации истории доступности устройств по типам продуктов устройств.
serials list / elements=string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса Serials. Необязательный параметр для фильтрации истории доступности устройств по серийным номерам.
startingAfter string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
statuses list / elements=string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса Statuses. Необязательный параметр для фильтрации истории доступности устройств по статусам устройств.
t0 string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса T0. Начало временного интервала для данных. Максимальный период, за который можно получить данные, составляет 31 день от текущей даты.
t1 string	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может отстоять от t0 не более чем на 31 день.
timespan float	Информационный модуль для получения сведений об истории изменений доступности устройств организаций. Параметр запроса Timespan. Временной интервал, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 31 день. По умолчанию — 1 день.
total_pages string / обязательный	total_pages(int), используется вместе с perPage для получения всех результатов в пределах total_pages*perPage; -1 — все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices _availabilities _changehistory
  cisco.meraki.organizations_devices_availabilities_change_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_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
    t0: string
    t1: string
    timespan: 0
    serials: []
    productTypes: []
    networkIds: []
    statuses: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращенным Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"ts\": \"string\",\n \"device\": {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"productType\": \"string\",\n \"model\": \"string\"\n },\n \"details\": {\n \"old\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"new\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"tags\": [\n \"string\"\n ]\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"ts\": \"string\",\n \"device\": {\n \"serial\": \"string\",\n \"name\": \"string\",\n \"productType\": \"string\",\n \"model\": \"string\"\n },\n \"details\": {\n \"old\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"new\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"tags\": [\n \"string\"\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_devices_availabilities_change_history_info_module.html