Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_camera_quality_retention_profiles — модуль ресурса для networks _camera _qualityretentionprofiles

Примечание

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

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

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

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

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

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

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

  • Управление операциями создания, обновления и удаления ресурса networks _camera _qualityretentionprofiles.
  • Создание профиля хранения данных о качестве для этой сети.
  • Удаление существующего профиля хранения данных о качестве для этой сети.
  • Обновление существующего профиля хранения данных о качестве для этой сети.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

audioRecordingEnabled

boolean

Записывать ли звук. Может иметь значение true или false. По умолчанию — false.

Варианты:

  • false
  • true

cloudArchiveEnabled

boolean

Создавать резервную копию видео в Cloud Archive. Может иметь значение true или false. По умолчанию — false.

Варианты:

  • false
  • true

maxRetentionDays

integer

Максимальное количество дней хранения данных или ‘null’, чтобы хранить данные до заполнения хранилища. В первом случае значение может составлять от одного до девяноста дней.

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), время ожидания перед повторной попыткой при ошибке 429 от Nginx

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

motionBasedRetentionEnabled

boolean

Удалять видеозаписи старше 3 дней, в которых не обнаружено движения. Может иметь значение true или false. По умолчанию — false. Эта настройка не применяется к камерам MV2.

Варианты:

  • false
  • true

motionDetectorVersion

integer

Версия детектора движения, используемая камерой. Применяется только к камерам Gen 2. По умолчанию — v2.

name

string

Название нового профиля. Должно быть уникальным. Этот параметр обязателен.

networkId

string

Параметр пути NetworkId. Идентификатор сети.

qualityRetentionProfileId

string

Параметр пути QualityRetentionProfileId. Идентификатор профиля хранения качества.

restrictedBandwidthModeEnabled

boolean

Отключить функции, требующие дополнительной пропускной способности, например Motion Recap. Может иметь значение true или false. По умолчанию — false. Эта настройка не применяется к камерам MV2.

Варианты:

  • false
  • true

scheduleId

string

Расписание записи видео этой камерой или ‘null’ для постоянной записи.

smartRetention

dictionary

Smart Retention записывает видео в двух форматах качества и интеллектуально сохраняет более качественную запись при обнаружении движения, людей или транспортных средств.

enabled

boolean

Логическое значение, указывающее, включена ли Smart Retention (true) или отключена (false).

Варианты:

  • false
  • true

videoSettings

dictionary

Настройки качества и разрешения видео для всех моделей камер.

MV12/MV22/MV72

dictionary

Качество и разрешение для моделей камер MV12/MV22/MV72.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1280x720’ или ‘1920x1080’.

MV12WE

dictionary

Качество и разрешение для моделей камер MV12WE.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1280x720’ или ‘1920x1080’.

MV13

dictionary

Качество и разрешение для моделей камер MV13.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV13M

dictionary

Качество и разрешение для моделей камер MV13M.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV21/MV71

dictionary

Качество и разрешение для моделей камер MV21/MV71.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможное значение: ‘1280x720’.

MV22X/MV72X

dictionary

Качество и разрешение для моделей камер MV22X/MV72X.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1280x720’, ‘1920x1080’ или ‘2688x1512’.

MV23

dictionary

Качество и разрешение для моделей камер MV23.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Возможные значения: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV23M

dictionary

Качество и разрешение для моделей камер MV23M.

quality

string

Качество изображения камеры. Возможные значения: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV23X

dictionary

Качество и разрешение для моделей камер MV23X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV32

dictionary

Качество и разрешение для моделей камер MV32.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’ или ‘2112x2112’.

MV33

dictionary

Качество и разрешение для моделей камер MV33.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’, ‘2112x2112’ или ‘2880x2880’.

MV33M

dictionary

Качество и разрешение для моделей камер MV33M.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’, ‘2112x2112’ или ‘2880x2880’.

MV52

dictionary

Качество и разрешение для моделей камер MV52.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1280x720’, ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV53X

dictionary

Качество и разрешение для моделей камер MV53X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV63

dictionary

Качество и разрешение для моделей камер MV63.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV63M

dictionary

Качество и разрешение для моделей камер MV63M.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV63X

dictionary

Качество и разрешение для моделей камер MV63X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV73

dictionary

Качество и разрешение для моделей камер MV73.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV73M

dictionary

Качество и разрешение для моделей камер MV73M.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV73X

dictionary

Качество и разрешение для моделей камер MV73X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV84X

