cisco.meraki.networks_events_info 模块 – 网络事件信息模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.meraki。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 Playbook 中使用它，请指定：cisco.meraki.networks_events_info。
cisco.meraki 2.16.0 中的新功能
概要
获取所有网络事件。
列出网络的事件。
注意
此模块具有相应的 action 插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ClientIp 查询参数。客户端的 IP，将使用它来过滤事件列表。仅支持按 IP 跟踪的网络。 |
|
ClientMac 查询参数。客户端的 MAC 地址，将使用它来过滤事件列表。仅支持按 MAC 跟踪的网络。 |
|
ClientName 查询参数。客户端的名称或部分名称，将使用它来过滤事件列表。 |
|
DeviceMac 查询参数。Meraki 设备的 MAC 地址，将使用它来过滤事件列表。 |
|
DeviceName 查询参数。Meraki 设备的名称，将使用它来过滤事件列表。 |
|
DeviceSerial 查询参数。Meraki 设备的序列号，将使用它来过滤事件列表。 |
|
方向 (字符串)，分页方向，可以是 “next”（默认）或 “prev” 页 默认值： |
|
EndingBefore 查询参数。服务器用于指示页面结尾的令牌。通常这是一个时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中的第一个、最后一个、上一个或下一个页面的链接应定义它。 |
|
ExcludedEventTypes 查询参数。事件类型列表。返回的事件将进行筛选，以排除具有这些类型的事件。 |
|
其他标头。 |
|
IncludedEventTypes 查询参数。事件类型列表。返回的事件将进行筛选，以仅包含具有这些类型的事件。 |
|
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 速率限制错误是否重试？ 选项
|
|
NetworkId 路径参数。网络 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围为 3 - 1000。默认值为 10。 |
|
ProductType 查询参数。要获取事件的产品类型。对于具有多种设备类型的网络，此参数是必需的。有效类型为 wireless、appliance、switch、systemsManager、camera 和 cellularGateway。 |
|
SmDeviceMac 查询参数。Systems Manager 设备的 MAC 地址，将使用该地址过滤事件列表。 |
|
SmDeviceName 查询参数。Systems Manager 设备的名称，将使用该名称过滤事件列表。 |
|
StartingAfter 查询参数。服务器用来指示页面开始的令牌。通常这是一个时间戳或 ID，但不仅限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一个、最后一个、上一个或下一个页面的链接应该定义它。 |
|
total_pages(int)，与 perPage 结合使用，以获取最多 total_pages*perPage 的总结果；-1 表示所有页面 |
备注
注意
使用的 SDK 方法是 networks.Networks.get_network_events，
使用的路径是 get /networks/{networkId}/events，
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 中的嵌入式连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 关于 networks getNetworkEvents 的文档
getNetworkEvents API 的完整参考。
示例
- name: Get all networks _events
cisco.meraki.networks_events_info:
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}}"
productType: string
includedEventTypes: []
excludedEventTypes: []
deviceMac: string
deviceSerial: string
deviceName: string
clientIp: string
clientMac: string
clientName: string
smDeviceMac: string
smDeviceName: string
perPage: 0
startingAfter: string
endingBefore: string
networkId: string
total_pages: -1
direction: next
register: result
返回值
常见返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
一个字典或列表，其中包含 Cisco Meraki Python SDK 返回的响应 返回：始终 示例： |