Submit a ticketCall us

Looking to compare latest NPM features with previous versions of NPM?
The NPM new feature summary offers a comparison of new features and improvements offered with this release.





Home > Success Center > Kiwi CatTools > Kiwi CatTools 3.11 Administrator Guide > Activities > Activities list > Device.Backup.TFTP > Setting up a Device.Backup.TFTP activity

Setting up a Device.Backup.TFTP activity

Table of contents
No headers
Created by Caroline Juszczak, last modified by Caroline Juszczak on Jun 28, 2016

Views: 134 Votes: 0 Revisions: 1


Activity tab:

Create a new Activity and select Device.Backup.TFTP as the Activity Type:


Time tab:

If you wish to run the Activity at a scheduled time set it here.


Devices tab:

Select the devices that you want this activity applied to by checking the tick box next to each device in the grid.


E-mail tab:

Set preferences for reporting on this Activity.


Options tab:


Optional alternate list of commands:

To use this option remove the tick from the 'File to write to TFTP Server' checkbox (see below).

Some of the CatTools device scripts will have a default set of commands that can be used to generate and TFTP the config for this activity. However, should there be no default commands for your device you can use this box to enter your own. Below is an example of the sort of commands you may enter;


copy running-config tftp:



NOTE: When specifying the name of the file to be written it must include the %ctDeviceName filename variables as CatTools will use this to correctly identify the file for the compare.


Enter commands in enable mode:

Selecting this check box tells CatTools to enter enable mode before entering any of the commands to the device.


Answer [yes] to any confirmation prompts:

Some commands have confirmations prompts ("are you sure? Y or N") so the program will automatically answer them in the affirmative, on the assumption that if you entered the commands you actually want them to be executed. If this option is unchecked, then the activity will enter an "n" in response to any confirmation requests.


File to write to TFTP server:

If you want to use the default list of commands (where available) to TFTP the file tick this box. Enter the name of the file you want to TFTP in the text box. i.e. running-config, vlan.dat etc.


Current file:

Specifies the folder and file name of where to store the current file. (By default this will be in the configs folder and use 'Config.Current.Running' as part of the file name as the most common use case for this activity is to backup the config by TFTP.) This will also be the filename that the file downloaded by TFTP will be compared against.


Default: ...\Configs\%GroupName%\Config.Current.Running.%BaseFile%.txt


The variables %GroupName% and %BaseFile% will be replaced at run time and produce a folder and file name.


For example:

C:\Program files\Cattools\Configs\Default\Config.Current.Running.Sales_Router.txt


This value is where any new configuration files will be stored. If an existing file exists a comparison will be done against the newly downloaded file. If there are no changes, no files will be modified.


Compare, move to dated file:

Tick this checkbox if you wish to run a compare between the file downloaded and an existing file (as specified by the current file).

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

Default: ...\Dated Configs\%GroupName%\Config.Dated.Running.%BaseFile%.%DateISO%-%TimeHHMM%.txt


The variables %GroupName%, %BaseFile%, %DateISO% and %TimeHHMM% will be replaced at run time and produce a folder and file name.


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.


Ignore Text: Should the new file contain any lines of text that are likely to different from the original file every time the comparison is run (such as a timestamp) and you would like to ignore these lines, they can be added here. More information is available on the Ignore Text field.

Note: to ignore "certificate self-signed" changes on Cisco routers, see the block text ignore example.


Only notify by e-mail if configs have changed:

This allows you to run configuration backups as often as you want, but only receive an e-mail notification when changes are detected.


Attach reports to e-mail:


Sub options:

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

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


If you want the full comparison reports, have it set to send you the HTML compare report. If you just want the changes sent, use the text report.


If you are sending the reports via an insecure medium (corporate network or internet), be aware that the HTML reports contain your full device configuration. It is recommended that you either don't send HTML reports over an insecure medium, or you protect the reports by using a zip password. The longer the password, the harder it is to crack.


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 (great when you have 400 devices). Protect your configs and reports by adding a password to your zip file by typing it in the text box. The longer the password, the harder it is to crack the protection. The password protection will protect your configs from prying eyes while it is in transit to your e-mail box.

Last modified
07:19, 28 Jun 2016