Skip to content

rConfig V8 Script Integration Engine (SIE)

rConfig V8 Script Integration Engine (SIE)

Section titled “rConfig V8 Script Integration Engine (SIE)”

The Script Integration Engine (SIE) lets rConfig collect a device’s configuration by running your script on the rConfig server instead of opening an SSH or Telnet session itself. Whatever the script prints to stdout is stored, versioned, diffed, searched and checked for compliance like any other backup. Read the Developer Notice and SIE Developer Notice first: you own the code SIE runs.

  • Runs a script in place of a CLI command. A device whose connection template sets protocol: script runs each command in its command group as a script.
  • Passes device data as arguments. Placeholders such as {device_ip}, {device_username} and {device_password} in the command are replaced with values from the device record.
  • Stores stdout as the config. stderr and the exit code are used to judge the run, not stored as config.
  • Checks each run. The template’s failure criteria (exit codes, error patterns and success patterns) decide whether a run passed. Failed runs store nothing and raise the normal backup failure notifications.
  • Runs on the normal schedule. SIE devices are collected by scheduled tasks and on demand, like any other device.

SIE is a collection method. It does not trigger scripts from rConfig events, run scripts on the devices themselves, or push configuration changes. Scripts can only be run by a device download. For automation that changes devices, see Custom Workflows and Custom Commands.

  • Devices with a restricted or menu-driven CLI that a connection template can’t drive.
  • Platforms with no CLI, where the configuration comes from a REST API in several calls.
  • Devices behind jump hosts or extra authentication steps.
  • Things that aren’t network devices, such as a database schema, whose changes you want versioned.

The Script Integration Engine guides cover how scripts work, server setup and copyable recipes:

Uplink guideScript Integration Engine guidesHow the rConfig Script Integration Engine runs your scripts, passes device data in, validates the output and when to use it over a built-in connection.Read the guide