dictionary

Качество и разрешение для моделей камер MV84X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’ или ‘Enhanced’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1440x1080’ или ‘2560x1920’.

MV93

dictionary

Качество и разрешение для моделей камер MV93.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’, ‘2112x2112’ или ‘2880x2880’.

MV93M

dictionary

Качество и разрешение для моделей камер MV93M.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’, ‘2112x2112’ или ‘2880x2880’.

MV93X

dictionary

Качество и разрешение для моделей камер MV93X.

quality

string

Качество камеры. Может быть одним из следующих: ‘Standard’, ‘Enhanced’ или ‘High’.

resolution

string

Разрешение камеры. Может быть одним из следующих: ‘1080x1080’, ‘2112x2112’ или ‘2880x2880’.

Примечания

Примечание

  • Используются методы SDK: camera.Camera.create_network_camera_quality_retention_profile, camera.Camera.delete_network_camera_quality_retention_profile, camera.Camera.update_network_camera_quality_retention_profile,
  • Используются пути: post /networks/{networkId}/camera/qualityRetentionProfiles, delete /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId}, put /networks/{networkId}/camera/qualityRetentionProfiles/{qualityRetentionProfileId},
  • Не поддерживается check_mode
  • Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений
  • из Python SDK Cisco Dashboard API
  • Параметры, начинающиеся с dnac_, используются Python SDK Cisco DNAC для установки подключения

См. также

См. также

Документация Cisco Meraki для camera createNetworkCameraQualityRetentionProfile

Полный справочник по API createNetworkCameraQualityRetentionProfile.

Документация Cisco Meraki для camera deleteNetworkCameraQualityRetentionProfile

Полный справочник по API deleteNetworkCameraQualityRetentionProfile.

Документация Cisco Meraki для camera updateNetworkCameraQualityRetentionProfile

Полный справочник по API updateNetworkCameraQualityRetentionProfile.

Примеры

- name: Create
  cisco.meraki.networks_camera_quality_retention_profiles:
    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 }}"
    state: present
    name: Sample quality retention profile
    networkId: string
- name: Update by id
  cisco.meraki.networks_camera_quality_retention_profiles:
    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 }}"
    state: present
    audioRecordingEnabled: true
    cloudArchiveEnabled: true
    maxRetentionDays: {}
    motionBasedRetentionEnabled: true
    motionDetectorVersion: 0
    name: string
    networkId: string
    qualityRetentionProfileId: string
    restrictedBandwidthModeEnabled: true
    scheduleId: {}
    smartRetention:
      enabled: true
    videoSettings:
      MV12/MV22/MV72:
        quality: string
        resolution: string
      MV12WE:
        quality: string
        resolution: string
      MV13:
        quality: string
        resolution: string
      MV13M:
        quality: string
        resolution: string
      MV21/MV71:
        quality: string
        resolution: string
      MV22X/MV72X:
        quality: string
        resolution: string
      MV23:
        quality: string
        resolution: string
      MV23M:
        quality: string
        resolution: string
      MV23X:
        quality: string
        resolution: string
      MV32:
        quality: string
        resolution: string
      MV33:
        quality: string
        resolution: string
      MV33M:
        quality: string
        resolution: string
      MV52:
        quality: string
        resolution: string
      MV53X:
        quality: string
        resolution: string
      MV63:
        quality: string
        resolution: string
      MV63M:
        quality: string
        resolution: string
      MV63X:
        quality: string
        resolution: string
      MV73:
        quality: string
        resolution: string
      MV73M:
        quality: string
        resolution: string
      MV73X:
        quality: string
        resolution: string
      MV84X:
        quality: string
        resolution: string
      MV93:
        quality: string
        resolution: string
      MV93M:
        quality: string
        resolution: string
      MV93X:
        quality: string
        resolution: string
- name: Delete by id
  cisco.meraki.networks_camera_quality_retention_profiles:
    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 }}"
    state: absent
    networkId: string
    qualityRetentionProfileId: string

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

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

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"audioRecordingEnabled": true, "cloudArchiveEnabled": true, "id": "string", "maxRetentionDays": 0, "motionBasedRetentionEnabled": true, "motionDetectorVersion": 0, "name": "string", "networkId": "string", "restrictedBandwidthModeEnabled": true, "scheduleId": {}, "smartRetention": {"enabled": true}, "videoSettings": {}}

Авторы

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

Spec-Zone.ru

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