Skip to content
Guides & References

Connection templates by platform

Every vendor folder in rconfig/rConfig-templates v2.2.2: which templates each holds, which have their own guide page, and where the rest live.

Connection TemplatesUpdated
On this page

Connection templates by platform

The community template library, rconfig/rConfig-templates, holds one folder per vendor. These pages document release v2.2.2: 77 templates across 39 vendor folders, plus a starter template and the Pro-only material in pro-features/. Vendors with more than one template, or with setup the template can’t express on its own, get a page here. The rest are listed in the table at the end, with a link to their folder.

Open source on GitHubrconfig/rConfig-templatesCommunity connection templates for rConfig V8 Core and Pro, with the key legend, the order of operations and the contributing guide.Browse v2.2.2

Reading a template’s header

Every template opens with a comment header that rConfig never reads but people should. Two lines matter when you pick one.

Header line What it tells you
## Edition: core templates run on Core and Pro. pro templates use a Pro-only protocol or key (TL1, script, xFTP, private key auth or prompt sync). Edition follows the capability, not the folder, so cisco/ holds both.
## Status: rconfig-verified (tested by the rConfig team), community-tested (someone ran it against real hardware and reported back) or untested-starter (the right shape on paper, not yet run against a device).

At v2.2.2, nine templates are untested starters, including both Arista templates, the F5 template and both Nokia templates. If you run one, a template test report moves it up a status for the next person.

Choosing within a folder

File names follow one pattern, so the name tells you most of what you need:

<vendor>-<osfamily>[-<version>]-<protocol>-<authmode>[-<variant>].yml
  • enable or noenable: whether rConfig enters a privileged mode after login. Pick noenable when the account already lands at full privilege.
  • ssh or telnet: the protocol. The two behave differently at the end of the session (see anatomy of a template).
  • Variants such as banner, vdom, noninteractive, nousername, kex or vector mark a template built for one quirk. Start with the plain template and move to a variant only when the plain one fails in the way the variant describes.

Optical and Pro-only templates

TL1 templates for Ciena 6500, Infinera DTN-X and Cisco ONS 15454 sit in their vendor folders but are documented in the Optical (TL1) guides. Script, xFTP and SSH private key templates live in pro-features/ and are covered in pull, push and trigger.

Every other vendor

These folders hold one or two templates each, mostly ready to use as they are. Open the folder for the template and any README.

VendorTemplatesNotes
A10 ACOSSSH, enable Untested starter.
Adtran AOSTelnet, enable
AdvaSSH
Alcatel-Lucent AOSSSH, two variants The promptsync template (Pro, rConfig-verified) is for OmniSwitch. AOS has no pager, so paging is off. Retrieval: show configuration snapshot.
Allied Telesis AlliedWare PlusSSH, enable
AudioCodes MediantSSH Paging is turned off through a multi-line configure system sequence.
Avaya ERSSSH (Vector), telnet Both use a vt100 section to get past the splash screen.
Brocade FastIronSSH Paging: skip-page-display.
Calix AXOSSSH Paging: paginate false.
Check Point GaiaSSH Paging: set clienv rows 0.
Digi Accelerated LinuxSSH
EdgecoreSSH
Huawei VRPSSH Set the device’s main prompt to the <device-name> prompt. Paging: screen-length 0 temporary.
Linux (EL)SSH Enterprise Linux hosts (RHEL, CentOS, Rocky, Alma).
NVIDIA Onyx and MLNX-OSSSH, enable Former Mellanox. On Onyx, set no cli default paging enable on the switch.
OpengearSSH Untested starter. A Linux shell: config -g config (classic) or ogcli export (NGCS).
pfSenseSSH The paging command sends 8 to leave the console menu for a shell. Retrieval: cat /cf/conf/config.xml.
RADSSH
Ruckus FastIronSSH, two variants
Siemens RUGGEDCOM ROSSSH Uses a vt100 section for the splash screen.
Ubiquiti UniFi OSSSH, enable
VyOSSSH Paging: set terminal length 0.
ZyxelSSH, enable Untested starter, for the full-CLI ranges (XGS, GS2xxx and above). Restricted-CLI models such as the GS1900 can’t be driven by a template.

Not listed?

The folder list is not a list of supported vendors. Anything that presents a CLI over SSH or telnet can be driven by a template, and most devices need only the prompts, the paging command and the enable setting changed from the starter. See building a template for a new device.


Type to search.