cisco.ios.ios_ospfv3 模块 – 用于配置 OSPFv3 的资源模块。

注意

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

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

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

要在 playbook 中使用它，请指定：cisco.ios.ios_ospfv3。

cisco.ios 1.1.0 中的新增功能

概要

• 此模块在 IOS 平台上配置和管理开放最短路径优先 (OSPF) 版本 3。

参数

参数	注释
config 字典	ospfv3 的配置列表。
processes 列表 / 元素=字典	OSPF 实例配置列表。
address_family 列表 / 元素=字典	进入地址族命令模式
adjacency 字典	控制邻接关系的建立
disable 布尔值	禁用邻接关系交错 选择 false true
max_adjacency 整数	允许形成的最大邻接关系数 请参阅供应商文档以获取有效值
min_adjacency 整数	区域中允许形成的初始邻接关系数 请参阅供应商文档以获取有效值
none 布尔值	无初始值 选择 false true
afi 字符串	进入地址族命令模式 选择 "ipv4" "ipv6"
areas 列表 / 元素=字典	OSPF 区域参数
area_id 字符串	OSPF 区域 ID，为十进制值。请参阅供应商文档以获取有效值。 OSPF 区域 ID，采用 IP 地址格式（例如 A.B.C.D）
authentication 字典	身份验证参数
key_chain 字符串	使用密钥链进行加密身份验证密钥
null 布尔值	不使用身份验证 选择 false true
default_cost 整数	设置 NSSA/存根区域的汇总默认成本 存根的通告外部路由度量 注意，请参阅供应商文档以获取相应的有效值
filter_list 列表 / 元素=字典	过滤 OSPFv3 区域之间的网络
direction 字符串 / 必需	将过滤器应用于发送到此区域和从该区域发送的网络的方向。 选择 "in" "out"
name 字符串	IP 前缀列表的名称
normal 布尔值	指定一个正常区域类型 选择 false true
nssa 字典	指定一个 NSSA 区域
default_information_originate 字典	将类型 7 默认值源发到 NSSA 区域
metric 整数	OSPF 默认度量
metric_type 整数	默认路由的 OSPF 度量类型 OSPF 链路状态类型 选择 1 2
nssa_only 布尔值	将默认通告限制为此 NSSA 区域 选择 false true
no_redistribution 布尔值	不重新分发到此 NSSA 区域 选择 false true
no_summary 布尔值	不发送汇总 LSA 到 NSSA 选择 false true
set 布尔值	启用 NSSA 区域 选择 false true
translate 字符串	转换 LSA 始终在此 ABR 上转换 LSA 禁止在转换的 LSA 中转发地址 选择 "always" "suppress-fa"
ranges 列表 / 元素=字典	汇总匹配地址/掩码的路由（仅限边界路由器）
address 字符串	要匹配的 IP 地址
advertise 布尔值	通告此范围（默认） 由于启用时通告不会显示在 running-config 中，因此在播放的第二次或下一次运行时，不会为播放保持幂等性。 选择 false true
cost 整数	此范围的用户指定度量
netmask 字符串	地址的 IP 掩码
not_advertise 布尔值	不通告此范围 选择 false true
sham_link 字典	定义一个虚链路及其参数
authentication 字典	身份验证参数
key_chain 字符串	使用密钥链进行加密身份验证密钥
null 布尔值	不使用身份验证 选择 false true
cost 整数	将成本与虚链路关联 虚链路的成本
destination 字符串	与虚链路目标关联的 IPv6 地址 (X:X:X:X::X)
source 字符串	与虚链路源关联的 IPv6 地址 (X:X:X:X::X)
ttl_security 整数	TTL 安全检查 允许的最大跳数
stub 字典	指定一个存根区域 主干网不能配置为存根区域
no_summary 布尔值	不发送汇总 LSA 到存根区域 选择 false true
set 布尔值	启用存根区域 选择 false true
authentication 字典	身份验证参数 身份验证操作模式
deployment 布尔值	操作的部署模式 选择 false true
normal 布尔值	操作的正常模式 选择 false true
auto_cost 字典	根据带宽计算 OSPF 接口成本
reference_bandwidth 整数	使用参考带宽方法分配 OSPF 成本 注意，请参阅供应商文档以获取相应的有效值
set 布尔值	启用 OSPF 自动成本 选择 false true
bfd 字典	BFD 配置命令
all_interfaces 布尔值	在所有接口上启用 BFD 选择 false true
disable 布尔值	在所有接口上禁用 BFD 选择 false true
capability 布尔值	启用特定功能 不执行 PE 特定检查 选择 false true
compatible 字典	OSPFv3 路由器兼容性列表
rfc1583 布尔值	与 RFC 1583 兼容 选择 false true
rfc1587 布尔值	与 RFC 1587 兼容 选择 false true
rfc5243 布尔值	支持 DBD 交换优化 选择 false true
default_information 字典	控制默认信息的分配
always 布尔值	始终通告默认路由 选择 false true
metric 整数	OSPF 默认度量 注意，请参阅供应商文档以获取相应的有效值
metric_type 整数	默认路由的 OSPF 度量类型 注意，请参阅供应商文档以获取相应的有效范围
originate 布尔值	分发默认路由 选择 false true
route_map 字符串	路由映射参考名称
default_metric 整数	设置重新分配的路由的度量
discard_route 字典	启用或禁用丢弃路由安装
external 布尔值	丢弃已汇总重新分配的路由的路由 选择 false true
internal 布尔值	丢弃汇总区域间路由的路由 选择 false true
sham_link 布尔值	丢弃虚链路路由的路由 选择 false true
距离 整数	定义管理距离 注意，请参阅供应商文档以获取相应的有效范围
distribute_list 字典	过滤路由更新中的网络
acls 列表 / 元素=字典	IP 访问列表
direction 字符串 / 必需	过滤传入和传出的路由更新。 选择 "in" "out"
接口 字符串	接口配置（千兆以太网 A/B） 对传入流量有效
name 字符串 / 必需	IP 访问列表名称/编号
协议 字符串	协议配置（bgp 1）。 对传出流量有效
前缀 字典	过滤路由更新中的前缀
direction 字符串 / 必需	过滤传入和传出的路由更新。 选择 "in" "out"
gateway_name 字符串	用于基于网关过滤传入更新的网关名称
接口 字符串	接口配置（千兆以太网 A/B） 对传入流量有效
name 字符串 / 必需	IP 前缀列表的名称
协议 字符串	协议配置（bgp 1）。 对传出流量有效
route_map 字典	过滤路由更新中的前缀
name 字符串 / 必需	路由映射名称
event_log 字典	事件日志记录
启用 布尔值	启用事件日志记录 选择 false true
one_shot 布尔值	当日志缓冲区满时禁用日志记录 选择 false true
暂停 布尔值	暂停事件日志记录 选择 false true
大小 整数	事件日志中存储的最大事件数 注意，请参阅供应商文档以获取相应的有效值
graceful_restart 字典	平滑重启选项 辅助支持
disable 布尔值	禁用辅助支持 选择 false true
启用 布尔值	已启用辅助支持 选择 false true
strict_lsa_checking 布尔值	启用辅助严格 LSA 检查 选择 false true
interface_id 字典	接口 ID 的来源
ios_if_index 布尔值	IOS 接口编号 选择 false true
snmp_if_index 布尔值	SNMP MIB ifIndex 选择 false true
限制 字典	限制特定的 OSPF 功能
dc 字典	按需电路重传
disable 布尔值	禁用该功能 选择 false true
编号 整数	最大重传次数
non_dc 字典	非按需电路重传
disable 布尔值	禁用该功能 选择 false true
编号 整数	最大重传次数
local_rib_criteria 字典	启用或禁用本地 RIB 作为路由标准的使用
启用 布尔值	启用本地 RIB 作为路由标准的使用 选择 false true
forwarding_address 布尔值	本地 RIB 用于验证外部/NSSA 转发地址 选择 false true
inter_area_summary 布尔值	本地 RIB 用作区域间摘要的标准 选择 false true
nssa_translation 布尔值	本地 RIB 用作 NSSA 转换的标准 选择 false true
log_adjacency_changes 字典	记录邻接状态的变化
详细 布尔值	记录所有状态更改 选择 false true
set 布尔值	记录邻接状态的变化 选择 false true
manet 字典	指定 MANET OSPF 参数
缓存 字典	指定 MANET 缓存大小
acknowledgement 整数	指定 MANET 确认缓存大小 缓存中最大确认数
更新 整数	指定 MANET LSA 缓存大小 缓存中最大 LSA 数
hello 字典	单播 Hello，而不是多播
多播 布尔值	多播 Hello 请求和响应，而不是单播 选择 false true
单播 布尔值	单播 Hello 请求和响应，而不是多播 选择 false true
peering 字典	MANET OSPF 智能对等
disable 布尔值	禁用选择性对等 选择 false true
per_interface 布尔值	按接口选择对等体，而不是按节点选择 选择 false true
冗余 整数	冗余路径 冗余 OSPF 路径数
set 布尔值	启用选择性对等 选择 false true
意愿 整数	指定和中继意愿值
max_lsa 字典	要接受的最大非自生成 LSA 数
ignore_count 整数	可以抑制邻接的最大次数 注意，请参阅供应商文档以获取相应的有效值
ignore_time 整数	所有邻接被抑制的分钟数 注意，请参阅供应商文档以获取相应的有效值
编号 整数	要接受的最大非自生成 LSA 数 注意，请参阅供应商文档以获取相应的有效值
reset_time 整数	忽略计数重置为零后的分钟数 注意，请参阅供应商文档以获取相应的有效值
threshold_value 整数	生成警告消息的阈值 (%) 注意，请参阅供应商文档以获取相应的有效值
warning_only 布尔值	仅在超出限制时发出警告消息 选择 false true
max_metric 字典	设置最大度量值 自发起的路由器 LSA 中的最大度量值
disable 布尔值	禁用自发起的路由器 LSA 中的最大度量值 选择 false true
external_lsa 整数	使用最大度量值覆盖外部 LSA 度量值 覆盖外部 LSA 中的度量值 注意，请参阅供应商文档以获取相应的有效值
inter_area_lsas 整数	使用最大度量值覆盖区域间 LSA 度量值 覆盖区域间 LSA 中的度量值 注意，请参阅供应商文档以获取相应的有效值
on_startup 字典	重新启动后临时设置最大度量值
时间 整数	路由器 LSA 以最大度量值发起的秒数 注意，请参阅供应商文档以获取相应的有效范围
wait_for_bgp 布尔值	让 BGP 决定何时以正常度量值发起路由器 LSA 选择 false true
stub_prefix_lsa 布尔值	设置前缀 LSA 中存根链接的最大度量值 选择 false true
maximum_paths 整数	通过多个路径转发数据包 路径数
passive_interface 字符串	禁止在接口上进行路由更新
prefix_suppression 字典	前缀抑制
disable 布尔值	禁用前缀抑制 选择 false true
启用 布尔值	启用前缀抑制 选择 false true
queue_depth 字典	Hello/路由器进程队列深度
hello 字典	OSPF Hello 进程队列深度
max_packets 整数	队列中的最大数据包数
unlimited 布尔值	无限队列深度 选择 false true
更新 字典	OSPF 路由器进程队列深度
max_packets 整数	队列中的最大数据包数
unlimited 布尔值	无限队列深度 选择 false true
router_id 字符串	此 OSPF 进程的路由器 ID 地址 IP 地址格式的 OSPF 路由器 ID (A.B.C.D)
shutdown 字典	关闭路由器进程
disable 布尔值	禁用关闭 选择 false true
启用 布尔值	关闭路由器进程 选择 false true
summary_prefix 字典	配置 IP 地址摘要
address 字符串	IP 摘要地址 (A.B.C.D) IP 前缀 <network>/<length> (A.B.C.D/nn)
掩码 字符串	IP 摘要掩码
not_advertise 布尔值	不通告或翻译 选择 false true
nssa_only 布尔值	将摘要限制为 NSSA 区域 选择 false true
标签 整数	设置标签
计时器 字典	调整路由计时器
lsa 整数	OSPF LSA 计时器，到达计时器 接受同一 LSA 的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
manet 字典	OSPF MANET 计时器
缓存 字典	指定 MANET 缓存大小
acknowledgement 整数	指定 MANET 确认缓存大小
冗余 整数	指定 MANET LSA 缓存大小
hello 布尔值	单播 Hello，而不是多播 单播 Hello 请求和响应，而不是多播 选择 false true
peering 字典	MANET OSPF 智能对等
per_interface 布尔值	按接口选择对等体，而不是按节点选择 选择 false true
冗余 整数	冗余路径 冗余 OSPF 路径数
set 布尔值	启用选择性对等 选择 false true
意愿 整数	指定和中继意愿值
pacing 字典	OSPF 步调计时器
flood 整数	OSPF 泛洪步调计时器 在接口上限制泛洪的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
lsa_group 整数	OSPF LSA 组步调计时器 刷新或最大化 LSA 组之间的间隔（以秒为单位） 注意，请参阅供应商文档以获取相应的有效值
retransmission 整数	OSPF 重传步调计时器 相邻重传之间的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
throttle 字典	OSPF 节流计时器
lsa 字典	OSPF LSA 节流计时器
first_delay 整数	生成 LSA 首次出现的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
max_delay 整数	发起同一 LSA 的最大延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
min_delay 整数	发起同一 LSA 的最小延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
spf 字典	OSPF SPF 节流计时器 - 接收到 SPF 计算更改之间的延迟（以毫秒为单位） - 注意：有关各个有效值，请参阅供应商文档
between_delay 整数	第一次和第二次 SPF 计算之间的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
max_delay 整数	SPF 计算的最大等待时间（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
receive_delay 整数	接收到 SPF 计算更改之间的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
单播 布尔值	地址族修饰符 选择 false true
vrf 字符串	指定 VPN 路由/转发实例的参数
adjacency 字典	控制邻接关系的建立
max_adjacency 整数	允许形成的最大邻接关系数 请参阅供应商文档以获取有效值
min_adjacency 整数	区域中允许形成的初始邻接关系数 请参阅供应商文档以获取有效值
none 布尔值	无初始值 选择 false true
areas 列表 / 元素=字典	OSPF 区域参数
area_id 字符串	OSPF 区域 ID，为十进制值。请参阅供应商文档以获取有效值。 OSPF 区域 ID，采用 IP 地址格式（例如 A.B.C.D）
authentication 字典	身份验证参数
ipsec 字典	使用 IPsec 身份验证
hex_string 字符串	SHA-1 密钥（40 个字符）
md5 整数	使用 MD5 身份验证
sha1 整数	使用 SHA-1 身份验证
spi 整数	设置 SPI（安全参数索引）
key_chain 字符串	使用密钥链进行加密身份验证密钥
default_cost 整数	设置 NSSA/存根区域的汇总默认成本 存根的通告外部路由度量 注意，请参阅供应商文档以获取相应的有效值
nssa 字典	指定一个 NSSA 区域
default_information_originate 字典	将类型 7 默认值源发到 NSSA 区域
metric 整数	OSPF 默认度量
metric_type 整数	默认路由的 OSPF 度量类型 OSPF 链路状态类型 选择 1 2
nssa_only 布尔值	将默认通告限制为此 NSSA 区域 选择 false true
no_redistribution 布尔值	不重新分发到此 NSSA 区域 选择 false true
no_summary 布尔值	不发送汇总 LSA 到 NSSA 选择 false true
set 布尔值	启用 NSSA 区域 选择 false true
translate 字符串	转换 LSA 始终在此 ABR 上转换 LSA 禁止在转换的 LSA 中转发地址 选择 "always" "suppress-fa"
stub 字典	指定一个存根区域 主干网不能配置为存根区域
no_summary 布尔值	不发送汇总 LSA 到存根区域 选择 false true
set 布尔值	启用存根区域 选择 false true
authentication 布尔值	身份验证参数模式 操作的部署模式 选择 false true
auto_cost 字典	根据带宽计算 OSPF 接口成本
reference_bandwidth 整数	使用参考带宽方法分配 OSPF 成本 注意，请参阅供应商文档以获取相应的有效值
set 布尔值	启用 OSPF 自动成本 选择 false true
bfd 布尔值	BFD 配置命令 在所有接口上启用 BFD 选择 false true
compatible 字典	OSPFv3 路由器兼容性列表
rfc1583 布尔值	与 RFC 1583 兼容 选择 false true
rfc1587 布尔值	与 RFC 1587 兼容 选择 false true
rfc5243 布尔值	支持 DBD 交换优化 选择 false true
event_log 字典	事件日志记录
启用 布尔值	启用事件日志记录 选择 false true
one_shot 布尔值	当日志缓冲区满时禁用日志记录 选择 false true
暂停 布尔值	暂停事件日志记录 选择 false true
大小 整数	事件日志中存储的最大事件数 注意，请参阅供应商文档以获取相应的有效值
graceful_restart 字典	辅助支持的平滑重启选项
disable 布尔值	禁用辅助支持 选择 false true
strict_lsa_checking 布尔值	启用辅助严格 LSA 检查 选择 false true
帮助 布尔值	交互式帮助系统的描述 选择 false true
interface_id 布尔值	接口 ID 的来源 SNMP MIB ifIndex 选择 false true
限制 字典	限制特定的 OSPF 功能以及 LS 更新、DBD 和 LS 请求重传
dc 字典	按需电路重传
disable 布尔值	禁用该功能 选择 false true
编号 整数	最大重传次数
non_dc 字典	非按需电路重传
disable 布尔值	禁用该功能 选择 false true
编号 整数	最大重传次数
local_rib_criteria 字典	启用或禁用本地 RIB 作为路由标准的使用
启用 布尔值	启用本地 RIB 作为路由标准的使用 选择 false true
forwarding_address 布尔值	本地 RIB 用于验证外部/NSSA 转发地址 选择 false true
inter_area_summary 布尔值	本地 RIB 用作区域间摘要的标准 选择 false true
nssa_translation 布尔值	本地 RIB 用作 NSSA 转换的标准 选择 false true
log_adjacency_changes 字典	记录邻接状态的变化
详细 布尔值	记录所有状态更改 选择 false true
set 布尔值	记录邻接状态的变化 选择 false true
manet 字典	指定 MANET OSPF 参数
缓存 字典	指定 MANET 缓存大小
acknowledgement 整数	指定 MANET 确认缓存大小
冗余 整数	指定 MANET LSA 缓存大小
hello 布尔值	单播 Hello，而不是多播 单播 Hello 请求和响应，而不是多播 选择 false true
peering 字典	MANET OSPF 智能对等
per_interface 布尔值	按接口选择对等体，而不是按节点选择 选择 false true
冗余 整数	冗余路径 冗余 OSPF 路径数
set 布尔值	启用选择性对等 选择 false true
意愿 整数	指定和中继意愿值
max_lsa 字典	要接受的最大非自生成 LSA 数
ignore_count 整数	可以抑制邻接的最大次数 注意，请参阅供应商文档以获取相应的有效值
ignore_time 整数	所有邻接被抑制的分钟数 注意，请参阅供应商文档以获取相应的有效值
编号 整数	要接受的最大非自生成 LSA 数 注意，请参阅供应商文档以获取相应的有效值
reset_time 整数	忽略计数重置为零后的分钟数 注意，请参阅供应商文档以获取相应的有效值
threshold_value 整数	生成警告消息的阈值 (%) 注意，请参阅供应商文档以获取相应的有效值
warning_only 布尔值	仅在超出限制时发出警告消息 选择 false true
max_metric 字典	设置最大度量值
external_lsa 整数	使用最大度量值覆盖外部 LSA 度量值 覆盖外部 LSA 中的度量值 注意，请参阅供应商文档以获取相应的有效值
include_stub 布尔值	设置路由器 LSA 中存根链接的最大度量值 选择 false true
on_startup 字典	重新启动后临时设置最大度量值
时间 整数	路由器 LSA 以最大度量值发起的秒数 注意，请参阅供应商文档以获取相应的有效范围
wait_for_bgp 布尔值	让 BGP 决定何时以正常度量值发起路由器 LSA 选择 false true
router_lsa boolean / 必需	自发起的路由器 LSA 中的最大度量值 选择 false true
summary_lsa 整数	使用最大度量值覆盖摘要 LSA 度量值 注意，请参阅供应商文档以获取相应的有效范围
passive_interface 字符串	禁止在接口上进行路由更新
prefix_suppression 布尔值	启用前缀抑制 选择 false true
process_id integer / 必需	进程 ID
queue_depth 字典	Hello/路由器进程队列深度
hello 字典	OSPF Hello 进程队列深度
max_packets 整数	队列中的最大数据包数
unlimited 布尔值	无限队列深度 选择 false true
router_id 字符串	此 OSPF 进程的路由器 ID 地址 IP 地址格式的 OSPF 路由器 ID (A.B.C.D)
shutdown 布尔值	关闭路由器进程 选择 false true
计时器 字典	调整路由计时器
lsa 整数	OSPF LSA 计时器，到达计时器 接受同一 LSA 的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
manet 字典	OSPF MANET 计时器
缓存 字典	指定 MANET 缓存大小
acknowledgement 整数	指定 MANET 确认缓存大小
冗余 整数	指定 MANET LSA 缓存大小
hello 布尔值	单播 Hello，而不是多播 单播 Hello 请求和响应，而不是多播 选择 false true
peering 字典	MANET OSPF 智能对等
per_interface 布尔值	按接口选择对等体，而不是按节点选择 选择 false true
冗余 整数	冗余路径 冗余 OSPF 路径数
set 布尔值	启用选择性对等 选择 false true
意愿 整数	指定和中继意愿值
pacing 字典	OSPF 步调计时器
flood 整数	OSPF 泛洪步调计时器 在接口上限制泛洪的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
lsa_group 整数	OSPF LSA 组步调计时器 刷新或最大化 LSA 组之间的间隔（以秒为单位） 注意，请参阅供应商文档以获取相应的有效值
retransmission 整数	OSPF 重传步调计时器 相邻重传之间的最小间隔（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
throttle 字典	OSPF 节流计时器
lsa 字典	OSPF LSA 节流计时器
first_delay 整数	生成 LSA 首次出现的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
max_delay 整数	发起同一 LSA 的最大延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
min_delay 整数	发起同一 LSA 的最小延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
spf 字典	OSPF SPF 节流计时器 - 接收到 SPF 计算更改之间的延迟（以毫秒为单位） - 注意：有关各个有效值，请参阅供应商文档
between_delay 整数	第一次和第二次 SPF 计算之间的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
max_delay 整数	SPF 计算的最大等待时间（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
receive_delay 整数	接收到 SPF 计算更改之间的延迟（以毫秒为单位） 注意，请参阅供应商文档以获取相应的有效值
running_config 字符串	此选项仅在状态为 parsed 时使用。 此选项的值应为通过执行命令 sh running-config | section ^router ospfv3 从 IOS 设备收到的输出。 状态 parsed 从 running_config 选项读取配置，并根据资源模块的 argspec 将其转换为 Ansible 结构化数据，然后该值在结果中的 parsed 键中返回。
state 字符串	配置应保留的状态 状态 rendered、gathered 和 parsed 不会对设备执行任何更改。 状态 rendered 会将 config 选项中的配置转换为特定于平台的 CLI 命令，这些命令将在结果中的 rendered 键中返回。对于状态 rendered，不需要到远程主机的活动连接。 状态 gathered 将从设备获取运行配置，并将其转换为资源模块 argspec 所定义的格式的结构化数据，该值将在结果中的 gathered 键中返回。 状态 parsed 从 running_config 选项读取配置，并根据资源模块参数将其转换为 JSON 格式，该值将在结果中的 parsed 键中返回。running_config 选项的值应与在设备上执行命令 show running-config | include ip route|ipv6 route 的输出格式相同。对于状态 parsed，不需要到远程主机的活动连接。 选择 "merged" ←（默认） "replaced" "overridden" "deleted" "gathered" "parsed" "rendered"

