Модуль cisco.meraki.organizations_floor_plans_auto_locate_devices_info — информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций.
Получение всех организаций _floor _plans _auto _locate _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.
floorPlanIds list / elements=string	Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций. Параметр запроса FloorPlanIds. Необязательный параметр для фильтрации устройств по одному или нескольким идентификаторам поэтажных планов.
headers dictionary	Дополнительные заголовки.
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 для всех конечных точек API По умолчанию: `"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` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по одному или нескольким идентификаторам сетей.
organizationId string	Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–10000. Значение по умолчанию — 1000.
startingAfter string	Информационный модуль для автоматического определения местоположения устройств на поэтажных планах организаций. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но токен не обязательно должен иметь один из этих форматов. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int) — используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу organizations getOrganizationFloorPlansAutoLocateDevices: Полный справочник по API getOrganizationFloorPlansAutoLocateDevices.

Примеры

- name: Get all organizations _floor _plans _auto _locate _devices
  cisco.meraki.organizations_floor_plans_auto_locate_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
    networkIds: []
    floorPlanIds: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"items\": [\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"model\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"status\": \"string\",\n \"network\": {\n \"id\": \"string\"\n },\n \"floorPlan\": {\n \"id\": \"string\",\n \"status\": \"string\"\n },\n \"lat\": 0,\n \"lng\": 0,\n \"autoLocate\": {\n \"lat\": 0,\n \"lng\": 0\n },\n \"type\": \"string\",\n \"isAnchor\": true\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\n }\n }\n }\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"items\": [\n {\n \"name\": \"string\",\n \"serial\": \"string\",\n \"mac\": \"string\",\n \"model\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"status\": \"string\",\n \"network\": {\n \"id\": \"string\"\n },\n \"floorPlan\": {\n \"id\": \"string\",\n \"status\": \"string\"\n },\n \"lat\": 0,\n \"lng\": 0,\n \"autoLocate\": {\n \"lat\": 0,\n \"lng\": 0\n },\n \"type\": \"string\",\n \"isAnchor\": true\n }\n ],\n \"meta\": {\n \"counts\": {\n \"items\": {\n \"total\": 0,\n \"remaining\": 0\n }\n }\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_floor_plans_auto_locate_devices_info_module.html