wktools Version 4 Documentation - under construction   (c) 2003 - 2009 by Mathias Spoerr

Table of contents:

  1. General

  2. wktools GUI

  3. Global Functions

  4. ConfigMaker

  5. Configure Devices

  6. IP List

  7. Device Information Parser

  8. Scheduler

1. General

wktools is a collection of tools which simplify the work with network devices, especially Cisco devices. At this time there are the following tools included:

Configmaker, IP list, Configure Devices and Device Information Parser.

How to work with these tools is explaned in the following document.

1.1. License

The application is FREEWARE. Use at your own risk.

1.2. Questions and Feature Requests

Please send questions and Feature Requests to wktools@spoerr.org

1.3. Bug Reports

Please send Bug Reports to wktools@spoerr.org

1.4. Using wktools

• Just execute the application - no installation is needed.
• Under Windows, .net is needed. If you get an error when starting the application, please install/update your .net Framework or the Microsoft Visual C++ 2008 Redistributable Package

1.5. Automatic version check

This feature was added in wktools Version 3.3.0.0.

wktools now checkes if there is a newer version available for download. It establishes a http session to www.spoerr.org and downloads a file with the version information. No other information is exchanged and all traffic is unencrypted.

Due to personal firewalls the version checker sometimes gets no connection and needs to timeout before the tool is startet. For the user it seems that the tool is not working. If this is the case for you, please disable the version check function in the Settings.

1.6. wktools.xml

All settings and tool profiles are saved in wktools.xml, which must be located in the same folder like wktools.exe.

2. wktools GUI

2.1. GUI layout

2.2. Toolbar

	Load File - Only available for Scheduler to load a Scheduler File
	Save Log output to file; For Scheduler it's used to save the Scheduler table
	Copy selected Log window output to clipboard
	Paste clipboard to Log window
	Cut selected Log window output
	Delete Log Output
	Load selected Profile Choose the profile to load in the drop down box
	Save Profile Write the profile name into the drop down box or select an existing profile to overwrite it.
BOX	Profile Selector DropDown Box Select or fill in the Profile name to load/save.
	DeviceGroup Refresh - Only available for Configure Devices; Load Device Group Table; Prerequisite to start Configure Devices
	Start/Stop Tool Select to start; unselect to stop
	Kill Tool - Use with caution.
	Settings
	Detailed Log/Error Log - Select for Error log only; unselect for Detailed Log

2.3. Tool Selector

	wktools - General information
	ConfigMaker: To simply generate many similar files/configurations. There are two data sources needed to achieve this: A pattern file and a data file.
	Configure Devices: To push/collect information to/from a network device. Supported protocols are Telnet, SSHv2, HTTP+S and Serial Console.
	IP List: To find and store IP addresses in config files.
	Device Information Parser: To parse Text files with "show" output from Cisco devices for Serial numbers, Module Information... - Very useful for making an inventory of your Installed base.
	Scheduler: To schedule Tasks/Tools at a specified time or start one or more tools at one time.
	About - General information.
	License - End User Agreement

2.4. Tool Settings

To specify the Tool specific settings. Each setting is described in detail below.

2.5. Log Window

All output of wktools is written into this window. Please use to toggle between "Full Log" and "Error Messages only" views. A documentation of all error messages is available here.

2.6. Tool specific output

This section is differenty used from each tool. ConfigMaker uses it to display the Data File, Configure Devices shows the DeviceGroup File and DeviceInformation Parser diplays the result. The Scheduler lists all configured items.

2.7. How to use the GUI

This section is differenty used from each tool. ConfigMaker uses it to display the Data File, Configure Devices shows the DeviceGroup File and DeviceInformation Parser diplays the result. The Scheduler lists all configured items.

3. Global Functions

3.1. CLI Options

It's possible to start wktools with some parameters to automatically load a profile or start a tool or disable the GUI...

SYNTAX: wktools [-s] [-S] [-h] [-t tool -p profile]

3.2. Settings

4. ConfigMaker

With this tool you can generate configuration files in a fast and easy way. To achieve this, two files are needed: A Template and a Data file. The variable parts are represented by a placeholder like $var in the Template. The data file includes the placeholder names and appendant values.

The output can be stored in two ways:

• A seperate file per Data file line
• One file for everything

4.1. Data File Format

• All placeholders must be in the first line. With the "Non standard format" option everything till the first character of the "Filename Variable" string is ignored (This character is used to mark the bgeinning of the file).
• The very first character of the file is the placeholder identifier, for example a "$" sign.
• Placeholders must not include the following chars: ENTER SPACE /,.;:_-\|()[]{}<>
• The data is seperated by a user editable char (default: ";") and ENTER at the end of the line
• No Spaces are allowed between placeholders
• All records for one file have to be in the same line
• All lines have to be seperated with ENTER
• All of the above statements are true, even if the "Use Seperator as Placeholder End" option is used

If the file is generated with MS Excel and line breaks within a cell are used, please check the "non-standard format" Checkbox. In this case, all "sub-linebreaks" are replaced by " // " and the existing Data file is overwritten with the new data to get compliant with the tool.

