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

Примечание

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

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

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

Для использования в playbook укажите: cisco.meraki.organizations_inventory_devices_info.

Добавлен в cisco.meraki 2.16.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	Дополнительные заголовки.
macs list / elements=string	Параметр запроса Macs. Поиск устройств в инвентаре по 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 Default: `""`

meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора попытки при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Варианты: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя отвечаете! Варианты: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Варианты: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку при возникновении ошибки ограничения скорости 429? Варианты: `false` `true` ← (default)
models list / elements=string	Параметр запроса Models. Поиск устройств в инвентаре по модели.
networkIds list / elements=string	Параметр запроса NetworkIds. Поиск устройств в инвентаре по идентификаторам сетей. Используйте явное значение «null», чтобы получить только доступные устройства.
orderNumbers list / elements=string	Параметр запроса OrderNumbers. Поиск устройств в инвентаре по номерам заказов.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон — от 3 до 1000. По умолчанию — 1000.
productTypes list / elements=string	Параметр запроса ProductTypes. Фильтрация устройств по типу продукта. Допустимые значения: appliance, camera, cellularGateway, sensor, switch, systemsManager и wireless.
search string	Параметр запроса Search. Поиск устройств в инвентаре по серийному номеру, MAC-адресу или модели.
serial string	Параметр пути Serial.
serials list / elements=string	Параметр запроса Serials. Поиск устройств в инвентаре по серийным номерам.
startingAfter string	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен задаваться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
tags list / elements=string	Параметр запроса Tags. Фильтрация устройств по тегам. Фильтрация чувствительна к регистру. Если указаны теги, то также должен быть указан ‘tagsFilterType’ (см. ниже).
tagsFilterType string	Параметр запроса TagsFilterType. Для использования с параметром ‘tags’, для фильтрации устройств, которые содержат ЛЮБЫЕ или ВСЕ заданные теги. Допустимые значения: ‘withAnyTags’ или ‘withAllTags’, по умолчанию — ‘withAnyTags’.

total_pages строка / обязательно	total_pages(целое число), используется с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц
usedState строка	Параметр запроса UsedState. Фильтрует результаты по использованию или неиспользованию инвентаризации. Допустимые значения — ‘used’ или ‘unused’.

Примечания

Примечание

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

См. также

Документация Cisco Meraki для организации getOrganizationInventoryDevice: Полное описание API getOrganizationInventoryDevice.
Документация Cisco Meraki для организации getOrganizationInventoryDevices: Полное описание API getOrganizationInventoryDevices.

Примеры

- name: Get all organizations _inventory _devices
  cisco.meraki.organizations_inventory_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
    usedState: string
    search: string
    macs: []
    networkIds: []
    serials: []
    models: []
    orderNumbers: []
    tags: []
    tagsFilterType: string
    productTypes: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

- name: Get organizations _inventory _devices by id
  cisco.meraki.organizations_inventory_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}}"
    organizationId: string
    serial: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращаемым Cisco Meraki Python SDK Возвращаемое значение: всегда Пример: `{"claimedAt": "string", "countryCode": "string", "details": [{"name": "string", "value": "string"}], "licenseExpirationDate": "string", "mac": "string", "model": "string", "name": "string", "networkId": "string", "orderNumber": "string", "productType": "string", "serial": "string", "tags": ["string"]}`

Ключ

Описание

meraki_response

словарь

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

Возвращаемое значение: всегда

Пример: {"claimedAt": "string", "countryCode": "string", "details": [{"name": "string", "value": "string"}], "licenseExpirationDate": "string", "mac": "string", "model": "string", "name": "string", "networkId": "string", "orderNumber": "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/organizations_inventory_devices_info_module.html