Submit a ticketCall us
Home > Success Center > Kiwi CatTools > Kiwi CatTools Documentation > Kiwi CatTools 3.11 Administrator Guide > Introduction to Kiwi CatTools > Getting started

Getting started

Table of contents
No headers

Updated September 27th, 2017


You can get started with CatTools in just four simple steps:

  1. Define your configuration options such as email using the Setup Menu. (Using the Options/Setup menu)
  2. Enter the details for at least one network device. (Using the Devices tab)
  3. Create an Activity and associate you device(s) to it. (Using the Activities tab)
  4. Run the Activity. This can be accomplished using either the "Run now" button or the scheduler.

More details on each of these steps follows:

Setting the CatTools configuration options:

  1. Click on the Options | Setup menu.
  2. Set the e-mail options
  3. Enter the e-mail address you want notified of errors and reports into the respective fields.
  4. Enter your e-mail address into the From address field.
  5. Set the details of your main SMTP mail server.
  6. If your server requires authentication, enter the details (most servers do not require this).
  7. Send a test e-mail by pressing the Test button.
  8. Defaults are fine for the rest of the settings while getting started.
Entering devices into the database:
  1. Click the Devices pane.
  2. Click the Add button.
  3. Fill in each of the required fields. When a field has focus, the description of each field is displayed in the status bar (at the bottom of the Device Information window).
  4. Fields marked with an asterisk (*) are required fields and must be filled in.

Creating a scheduled Activity:

  1. Click the Activities pane.
  2. Click Add.
  3. Select the type of activity to perform from the drop down list (e.g. Device.Backup.Running Config).
  4. Give the activity a meaningful unique name and description.
  5. Choose the persistence of the activity (e.g. Permanent or Run once then deactivate).
  6. The report file and e-mail addresses can usually be left as default.
  7. Click Time and set the time you want the activity to run. Leaving the time as "Never" means that you must initiate it manually using the Run now to activate the activity.
  8. If required, you can save your activity to the favorites database. This saves the Time part of the schedule, so you can recall it for use on other activities.
  9. Click Devices and check all the devices you want to connect to for this activity.
  10. Click Options and set any specific options that relate to this activity. In most cases, the options can be left as default.
Running a scheduled Activity:
  1. Click Activities pane.
  2. Check all the Activities you would like to schedule.
  3. Press Start timer.

CatTools will enter into "Active Timer Mode" and run the activities at the scheduled intervals and/or times.


Running an Activity immediately:

  1. Click Activities.
  2. Select the activity you would like to run immediately.
  3. Press Run now (alternatively, right-click the activity and click Run now in the drop down list).
  4. CatTools will run the selected activity and then return to idle mode.

Monitoring the client Activity:

  1. Click Info log.
  2. Select the message level you want to see from the drop down list (Info messages only).
  3. View the messages as they arrive from the clients and main program.
  4. Last message received is shown at the top of the list.
  5. You can resort the info log entries by clicking on one of the column headers within the Info log pane.

Viewing the results:

  1. Click Activity log.
  2. View the results of the activities as they finish.

Viewing a report:

Select the Report pane, click Open and select the text report you wish to view in the report grid.


Viewing captured data and config files:

  1. Click View menu and choose the folder to view.
    CatTools will open a Windows explorer session to the selected folder.
  2. Navigate the folder structure and view the desired files.
Last modified