注释

注意

• 在 CML 上针对 Cisco IOSXE 版本 17.3 进行了测试。

• 此模块与连接 network_cli 配合使用。请参阅 https://docs.ansible.org.cn/ansible/latest/network/user_guide/platform_ios.html

示例

# Using merged

# Before state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router-ios#

- name: Merge provided OSPFV3 configuration
  cisco.ios.ios_ospfv3:
    config:
      processes:
        - process_id: 1
          max_metric:
            router_lsa: true
            on_startup:
              time: 110
          address_family:
            - afi: ipv4
              unicast: true
              vrf: blue
              adjacency:
                min_adjacency: 50
                max_adjacency: 50
              areas:
                - area_id: 25
                  nssa:
                    default_information_originate:
                      metric: 25
                      nssa_only: true
          areas:
            - area_id: "10"
              nssa:
                default_information_originate:
                  metric: 10
          timers:
            throttle:
              lsa:
                first_delay: 12
                min_delay: 14
                max_delay: 16
        - process_id: 200
          address_family:
            - afi: ipv4
              unicast: true
              adjacency:
                min_adjacency: 200
                max_adjacency: 200
          max_metric:
            router_lsa: true
            on_startup:
              time: 100
          auto_cost:
            reference_bandwidth: 4
    state: merged

