1). Define the new device type
Devices are defined to CatTools via ini files in the \Devices folder. Each ini file represents a separate device type. To add a new device, you create an ini file defining the device characteristics. The easiest way to do this is to copy an existing device ini file and make the required changes to the internal settings.
Go to the CatTools \Devices folder and make a copy of a device such as Cisco.Router.General.ini file. Rename the file to reflect the new device, ie MyCoSwitch.New1000.ini . Use the format of vendor.model.ini for the device name.
Choose a unique new id number for the device type from the custom range of 5000 to 5999.
2). Add new client device specific script
The scripts used for devices are located in the \Scripts sub folder and are called by the name of the device type as defined in the device ini file. Create a script file called the same name as you called the device in its ini file, with an extension of .txt instead of .ini.
The easiest way to do this is to create a copy of an existing script file such as the Cisco.Router.General.txt file and rename it to the correct name. This device and its characteristics act as a good template for many other brands of device. If there is another device type that closely resembles the new device, copy that script instead.
There are a number of script functions that must exist before CatTools can access the new device correctly. These are:
Login
DetermineHostname
EnableMode to enter privileged mode
SetTermLenZero to turn off the 'more' paging prompt on long displays
SetTermLen24 to turn paging mode back on after an activity
Then there are the standard functions that may be called to do specific functions from the various activities such as:
BackupRunningConfig back up a configuration
EnterCommand enter one or more commands
... and the functions CatTools has tried to standardise on, such as:
EnterCmdSingle to enter a command to the new device and wait for the device specific prompts
3). Save the new scripts
Before CatTools can access the scripts you have built you must save them in the \Scripts folder. Normally you do not have to stop and restart CatTools, but there may be occasions during testing that you have to do this to get new script code recognised.
4). Test the new scripts
Once you have the scripts set up you can test the new device with CatTools by setting up activities using the new device. The most basic activity to test is the Connectivity.Login test to ensure you can access the device. Once you can gain access, the rest will follow.
5). Send us your working scripts
Send your custom client script file and custom device ini file to support@kiwisyslog.com to have it added to CatTools as a standard device type.