Модуль cisco.meraki.organizations_devices_statuses_info – Модуль информации об устройствах и статусах организаций

Примечание

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

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

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

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

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

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

Описание

Получить все статусы устройств организаций.
Отобразить состояние каждого устройства Meraki в организации.

Примечание

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

Требования

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

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 (булево), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `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)
models list / elements=string	Параметр запроса Models. Необязательный параметр для фильтрации устройств по моделям.
networkIds list / elements=string	Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по идентификаторам сетей.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон от 3 до 1000. По умолчанию 1000.
productTypes list / elements=string	Параметр запроса ProductTypes. Необязательный параметр для фильтрации статусов устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway и sensor.
serials list / elements=string	Параметр запроса Serials. Необязательный параметр для фильтрации устройств по серийным номерам.
startingAfter string	Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
statuses list / elements=string	Параметр запроса Statuses. Необязательный параметр для фильтрации устройств по статусам. Допустимые статусы: “online”, “alerting”, “offline”, “dormant”.
tags list / elements=string	Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам. Фильтрация чувствительна к регистру. Если включены теги, то также должен быть включен ‘tagsFilterType’ (см. ниже).
tagsFilterType string	Параметр запроса TagsFilterType. Необязательный параметр со значением ‘withAnyTags’ или ‘withAllTags’, указывающий, следует ли возвращать устройства, которые содержат ЛЮБЫЕ или ВСЕ включенные теги. Если тип не указан, будет выбран ‘withAnyTags’.
total_pages string / required	total_pages(int), использовать с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

Cisco Meraki documentation for organizations getOrganizationDevicesStatuses: Полная справка по API getOrganizationDevicesStatuses.

Примеры

- name: Get all organizations _devices _statuses
  cisco.meraki.organizations_devices_statuses_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: []
    statuses: []
    productTypes: []
    models: []
    tags: []
    tagsFilterType: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список со значением, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"components\": {\n \"powerSupplies\": [\n {\n \"model\": \"string\",\n \"poe\": {\n \"maximum\": 0,\n \"unit\": \"string\"\n },\n \"serial\": \"string\",\n \"slot\": 0,\n \"status\": \"string\"\n }\n ]\n },\n \"gateway\": \"string\",\n \"ipType\": \"string\",\n \"lanIp\": \"string\",\n \"lastReportedAt\": \"string\",\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"string\",\n \"primaryDns\": \"string\",\n \"productType\": \"string\",\n \"publicIp\": \"string\",\n \"secondaryDns\": \"string\",\n \"serial\": \"string\",\n \"status\": \"string\",\n \"tags\": [\n \"string\"\n ]\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"components\": {\n \"powerSupplies\": [\n {\n \"model\": \"string\",\n \"poe\": {\n \"maximum\": 0,\n \"unit\": \"string\"\n },\n \"serial\": \"string\",\n \"slot\": 0,\n \"status\": \"string\"\n }\n ]\n },\n \"gateway\": \"string\",\n \"ipType\": \"string\",\n \"lanIp\": \"string\",\n \"lastReportedAt\": \"string\",\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"string\",\n \"primaryDns\": \"string\",\n \"productType\": \"string\",\n \"publicIp\": \"string\",\n \"secondaryDns\": \"string\",\n \"serial\": \"string\",\n \"status\": \"string\",\n \"tags\": [\n \"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_statuses_info_module.html