# Task Output:
# ------------

# before: {}
#
# commands:
# - router ospfv3 1
# - max-metric router-lsa on-startup 110
# - area 10 nssa default-information-originate metric 10
# - address-family ipv4 unicast vrf blue
# - adjacency stagger 50 50
# - area 25 nssa default-information-originate metric 25 nssa-only
# - exit-address-family
# - router ospfv3 200
# - auto-cost reference-bandwidth 4
# - max-metric router-lsa on-startup 100
# - address-family ipv4 unicast
# - adjacency stagger 200 200
# - exit-address-family
#
# after:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200

# After state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

# Using deleted

# Before state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Delete provided OSPF V3 processes
  cisco.ios.ios_ospfv3:
    config:
      processes:
        - process_id: 1
    state: deleted

# Task Output:
# ------------

# before:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200
#
# commands:
# - no router ospfv3 1
#
# parsed:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200
#
# After state:
# ------------
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

# Using deleted without any config passed (NOTE: This will delete all OSPFV3 configuration from device)

# Before state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Delete all OSPF processes
  cisco.ios.ios_ospfv3:
    state: deleted

# Task Output:
# ------------

# before:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200
#
# commands:
# - no router ospfv3 200
# - no router ospfv3 1
#
# after: {}
#
# After state:
# ------------
# router-ios#sh running-config | section ^router ospfv3
# router-ios#


