cisco.meraki.devices_camera_quality_and_retention 模块 – 用于设备 _camera _qualityandretention 的资源模块

注意

此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在剧本中使用它，请指定： cisco.meraki.devices_camera_quality_and_retention。

cisco.meraki 2.16.0 中的新增功能

概要

• 管理资源 devices _camera _qualityandretention 的操作更新。

• 更新给定摄像头的质量和保留设置。

注意

此模块具有相应的操作插件。

要求

执行此模块的主机需要满足以下要求。

• meraki >= 2.4.9

• python >= 3.5

参数

参数	注释
audioRecordingEnabled 布尔值	指示摄像头上是否启用 (true) 或禁用 (false) 音频录制的布尔值。 选择 false true
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 默认值： ""
meraki_caller 字符串	meraki_caller（字符串），用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认值： ""
meraki_certificate_path 字符串	meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认值： ""
meraki_inherit_logging_config 布尔值	meraki_inherit_logging_config（布尔值），继承您自己的记录器实例 选择 false ← (默认值) true
meraki_log_file_prefix 字符串	meraki_log_file_prefix（字符串），附加日期和时间戳的日志文件名 默认值： "meraki_api_"
meraki_log_path 字符串	log_path（字符串），输出日志的路径；如果未指定，则默认为脚本的工作目录 默认值： ""
meraki_maximum_retries 整数	meraki_maximum_retries（整数），当遇到 429 或其他服务器端错误时，最多重试此次数 默认值： 2
meraki_nginx_429_retry_wait_time 整数	meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认值： 60
meraki_output_log 布尔值	meraki_output_log（布尔值），创建输出日志文件？ 选择 false true ← (默认值)
meraki_print_console 布尔值	meraki_print_console（布尔值），将日志输出打印到控制台？ 选择 false true ← (默认值)
meraki_requests_proxy 字符串	meraki_requests_proxy（字符串），如果需要，用于 HTTPS 的代理服务器和端口 默认值： ""
meraki_retry_4xx_error 布尔值	meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429）是否重试？ 选择 false ← (默认值) true
meraki_retry_4xx_error_wait_time 整数	meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间 默认值： 60
meraki_simulate 布尔值	meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？ 选择 false ← (默认值) true
meraki_single_request_timeout 整数	meraki_single_request_timeout（整数），每次 API 调用的最大秒数 默认值： 60
meraki_suppress_logging 布尔值	meraki_suppress_logging（布尔值），禁用所有日志记录？那您就自己看着办吧！ 选择 false ← (默认值) true
meraki_use_iterator_for_get_pages 布尔值	meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回每个对象的迭代器，而不是包含所有项的完整列表 选择 false ← (默认值) true
meraki_wait_on_rate_limit 布尔值	meraki_wait_on_rate_limit（布尔值），如果遇到 429 速率限制错误是否重试？ 选择 false true ← (默认值)
motionBasedRetentionEnabled 布尔值	指示摄像头上是否启用 (true) 或禁用 (false) 基于运动的保留的布尔值。 选择 false true
motionDetectorVersion 整数	摄像头将使用的运动检测器版本。仅适用于 Gen 2 摄像头。默认为 v2。
profileId 字符串	要分配给摄像头的质量和保留配置文件的 ID。配置文件的设置将覆盖所有按摄像头质量和保留设置。如果此参数的值为空，则将从摄像头取消分配任何现有配置文件。
quality 字符串	摄像头的质量。可以是“标准”、“高”或“增强”之一。并非所有摄像头型号都支持所有质量。
resolution 字符串	摄像头的分辨率。可以是“1280x720”、“1920x1080”、“1080x1080”、“2112x2112”、“2880x2880”、“2688x1512”或“3840x2160”之一。并非所有摄像头型号都支持所有分辨率。
restrictedBandwidthModeEnabled 布尔值	布尔值，指示摄像头是否启用（true）或禁用（false）了受限带宽。此设置不适用于 MV2 摄像头。 选择 false true
serial 字符串	串行路径参数。

注释

注意

• 使用的 SDK 方法是 camera.Camera.update_device_camera_quality_and_retention，

• 使用的路径是 put /devices/{serial}/camera/qualityAndRetention，

• 不支持 check_mode

• 该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关摄像头 updateDeviceCameraQualityAndRetention 的 Cisco Meraki 文档

updateDeviceCameraQualityAndRetention API 的完整参考。

示例

- name: Update all
  cisco.meraki.devices_camera_quality_and_retention:
    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: false
    motionBasedRetentionEnabled: false
    motionDetectorVersion: 2
    profileId: '1234'
    quality: Standard
    resolution: 1280x720
    restrictedBandwidthModeEnabled: false
    serial: string

返回值

通用返回值记录在这里，以下是此模块特有的字段

键	描述
meraki_response 字典	包含 Cisco Meraki Python SDK 返回的响应的字典或列表 返回: 总是 示例: {}

作者

• Francisco Munoz (@fmunoz)

集合链接

• 问题跟踪器
• 存储库（源代码）