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

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Обзор

Получить все устройства организаций.
Отобразить устройства в организации.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
configurationUpdatedAfter string	Параметр запроса ConfigurationUpdatedAfter. Фильтрует результаты по тому, обновлялась ли конфигурация устройства после указанного момента времени.
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница Default: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна его определять.
headers dictionary	Дополнительные заголовки.
mac string	Параметр запроса Mac. Необязательный параметр для фильтрации устройств по MAC-адресу. Все возвращаемые устройства будут иметь MAC-адрес, содержащий поисковый термин или являющийся точным совпадением.
macs list / elements=string	Параметр запроса Macs. Необязательный параметр для фильтрации устройств по одному или нескольким MAC-адресам. Все возвращаемые устройства будут иметь MAC-адрес, который является точным совпадением.
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 (целое число), время ожидания повторной попытки Nginx 429 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 По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторить попытку при ошибке 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания повторной попытки при ошибке 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное количество секунд для каждого API-вызова По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить всю журнализацию? Тогда сами разбирайтесь! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторить попытку при ошибке ограничения скорости 429? Варианты: `false` `true` ← (по умолчанию)
model string	Параметр запроса model. Необязательный параметр для фильтрации устройств по модели. Все возвращаемые устройства будут иметь модель, содержащую поисковый термин или являющуюся точным совпадением.
models список / элементы=строка	Параметр запроса models. Необязательный параметр для фильтрации устройств по одной или нескольким моделям. Все возвращаемые устройства будут иметь модель, являющуюся точным совпадением.
name строка	Параметр запроса name. Необязательный параметр для фильтрации устройств по имени. Все возвращаемые устройства будут иметь имя, содержащее поисковый термин или являющееся точным совпадением.
networkIds список / элементы=строка	Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по сети.
organizationId строка	Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Параметр запроса perPage. Количество записей на страницу, возвращаемых. Допустимый диапазон составляет от 3 до 1000. По умолчанию 1000.
productTypes список / элементы=строка	Параметр запроса productTypes. Необязательный параметр для фильтрации устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway и sensor.
sensorAlertProfileIds список / элементы=строка	Параметр запроса sensorAlertProfileIds. Необязательный параметр для фильтрации устройств по профилям уведомлений, привязанным к ним. Применимо только к датчиковым устройствам.
sensorMetrics список / элементы=строка	Параметр запроса sensorMetrics. Необязательный параметр для фильтрации устройств по метрикам, которые они предоставляют. Применимо только к датчиковым устройствам.
serial строка	Параметр запроса serial. Необязательный параметр для фильтрации устройств по серийному номеру. Все возвращаемые устройства будут иметь серийный номер, содержащий поисковый термин или являющийся точным совпадением.
serials список / элементы=строка	Параметр запроса serials. Необязательный параметр для фильтрации устройств по одному или нескольким серийным номерам. Все возвращаемые устройства будут иметь серийный номер, являющийся точным совпадением.

startingAfter строка	Параметр запроса startingAfter. Маркер, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Связь для первой, последней, предыдущей или следующей страницы в заголовке HTTP Link должна его определить.
tags список / элементы=строка	Параметр запроса тегов. Необязательный параметр для фильтрации устройств по тегам.
tagsFilterType строка	Параметр запроса TagsFilterType. Необязательный параметр со значением ‘withAnyTags’ или ‘withAllTags’, указывающий, следует ли возвращать сети, содержащие ЛЮБОЙ или ВСЕ включенные теги. Если тип не указан, будет выбран ‘withAnyTags’.
total_pages строка / обязательный	total_pages(целое число), используйте с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices
  cisco.meraki.organizations_devices_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
    configurationUpdatedAfter: string
    networkIds: []
    productTypes: []
    tags: []
    tagsFilterType: string
    name: string
    mac: string
    serial: string
    model: string
    macs: []
    serials: []
    sensorMetrics: []
    sensorAlertProfileIds: []
    models: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"address\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"firmware\": \"string\",\n \"imei\": \"string\",\n \"lanIp\": \"string\",\n \"lat\": 0,\n \"lng\": 0,\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"string\",\n \"notes\": \"string\",\n \"productType\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ]\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"address\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ],\n \"firmware\": \"string\",\n \"imei\": \"string\",\n \"lanIp\": \"string\",\n \"lat\": 0,\n \"lng\": 0,\n \"mac\": \"string\",\n \"model\": \"string\",\n \"name\": \"string\",\n \"networkId\": \"string\",\n \"notes\": \"string\",\n \"productType\": \"string\",\n \"serial\": \"string\",\n \"tags\": [\n \"string\"\n ]\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_info_module.html