# Using overridden

# Before state:
# -------------
#
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Override provided OSPFV3 configuration
  cisco.ios.ios_ospfv3:
    config:
      processes:
        - process_id: 200
          max_metric:
            router_lsa: true
            on_startup:
              time: 200
          address_family:
            - afi: ipv4
              unicast: true
              adjacency:
                min_adjacency: 50
                max_adjacency: 50
              areas:
                - area_id: 200
                  nssa:
                    default_information_originate:
                      metric: 200
                      nssa_only: true
          areas:
            - area_id: "10"
              nssa:
                default_information_originate:
                  metric: 10
    state: overridden

# Task Output:
# ------------

# before:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200
#
# commands:
# - no router ospfv3 1
# - router ospfv3 200
# - no auto-cost reference-bandwidth 4
# - max-metric router-lsa on-startup 200
# - area 10 nssa default-information-originate metric 10
# - address-family ipv4 unicast
# - adjacency stagger 50 50
# - area 200 nssa default-information-originate metric 200 nssa-only
# - exit-address-family
#
# after:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '200'
#           nssa:
#             default_information_originate:
#               metric: 200
#               nssa_only: true
#         unicast: true
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 200
#         router_lsa: true
#       process_id: 200

# After state:
# ------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 200
#  max-metric router-lsa on-startup 200
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast
#   adjacency stagger 50 50
#   area 200 nssa default-information-originate metric 200 nssa-only
#  exit-address-family

