cisco.meraki.networks_camera_quality_retention_profiles 模块 – 用于 networks _camera _qualityretentionprofiles 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：cisco.meraki.networks_camera_quality_retention_profiles。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源 networks _camera _qualityretentionprofiles 的创建、更新和删除操作。
为此网络创建新的质量保留配置文件。
为此网络删除现有的质量保留配置文件。
为此网络更新现有的质量保留配置文件。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
是否录制音频。可以是 true 或 false。默认为 false。 选项
|
|
使用云存档创建冗余视频备份。可以是 true 或 false。默认为 false。 选项
|
|
数据将存储的最大天数，或“null”以保留数据直到存储空间耗尽。 如果是前者，则可以是 1、2、3、4、5、6、7、8、9、10、14、30、60、90 天。 |
|
meraki_action_batch_retry_wait_time（整数），操作批处理并发错误重试等待时间 默认： |
|
meraki_api_key（字符串），在仪表板中生成的 API 密钥；也可以设置为环境变量 MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url（字符串），在所有端点资源之前 默认： |
|
meraki_be_geo_id（字符串），用于 API 使用情况跟踪的可选合作伙伴标识符；也可以设置为环境变量 BE_GEO_ID 默认： |
|
meraki_caller（字符串），用于 API 使用情况跟踪的可选标识符；也可以设置为环境变量 MERAKI_PYTHON_SDK_CALLER 默认： |
|
meraki_certificate_path（字符串），如果位于本地代理后面，则用于 TLS/SSL 证书验证的路径 默认： |
|
meraki_inherit_logging_config（布尔值），继承您自己的记录器实例 选项
|
|
meraki_log_file_prefix（字符串），附加日期和时间戳的日志文件名 默认： |
|
log_path（字符串），输出日志的路径；默认情况下，如果未指定，则为脚本的工作目录 默认： |
|
meraki_maximum_retries（整数），遇到 429 或其他服务器端错误时最多重试此次数 默认： |
|
meraki_nginx_429_retry_wait_time（整数），Nginx 429 重试等待时间 默认： |
|
meraki_output_log（布尔值），创建输出日志文件？ 选项
|
|
meraki_print_console（布尔值），将日志输出打印到控制台？ 选项
|
|
meraki_requests_proxy（字符串），如果需要，HTTPS 的代理服务器和端口 默认： |
|
meraki_retry_4xx_error（布尔值），如果遇到其他 4XX 错误（除了 429）是否重试？ 选项
|
|
meraki_retry_4xx_error_wait_time（整数），其他 4XX 错误重试等待时间 默认： |
|
meraki_simulate（布尔值），模拟 POST/PUT/DELETE 调用以防止更改？ 选项
|
|
meraki_single_request_timeout（整数），每次 API 调用的最大秒数 默认： |
|
meraki_suppress_logging（布尔值），禁用所有日志记录？那么您就靠自己了！ 选项
|
|
meraki_use_iterator_for_get_pages（布尔值），list* 方法将返回一个迭代器，其中包含每个对象，而不是包含所有项的完整列表 选项
|
|
meraki_wait_on_rate_limit（布尔值），如果遇到 429 速率限制错误是否重试？ 选项
|
|
删除未检测到运动超过 3 天的镜头。可以是 true 或 false。默认为 false。此设置不适用于 MV2 摄像机。 选项
|
|
摄像机将使用的运动检测器版本。仅适用于 Gen 2 摄像机。默认为 v2。 |
|
新配置文件的名称。必须唯一。此参数是必需的。 |
|
NetworkId 路径参数。网络 ID。 |
|
QualityRetentionProfileId 路径参数。质量保留配置文件 ID。 |
|
禁用需要额外带宽的功能，例如运动回顾。可以是 true 或 false。默认为 false。此设置不适用于 MV2 摄像机。 选项
|
|
此摄像机将录制视频的时间表，或者“null”表示始终录制。 |
|
所有摄像机型号的视频质量和分辨率设置。 |
|
MV12/MV22/MV72 摄像机型号的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像机的分辨率。可以是“1280x720”或“1920x1080”之一。 |
|
MV12WE 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像机的分辨率。可以是“1280x720”或“1920x1080”之一。 |
|
MV13 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1920x1080’、‘2688x1512’ 或 ‘3840x2160’ 中的一种。 |
|
MV21/MV71 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1280x720’。 |
|
MV22X/MV72X 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1280x720’、‘1920x1080’ 或 ‘2688x1512’ 中的一种。 |
|
MV32 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1080x1080’ 或 ‘2112x2112’ 中的一种。 |
|
MV33 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1080x1080’、‘2112x2112’ 或 ‘2880x2880’ 中的一种。 |
|
MV52 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1280x720’、‘1920x1080’、‘2688x1512’ 或 ‘3840x2160’ 中的一种。 |
|
MV63 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1920x1080’ 或 ‘2688x1512’ 中的一种。 |
|
MV63X 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1920x1080’、‘2688x1512’ 或 ‘3840x2160’ 中的一种。 |
|
MV93 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘1080x1080’ 或 ‘2112x2112’ 中的一种。 |
|
MV93X 型号摄像头的质量和分辨率。 |
|
摄像机的质量。可以是“标准”、“增强”或“高”之一。 |
|
摄像头的分辨率。可以是 ‘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 用于建立连接
另请参阅
另请参阅
- 关于 camera createNetworkCameraQualityRetentionProfile 的 Cisco Meraki 文档
createNetworkCameraQualityRetentionProfile API 的完整参考。
- 关于 camera deleteNetworkCameraQualityRetentionProfile 的 Cisco Meraki 文档
deleteNetworkCameraQualityRetentionProfile API 的完整参考。
- 关于 camera updateNetworkCameraQualityRetentionProfile 的 Cisco Meraki 文档
updateNetworkCameraQualityRetentionProfile API 的完整参考。
示例
- 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
返回值
通用返回值已在此处记录：此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应 返回: 总是 示例: |