跳转到内容

配置参考

这个页面把 README 与 CLI 源码中分散的配置细节汇总为一份统一参考。

下列参数会通过全局 CLI 选项复用于大多数执行命令。

参数来源说明
--hostCLI设备主机名或 IP 地址
--username, -uCLISSH 用户名
--password, -pCLI / RAUTO_PASSWORDSSH 密码
--ssh-port, -PCLISSH 端口
--enable-password, -eCLIEnable / 特权模式密码
--ssh-securityCLISSH 兼容档位:securebalancedlegacy-compatible
--linux-shell-flavorCLILinux shell 退出码解析模式:posix(兼容 bash 别名)或 fish
--device-profile, -dCLI设备 profile 名称,默认 linux
--connectionCLI按名称使用已保存连接
--save-connectionCLI成功后保存当前解析出的有效连接
--save-passwordCLI配合 --save-connection 保存密码与 enable 密码
--template-dirCLI / RAUTO_TEMPLATE_DIR旧参数,现已废弃;模板与自定义 profile 已存入 SQLite

rauto 当前暴露的环境变量默认项并不多,但对自动化部署很重要。

环境变量用途说明
RAUTO_PASSWORD全局认证默认 SSH 密码
RAUTO_MANAGER_URLrauto agent默认 manager 地址
RAUTO_AGENT_NAMErauto agent默认 agent 名称
RAUTO_AGENT_TOKENrauto agent默认 agent 认证 token
RAUTO_MANAGER_REPORT_MODErauto agent默认上报方式
RAUTO_AGENT_PROBE_REPORT_INTERVALrauto agent默认探测上报间隔
RAUTO_HOME运行时目录覆盖默认运行目录 ~/.rauto

默认运行时数据保存在:

~/.rauto
├── rauto.db
└── backups/

其中:

  • rauto.db
    • 已保存连接
    • 历史录制索引
    • 黑名单规则
    • 自定义设备 profile
    • 命令模板
    • 命令流模板
    • 执行模板元数据
  • backups/
    • 生成的 .tar.gz 备份归档

多个执行命令共享同一套录制参数。

参数命令说明
--record-file <path>exectemplateflowuploadtxtx-workflow导出 JSONL 录制文件
--record-level key-events-only同上最小审计级录制
--record-level full同上更丰富的 prompt / 状态录制

源码中的 RecordLevelOpt 当前提供两个枚举值:

  • KeyEventsOnly
  • Full
参数说明
--mode, -m在指定模式执行命令,例如 EnableConfigShell
参数说明
--vars, -vJSON 或 YAML 变量文件
--dry-run仅渲染不执行
参数说明
--template已保存命令流模板名
--file临时 TOML 命令流模板
--vars, -vJSON 变量文件
--vars-json内联 JSON 变量
参数说明
--local-path运行 rauto 的本地文件路径
--remote-path远端目标路径
--timeout-secs上传超时,默认 300
--buffer-size可选传输 buffer 大小
--show-progress输出上传进度日志

源码里 tx 暴露的控制项比当前概览文档更多。

参数说明
--name事务块名称,用于日志与录制
--run-kindcommandscommand-flow
--template从已保存模板渲染命令
--vars--template 的变量文件
--flow-template / --flow-file正向命令流来源
--flow-vars / --flow-vars-json正向命令流变量
--rollback-flow-template / --rollback-flow-file回滚命令流来源
--rollback-flow-vars / --rollback-flow-vars-json回滚命令流变量
--command命令模式下可重复输入的命令
--rollback-command可重复输入的步骤级回滚命令
--rollback-commands-file每行一条回滚命令
--rollback-commands-jsonJSON 数组回滚命令
--rollback-on-failure在步骤级回滚中,对失败步骤本身也执行回滚
--rollback-trigger-step-index触发资源级回滚的步骤索引
--mode目标模式或命令流执行模式
--timeout-secs每步超时
--resource-rollback-command显式资源级回滚命令
--dry-run打印标准化后的 tx 计划
--jsonJSON 输出结果
参数说明
workflow_file必填,工作流 JSON 路径
--dry-run打印标准化计划后退出
--view终端可视化工作流结构
--json输出原始执行结果 JSON
参数说明
plan_file必填,编排计划 JSON 路径
--dry-run打印标准化计划后退出
--view终端可视化编排结构
--json输出编排结果 JSON
--record-level应用于各目标执行的录制级别
参数说明
record_fileJSONL 录制文件路径
--list列出录制的命令输出事件
--command回放指定命令
--mode回放时附加模式过滤

rauto agent 支持 CLI 参数、环境变量和配置文件三层默认项。

参数默认值说明
--bind0.0.0.0Agent 监听地址
--port8123Agent 监听端口
--manager-url注册与上报使用的 manager 地址
--agent-name全局唯一 agent 名称
--agent-tokenmanager 回调与认证共享密钥
--report-modemanager 上报方式
--agent-config~/.rauto/agent.toml可选配置文件路径
--probe-report-interval周期探测上报间隔(秒)
[manager]
url = "http://manager:50051"
token = "my-secret-token"
report_mode = "grpc"
[agent]
name = "agent-beijing-01"
heartbeat_interval = 30
probe_report_interval = 300

当前 Inventory 的目标源是已保存连接,而不是一个独立目标数据库。

  • 不再维护单独的 inventory target 记录层
  • saved connection 负责目标身份、标签、分组与 vars
  • Inventory CLI 重点是 group 管理与变量合并预览

变量合并顺序:

  1. group vars
  2. saved connection vars
  3. runtime vars

根据当前源码与 README:

  • 默认设备 profile 是 linux
  • Web 控制台默认监听 127.0.0.1:3000
  • agent 默认监听 0.0.0.0:8123
  • upload 默认超时 300
  • tx 默认名称是 tx-block
  • replay 读取执行命令生成的 JSONL 录制
  • 已保存密码会加密写入 SQLite,但主密钥仍保存在系统 keyring 中