Documentation forKiwi CatTools

Device.Backup.Running Config

The Device.Backup.Running Config activity creates a backup of a device's running configuration and compare it to the current config file on disk. If there are differences, the current config is moved to the "Dated Configs" folder and the filename is appended with the current date. The newly downloaded config then becomes the current config.

An HTML comparison report is created in the Reports folder and a copy is e-mailed to the nominated person. This report includes the device group, device name, host address, backup status, and what was changed. The HTML report also includes devices that failed during the backup process.

The Device.Backup.Running Config activity completes the following tasks:

  1. A connection is made via SSH or telnet to the device.
  2. A command, such as "Show running configuration", is issued.
  3. The configurations are collected and stored on disk in a temporary file.
  4. A check is made to see if there is an existing config file on disk for this device.
  5. If there is an existing config file, the existing file and the new file are compared for differences.
    1. A text and HTML report is made of any differences and stored in the "Reports" folder. A copy of the difference report is sent via e-mail.
    2. The existing config file is moved into the "Dated configs" folder and appended with the current date.
    3. The new config file is put in the "Configs" folder and becomes the current device backup.
  6. If there is no existing config file, the generated config is placed in the "Configs" folder as the current device backup.

Setting up the activity for Device.Backup.Running Config

For information on setting up activities, see Add / Edit scheduled activity details.

Activity options

Configure the options specific to this activity in the Options tab.

Use alternate command

The command issued to backup the running config depends on the device type.

For example, a Cisco router is sent the command Show running-config. If you wanted to send a different command, enter it in this field.

The command must be suitable for all the devices selected for this activity. If your alternate command is only suitable for a Cisco VPN, then make sure only Cisco VPN devices are selected under the devices tab.
Current config file

Specifies the folder and file name of where to store the current device configuration. If an existing file exists a comparison is completed between the two files. If there are no changes, no files is modified.

The default location is \Configs\%GroupName%\Config.Current.Running.%BaseFile%.txt

The variables %GroupName% and %BaseFile% are replaced at run time. For example: C:\Program files\Cattools\Configs\Default\Config.Current.Running.Sales_Router.txt
Dated config file

Specifies the folder and file name of where to store dated configuration files. The current file is moved to the dated config folder when changes are detected.

The default location is \Dated Configs\%GroupName%\Config.Dated.Running.%BaseFile%.%DateISO%-%TimeHHMM%.txt

The variables %GroupName%, %BaseFile%, %DateISO% and %TimeHHMM%are replaced at run time. For example: C:\Program files\Cattools\Dated Configs\Default\Config.Dated.Running.Cisco805.20031006-1914.txt

See the section Filename Variables for a list of variables you can use.
HTML comparison report

Specifies the folder and file name of where to store the HTML comparison report. This comparison report file contains a side by side comparison of the old and new configuration. Changes are highlighted in different colors.

The default location is under \Reports\ConfigChanges\%GroupName%\Config.Changes.Running.%BaseFile%.%DateISO%-%TimeHHMM%.htm

The variables %GroupName%, %BaseFile%, %DateISO% and %TimeHHMM% are replaced at run time. For example: C:\Program files\Cattools\Reports\ConfigChanges\Default\Config.Changes.Running.Cisco805.20031006-1914.htm
Text summary diff report

Specifies the folder and file name of where to store the text based diff report. This diff report file contains a list of the changes found in the old and new configs. This report is a smaller and simpler way to view the changes. Unlike the HTML report, where both the old and new configs are shown in full. The text report only shows the lines that are different.

The default location is \Reports\ConfigChanges\%GroupName%\Config.Changes.Running.%BaseFile%.%DateISO%-%TimeHHMM%.txt

The variables %GroupName%, %BaseFile%, %DateISO%, and %TimeHHMM% are replaced at run time. For example: C:\Program files\Cattools\Reports\ConfigChanges\Default\Config.Changes.Running.Cisco805.20031006-1914.txt
Only notify by e-mail if configs have changed

Run configuration backups as often as you want, but only receive an e-mail notification when changes are detected between two configuration files.
Attach reports to e-mail

Allows you to choose what level of diff reports you are sent via e-mail:

  • HTML compare report only (default)
  • Text diff report only
  • Both reports

If you want full comparison reports with highlighting, use the HTML compare report. If you just want the changes, use the text report.

If you are sending the reports via an insecure medium, such as a corporate network or internet, be aware that the HTML reports contain your full device configuration. SolarWinds recommends that you send password protected HTML reports over an insecure medium.
Zip attachments To reduce network traffic and allow for password protection, you can choose to zip the attachments. This is the recommended and default option. It keeps the e-mail smaller and places all the files in a single attachment, which can be beneficial when you have, for example, 400 devices.
Password protect zip file Protect your configs and reports by adding a password to your zip file. A password protects your files over insecure mediums while in transit to your e-mail box. SolarWinds recommends using current password strength standards when creating a password for your files.