Configuration Reference#

This page consolidates the configuration details that are currently spread across the README and CLI source definitions.

#Global connection options

The following options are shared by most execution commands through global CLI flags.

#Runtime environment variables

rauto currently exposes a small set of environment-based defaults.

#Default runtime layout

By default, runtime data is stored under:

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

What lives there:

• rauto.db
  • saved connections
  • optional saved-connection device model and software version facts
  • unified session records and replay events
  • latest device discovery run and results
  • config fetch command overrides and volatile-line patterns
  • blacklist rules
  • custom device profiles
  • command templates
  • command flow templates
  • custom TextFSM templates and command mappings
  • custom show objects
  • execution template metadata
• backups/
  • generated .tar.gz archives

#Execution recording options

Several execution commands share the same recording model.

The RecordLevelOpt source definition currently exposes two values:

• KeyEventsOnly
• Full

#Command-specific configuration

#rauto exec

flow, show, and config fetch share the same repeatable target selectors and bounded concurrency model.

#rauto show

#rauto template

#rauto flow

#rauto upload

#rauto tx

The source code exposes a richer set of tx controls than the current docs homepage covers.

#rauto tx-workflow

#rauto orchestrate

#rauto config fetch

#rauto session replay

#Agent configuration

rauto agent combines CLI flags, environment variables, and optional config file defaults.

#Agent CLI flags

#Agent config file example

[manager]
url = "http://manager:50051"
token = "my-secret-token"
report_mode = "grpc"

[agent]
name = "agent-beijing-01"
heartbeat_interval = 30
probe_report_interval = 300

#TextFSM customization model

Custom TextFSM data is stored in SQLite.

• custom_textfsm_templates stores named TextFSM template content.
• custom_textfsm_mappings binds (device_profile, command) to a template name.
• Exact commands are normalized before lookup.
• Custom mappings are checked before bundled NTC templates.
• TextFSM parsing is lenient by default: fallback Error rules are filtered before parsing.
• Pass --textfsm-strict-errors on show, exec, template, or flow to preserve those Error rules.
• For exec, template, and flow, parsing is enabled by --parse-textfsm, --textfsm-template, or --textfsm-excel.

#Custom show object model

Custom show objects are stored in SQLite and keyed by (device_profile, object).

• They override bundled show mappings for the same profile and object.
• Object names are normalized, so aliases and punctuation resolve consistently.
• A custom object can set a command, optional execution mode, and optional TextFSM template.
• A custom object can also reference an existing profile-command TextFSM mapping by textfsm_mapping_command.
• When textfsm_mapping_command is set, that mapped command becomes the effective show command and any direct custom-object TextFSM template binding is cleared.
• Disabled custom objects remain stored but are ignored during resolution.

#Web API template stores

The Svelte Web UI and local API expose reusable JSON template stores in addition to CLI command-template stores.

CLI management commands currently exist for tx-workflow template ... and orchestrate template ...; tx block JSON templates are managed through Web/API and executed through the tx block API flow.

The Web connection editor uses /api/connection/detect-facts to run the resolved Profile's version query and return parsed device facts. A partial parse is returned with a warning instead of discarding facts already entered by the operator.

#Inventory configuration model

Current inventory behavior is source-of-truth driven by saved connections.

• There is no separate persistent target database for inventory records.
• Saved connections hold target identity, labels, groups, and vars.
• Inventory CLI focuses on group management.
• Groups contain only a name, optional description, and saved connection host names.

#Operational defaults and guardrails

From the source and current README behavior:

• default device profile is autodetect
• Web console default bind is 127.0.0.1:3000
• first-run Web startup generates a password in ~/.rauto/config.toml; unauthenticated APIs return 401
• agent default bind is 0.0.0.0:8123
• upload timeout defaults to 300 seconds
• tx default name is tx-block
• successful autodetect results are cached by host:port
• session replay reads database records or JSONL recordings produced by execution commands
• credential secrets are encrypted in SQLite, while the master key remains in the operating system keyring

#Related pages

• Commands and Capability Index
• Example Library
• Runtime Data and Configuration
• Web Console and Agent