示例库#

这个页面把 rauto 仓库里 templates/examples/ 下的示例文件整理成面向运维团队的“示例库”。

#为什么需要这个页面

仓库里已经提供了不少高质量示例，但如果没有系统索引，团队很难快速知道：

• 哪个示例适合哪个场景
• 哪个示例是命令流，哪个是工作流
• 哪个示例适合单目标事务，哪个适合多设备编排
• 哪些示例可以直接作为企业级变更模板的起点

#示例总览

#命令流示例

#cisco-like-command-flow.toml

适合以下场景：

• copy scp:
• copy tftp:
• 多轮文件导入导出
• 需要多次确认的设备操作

它重点展示：

• prompt 正则匹配
• {{var}} 模板替换
• 运行时变量 schema
• mode 控制
• 命令流模板在 SQLite 中复用

#linux-scp-with-current-and-peer-command-flow.toml

适合 Linux 主机同时引用“当前执行目标”和“另一台已保存连接”的场景。

它重点展示：

• current_connection_alias
• {{peer.host}} 这类跨连接引用
• “变量值指向另一条 saved connection 名称”的模式
• 当前连接与 peer 凭据的混合使用

#工作流示例

#core-vlan-workflow.json

这是理解 tx-workflow 的最佳起点之一。

适合：

• block 命名清晰的事务
• 回滚策略相对简单的变更
• 团队刚开始引入工作流 JSON 的阶段

#fabric-change-workflow.json

适合对 block 模型已经熟悉、需要更复杂单目标变更结构的团队。

常见用途：

• fabric 级变更
• 多 block 且回滚策略不同的变更
• 需要在企业变更评审中复用的标准工作流模板

#Linux 镜像工作流示例

以下三个文件适合 Linux 侧应用或镜像发布：

• linux-image-export-and-transfer-workflow.json
• linux-image-export-and-transfer-with-password-scp-workflow.json
• linux-image-load-and-restart-workflow.json

这类示例非常适合企业文档中的：

• 导出 / 打包 / 分发流水线
• SCP 传输差异路径说明
• 发布后重启或切换步骤说明

#编排示例

#campus-vlan-orchestration.json

这是一个比较紧凑的 staged rollout 示例。

适合学习：

• stage 结构
• 串行 / 并发策略
• tx_block / tx_workflow 动作绑定
• 通过 saved connection 选取目标

#fabric-advanced-orchestration.json

适合更复杂的大规模发布。

常见企业级用途：

• 园区或 fabric 全网变更
• core 与 access 分层发布
• 需要并发控制与 blast radius 控制的上线计划

#linux-image-rollout-orchestration.json

这个示例说明：编排不仅用于网络设备，也适合 Linux 主机批量发布。

适合文档化这些场景：

• Linux 主机批次发布
• 软件 / 镜像统一分发
• 多机分阶段切换

#Inventory 示例

#campus-inventory.json

这是理解 inventory 结构的最佳起点。

重点包括：

• 全局 defaults
• group membership
• 基于 saved connection 名称的 group 成员关系
• 目标级覆盖

#fabric-advanced-inventory.json

适合企业级 inventory 建模。

重点包括：

• 更复杂的 defaults 层次
• 更丰富的目标元数据
• 更贴近真实网络拓扑的 group 结构

#批量导入模板

#connection-import-template-en.csv

#connection-import-template-zh.csv

这两份文件特别适合：

• 运维团队批量接入设备
• 从 Excel / CSV 迁移已有资产表
• 在编排上线前统一 saved connection 规范

推荐表头：

name,host,credential,port,connect_timeout_secs,device_model,software_version,ssh_security,linux_shell_flavor,device_profile,template_dir

#如何选择合适示例

#企业级文档最佳实践

在企业级文档里，不要只写“示例文件名”，还应补充：

• 它解决的生产问题是什么
• 它对 saved connection / inventory 有什么前置假设
• 运行时必须提供哪些变量
• 它是否包含回滚 / 补偿逻辑
• 它属于设备侧交互、目标内工作流，还是多设备编排

#相关页面

• 模板与命令流
• 事务与多设备编排
• 配置参考