Try SpotterResource module for networks _camera _qualityretentionprofiles
| "added in version" 2.16.0 of cisco.meraki"
Authors: Francisco Munoz (@fmunoz)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections:
- name: cisco.meraki
version: 2.18.0Manage operations create, update and delete of the resource networks _camera _qualityretentionprofiles.
Creates new quality retention profile for this network.
Delete an existing quality retention profile for this network.
Update an existing quality retention profile for this network.
- 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
name:
description: The name of the new profile. Must be unique. This parameter is required.
type: str
networkId:
description: NetworkId path parameter. Network ID.
type: str
scheduleId:
description: Schedule for which this camera will record video, or 'null' to always
record.
type: str
meraki_caller:
default: ''
description:
- meraki_caller (string), optional identifier for API usage tracking; can also be
set as an environment variable MERAKI_PYTHON_SDK_CALLER
type: str
videoSettings:
description: Video quality and resolution settings for all the camera models.
suboptions:
MV12/MV22/MV72:
description: Quality and resolution for MV12/MV22/MV72 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1280x720' or '1920x1080'.
type: str
type: dict
MV12WE:
description: Quality and resolution for MV12WE camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1280x720' or '1920x1080'.
type: str
type: dict
MV13:
description: Quality and resolution for MV13 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1920x1080', '2688x1512'
or '3840x2160'.
type: str
type: dict
MV21/MV71:
description: Quality and resolution for MV21/MV71 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1280x720'.
type: str
type: dict
MV22X/MV72X:
description: Quality and resolution for MV22X/MV72X camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1280x720', '1920x1080'
or '2688x1512'.
type: str
type: dict
MV32:
description: Quality and resolution for MV32 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1080x1080' or '2112x2112'.
type: str
type: dict
MV33:
description: Quality and resolution for MV33 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1080x1080', '2112x2112'
or '2880x2880'.
type: str
type: dict
MV52:
description: Quality and resolution for MV52 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1280x720', '1920x1080',
'2688x1512' or '3840x2160'.
type: str
type: dict
MV63:
description: Quality and resolution for MV63 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1920x1080' or '2688x1512'.
type: str
type: dict
MV63X:
description: Quality and resolution for MV63X camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1920x1080', '2688x1512'
or '3840x2160'.
type: str
type: dict
MV93:
description: Quality and resolution for MV93 camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1080x1080' or '2112x2112'.
type: str
type: dict
MV93X:
description: Quality and resolution for MV93X camera models.
suboptions:
quality:
description: Quality of the camera. Can be one of 'Standard', 'Enhanced' or
'High'.
type: str
resolution:
description: Resolution of the camera. Can be one of '1080x1080', '2112x2112'
or '2880x2880'.
type: str
type: dict
type: dict
meraki_api_key:
description:
- meraki_api_key (string), API key generated in dashboard; can also be set as an environment
variable MERAKI_DASHBOARD_API_KEY
required: true
type: str
meraki_base_url:
default: https://api.meraki.com/api/v1
description:
- meraki_base_url (string), preceding all endpoint resources
type: str
meraki_log_path:
default: ''
description:
- log_path (string), path to output log; by default, working directory of script if
not specified
type: str
meraki_simulate:
default: false
description:
- meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes?
type: bool
maxRetentionDays:
description: The maximum number of days for which the data will be stored, or 'null'
to keep data until storage space runs out. If the former, it can be one of 1, 2,
3, 4, 5, 6, 7, 8, 9, 10, 14, 30, 60, 90 days.
type: int
meraki_be_geo_id:
default: ''
description:
- meraki_be_geo_id (string), optional partner identifier for API usage tracking; can
also be set as an environment variable BE_GEO_ID
type: str
meraki_output_log:
default: true
description:
- meraki_output_log (boolean), create an output log file?
type: bool
cloudArchiveEnabled:
description: Create redundant video backup using Cloud Archive. Can be either true
or false. Defaults to false.
type: bool
meraki_print_console:
default: true
description:
- meraki_print_console (boolean), print logging output to console?
type: bool
audioRecordingEnabled:
description: Whether or not to record audio. Can be either true or false. Defaults
to false.
type: bool
meraki_requests_proxy:
default: ''
description:
- meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS
type: str
motionDetectorVersion:
description: The version of the motion detector that will be used by the camera. Only
applies to Gen 2 cameras. Defaults to v2.
type: int
meraki_log_file_prefix:
default: meraki_api_
description:
- meraki_log_file_prefix (string), log file name appended with date and timestamp
type: str
meraki_maximum_retries:
default: 2
description:
- meraki_maximum_retries (integer), retry up to this many times when encountering
429s or other server-side errors
type: int
meraki_retry_4xx_error:
default: false
description:
- meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides
429)?
type: bool
meraki_certificate_path:
default: ''
description:
- meraki_certificate_path (string), path for TLS/SSL certificate verification if behind
local proxy
type: str
meraki_suppress_logging:
default: false
description:
- meraki_suppress_logging (boolean), disable all logging? you're on your own then!
type: bool
meraki_wait_on_rate_limit:
default: true
description:
- meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered?
type: bool
qualityRetentionProfileId:
description: QualityRetentionProfileId path parameter. Quality retention profile ID.
type: str
motionBasedRetentionEnabled:
description: Deletes footage older than 3 days in which no motion was detected. Can
be either true or false. Defaults to false. This setting does not apply to MV2 cameras.
type: bool
meraki_inherit_logging_config:
default: false
description:
- meraki_inherit_logging_config (boolean), Inherits your own logger instance
type: bool
meraki_single_request_timeout:
default: 60
description:
- meraki_single_request_timeout (integer), maximum number of seconds for each API
call
type: int
restrictedBandwidthModeEnabled:
description: Disable features that require additional bandwidth such as Motion Recap.
Can be either true or false. Defaults to false. This setting does not apply to MV2
cameras.
type: bool
meraki_nginx_429_retry_wait_time:
default: 60
description:
- meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time
type: int
meraki_retry_4xx_error_wait_time:
default: 60
description:
- meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time
type: int
meraki_use_iterator_for_get_pages:
default: false
description:
- meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator
with each object instead of a complete list with all items
type: bool
meraki_action_batch_retry_wait_time:
default: 60
description:
- meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry
wait time
type: int
meraki_response:
description: A dictionary or list with the response returned by the Cisco Meraki
Python SDK
returned: always
sample: '{}
'
type: dict