# Using replaced

# Before state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Perform replace with provided configurations.
  cisco.ios.ios_ospfv3:
    config:
      processes:
        - process_id: 200
          max_metric:
            router_lsa: true
            on_startup:
              time: 200
          address_family:
            - afi: ipv4
              unicast: true
              adjacency:
                min_adjacency: 50
                max_adjacency: 50
              areas:
                - area_id: 200
                  nssa:
                    default_information_originate:
                      metric: 200
                      nssa_only: true
          areas:
            - area_id: "10"
              nssa:
                default_information_originate:
                  metric: 10
    state: replaced

# Task Output:
# ------------

# before:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200
#
# commands:
# - router ospfv3 200
# - no auto-cost reference-bandwidth 4
# - max-metric router-lsa on-startup 200
# - area 10 nssa default-information-originate metric 10
# - address-family ipv4 unicast
# - adjacency stagger 50 50
# - area 200 nssa default-information-originate metric 200 nssa-only
# - exit-address-family
#
# after:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - afi: ipv4
#         areas:
#         - area_id: '200'
#           nssa:
#             default_information_originate:
#               metric: 200
#               nssa_only: true
#         unicast: true
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 200
#         router_lsa: true
#       process_id: 200
#
# After state:
# -------------
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 200
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast
#   adjacency stagger 50 50
#   area 200 nssa default-information-originate metric 200 nssa-only
#  exit-address-family

