cisco.meraki.meraki_network 模块 – 管理 Meraki 云中的网络

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在剧本中使用它，请指定：cisco.meraki.meraki_network。

已弃用

在以下版本中移除：

版本 3.0.0

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.networks

概要

• 允许创建、管理和查看 Meraki 中的网络。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
copy_from_network_id 字符串	新网络继承自此网络 ID 的属性。 其他提供的参数将覆盖复制的配置。 类型必须与该网络的类型完全匹配。
enable_vlans 布尔值	布尔值，指定网络是否应支持 VLAN。 需要指定 net_name 或 net_id。 选项 false true
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
local_status_page_enabled 布尔值	此功能不再有效，可能将移至单独的模块。- 启用本地设备状态页面 (U[my.meraki.com](my.meraki.com)、U[ap.meraki.com](ap.meraki.com)、U[switch.meraki.com](switch.meraki.com)、U[wired.meraki.com](wired.meraki.com))。- 只能单独指定或与 remote_status_page_enabled 一起指定。 选项 false true
net_id 字符串	网络的 ID 号。
net_name 别名：name, network 字符串	网络的名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
remote_status_page_enabled 布尔值	此功能不再有效，可能将移至单独的模块。 启用对设备状态页面的访问 (http://device LAN IP)。 只有在 local_status_page_enabled: 设置为 yes 时才能设置。 只能单独指定或与 local_status_page_enabled 一起指定。 选项 false true
state 字符串	创建或修改组织。 选项 "absent" "present" ← (默认) "query"
tags 列表 / 元素=字符串	要分配给网络的标签列表。 tags 名称与 Ansible 中的 tags 参数冲突。缩进问题可能会导致意外行为。 Ansible 2.8 将此从逗号分隔的列表转换为列表。
timeout 整数	HTTP 请求的超时时间。 默认值： 30
timezone 字符串	与网络关联的时区。 有关有效时区的列表，请参阅 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones。
type 别名：net_type 列表 / 元素=字符串	网络设备网络管理的类型。 创建网络时需要此参数。 从 Ansible 2.8 开始，不再接受 combined 类型。 从 Ansible 2.8 开始，对此参数的更改不再是幂等的。 选项 "appliance" "switch" "wireless" "sensor" "systemsManager" "camera" "cellularGateway"
use_https 布尔值	如果为 no，它将使用 HTTP。否则，它将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为 no，即使在目标主机上的环境变量中定义了代理，它也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ← (默认)

备注

注意

• 有关 Meraki API 的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供 Meraki 内部开发人员使用。

• 从 Ansible 2.9 开始，Meraki 模块将键输出为蛇形命名法。要使用驼峰命名法，请将ANSIBLE_MERAKI_FORMAT环境变量设置为camelcase。

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰命名法输出。请更新您的 playbook。

• 检查模式会从仪表板下载当前配置，然后将更改与下载的配置进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到 API 以进行更改验证。

示例

- delegate_to: localhost
  block:
    - name: List all networks associated to the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
    - name: Query network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
    - name: Create network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type: switch
        timezone: America/Chicago
        tags: production, chicago
    - name: Create combined network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type:
          - switch
          - appliance
        timezone: America/Chicago
        tags: production, chicago
    - name: Create new network based on an existing network
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type:
          - switch
          - appliance
        copy_from_network_id: N_1234
    - name: Enable VLANs on a network
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        enable_vlans: yes
    - name: Modify local status page enabled state
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        local_status_page_enabled: yes

返回值

常见返回值已在此处记录，以下是此模块独有的字段

键	描述
数据 复杂	有关已创建或操作的对象的信息。 返回值： info
id 字符串	网络的标识符字符串。 返回值： success 示例： "N_12345"
local_status_page_enabled 布尔值	指示是否应启用my.meraki.com和其他设备门户。 返回值： success 示例： true
名称 字符串	网络的书写名称。 返回值： success 示例： "YourNet"
组织ID 字符串	拥有该网络的组织 ID。 返回值： success 示例： "0987654321"
remote_status_page_enabled 布尔值	启用对设备状态页面的访问。 返回值： success 示例： true
tags 列表 / 元素=字符串	分配给网络的以空格分隔的标签。 返回值： success 示例： ["production"]
时区 字符串	网络所在的时区。 返回值： success 示例： "America/Chicago"
类型 列表 / 元素=字符串	网络的功能类型。 返回值： success 示例： ["switch"]

状态

• 此模块将在 3.0.0 版本中删除。[已弃用]

• 更多信息请参见已弃用。

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题追踪器
• 代码库 (源代码)