cisco.meraki.meraki_mx_static_route 模块 – 管理 Meraki 云中的静态路由

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.meraki.meraki_mx_static_route。

已弃用

移除于：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_appliance_static_routes

概要

• 允许在 Meraki 中创建、管理和查看静态路由。

参数

参数	注释
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
enabled 布尔值	指示是否在网络中启用静态路由。 选项 false true
fixed_ip_assignments 列表 / elements=字典	用于 DHCP 的固定 MAC 到 IP 绑定的列表。
ip 字符串	端点的 IP 地址。
mac 字符串	端点的 MAC 地址。
name 字符串	端点的主机名。
gateway_ip 字符串	子网网关的 IP 地址。
gateway_vlan_id 整数	静态路由的网关 IP（下一跳）VLAN ID。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 字符串	静态路由的描述性名称。
net_id 字符串	网络的 ID 号。
net_name 字符串	网络的名称。
org_id 字符串	组织的 ID。
org_name 别名: organization 字符串	组织的名称。
output_format 字符串	指示模块响应键应采用蛇形命名法（例如，net_id）还是驼峰命名法（例如，netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
reserved_ip_ranges 列表 / elements=字典	为静态 IP 分配保留的 IP 范围的列表。
comment 字符串	保留范围的人类可读描述。
end 字符串	保留范围的最后一个 IP 地址。
start 字符串	保留范围的第一个 IP 地址。
route_id 字符串	静态路由的唯一 ID。
state 字符串	创建或修改组织。 选项 "absent" "query" "present" ← (默认)
subnet 字符串	基于 CIDR 表示法的静态路由子网。
timeout 整数	HTTP 请求超时的时间。 默认值： 30
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 模块将键值输出为蛇形命名 (snake case)。要使用驼峰命名 (camel case)，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

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

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

示例

- name: Create static_route
  meraki_static_route:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test Route
    subnet: 192.0.1.0/24
    gateway_ip: 192.168.128.1
  delegate_to: localhost

- name: Update static route with fixed IP assignment
  meraki_static_route:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    route_id: d6fa4821-1234-4dfa-af6b-ae8b16c20c39
    fixed_ip_assignments:
      - mac: aa:bb:cc:dd:ee:ff
        ip: 192.0.1.11
        comment: Server
  delegate_to: localhost

- name: Query static routes
  meraki_static_route:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
  delegate_to: localhost

- name: Delete static routes
  meraki_static_route:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    route_id: '{{item}}'
  delegate_to: localhost

返回值

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

键	描述
data 复杂类型	关于创建或操作的对象的信息。 返回: 信息
enabled 布尔值	静态路由的启用状态。 返回: 查询或更新 示例: true
fixedIpAssignments 复杂类型	静态 MAC 地址到 IP 地址绑定的列表。 返回: 查询或更新
mac 复杂类型	键是端点的 MAC 地址。 返回: 查询或更新
ip 字符串	要绑定到端点的 IP 地址。 返回: 查询或更新 示例: "192.0.1.11"
name 字符串	分配给端点的主机名。 返回: 查询或更新 示例: "JimLaptop"
gatewayIp 字符串	下一跳 IP 地址。 返回: 成功 示例: "192.1.1.1"
id 字符串	分配给每个静态路由的唯一标识字符串。 返回: 成功 示例: "d6fa4821-1234-4dfa-af6b-ae8b16c20c39"
name 字符串	静态路由的名称。 返回: 成功 示例: "数据 中心 静态 路由"
net_id 字符串	网络的标识字符串。 返回: 查询或更新 示例: "N_12345"
reservedIpRanges 复杂类型	保留用于静态分配的 IP 地址范围列表。 返回: 查询或更新
comment 字符串	范围的人工可读描述。 返回: 查询或更新 示例: "服务器 范围"
end 字符串	保留范围中的最后一个地址（包含）。 返回: 查询或更新 示例: "192.0.1.10"
start 字符串	保留范围中的第一个地址（包含）。 返回: 查询或更新 示例: "192.0.1.2"
subnet 字符串	静态路由的 CIDR 表示法的子网。 返回: 成功 示例: "192.0.1.0/24"

状态

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

• 有关更多信息，请参阅已弃用。

作者

• Kevin Breit (@kbreit)

集合链接

• 问题跟踪器
• 存储库 (源代码)