# Using Gathered

# Before state:
# -------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Gather OSPFV3 provided configurations
  cisco.ios.ios_ospfv3:
    config:
    state: gathered

# Task Output:
# ------------
#
# parsed:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200

# After state:
# ------------
#
# router-ios#sh running-config | section ^router ospfv3
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

# Using Rendered

- name: Render the commands for provided  configuration
  cisco.ios.ios_ospfv3:
    config:
      processes:
        - process_id: 1
          max_metric:
            router_lsa: true
            on_startup:
              time: 110
          address_family:
            - afi: ipv4
              unicast: true
              vrf: blue
              adjacency:
                min_adjacency: 50
                max_adjacency: 50
              areas:
                - area_id: 25
                  nssa:
                    default_information_originate:
                      metric: 25
                      nssa_only: true
          areas:
            - area_id: "10"
              nssa:
                default_information_originate:
                  metric: 10
          timers:
            throttle:
              lsa:
                first_delay: 12
                min_delay: 14
                max_delay: 16
        - process_id: 200
          address_family:
            - afi: ipv4
              unicast: true
              adjacency:
                min_adjacency: 200
                max_adjacency: 200
          max_metric:
            router_lsa: true
            on_startup:
              time: 100
          auto_cost:
            reference_bandwidth: 4
    state: rendered

