KIWI CATTOOLS ADMINISTRATOR GUIDE Kiwi CatTools Version 3.11.8 Last Updated: Thursday, February 11, 2021 © 2021 SolarWinds Worldwide, LLC. All rights reserved. This document may not be reproduced by any means nor modified, decompiled, disassembled, published or distributed, in whole or in part, or translated to any electronic medium or other means without the prior written consent of SolarWinds. All right, title, and interest in and to the software, services, and documentation are and shall remain the exclusive property of SolarWinds, its affiliates, and/or its respective licensors. SOLARWINDS DISCLAIMS ALL WARRANTIES, CONDITIONS, OR OTHER TERMS, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE, ON THE DOCUMENTATION, INCLUDING WITHOUT LIMITATION NONINFRINGEMENT, ACCURACY, COMPLETENESS, OR USEFULNESS OF ANY INFORMATION CONTAINED HEREIN. IN NO EVENT SHALL SOLARWINDS, ITS SUPPLIERS, NOR ITS LICENSORS BE LIABLE FOR ANY DAMAGES, WHETHER ARISING IN TORT, CONTRACT OR ANY OTHER LEGAL THEORY, EVEN IF SOLARWINDS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. The SolarWinds, SolarWinds & Design, Orion, and THWACK trademarks are the exclusive property of SolarWinds Worldwide, LLC or its affiliates, are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other SolarWinds trademarks, service marks, and logos may be common law marks or are registered or pending registration. All other trademarks mentioned herein are used for identification purposes only and are trademarks of (and may be registered trademarks) of their respective companies. page 2 Table of Contents Introduction to Kiwi CatTools 19 Get started with Kiwi CatTools 19 Features in the free edition versus the enterprise edition of CatTools 21 Comparison of free and licensed features 21 Purchase licenses 21 View purchased licenses 21 Next steps 22 Installing CatTools as an application or a service 23 Install CatTools as an application 23 Install CatTools as a service 23 Install CatTools on a virtual machine 24 Automatic service start up and service dependency 25 Service dependencies 25 Adding service dependencies 25 What is the Kiwi CatTools Manager? 28 Devices supported on Kiwi CatTools 29 Kiwi CatTools Device Matrix 30 Configuring device variations 30 Activities 31 Reports 37 Connections 42 More information on adding devices 47 How to create a custom device 48 Add devices to Kiwi CatTools 50 Add a device using the setup wizard 50 page 3 KIWI CATTOOLS ADMINISTRATOR GUIDE: KIWI CATTOOLS Add a device from the Device pane 50 Device info tab 51 Passwords tab 52 Prompts tab 54 Contact info tab 54 Extra info tab 55 Variations GUI tab 56 Custom devices in Kiwi CatTools 57 Create a custom device 57 Define Kiwi CatTools custom device type using .ini file 60 .ini file sections overview 60 Custom device type .ini template 63 Creating your custom device type .ini file 63 Editing the .ini file 64 Default values 65 Device information 65 Device passwords 67 Device Prompts 69 Device contact information 70 Define Kiwi CatTools custom device script using .txt file 73 Custom device script .txt template 73 Creating your custom device script .txt file 74 Editing the .txt file 74 Unsupported activities 76 Saving the script file 77 Testing your custom device scripts 77 Send us your working scripts 77 page 4 Custom device script cl. variables and functions for Kiwi CatTools 78 Variables 78 Functions 81 Details and examples of functions 83 Testing your custom device 94 Aids to test your device 94 Device specific information 95 Device Variations 96 What are variations? 96 Which devices support variations? 96 Overview of how to use variations 97 Applying variations to a group of devices 97 Variations File Contents 97 Device Variations GUI 102 Saving a device variation 104 Applying a device variation to a group of devices 104 Removing variations 104 How to use variations in Kiwi CatTools 105 Device variations supported by CatTools 105 Prompts tab 106 Full Prompts tab 107 Backup Ignore Text tab 107 Modify Output tab 109 Device Messages tab 110 Additional Commands tab 111 Pre/Post-Login tab 112 Help tab 113 page 5 KIWI CATTOOLS ADMINISTRATOR GUIDE: KIWI CATTOOLS Using Dell devices in CatTools 114 SSH2 connection issues 114 Configure ASA dap.xml file backup 116 Configure backup for 3Com superstack switches 117 Recommended backup plan 117 What commands are issued? 118 Device setup 118 Accessing switch stacks 119 Sending commands to the CLI via CatTools 119 Connecting via a Cisco Terminal Server 120 Set up a terminal server 120 Use the terminal server to connect a device 120 Run an activity when connected to the terminal server 120 Connecting to a device via a session 122 Set up a connection via a session 122 Disclaimer regarding connecting via a session 123 SSH2 for Cisco and Netscreen 124 Add a Cisco VPN device 125 Differences between Cisco VPN Versions 125 Cisco WAAS 126 Backup a device via SFTP or SCP 127 Unsupported devices or device activities in Kiwi CatTools 128 Get support for devices added to CatTools 128 Activities 130 Add or edit activity details in Kiwi CatTools 131 Activity Tab 131 Time tab 132 page 6 Devices tab 134 Email tab 136 Options tab 137 Activities types 138 Database Activities 138 Device Activities 139 Report Activities 141 System Activities 143 DB.Backup.CatTools 144 Setting up the activity for DB.Backup.CatTools 144 DB.UpdateDevice.Password field 145 Setting up the activity DB.UpdateDevice.Password field 145 DB.UpdateDevice.Text field 147 Setting up the activity for DB.UpdateDevice.Text field 147 Device.Backup.Running Config 148 Setting up the activity for Device.Backup.Running Config 148 Why it is important to backup your device configurations? 151 Common scenarios 151 How does backing up my configurations with Kiwi CatTools benefit my organization? 151 Device.Backup.TFTP 153 Setting up the activity for Device.Backup.TFTP 153 Device.CLI.Modify Config 157 Setting up the activity for Device.CLI.Modify Config 157 When to use the Device.CLI.Modify Config activity in Kiwi CatTools 160 Task scheduling 160 How to enter different commands onto each device for Device.CLI.Modify Config 161 Example 161 page 7 KIWI CATTOOLS ADMINISTRATOR GUIDE: KIWI CATTOOLS Device.CLI.Send commands 163 Setting up the activity for Device.CLI.Send commands 163 Run external scripts in Kiwi CatTools 166 Supported device scripts 166 Usage 166 Sample External Scripts 168 Example Generic Script 169 How to enable or disable ports on a Catalyst CatOS switch 173 1. Create a scheduled activity to enable the ports in the morning. 173 2. Create another scheduled activity to disable the ports in the evening. 174 How to backup Cisco IOS image to TFTP server 175 How to download Cisco IOS running config to TFTP server 176 How to download Cisco IOS running config to SCP server 177 Example 177 How to upload Cisco IOS config from TFTP to device 179 How to upgrade Cisco IOS via TFTP 181 How to enter different commands onto each device for Device.CLI.Send 182 Example 182 Save outputs from multiple devices into a single file 184 Catalyst switches 184 Device.ConnectivityTest.Login 185 Setting up the activity for Device.ConnectivityTest.Login 185 Device.ConnectivityTest.Ping 186 Setting up the activity for Device.ConnectivityTest.Ping 186 Device.InterDevice.Ping 187 Hostname and IP address 187 Setting up the activity for Device.InterDevice.Ping 188 page 8 When to use the Device.InterDevice.Ping 189 Checking availability of a central device 189 Device.TFTP.Upload Config 190 Setting up the activity for Device.TFTP.Upload Config 190 Device.Update.Banner 191 Setting up the activity for Device.Update.Banner 191 Device.Update.Password 193 Setting up the activity for Device.Update.Password 193 Report.ARP table 195 Setting up the activity for Report.ARP table 195 Report.CDP Neighbors table 197 Setting up activity for Report.CDP Neighbors table 197 Report.Compare.Running Startup 198 How the activity works 198 Report generation 198 Setting up the activity for Report.Compare.Running Startup 198 Report.Compare.Two files 201 Generating comparison reports 201 Setting up the activity for Report.Compare.Two files 201 Report.Error info table 203 Setting up activity for Report.Error info table 203 Report.MAC address table 205 Setting up the activity for Report.MAC address table 205 Report.Port info table 206 Setting up the activity for Report.Port info table 206 Report.SNMP.System summary 207 Setting up the activity for Report.Compare.Running Startup 207 page 9 KIWI CATTOOLS ADMINISTRATOR GUIDE: KIWI CATTOOLS Report.Version table 209 Setting up the activity for Report.Version table 209 Report.X-Ref.Port MAC ARP 210 Setting up the activity for Report.X-Ref.Port MAC ARP 210 System.File.Delete 212 CatTools naming convention 213 Troubleshoot 'Number of device specific dated files to retain' option not working: 213 Kiwi CatTools internal functions 214 Ignore Text 215 Examples 215 Filename Variables 218 Meta Data 219 Meta Commands 220 Available Meta Commands 220 %ctDB Command 220 %ctUM 223 Meta Variables 225 Available Meta Variables 225 Creating a custom activity 227 Prerequisites 227 Overview 227 How to create a custom activity 229 1. Create a custom activity type file (.ini) 229 2. Edit the .ini file 229 3. Save & restart 230 4. Create a custom activity main script file (.txt) 230 5. Edit the main script .txt file 230 page 10 6. Save the main script .txt file 230 7. Create a custom activity client script file (.txt) 231 8. Edit the client script .txt file 231 9. Save the client script .txt file 231 10. Create a custom activity device script file (.custom) 231 11. Edit the device script .custom file 232 12.