Spec-Zone.ru › Ansible

cisco.meraki.devices_info модуль — Модуль информации о устройствах

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.meraki.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. Необязательный параметр для фильтрации устройств по типу продукта. Допустимые типы — беспроводной, прибор, коммутатор, systemsManager, камера, cellularGateway и датчик.

sensorAlertProfileIds

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

Параметр запроса SensorAlertProfileIds. Необязательный параметр для фильтрации устройств по связанным с ними профилям оповещений. Применяется только к датчикам.

sensorMetrics

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

Параметр запроса SensorMetrics. Необязательный параметр для фильтрации устройств по предоставляемым ими метрикам. Применяется только к датчикам.

serial

строка

Параметр пути Serial.

serials

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

Параметр запроса Serials. Необязательный параметр для фильтрации устройств по одному или нескольким серийным номерам. Все возвращаемые устройства будут иметь серийный номер, являющийся точным совпадением.

startingAfter

строка

Параметр запроса StartingAfter. Маркер, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но не только они. Этот параметр не должен задаваться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определить его.

метки

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

Параметр запроса меток. Дополнительный параметр для фильтрации устройств по меткам.

tagsFilterType

строка

Параметр запроса TagsFilterType. Дополнительный параметр со значениями 'withAnyTags' или 'withAllTags', указывающий, нужно ли возвращать сети, содержащие ЛЮБУЮ или ВСЕ включенные метки. Если тип не указан, будет выбран 'withAnyTags'.

total_pages

строка / обязательно

total_pages(целое число), используется с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

См. также

Документация Cisco Meraki для устройства getDevice

Полное описание API getDevice.

Документация Cisco Meraki для устройств getOrganizationDevices

Полное описание API getOrganizationDevices.

Примеры

- name: Get all devices
  cisco.meraki.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

- name: Get devices by id
  cisco.meraki.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}}"
    serial: string
  register: result

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"address": "string", "details": [{"name": "string", "value": "string"}], "firmware": "string", "imei": "string", "lanIp": "string", "lat": 0, "lng": 0, "mac": "string", "model": "string", "name": "string", "networkId": "string", "notes": "string", "productType": "string", "serial": "string", "tags": ["string"]}

Авторы

  • 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/devices_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API