If you use Linux, line breaks within cells are not supported, since LF is used for all line breaks. In Windows, line breaks within Cells are marked with LF, while "global" line breaks are marked with CRLF.

4.1.1. Data File enhancements

4.1.1.1. non-standard format

Sometimes it is needed that Line breaks within cells are used in Excel sheets. In this case the line breaks are converted into csv with a LF character. A line break at the end of a line is specified with CR/LF. The LF onlys are now replaced with the string specified at the "Replace LF" option.

4.1.1.2. Flexible Data File

In this case the LFs described under 4.1.1.1. are used to seperate data entries. Each entry is only used once. For an example see the Tutorials at www.spoerr.org/wktools.

4.1.1.3. Use Tags

Tags are specified with two beginning placeholder identifiers - i.e. $$n. With tags you can add Linebreaks or copy entries several times. To get an idea when to use this option (in conjunction with 4.1.1.2.) is, when generating Firewall object-groups where the number of entries could vary for each device.

Possible tags ($ is used in this example as placeholder indentifier):

• $$n: Linebreak
• $$t: Tabulator
• $$s: Space
• $$b: Begin
• $$e: End
• $$i: Number of copies of the dtring between $$b and $$e

4.1.2. Simple Example

Data and placeholders in tabular format:

Needed format:

    $hostname;$lip;$dlci;$sip
    host1;10.1.1.1;100;10.1.2.1
    host2;10.2.1.1;101;10.2.2.1
    host3;10.3.1.1;102;10.3.2.1 
	

NOTE: This example also applies to the scenario when "Use Seperator as Placeholder End" option is used.

4.2. Format of the Template File

Placeholders must be seperated by the text with one of the following chars: CR SPACE /,.;:_-\|()[]{}<>

This statement is false when using the "Use Seperator as Placeholder End" option.

4.2.1. Example

    hostname $hostname
    !
    interface Loopback0
     ip address $lip 255.255.255.0
     no shutdown
    !
    interface Serial0.$dlci point-to-point
     ip address $sip 255.255.255.252
     frame-relay interface-dlci $dlci IETF
    !
    ...
	

4.2.2. Example when using "Use Seperator as Placeholder End" option

Additional Seperator: ";"

    hostname $hostname;
    !
    interface Loopback0
     ip address $lip; 255.255.255.0
     no shutdown
    !
    interface Serial0.$dlci; point-to-point
     ip address $sip; 255.255.255.252
     frame-relay interface-dlci $dlci; IETF
    !
    ...
	

4.3. ConfigMaker Settings

5. Configure Devices

With this tool you can automatically configure Cisco IOS, CatOS and PIXOS devices. Aside these boxes also Linux with the following prompt ending is supported: "$ ".

The supported protocols are Telnet, SSHv2, HTTP+S and Serial Console. This protocols can be combined with one of the following connection types:

• SingleHop: A seperate connection to each Host. All connections are handled one after another.
• MultiHop: One or more hosts are used as entry device. From the last "entry" the true devices are configured. The initial connection is used until all devices are configured.

Note: MultiHop: Don't forget "exit" at the end of the configuration file, because it is not sent per default!

When using the serial console, only MultiHop is supported, since one of the COM Ports is used as first Hop from which all others are configured.

When using HTTP or HTTPS, all output is saved in a file. The config file must contain the urls to request. When using an empty config file, "ip-address/" is downloaded and saved. At this time only one URL is supported. If you cannot live with this limitation, please smend me an email.

If there are "show" commands in the configuration, the output is stored in a file. The filename is either the Hostname or the IP address of the device. It's also possible to save the whole output in one file.

Note: "show" must be written out in full! Otherwise the output will not be saved.

The devices can have different configuration files and/or Username/Passwords. For different Usernames/Passwords there are two possible methods:

Software upgrade for IOS devices is supported. The configuration file must include the following lines:

     copy tftp flash:
     1.1.1.1
     test.bin
     test.bin

5.1. DeviceGroup File

With Version 3.1 a new feature was added: Device Groups. This feature allows you to define the whole dynamic information within one csv file. If the DeviceGroup file is not specified, the Tool generates its own file. The information used to configure the devices is displayed in the Tool specific outout window. The data format is a List. In front of each entry is a checkbox to select the Hosts for the next run - only checked lines are used.

Each entry in the list can be edited and new lines can be added. The information provided in the list is the data basis for configuring the devices. The list is temporarily stored in "tempDevGroup.txt".

The Configuration File can be viewed by right clicking the config file name in the Device Group and using the "Show Config File" option in the popup menu.

If the Device Group data is generated by the tool, the settings in the "Settings Tab" change to "Use Device Groups" and the temporary DeviceGroup File is added to the Settings Panel.

Note: The first element in the table must be checked when using MultiHop. The used protocol in all lines must be the same for Multihop. The used protocol for connections from the first device is specified under "Multihop Command" setting.

5.1.1. DeviceGroup File Format

• Comma Seperated file with semicolon (;) as Seperator
• "ENTER" at the end of each line
• If one subitem is not needed, use two semicolons right after another
• Eleven columns:

