cisco.meraki.meraki_ms_ospf 模块 – 管理 MS 交换机上的 OSPF 配置

注意

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

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

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

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

已弃用

在以下版本中移除：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_switch_routing_ospf

概要

• 为兼容的 Meraki MS 交换机配置 OSPF。

参数

参数	注释
areas 列表 / 元素=字典	OSPF 网络中的区域列表。
area_id 别名：id 整数	OSPF 区域 ID
area_name 别名：name 字符串	OSPF 区域的描述性名称。
area_type 别名：type 字符串	OSPF 区域类型。 选项 "normal" "stub" "nssa"
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
dead_timer 整数	确定何时将对等体声明为非活动状态的时间间隔。 值必须在 1 和 65535 之间。
enabled 布尔值	启用或禁用网络上的 OSPF。 选项 false true
hello_timer 整数	以秒为单位的时间间隔，在此时间间隔内将向 OSPF 邻居发送 hello 数据包以保持连接。 值必须在 1 和 255 之间。 默认为 10 秒。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
md5_authentication_enabled 布尔值	是否启用或禁用 MD5 身份验证。 选项 false true
md5_authentication_key 字典	MD5 身份验证凭据。
id 字符串	MD5 身份验证密钥索引。 必须在 1 和 255 之间。
passphrase 字符串	纯文本身份验证密码
net_id 字符串	包含 OSPF 配置的网络的 ID。
net_name 别名：name, network 字符串	包含 OSPF 配置的网络的名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键是否应为蛇形命名法（例如 net_id）或驼峰命名法（例如 netId）。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间调试输出的数量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串	读取或编辑 OSPF 设置。 选项 "present" ← (默认) "query"
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 模块将键输出为蛇形命名法。要使用驼峰命名法，请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

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

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

示例

- name: Query OSPF settings
  meraki_ms_ospf:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Enable OSPF with check mode
  meraki_ms_ospf:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    enabled: true
    hello_timer: 20
    dead_timer: 60
    areas:
      - area_id: 0
        area_name: Backbone
        area_type: normal
      - area_id: 1
        area_name: Office
        area_type: nssa
    md5_authentication_enabled: false

返回值

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

键	描述
数据 复杂数据	查询对象的详细信息。 返回：成功
areas 复杂数据	OSPF 网络中的区域列表。 返回：成功
区域ID 整数	OSPF 区域 ID 返回：成功
区域名称 字符串	OSPF 区域的描述性名称。 返回：成功
区域类型 字符串	OSPF 区域类型。 返回：成功
失效计时器（秒） 整数	确定何时将对等体声明为非活动状态的时间间隔。 返回：成功
enabled 布尔值	启用或禁用网络上的 OSPF。 返回：成功
问候计时器（秒） 整数	以秒为单位的时间间隔，在此时间间隔内将向 OSPF 邻居发送 hello 数据包以保持连接。 返回：成功
md5_authentication_enabled 布尔值	是否启用或禁用 MD5 身份验证。 返回：成功
md5_authentication_key 复杂数据	MD5 身份验证凭据。 返回：成功
id 整数	MD5 密钥索引。 返回：成功
passphrase 字符串	MD5 密钥的密码。 返回：成功

状态

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

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

作者

• Kevin Breit (@kbreit)

资源链接

• 问题跟踪器
• 代码仓库