Spec-Zone.ru › Ansible

Модуль cisco.meraki.networks_camera_quality_retention_profiles – Ресурсный модуль для networks_camera_qualityretentionprofiles

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.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’, чтобы хранить данные до тех пор, пока не закончится место для хранения. В первом случае это может быть один из вариантов: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 14, 30, 60, 90 дней.

meraki_action_batch_retry_wait_time

integer

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

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

meraki_api_key

string / required

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

meraki_base_url

string

meraki_base_url (string), предшествует всем ресурсам конечных точек

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

meraki_be_geo_id

string

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

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

meraki_caller

string

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

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

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 (целое число), время ожидания при повторной попытке ошибки 4XX

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

meraki_simulate

boolean

meraki_simulate (boolean), смоделировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения?

Варианты:

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

meraki_single_request_timeout

integer

meraki_single_request_timeout (целое число), максимальное количество секунд для каждого вызова 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’, чтобы всегда записывать.

videoSettings

dictionary

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

MV12/MV22/MV72

dictionary

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

quality

string

Качество камеры. Может быть одним из значений ‘Стандартный’, ‘Улучшенный’ или ‘Высокий’.

resolution

string

Разрешение камеры. Может быть одним из значений ‘1280x720’ или ‘1920x1080’.

MV12WE

dictionary

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

quality

string

Качество камеры. Может быть одним из значений ‘Стандартный’, ‘Улучшенный’ или ‘Высокий’.

resolution

string

Разрешение камеры. Может быть одним из значений ‘1280x720’ или ‘1920x1080’.

MV13

dictionary

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

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’.

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’.

MV52

dictionary

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

quality

string

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

resolution

string

Разрешение камеры. Может быть одним из значений ‘1280x720’, ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV63

dictionary

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

quality

string

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

resolution

string

Разрешение камеры. Может быть одним из значений ‘1920x1080’ или ‘2688x1512’.

MV63X

dictionary

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

quality

string

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

resolution

string

Разрешение камеры. Может быть одним из значений ‘1920x1080’, ‘2688x1512’ или ‘3840x2160’.

MV93

словарь

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

quality

строка

Качество камеры. Может быть 'Стандартным', 'Улучшенным' или 'Высоким'.

resolution

строка

Разрешение камеры. Может быть '1080x1080' или '2112x2112'.

MV93X

словарь

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

quality

строка

Качество камеры. Может быть 'Стандартным', 'Улучшенным' или 'Высоким'.

resolution

строка

Разрешение камеры. Может быть '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, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
  • Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

См. также

Документация Cisco Meraki для создания профиля хранения качества камеры

Полное описание API createNetworkCameraQualityRetentionProfile.

Документация Cisco Meraki для удаления профиля хранения качества камеры

Полное описание API deleteNetworkCameraQualityRetentionProfile.

Документация Cisco Meraki для обновления профиля хранения качества камеры

Полное описание 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_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: 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_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

- 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_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: 0
    motionBasedRetentionEnabled: true
    motionDetectorVersion: 0
    name: string
    networkId: string
    qualityRetentionProfileId: string
    restrictedBandwidthModeEnabled: true
    scheduleId: string
    videoSettings:
      MV12/MV22/MV72:
        quality: string
        resolution: string
      MV12WE:
        quality: string
        resolution: string
      MV13:
        quality: string
        resolution: string
      MV21/MV71:
        quality: string
        resolution: string
      MV22X/MV72X:
        quality: string
        resolution: string
      MV32:
        quality: string
        resolution: string
      MV33:
        quality: string
        resolution: string
      MV52:
        quality: string
        resolution: string
      MV63:
        quality: string
        resolution: string
      MV63X:
        quality: string
        resolution: string
      MV93:
        quality: string
        resolution: string
      MV93X:
        quality: string
        resolution: string

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

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

Ключ

Описание

meraki_response

словарь

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

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

Пример: {}

Авторы

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

Spec-Zone.ru

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