Skip to content
Guides & References

Pull, push and trigger

Every way rConfig can get a configuration off a device (CLI, TL1, scripts, REST APIs, file uploads and SNMP traps) and how to choose between them.

Connection TemplatesUpdated
On this page

Pull, push and trigger

An interactive CLI session is the usual way rConfig collects a configuration, but not the only one. It can also speak TL1 to optical nodes, run a script you supply, call a REST API, accept a file the device uploads, and use an SNMP trap to decide when to collect. For device records, the template’s connect.protocol is the switch between most of these: change the template and you change the method.


Who starts the transfer

  • Pull. rConfig opens a session to the device and asks for the configuration. CLI, TL1, scripts and API collections all work this way.
  • Push. The device sends a file to rConfig over TFTP, FTP or SFTP, and rConfig files it against the right device. This is xFTP.
  • Trigger. An SNMP trap tells rConfig a change happened. The trap doesn’t carry the configuration: a matching filter queues a normal backup job, which collects the device by its usual method.

Pull gives rConfig control of timing and an immediate success or failure. Push suits devices that can only send files out, or that sit where rConfig can’t open a session to them. Triggers add timeliness to either.

The methods compared

Method Direction and transport What selects it Best for
CLI rConfig to device, SSH or telnet connect.protocol: ssh or telnet, plus the command group Any device with a CLI. The default
TL1 (Pro) rConfig to an optical gateway, TL1 over SSH or raw TCP connect.protocol: tl1 Ciena, Infinera and Cisco optical nodes, including elements behind a gateway
Script (Pro) rConfig runs a script on its own server, which reaches the device however it needs to connect.protocol: script; the command is the script call Devices with no usable CLI, proprietary interfaces, multi-step procedures
API collection rConfig to a REST API, HTTP GET or POST An API collection, not a device record Cloud platforms, SD-WAN controllers, SaaS services
xFTP upload (Pro) Device to rConfig, TFTP, FTP or SFTP connect.protocol: xftp, and a filename or matching rule Devices that push files, or that rConfig can’t connect out to
SNMP trap Device to rConfig, trap on UDP A trap filter with a Download Configuration action Capturing a change within seconds, not at the next schedule

API collections are the exception to “the template decides”: they are their own objects with their own credentials, scheduled through their own task types.

Choosing

  • The device has a usable CLI over SSH or telnet. Use CLI. Even the API Collections docs say so: if a CLI connection works, back the target up as a normal device.
  • The configuration lives behind a REST API. Use an API collection. One credential set authenticates every endpoint in it, and each endpoint is stored as its own file.
  • It’s an optical node speaking TL1. Use TL1. You add and collect the gateway; rConfig discovers the elements behind it and manages each as a device. See the Optical (TL1) guides.
  • Nothing standard fits. Use the Script Integration Engine. Your script does the talking, and its standard output becomes the configuration. See the Script Integration Engine guides.
  • The device can only push, or can’t be reached from rConfig. Use xFTP with the inbound-only template.
  • You want changes captured as they happen. Add SNMP traps on top of a schedule. Traps complement scheduled backups rather than replace them: the schedule still catches changes that never raise a trap.

xFTP also works alongside CLI collection. An upload command in a device’s command group can make the device push a file (a binary or archive, for example) to rConfig during a normal backup.

The Pro templates

The templates for these methods are in the repository’s pro-features/ folder, apart from TL1, whose templates sit with their vendor.

rConfig-templates / pro-features / sie / _base /script_template.ymlView on GitHub
Protocol
script
Reads
connect, failure_criteria
Status
rconfig-verified
rConfig-templates / pro-features / xftp /xftp-inbound-only.ymlView on GitHub
Protocol
xftp
Connects out
Never
Reachability
Ping
rConfig-templates / pro-features / xftp /README.mdView on GitHub
Covers
Transports, file matching
Also
Device-side push commands
rConfig-templates / pro-features / ssh-private-key /ssh-private-key-template.ymlView on GitHub
Protocol
SSH, port 22
Auth
Private key
Status
community-tested

The private key template is an ordinary SSH template with sshPrivKey set. That key is a flag: the key and its passphrase come from the credential set attached to the device. Private key authentication is supported on Pro only.

The xFTP template uses connect.protocol: xftp. Templates on older releases use ftp, which is still accepted.

SSH with telnet as a fallback

A Pro template can name a second protocol with fallbackProtocol (V8.3.1 and later). rConfig probes the primary port, uses the fallback only when nothing answers, caches the result on the device, and moves back to the primary once it works. It chooses a protocol before the session opens; it is not a retry after a failed login. It suits a mixed estate where you don’t know device by device whether SSH is enabled. No template in the repository uses it yet, and telnet isn’t supported on Vector agents. See protocol fallback.

What changes with the method

The method decides more than the transport. It changes how a failure shows up.

Method How a failure shows up
CLI One connection attempt per job, no automatic retry. The device is marked Config Failed and connection-failure notifications are sent.
TL1 An element reached through two or more gateways fails over to another path if its primary gateway can’t be reached.
Script The template’s failure_criteria decide: exit codes, error patterns and required success patterns.
API collection A retry count and delay per collection. From V8.4.2, any endpoint outside 200 to 299 marks the collection Down with a one-line reason, and the endpoints that worked are still saved.
xFTP inbound-only No outbound run, so nothing is marked Config Failed and no connection-failure notification is sent. Status comes from a ping check and from uploads arriving.
SNMP trap Trap-triggered jobs have their own retry and backoff, and a cooldown per filter stops a burst of traps causing repeated backups.

API and script output joins the same configuration history as CLI backups, so diff, search, compliance and notifications apply to them too.


Type to search.