Tools

Read Kiwi CatTools debugging files

The CatTools Debug file provides details regarding the communication transactions between CatTools and the target system. This can be helpful when CatTools is returning errors.

First published date

10/9/2018 8:31 PM

Last published date

10/9/2018 8:31 PM

Overview

This article details how the Kiwi CatTools debug file provides details regarding the communication transactions between CatTools and the target system.  This can be helpful when CatTools is returning errors.

Product section

Kiwi CatTools

Resolution

  1. From within the CatTools Manager, click File > Enable Capture Mode.
  2. Run the Activity that appears to be failing.
  3. Open the device debug file within the following directory:
    \Program Files (x86)\CatTools\Debug\

The debug file contains the following:

  • The CatTools version being used.
  • The Protocol used to connect to the device.
  • The Device Type assigned to the Device in CatTools.
  • The Activity Type being run.

Example 


The DebugLog file also contains within it, the commands and control characters sent to and received from the device.

  • Commands sent are preceded with a <W-…> time-stamped tag.
  • The responses from the device are preceded with an <R-…> time-stamped tag.

 

Below is an extract from a debug log (header and footer removed) showing a simple password-only authentication to arrive at the device non-privileged prompt and then logout:

<C OK 4:06:53 PM>
<R-4:06:53 PM>[13][10][13][10]User Access Verification [13][10][13][10]Password: 
<W-4:06:53 PM>MyPassword[13]
<R-4:06:53 PM>MyPas
<R-4:06:53 PM>sword
<R-4:06:53 PM>[13][10][13][10]EW1_Server_Switch>
<W-4:06:54 PM>logout[13]
<D 4:06:54 PM>
  • The <C …> tag shows the connection being made to the device.
  • The <D …> tag is the disconnect.
  • The [13] and [10] signify a CR and an LF control character respectively.

 

For SSH protocol connections, unless the device is set up with 2-factor authentication (e.g. connection over SSH and local device authentication), you will normally only see the connection <C …> tag and then most likely the device hostname prompt.  The authentication for SSH connections is handled internally by the WODSSH connection client, so it is not written to the CatTools device debug file.

 

Once CatTools is connected and logged in, it will expect one of three things:

  • A user prompt (such as EW1_Server_Switch>)
  • An additional username prompt (such as username:)
  • An additional password prompt (such as password:)

 

If it does not receive either one of these, it will report something like this:

 

<R-4:06:53 PM>Last login: Fri Dec 18 09:14:56 2008 from 10.0.0.0[13][13][10]
<R-4:06:53 PM>Press enter to continue... 
================================================================================
WFMDRetVal=1 Waiting for: "EW1_Server_Switch> "
WFMDRetVal=2 Waiting for: "EW1_Server_Switch#"
WFMDRetVal=3 Waiting for: "Username:"
WFMDRetVal=4 Waiting for: "Password:"
WFMDBuffer="Last login: Fri Dec 18 09:14:56 2008 from 10.0.0.0[13][13][10]Press enter to continue..."
================================================================================

 

To resolve this, you will need to set the Device's Variations to compensate for the unexpected responses from the device. To learn more about Variations, see How to Use Variations . 

 

To resolve the above issue, you would set the Post-Login Variations as follows:

1. Post-Login Keystroke: CR

2. Post-Login Message: Press enter to continue