cisco.meraki.organizations_camera_boundaries_lines_by_device_info модуль – Информационный модуль для организаций _camera _boundaries _lines _bydevice

Примечание

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

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

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

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

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

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

Обзор

Получение всех организаций _camera _boundaries _lines _bydevice.
Возвращает все настроенные границы пересечения линий камер.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers словарь	Дополнительные заголовки.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания повторной попытки при ошибке одновременной обработки действий По умолчанию: `60`
meraki_api_key строка / обязательно	meraki_api_key (строка), ключ API, сгенерированный в панели управления; также можно задать как переменную окружения MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; также можно задать как переменную окружения BE_GEO_ID По умолчанию: `""`
... (rest of the translated table)

END_OF_DOCUMENT_MARKER

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` ← (по умолчанию)
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
serials list / elements=string	Параметр запроса serials. Список серийных номеров. Возвращаемые камеры будут отфильтрованы так, чтобы включать только эти серийные номера.

Примечания

Примечание

Используемый метод SDK - camera.Camera.get_organization_camera_boundaries_lines_by_device,
Используемые пути - get /organizations/{organizationId}/camera/boundaries/lines/byDevice,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления подключения

См. также

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

Примеры

- name: Get all organizations _camera _boundaries _lines _bydevice
  cisco.meraki.organizations_camera_boundaries_lines_by_device_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}}"
    serials: []
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список со значением ответа, возвращаемым Cisco Meraki Python SDK Возвращаемое значение: всегда Пример: `"[\n {\n \"boundaries\": {\n \"directionVertex\": {\n \"x\": 0,\n \"y\": 0\n },\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"vertices\": [\n {\n \"x\": 0,\n \"y\": 0\n }\n ]\n },\n \"networkId\": \"string\",\n \"serial\": \"string\"\n }\n]\n"`

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"boundaries\": {\n \"directionVertex\": {\n \"x\": 0,\n \"y\": 0\n },\n \"id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"vertices\": [\n {\n \"x\": 0,\n \"y\": 0\n }\n ]\n },\n \"networkId\": \"string\",\n \"serial\": \"string\"\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_camera_boundaries_lines_by_device_info_module.html