# Task Output:
# ------------

# rendered:
# - router ospfv3 1
# - max-metric router-lsa on-startup 110
# - area 10 nssa default-information-originate metric 10
# - address-family ipv4 unicast vrf blue
# - adjacency stagger 50 50
# - area 25 nssa default-information-originate metric 25 nssa-only
# - exit-address-family
# - router ospfv3 200
# - auto-cost reference-bandwidth 4
# - max-metric router-lsa on-startup 100
# - address-family ipv4 unicast
# - adjacency stagger 200 200
# - exit-address-family


# Using Parsed

# File: parsed.cfg
# ----------------
#
# router ospfv3 1
#  max-metric router-lsa on-startup 110
#  area 10 nssa default-information-originate metric 10
#  !
#  address-family ipv4 unicast vrf blue
#   adjacency stagger 50 50
#   area 25 nssa default-information-originate metric 25 nssa-only
#  exit-address-family
# router ospfv3 200
#  max-metric router-lsa on-startup 100
#  auto-cost reference-bandwidth 4
#  !
#  address-family ipv4 unicast
#   adjacency stagger 200 200
#  exit-address-family

- name: Parse the provided configuration and display structured ospfv3 facts.
  cisco.ios.ios_ospfv3:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Task Output:
# ------------
#
# parsed:
#     processes:
#     - address_family:
#       - adjacency:
#           max_adjacency: 50
#           min_adjacency: 50
#         afi: ipv4
#         areas:
#         - area_id: '25'
#           nssa:
#             default_information_originate:
#               metric: 25
#               nssa_only: true
#         unicast: true
#         vrf: blue
#       areas:
#       - area_id: '10'
#         nssa:
#           default_information_originate:
#             metric: 10
#       max_metric:
#         on_startup:
#           time: 110
#         router_lsa: true
#       process_id: 1
#     - address_family:
#       - adjacency:
#           max_adjacency: 200
#           min_adjacency: 200
#         afi: ipv4
#         unicast: true
#       auto_cost:
#         reference_bandwidth: 4
#       max_metric:
#         on_startup:
#           time: 100
#         router_lsa: true
#       process_id: 200

返回值

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

键	描述
after 字典	生成的配置模型调用。 返回：当更改时 示例： "返回的配置将始终与上述参数的格式相同。\n"
before 字典	模型调用之前的配置。 返回：始终 示例： "返回的配置将始终与上述参数的格式相同。\n"
commands list / elements=string	推送到远程设备的一组命令。 返回：始终 示例: ["router ospfv3 1", "address-family ipv4 unicast vrf blue", "adjacency stagger 50 50"]
已收集 字典	从远程设备收集的网络资源的相关信息，以结构化数据的形式呈现。 返回: 当 state 为 gathered 时 示例: "此 输出 将 始终 与 模块 参数规格 格式相同。\n"
已解析 字典	running_config 选项中提供的设备原生配置已根据模块参数规格解析为结构化数据。 返回: 当 state 为 parsed 时 示例: "此 输出 将 始终 与 模块 参数规格 格式相同。\n"
已渲染 list / elements=string	任务中提供的配置以设备原生格式渲染（离线）。 返回: 当 state 为 rendered 时 示例: ["router ospfv3 1", "max-metric router-lsa on-startup 110", "area 10 nssa default-information-originate metric 10"]

作者

• Sumit Jaiswal (@justjais)

集合链接

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