Each device type is configured via a separate .ini file located in the Devices sub folder.
The ini file name is usually in the format of: Vendor.DeviceType.Model.ini .
For example: Cisco.router.General.ini, Cisco.Switch.CatOS.ini or Linux.RedHat.Bash.ini define existing device types.
When CatTools starts, it searches for all the *.ini files in the Devices sub folder and reads their contents. All the device types found are then available for selection when defining devices.
Sections
The main sections inside the INI file are as follows:
The info section. This is required and identifies the ini file as a CatTools V2 file.
The device section. This is required and defines the name used within the CatTools Devices GUI and within scripting, and the unique key of the device type in the database.
Even though the filename of the ini file may be similar to the device name, it is not used to define the device name.
CatTools reserves id's from 0 to 4999 for supplied device types. You can use the number range from 5000 to 5999 for custom devices that you define. You must ensure the number is unique.
[device]
name=MyCoSwitch.New1000
id=5000
The item sections.
Each item section defines the input fields used for the Device setup GUI.
[item_group]
name=Group
default=Default
required=1
info="The logical group that this device belongs to."
Each input field in the GUI has a separate [item_xxx] type section.
The name field sets the text to be displayed next to the input field.
The default field sets the default value to be used when adding a new device to the database.
The required field tells the GUI if the field must contain valid data or not. 0=not required, 1=required.
The info field is the description associated with this field. This text is displayed in the status bar of the GUI when a field has focus.
The above section is a standard text box input field. When the input field is a list box, you need to define the list box contents with the list field...
The list field contains a comma delimited string of items to populate the list box with. The Default field specifies which item to show as the default when adding a new device.
Check box input fields can only accept values of 0 or 1. Any value other than a 1 is considered a 0.
[item_require_vty_login]
name=Initial login requires password
default=1
required=0
info="This device requires an initial password for access"
The size of each field is determined by the design of the Database. Any data entered via the GUI that is too long for the field will be truncated accordingly.
When adding support for a new device, it is recommended that you copy the Cisco.Router.General.ini file and modify the appropriate sections to suit the new device.