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

Примечание

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

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

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

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

Новая функция в cisco.meraki 2.18.0

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница Default: `"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 (целое число), время ожидания повтора попытки при ошибке параллельной обработки пакета действий 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 (целое число), время ожидания повтора попытки при ошибке 429 Nginx 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 Default: `""`

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. По умолчанию 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 может быть максимум через 31 день после t0.
timespan float	Параметр запроса Timespan. Временной интервал, для которого будет извлечена информация. Если задается timespan, не задавайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 31 дню. По умолчанию 1 день.
total_pages string / обязательно	total_pages(int), используется с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

END_OF_DOCUMENT_MARKER

Примечания

Примечание

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

См. также

Документация Cisco Meraki по организации 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_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 список / элементы=словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"details\": {\n \"new\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"old\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n },\n \"device\": {\n \"model\": \"string\",\n \"name\": \"string\",\n \"productType\": \"string\",\n \"serial\": \"string\"\n },\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"url\": \"string\"\n },\n \"ts\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

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