cisco.meraki.networks_info 模块 – 用于网络的信息模块
注意
此模块是 cisco.meraki 集合（版本 2.18.3）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install cisco.meraki。您需要满足进一步的要求才能使用此模块，请参阅 要求 以获取详细信息。
要在 Playbook 中使用它，请指定： cisco.meraki.networks_info。
cisco.meraki 2.16.0 中的新增功能
概要
获取所有网络。
按 ID 获取网络。
列出用户在组织中具有权限的网络。
返回一个网络。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要满足以下要求。
meraki >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
ConfigTemplateId 查询参数。一个可选参数，它是配置模板的 ID。将返回绑定到该模板的所有网络。 |
|
direction（字符串），分页方向，可以是“next”（默认）或“prev”页 默认值： |
|
EndingBefore 查询参数。服务器用来指示页面结尾的标记。通常这是一个时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
附加标头。 |
|
IsBoundToConfigTemplate 查询参数。一个可选参数，用于过滤绑定配置模板的网络。如果设置了 configTemplateId，则此参数不能为 false。 选择
|
|
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。 |
|
OrganizationId 路径参数。组织 ID。 |
|
PerPage 查询参数。每页返回的条目数。可接受的范围为 3 - 100000。默认为 1000。 |
|
StartingAfter 查询参数。服务器用来指示页面开头的标记。通常这是一个时间戳或 ID，但不限于这些。此参数不应由客户端应用程序定义。HTTP Link 标头中第一页、最后一页、上一页或下一页的链接应定义它。 |
|
Tags 查询参数。用于按标签筛选网络的可选参数。筛选区分大小写。如果包含标签，则还应包含“tagsFilterType”（见下文）。 |
|
TagsFilterType 查询参数。一个可选参数，值为 'withAnyTags' 或 'withAllTags'，用于指示返回包含**任意**或**所有**所包含标签的网络。如果未包含类型，则将选择 'withAnyTags'。 |
|
total_pages(整数)，与 perPage 一起使用以获取最多 total_pages*perPage 的总结果；-1 表示所有页面 |
备注
注意
使用的 SDK 方法是 networks.Networks.get_network, networks.Networks.get_organization_networks,
使用的路径是 get /networks/{networkId}, get /organizations/{organizationId}/networks,
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco Meraki SDK 中嵌入的连接管理器
以 meraki_ 开头的参数由 Cisco Meraki Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco Meraki 文档，关于 networks getNetwork
getNetwork API 的完整参考。
- Cisco Meraki 文档，关于 networks getOrganizationNetworks
getOrganizationNetworks API 的完整参考。
示例
- name: Get all networks
cisco.meraki.networks_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}}"
configTemplateId: string
isBoundToConfigTemplate: True
tags: []
tagsFilterType: string
perPage: 0
startingAfter: string
endingBefore: string
organizationId: string
total_pages: -1
direction: next
register: result
- name: Get networks by id
cisco.meraki.networks_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}}"
networkId: string
register: result
返回值
通用返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
一个字典或列表，包含 Cisco Meraki Python SDK 返回的响应 返回： 始终 示例： |