Kiwi Cattools Administrator Guide

Total Page:16

File Type:pdf, Size:1020Kb

Kiwi Cattools Administrator Guide 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.
Recommended publications
  • Alliedview Network Management System (NMS) Administration Guide
    AlliedView Network Management System Administration Guide Release 15.1 613-001999 Rev. B Copyright © 2014 Allied Telesis, Inc. All rights reserved. No part of this publication may be reproduced without prior written permission from Allied Telesis, Inc. Allied Telesis and the Allied Telesis logo are trademarks of Allied Telesis, Incorporated. All other product names, company names, logos or other designations mentioned herein are trademarks or registered trademarks of their respective owners. Allied Telesis, Inc. reserves the right to make changes in specifications and other information contained in this document without prior written notice. The information provided herein is subject to change without notice. In no event shall Allied Telesis, Inc. be liable for any incidental, special, indirect, or consequential damages whatsoever, including but not limited to lost profits, arising out of or related to this manual or the information contained herein, even if Allied Telesis, Inc. has been advised of, known, or should have known, the possibility of such damages. This product contains copyright material licensed from Zoho Corporation, http://www.zoho.com. All rights to such copyright material rest with Zoho Corporation. Table of Contents 1 The AlliedView Network Management System (NMS) - - - - - - - - - - - - - - - - - - - - - - - - - -13 1.1 The NMS Editions - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -13 1.2 Documentation Set - - - - - -
    [Show full text]
  • Allied Telesis Product Catalog, Issue 13 (Summer 2012)
    Issue 13 | Summer 2012 2 Switches 26 iMAP and iMG 32 Media Converters 39 Optical Modules 42 Network Interface Cards 49 Routers 51 Wireless 57 Network Management 61 Index Our Commitment to Excellence Allied Telesis is a world-class leader in delivering IP/Ethernet network solutions to the Known for global marketplace. We create innovative, standards-based IP networks that seamlessly reliability connect users with their voice, video and data services. Publicly traded in Japan and with major corporate divisions in Europe, Asia and the Americas, Allied Telesis is a truly international company ready to service, support, and supply a globally connected customer base of diverse enterprises, organizations and Chosen for governments. Our partners include the world’s largest distributors, integrators, solution quality providers and resellers to assure you receive immediate local service and support. Our solutions are used in a wide variety of complex networking applications, and optimized for very demanding and highly specialized markets such as healthcare, IP surveillance, hospitality, the military and public utilities, to name but a few. Because Recognized for we provide world-class quality and performance at prices suited to budgets facing a challenging world economy, Allied Telesis has become the default standard for many of innovation today’s critical network operations. Our worldwide research and development centers work to bring you innovative products that help your company succeed. We also operate state-of-the-art production facilities, compliant with the world’s most-stringent environmental policies, manufacturing more than 600 different products every month, and shipping globally. As a major industry manufacturer, Allied Telesis is committed to providing you with solutions comprised of products designed and built to the highest-possible standards and quality.
    [Show full text]
  • Dynamic Virtual Network Restoration with Optimal Standby
    DYNAMIC VIRTUAL NETWORK RESTORATION WITH OPTIMAL STANDBY VIRTUAL ROUTER SELECTION A Dissertation IN Telecommunication & Computer Networking and Mathematics Presented to the Faculty of the University of Missouri–Kansas City in partial fulfillment of the requirements for the degree DOCTOR OF PHILOSOPHY by XUAN LIU M.S., University of Missouri–Kansas City, USA, 2010 B.S., China University of Geosciences, Wuhan, Hubei, China, 2007 Kansas City, Missouri 2015 c 2015 XUAN LIU ALL RIGHTS RESERVED DYNAMIC VIRTUAL NETWORK RESTORATION WITH OPTIMAL STANDBY VIRTUAL ROUTER SELECTION Xuan Liu, Candidate for the Doctor of Philosophy Degree University of Missouri–Kansas City, 2015 ABSTRACT Network virtualization technologies allow service providers to request partitioned, QoS guaranteed and fault-tolerant virtual networks provisioned by the substrate network provider (i.e., physical infrastructure provider). A virtualized networking environment (VNE) has common features such as partition, flexibility, etc., but fault-tolerance requires additional efforts to provide survivability against failures on either virtual networks or the substrate network. Two common survivability paradigms are protection (proactive) and restoration (reactive). In the protection scheme, the substrate network provider (SNP) allocates re- dundant resources (e.g., nodes, paths, bandwidths, etc) to protect against potential failures in the VNE. In the restoration scheme, the SNP dynamically allocates resources to restore the networks, and it usually occurs after the failure is detected. iii In this dissertation, we design a restoration scheme that can be dynamically imple- mented in a centralized manner by an SNP to achieve survivability against node failures in the VNE. The proposed restoration scheme is designed to be integrated with a pro- tection scheme, where the SNP allocates spare virtual routers (VRs) as standbys for the virtual networks (VN) and they are ready to serve in the restoration scheme after a node failure has been identified.
    [Show full text]
  • New and Enhanced Features in Alliedware Plus 5.4.4 Major and Minor Versions
    New and Enhanced Features in AlliedWare Plus 5.4.4 Major and Minor Versions » SBx8100 Series » SBx908 Series » x900 Series » x610 Series » x510 Series » IX5 » x310 Series » x230 Series » x210 Series » 5.4.4-0.1 » 5.4.4-1.1 » 5.4.4-2.3 » 5.4.4-3.5 » 5.4.4-4.11 Acknowledgments This product includes software developed by the University of California, Berkeley and its contributors. Copyright ©1982, 1986, 1990, 1991, 1993 The Regents of the University of California. All rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. For information about this see www.openssl.org/ Copyright ©1998-2008 The OpenSSL Project. All rights reserved. This product includes software licensed under the GNU General Public License available from: www.gnu.org/licenses/gpl2.html Source code for all GPL licensed software in this product can be obtained from the Allied Telesis GPL Code Download Center at: www.alliedtelesis.com/support/default.aspx Allied Telesis is committed to meeting the requirements of the open source licenses including the GNU General Public License (GPL) and will make all required source code available. If you would like a copy of the GPL source code contained in Allied Telesis products, please send us a request by registered mail including a check for US$15 to cover production and shipping costs and a CD with the GPL code will be mailed to you. GPL Code Request Allied Telesis Labs (Ltd) PO Box 8011 Christchurch New Zealand ©2014 Allied Telesis Inc. All rights reserved.
    [Show full text]
  • Escuela Superior Politécnica De Chimborazo
    ESCUELA SUPERIOR POLITÉCNICA DE CHIMBORAZO FACULTAD DE INFORMÁTICA Y ELECTRÓNICA ESCUELA DE INGENIERÍA ELECTRÓNICA EN TELECOMUNICACIONES Y REDES “EVALUACIÓN DE RENDIMIENTO E INTEROPERABILIDAD DE UNA PLATAFORMA HW/SW DE ROUTING OPENSOURCE” TRABAJO DE TITULACIÓN: DISPOSITIVO TECNOLÓGICO Para optar al Grado Académico de: INGENIERO EN ELECTRÓNICA, TELECOMUNICACIONES Y REDES AUTORES: ANDRÉS SEBASTIÁN LAGUA GAVILANES JUAN CARLOS LUGMANIA BALLADAREZ TUTOR: ING. ALBERTO ARELLANO AUCANCELA Riobamba – Ecuador 2017 @2017, Andres Sebastian Lagua Gavilanes y Juan Carlos Lugmania Balladarez Se autoriza la reproducción total o parcial, con fines académicos, por cualquier medio o procedimiento, incluyendo la cita bibliográfica del documento, siempre y cuando se reconozca el Derecho de Autor. RESPONSABILIDAD i ESCUELA SUPERIOR POLITÉCNICA DE CHIMBORAZO FACULTAD DE INFORMÁTICA Y ELECTRÓNICA ESCUELA DE INGENIERÍA ELECTRÓNICA EN TELECOMUNICACIONES Y REDES El tribunal del trabajo de titulación certifica que: El trabajo de titulación: EVALUACIÓN DE RENDIMIENTO E INTEROPERABILIDAD DE UNA PLATAFORMA HW/SW DE ROUTING OPENSOURCE”, de responsabilidad de los señores ANDRÉS SEBASTIÁN LAGUA GAVILANES Y JUAN CARLOS LUGMANIA BALLADAREZ, ha sido minuciosamente revisado por los Miembros del Tribunal del Trabajo de Titulación, quedando autorizada su presentación. CERTIFICACIÓN NOMBRE FIRMA FECHA Ing. Washington Luna. DECANO DE LA FACULTAD DE INFORMÁTICA Y ELECTRÓNICA ……………………… ………..…………….. Ing. Franklin Moreno DIRECTOR DE LA ESCUELA DE INGENIERÍA ELECTRÓNICA EN TELECOMUNICACIONES Y REDES ……………………… ………..…………….. Ing. Alberto Arellano Aucancela. DIRECTOR DEL TRABAJO DE TITULACIÓN ……………………… ………..…………….. Ing. Oswaldo Martínez MIEMBRO DEL TRIBUNAL ……………………… ………..…………….. ii Nosotros, Andrés Sebastián Lagua Gavilanes, con cédula de identidad 180382398-6, Juan Carlos Lugmania Balladarez, con cédula de identidad 050288165-9, declaramos que el presente trabajo de titulación es de nuestra autoría y que los resultados del mismo son auténticos y originales.
    [Show full text]
  • Allied Telesis Product Catalog, Issue 11
    Issue 11 | January 2011 Product Catalog 1 Solutions Support, Training 4 and Services 7 Star Partner Program 8 Switches 28 iMAP and iMG 34 Media Converters 41 Optical Modules 44 Network Interface Cards 51 Routers 54 Wireless 61 Network Management 64 Product Index Our Commitment to Excellence Allied Telesis is a world-class leader in delivering IP/Ethernet network solutions to the Known for global marketplace. We create innovative, standards-based IP networks that seamlessly reliability connect users with their voice, video and data services. Publicly traded in Japan and with major corporate divisions in Europe, Asia and the Americas, Allied Telesis is a truly international company ready to service, support, and supply a globally connected customer base of diverse enterprises, organizations and Chosen for governments. Our partners include the world’s largest distributors, integrators, solution quality providers and resellers to assure you receive immediate local service and support. Our solutions are used in a wide variety of complex networking applications, and optimized for very demanding and highly specialized markets such as healthcare, IP surveillance, hospitality, the military and public utilities, to name but a few. Because Awarded for we provide world-class quality and performance at prices suited to budgets facing a challenging world economy, Allied Telesis has become the default standard for many of innovation today’s critical network operations. Our worldwide research and development centers work to bring you innovative products that help your company succeed. We also operate state-of-the-art production facilities, compliant with the world’s most-stringent environmental policies, manufacturing more than 600 different products every month, and shipping globally.
    [Show full text]
  • New and Enhanced Features in Alliedware Plus 5.4.5 Major and Minor Versions (5.4.5-X.X)
    New and enhanced features in AlliedWare Plus 5.4.5 major and minor versions (5.4.5-x.x) » SBx8100 Series » SBx908 » DC2552XS » x930 Series » x610 Series » x510 Series » IX5 » x310 Series » x230 Series » x210 Series » AR3050S NGFW » AR4050S NGFW » VAA » 5.4.5-2.x » 5.4.5-1.x » 5.4.5-0.x Acknowledgments This product includes software developed by the University of California, Berkeley and its contributors. Copyright ©1982, 1986, 1990, 1991, 1993 The Regents of the University of California. All rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. For information about this see www.openssl.org/ Copyright ©1998-2008 The OpenSSL Project. All rights reserved. This product includes software licensed under the GNU General Public License available from: www.gnu.org/licenses/gpl2.html Source code for all GPL licensed software in this product can be obtained from the Allied Telesis GPL Code Download Center at: www.alliedtelesis.com/support/default.aspx Allied Telesis is committed to meeting the requirements of the open source licenses including the GNU General Public License (GPL) and will make all required source code available. If you would like a copy of the GPL source code contained in Allied Telesis products, please send us a request by registered mail including a check for US$15 to cover production and shipping costs and a CD with the GPL code will be mailed to you. GPL Code Request Allied Telesis Labs (Ltd) PO Box 8011 Christchurch New Zealand ©2015 Allied Telesis Inc. All rights reserved.
    [Show full text]
  • EXECUTIVE INFORMATIONAL OVERVIEW Patents and Patent Applications Through Its U.S
    Allied Telesis Holdings, K.K. 2nd TOC Bldg., 7-21-11, Nishi-Gotanda, Shinagawa-ku Tokyo 141-0031, Japan Phone: +81-3-5437-6000 Fax: +81-3-5437-6008 www.at-global.com IP- and Ethernet-based Network Technologies and Solutions Snapshot September 11, 2008 Allied Telesis Holdings, K.K. (collectively, “Allied Telesis,” “the Company,” or “the Group”) delivers advanced, cost-effective, end-to-end Internet protocol (IP)†/Ethernet-based scalable networking solutions and services that meet current and future business demands. Allied Telesis comprises 40 companies operating in 21 countries, which include eight research and development (R&D) centers, multiple production facilities, and a series of sales, marketing, and services offices that synergistically align to create a global leader in the network business. To the Company’s knowledge, it is one of only a few network device vendors in the world that has operations ranging from developing, manufacturing, and marketing high-speed, high-capacity network equipment to providing expert service solutions. Moreover, as an innovator in the expanding IP Triple Play market, Allied Telesis can offer an integrated voice, video, and data solution spanning an entire network—from the core devices to the customer premise equipment (CPE)—over both conventional copper and next-generation fiber optic infrastructure. At present, the Group markets over 700 active products and has 32,000 customers. Since its inception in 1987, Allied Telesis has created more than 2,000 products for over one million customers, resellers, systems integrators, and end users. Allied Telesis believes that its network solutions offer a high level of performance, reliability, security, and manageability, as well as competitive pricing and single-vendor convenience.
    [Show full text]