Spec-Zone.ru › Ansible

модуль cisco.meraki.organizations_inventory_devices_info – информационный модуль для organizations _inventory _devices

Примечание

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

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

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

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

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

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

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

  • Получить все organizations _inventory _devices.
  • Получить organizations _inventory _devices по идентификатору.
  • Вернуть отдельное устройство из инвентаря организации.
  • Вернуть инвентарь устройств организации.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

direction (string), направление постраничной навигации: страница “next” (по умолчанию) или “prev”

По умолчанию: "https://api.meraki.com/api/v1"

endingBefore

string

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

eoxStatuses

list / elements=string

Параметр запроса EoxStatuses. Фильтрация устройств по статусу EoX. Допустимые значения: ‘endOfSale’, ‘endOfSupport’, ‘nearEndOfSupport’ или ‘null’. Используйте ‘null’, чтобы отфильтровать устройства без данных EOX. Поддерживается несколько значений для фильтрации с множественным выбором.

headers

dictionary

Дополнительные заголовки.

macs

list / elements=string

Параметр запроса Macs. Поиск устройств в инвентаре по MAC-адресам.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельной обработки пакета действий

По умолчанию: 60

meraki_api_key

string / обязательный

meraki_api_key (string), API-ключ, созданный в панели управления; также можно задать с помощью переменной окружения MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), базовый URL, предшествующий всем ресурсам конечных точек

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также можно задать с помощью переменной окружения BE_GEO_ID

По умолчанию: ""

meraki_certificate_path

string

meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер

По умолчанию: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследовать собственный экземпляр регистратора

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временной меткой

По умолчанию: "meraki_api_"

meraki_log_path

string

log_path (string), путь для выходного журнала; если не указан, используется рабочий каталог скрипта

По умолчанию: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), максимальное количество повторных попыток при получении ошибки 429 или других ошибок на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке Nginx 429

По умолчанию: 60

meraki_output_log

boolean

meraki_output_log (boolean), создавать файл выходного журнала?

Допустимые значения:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (boolean), выводить журнал в консоль?

Допустимые значения:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (string), адрес прокси-сервера и порт для HTTPS, если требуется

По умолчанию: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторять запрос при других ошибках 4XX (кроме 429)?

Допустимые значения:

  • false ← (по умолчанию)
  • 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 ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API

По умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить ведение журнала? В этом случае вы действуете на свой страх и риск!

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов

Допустимые значения:

  • false ← (по умолчанию)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторять запрос при ошибке ограничения частоты запросов 429?

Допустимые значения:

  • false
  • true ← (по умолчанию)

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, campusGateway, cellularGateway, secureConnect, sensor, switch, systemsManager, wireless и wirelessController.

search

string

Параметр запроса Search. Поиск устройств в инвентаре по серийному номеру, MAC-адресу или модели.

serial

string

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

serials

list / elements=string

Параметр запроса Serials. Поиск устройств в инвентаре по серийным номерам.

startingAfter

string

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

tags

list / elements=string

Параметр запроса Tags. Фильтрация устройств по тегам. Фильтрация чувствительна к регистру. При указании tags необходимо также указать ‘tagsFilterType’ (см. ниже).

tagsFilterType

string

Параметр запроса TagsFilterType. Используется вместе с параметром ‘tags’ для фильтрации устройств, содержащих ЛЮБЫЕ или ВСЕ указанные теги. Допустимые значения: ‘withAnyTags’ или ‘withAllTags’; значение по умолчанию — ‘withAnyTags’.

total_pages

string / обязательный

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

usedState

string

Параметр запроса 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_, используются Python SDK Cisco meraki для установления соединения

См. также

См. также

Документация 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_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
    usedState: string
    search: string
    macs: []
    networkIds: []
    serials: []
    models: []
    orderNumbers: []
    tags: []
    tagsFilterType: string
    productTypes: []
    eoxStatuses: []
    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_caller: "{{ meraki_caller }}"
    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

dictionary

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

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

Пример: {"claimedAt": "string", "countryCode": "string", "details": [{"name": "string", "value": "string"}], "eox": {"endOfSaleAt": "string", "endOfSupportAt": "string", "status": "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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/organizations_inventory_devices_info_module.html

Spec-Zone.ru

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