cisco.meraki.organizations_alerts_profiles 模块 – 用于组织_alerts_profiles 的资源模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：cisco.meraki.organizations_alerts_profiles。
cisco.meraki 2.16.0 中的新增功能
概要
管理资源组织_alerts_profiles 的创建、更新和删除操作。
创建组织范围的警报配置。
删除组织范围的警报配置。
更新组织范围的警报配置。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
确定警报是否触发的条件。 |
|
指标必须跨越的阈值才能有效触发警报。仅用于 WAN 利用率警报。 |
|
阈值应在触发警报之前跨越的总持续时间（以秒为单位）。 |
|
警报观察到的上行链路。接口必须是以下之一：wan1、wan2、wan3、cellular。 |
|
指标必须跨越的阈值才能有效触发警报。仅用于 VoIP 抖动警报。 |
|
指标必须跨越的阈值才能有效触发警报。仅用于 WAN 延迟警报。 |
|
指标必须跨越的阈值才能有效触发警报。仅用于数据包丢失警报。 |
|
指标必须降至以下阈值才能有效触发警报。仅用于 VoIP MOS 警报。 |
|
用于感应警报的回溯时间段（以秒为单位）。 |
|
AlertConfigId 路径参数。警报配置 ID。 |
|
用户提供的警报描述。 |
|
是否启用警报配置。 选项
|
|
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 速率限制错误是否重试？ 选项
|
|
具有这些标签的网络将受到警报监控。 |
|
OrganizationId 路径参数。组织 ID。 |
|
将接收警报的收件人列表。 |
|
将接收有关警报信息的电子邮件列表。 |
|
将接收有关警报信息的 webhook 端点的 base64 编码 URL 列表。 |
|
警报类型。 |
备注
注意
使用的 SDK 方法是 organizations.Organizations.create_organization_alerts_profile，organizations.Organizations.delete_organization_alerts_profile，organizations.Organizations.update_organization_alerts_profile。
使用的路径是 post /organizations/{organizationId}/alerts/profiles，delete /organizations/{organizationId}/alerts/profiles/{alertConfigId}，put /organizations/{organizationId}/alerts/profiles/{alertConfigId}。
不支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco Meraki 文档，关于 organizations createOrganizationAlertsProfile
createOrganizationAlertsProfile API 的完整参考。
- Cisco Meraki 文档，关于 organizations deleteOrganizationAlertsProfile
deleteOrganizationAlertsProfile API 的完整参考。
- Cisco Meraki 文档，关于 organizations updateOrganizationAlertsProfile
updateOrganizationAlertsProfile API 的完整参考。
示例
- 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:
- [email protected]
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:
- [email protected]
httpServerIds:
- aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA==
type: wanUtilization
返回值
常用返回值记录在这里，以下是此模块独有的字段。
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应。 返回: 始终 示例: |