Skip to content
Guides & References

Command groups and commands

How to divide commands into rConfig command groups, when to use command sets, and how each command's toggles decide what a backup stores and reports.

Connection TemplatesUpdated
On this page

Command groups and commands

The template decides how rConfig talks to a device. The command group decides what it asks for. The split catches people out: if you are looking for where show running-config lives, it is a command, attached to a command group, attached to the device. It is never in the template.

This page covers how to design that layer. Creating groups and commands, and every toggle, are in the main docs: Command Groups and Commands.


The relationships

Object Rule Consequence
Device to command group Every device belongs to exactly one command group A device runs every command in its group, and nothing else
Command group to command Many to many Edit a command once and every group that holds it sees the change
Scheduled task to command group A backup task can target command groups, as well as devices, tags, Smart Groups or Vector agents Splitting groups is one way to give commands different schedules
Device profile to command group A profile names the group a synced device joins Device Sync puts new devices in the right group without a manual step

Command groups were called categories before V7.2.0. The name still appears in URLs, permission tables and some API responses.

How many groups

Every command in a group runs against every device in it. A vendor-specific command in a mixed group fails on the devices that don’t understand it, and depending on the device, that failure can be a timeout, an error in the stored output, or a backup that doesn’t complete. So groups follow the CLI, not the org chart.

A pattern that holds up well:

  • One group per CLI family. Cisco IOS, Junos, FortiOS, EOS and so on. Platforms that accept the same commands can share a group; a FortiGate and an IOS router can’t.
  • Split further only when command needs really differ. Firewalls in a family that also need policy exports, or core routers that also need a BGP summary, are reasons for a second group. Site, customer and owner are not: those belong in tags.
  • Separate frequent from heavy. A nightly configuration backup and a weekly operational snapshot (routing tables, inventory, interface counters) work better as two groups on two schedules than one group that does everything every night.

More groups mean more administration, and every device can only be in one, so start broad and split when you have a reason.

Single commands or command sets

A command can be a single command, or a command set: several commands separated by line breaks, sent one after another.

Single commands Command set
Stored as One file per command One file for the whole set
Change tracking Each command has its own diff, history and notifications One diff across all the output
Toggles and exclusions Set per command One setting covers the set
Good for The configuration itself, and anything you want to watch for change Related informational output you always read together

The configuration deserves its own command, so its changes, integrity check and notifications aren’t tangled with output that changes every run, such as a clock or uptime.

What each command decides

Each command carries four toggles and its own compare options. Between them they decide how much noise a backup creates.

Setting What it decides Usual choice
CIC Whether the output is checked for a complete, valid configuration On for configuration commands, off for short informational ones
Keep Unchanged Config Whether an identical backup stores a full file Off for configuration commands, to save disk
Diff Whether a changed backup is compared with the previous one On, unless the output is pure status
Change Notifications Whether a change sends a notification On only where a change needs someone’s attention
Compare exclusions Lines removed from both sides before comparing Timestamps, counters, rotating keys

“Identical” means identical after exclusions, so an excluded timestamp doesn’t count as a change. Don’t exclude everything (.*) to silence a command: rConfig then treats every backup as unchanged. Turn Diff off instead.

rConfig docsHow to configure diff exclusions in rConfig V8Configure rConfig V8 diff exclusions to filter noise from configuration comparisons using regex patterns, multiline support, and smart filtering.Read the docs

Matching commands to the template

Commands and templates are independent, but they have to agree on the device’s state:

  • Privilege. Commands that need privileged mode only work if the template reaches it (an enable template, or an account that lands at full privilege).
  • Paging. Long outputs need paging turned off in the template, or they stop at the first pager prompt.
  • Shell. Some platforms need the account to land in the right shell before any command works: an F5 account must land in tmsh, not bash.
  • One-line output. rConfig drops the first and last line of each response, so a command whose whole output is one line comes back empty. Choose a command that returns more.

The platform pages list the retrieval commands the template repository suggests for each vendor. See connection templates by platform.


Type to search.