cisco.meraki.meraki_ms_stack_l3_interface 模块 – 管理 MS 交换机上的路由接口

注意

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

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

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

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

已弃用

在以下版本中移除：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_switch_stacks_routing_interfaces

概要

• 允许创建、管理和查看 Meraki MS 交换机上的路由接口。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
default_gateway 字符串	任何不直接连接到子网或通过静态路由传输的流量的下一跳。 此 IP 地址必须存在于具有路由接口的子网中。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
interface_id 字符串	第 3 层接口的唯一标识号。
interface_ip 字符串	此交换机在此 VLAN 或子网上用于第 3 层路由的 IP 地址。 此 IP 地址不能与交换机的管理 IP 地址相同。
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
multicast_routing 字符串	如果需要 VLAN 之间的组播路由，则启用组播支持。 选项 "disabled" "enabled" "IGMP snooping querier"
name 字符串	接口或 VLAN 的友好名称或描述。
net_id 字符串	应用配置的网络 ID。
net_name 别名：network 字符串	应用配置的网络名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
ospf_settings 字典	接口的 OSPF 路由设置。
area 字符串	此接口应所属的 OSPF 区域。 可以是“disabled”或现有 OSPF 区域的标识符。
cost 整数	此接口的路径成本。
is_passive_enabled 布尔值	启用后，OSPF 将不会在此接口上运行，但仍会通告子网。 选项 false true
output_format 字符串	指示模块响应键是否应为蛇形命名法（例如 net_id）或驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
stack_id 字符串	堆栈的唯一标识符。
state 字符串	创建或修改组织。 选项 "present" ← (默认) "query" "absent"
subnet 字符串	此路由接口所在的网络，以 CIDR 表示法表示。
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则将使用 HTTP。否则将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为no，则即使目标主机环境变量中定义了代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证HTTP证书。 选项 false true ← (默认)
vlan_id 整数	此路由接口所在的VLAN。 VLAN必须在1到4094之间。

注释

注意

• 创建三层接口后，API不允许更新接口并指定default_gateway。

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

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

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

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

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

示例

- name: Query all l3 interfaces
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc

- name: Query one l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: query
    serial: aaa-bbb-ccc
    name: Test L3 interface

- name: Create l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 1
      is_passive_enabled: true

- name: Update l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: present
    serial: aaa-bbb-ccc
    name: "Test L3 interface 2"
    subnet: "192.168.3.0/24"
    interface_ip: "192.168.3.2"
    multicast_routing: disabled
    vlan_id: 11
    ospf_settings:
      area: 0
      cost: 2
      is_passive_enabled: true

- name: Delete l3 interface
  meraki_ms_stack_l3_interface:
    auth_key: abc123
    state: absent
    serial: aaa-bbb-ccc
    interface_id: abc123344566

返回值

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

键	描述
data complex	关于三层接口的信息。 返回值：成功
default_gateway 字符串	任何不直接连接到子网或通过静态路由传输的流量的下一跳。 返回值：成功 示例："192.168.2.1"
interface_id 字符串	第 3 层接口的唯一标识号。 返回值：成功 示例："62487444811111120"
interface_ip 字符串	此交换机在此 VLAN 或子网上用于第 3 层路由的 IP 地址。 返回值：成功 示例："192.168.2.2"
multicast_routing 字符串	如果需要 VLAN 之间的组播路由，则启用组播支持。 返回值：成功 示例："disabled"
name 字符串	接口或 VLAN 的友好名称或描述。 返回值：成功 示例："L3 interface"
ospf_settings complex	接口的 OSPF 路由设置。 返回值：成功
area 字符串	此接口应所属的 OSPF 区域。 返回值：成功 示例："0"
cost 整数	此接口的路径成本。 返回值：成功 示例：1
is_passive_enabled 布尔值	启用后，OSPF 将不会在此接口上运行，但仍会通告子网。 返回值：成功 示例：true
subnet 字符串	此路由接口所在的网络，以 CIDR 表示法表示。 返回值：成功 示例："192.168.2.0/24"
vlan_id 整数	此路由接口所在的VLAN。 返回值：成功 示例：10

状态

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

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

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题跟踪器
• 资源库（源代码）