5.1.2. Example

    x;1.1.1.1;user1;lopw1;enpw1;conf1.txt;Telnet;;;telnet $ip;host1; 
    x;1.1.1.2;user2;lopw2;enpw2;conf2.txt;COM1;;;telnet $ip;host2;
    x;1.1.1.3;user3;lopw3;;conf3.txt;SSHv1;;;telnet $ip;host3; 
    x;1.1.1.4;user4;lopw4;enpw4;conf3.txt;SSHv2;;;telnet $ip;host4; 
    x;1.1.1.5;user5;lopw5;enpw5;conf5.txt;Telnet;;;telnet $ip;host5; 

5.2. IP Address File Format

• The addresses can be either IP addresses or DNS names
• The addresses must be seperated with one of the following chars: ,;ENTER
• It is possible to enter remarks at the end of the line (See 6.2.1 for an example). These remarks will be taken over to to the Remark column of the DeviceGroup File.

5.2.1. Example

    1.1.1.1; host1
    2.2.2.2;
    3.3.3.3; host3

5.3. Configuration File

• The configuration file has no special format
• Exception: Dynamic Username/Password are included
• In case of dynamic configuration files and/or dynamic Username/Passwords the filename has to be the IP address or DNS name of the device.
• It is also possible to specify a default configuration file which will be taken when no special file is found.
• Two Config Templates are available. These templates are helpful for the "Device Information Parser". One template is for the Inventroy Parser and the second one for the Interface Parser. Use the "Config Option" drop-down Menu to select the template to be used. The commands used in the templates can be found in section 7.1.2 of this document.

5.3.1. Example of a config file with dynamic Username/Password

     !user = username           -> Username
     !lopw = login password     -> Login Password
     !enpw = enable password    -> enable Password
     !
     conf term
     logging buff 8000
     exit
     wr
     show run                  -> running configuration will be stored in file
     show version              -> show version output will be stored in file
     exit

5.4. Configure Devices Settings

5.4.1. DeviceGroup Settings

5.4.2. Host & ConfigFile Settings

5.4.3. User/Password Settings

For more information on how to use more than one Username/Password, please refer to 5.

5.4.4. Connection Settings

5.4.5. Output Settings

5.4.6. Advanced Settings

5.4.7. Debug Options

5.5. Special Config Tags

6. IP List

Use this tool to search configuration files in a directory, including sub directories, for IP addresses of a specified Interface. The result will be stored in a file.

The files to search can be restricted using search patterns for the file name.

6.1. IP List Settings

7. Device Information Parser

• Inventory Parse
• Interface Information Parser

7.1. Inventory Parser

• Hostname
• SNMP Location
• Device type
• Chassis S/N
• Memory
• Bootfile
• Softwareversion
• Installed Modules
• S/N of the Modules
• Hardware Revision (Chassis and modules)
• Memory (Chassis and modules, if applicable)
• PIX/ASA License Information
• Flash size

7.1.1. Supported Devices

7.1.1.1. Cisco Router

• 7600 with Sup720
• GSR (12008)
• 7200VXR
• 7304 NSE
• ASR 100x Router
• ISR x8xx Router
• 3600
• 7500
• 25xx
• 26xx

7.1.1.2. Cisco Switches

• Catalyst 3500XL
• Catalyst 3550
• Catalyst 3560
• Catalyst 3750
• Catalyst 3750 Stack
• Catalyst 4500 IOS
• Catalyst 2900XL
• Catalyst 6500 IOS
• Catalyst 2950
• CatOS based Switches

7.1.1.3. Cisco Other

• LS1010
• AS5300
• 6260 DSLAM
• IOS Access Points
• PIX, ASA, FWSM
• Cisco IP phones - information is collected with http or https

It may work for other IOS or CatOS hardware but there is no guarantee for it. If you have problems with any kind of IOS/CatOS hardware please send an email to wktools@spoerr.org.

7.1.1. Format of the file to parse

7.1.2.1. Template for all devices except 6200 DSLAMs

     show ver           ! Version Information
     show snmp          ! Location Information
     show module        ! Module Information for CatOS Devices
     show c7200         ! NPE Information for 7200 routers
     show diag          ! Module Information for IOS devices
     show invent        ! Module and Chassis Information for IOS devices
     show hardware      ! Module Information for LS1010 devices
     show system        ! Powersupply Information for CatOS devices
     show file system   ! File system Information for getting flash sizes
     exit

7.1.2.2. Template for 6200 DSLAMs

     show ver
     show harware chassis
     show hardware
     show hardware slot x   ! where x is the Slotnumber (Information for all Slots should be collected)
     exit

7.1.2.3. Cisco IP Phones

7.2. Interface Information Parser

With this Parser you can collect interface status information like sent/received Packets or Bytes or Interface errors. At this time only IOS devices (routers and switches) are supported.

The output will be comma seperated file (.csv) with ";" as seperators.

The information the parser uses to collect the statistics is from "show version" and "show interfaces" output. The output of each device has to be stored in a seperate file and the output of both commands must be collected. Otherwise the Parser will fail.

7.3. GUI explanation

8. Scheduler