cisco / cisco.meraki / 2.18.0 / module / organizations_alerts_profiles Resource module for organizations _alerts _profiles | "added in version" 2.16.0 of cisco.meraki" Authors: Francisco Munoz (@fmunoz) This plugin has a corresponding action plugin.cisco.meraki.organizations_alerts_profiles (2.18.0) — module
Install with ansible-galaxy collection install cisco.meraki:==2.18.0
collections: - name: cisco.meraki version: 2.18.0
Manage operations create, update and delete of the resource organizations _alerts _profiles.
Create an organization-wide alert configuration.
Removes an organization-wide alert config.
Update an organization-wide alert config.
- name: Create cisco.meraki.organizations_alerts_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 alertCondition: bit_rate_bps: 10000 duration: 60 interface: wan1 jitter_ms: 100 latency_ms: 100 loss_ratio: 0.1 mos: 3.5 window: 600 description: WAN 1 high utilization networkTags: - tag1 - tag2 organizationId: string recipients: emails: - admin@example.org httpServerIds: - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA== type: wanUtilization
- name: Delete by id cisco.meraki.organizations_alerts_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 alertConfigId: string organizationId: string
- name: Update by id cisco.meraki.organizations_alerts_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 alertCondition: bit_rate_bps: 10000 duration: 60 interface: wan1 jitter_ms: 100 latency_ms: 100 loss_ratio: 0.1 mos: 3.5 window: 600 alertConfigId: string description: WAN 1 high utilization enabled: true networkTags: - tag1 - tag2 organizationId: string recipients: emails: - admin@example.org httpServerIds: - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA== type: wanUtilization
type: description: The alert type. type: str enabled: description: Is the alert config enabled. type: bool recipients: description: List of recipients that will recieve the alert. suboptions: emails: description: A list of emails that will receive information about the alert. elements: str type: list httpServerIds: description: A list base64 encoded urls of webhook endpoints that will receive information about the alert. elements: str type: list type: dict description: description: User supplied description of the alert. type: str networkTags: description: Networks with these tags will be monitored for the alert. elements: str type: list alertConfigId: description: AlertConfigId path parameter. Alert config ID. 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 alertCondition: description: The conditions that determine if the alert triggers. suboptions: bit_rate_bps: description: The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts. type: int duration: description: The total duration in seconds that the threshold should be crossed before alerting. type: int interface: description: The uplink observed for the alert. Interface must be one of the following wan1, wan2, wan3, cellular. type: str jitter_ms: description: The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts. type: int latency_ms: description: The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts. type: int loss_ratio: description: The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts. type: float mos: description: The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts. type: float window: description: The look back period in seconds for sensing the alert. type: int 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 organizationId: description: OrganizationId path parameter. Organization ID. 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 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 meraki_print_console: default: true description: - meraki_print_console (boolean), print logging output to console? type: bool meraki_requests_proxy: default: '' description: - meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS type: str 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 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 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: "{\n \"alertCondition\": {\n \"bit_rate_bps\": 0,\n \"duration\"\ : 0,\n \"interface\": \"string\",\n \"window\": 0\n },\n \"description\"\ : \"string\",\n \"enabled\": true,\n \"id\": \"string\",\n \"networkTags\"\ : [\n \"string\"\n ],\n \"recipients\": {\n \"emails\": [\n \"string\"\ \n ],\n \"httpServerIds\": [\n \"string\"\n ]\n },\n \"type\"\ : \"string\"\n}\n" type: dict