модуль cisco.meraki.organizations_devices_statuses_info — информационный модуль для статусов устройств организаций

Примечание

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

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

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

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

Добавлено в cisco.meraki 1.0.0

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

Краткое описание

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

Примечание

Этому модулю соответствует модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction строка	direction (строка), направление пагинации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый адрес перед ресурсами конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе через локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать экземпляр вашего регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), к имени файла журнала добавляются дата и временная метка По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять попытку при других ошибках 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить все журналы? Тогда вы предоставлены сами себе! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять попытку при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
models список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса Models. Необязательный параметр для фильтрации устройств по моделям.
networkIds список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по идентификаторам сетей.
organizationId строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. По умолчанию — 1000.
productTypes список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса ProductTypes. Необязательный параметр для фильтрации статусов устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway и secureConnect.
serials список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса Serials. Необязательный параметр для фильтрации устройств по серийным номерам.
startingAfter строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это временная метка или идентификатор, но это не обязательно. Клиентские приложения не должны задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
statuses список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса Statuses. Необязательный параметр для фильтрации устройств по статусам. Допустимые статусы: “online”, “alerting”, “offline”, “dormant”.
tags список / элементы=строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам. Фильтрация чувствительна к регистру. Если указаны теги, следует также указать ‘tagsFilterType’ (см. ниже).
tagsFilterType строка	Информационный модуль для получения сведений о статусах устройств организаций. Параметр запроса TagsFilterType. Необязательный параметр со значением ‘withAnyTags’ или ‘withAllTags’, указывающий, возвращать ли устройства, содержащие ЛЮБОЙ из указанных тегов или ВСЕ указанные теги. Если тип не задан, будет выбрано значение ‘withAnyTags’.
total_pages строка / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу 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_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
    networkIds: []
    serials: []
    statuses: []
    productTypes: []
    models: []
    tags: []
    tagsFilterType: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

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

Ключ

Описание

meraki_response

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

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

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

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