Redirect Software Configuration Guide v4support.westell.com/Documents/Manuals/Redirect-Version-4-5-Configuration-Guide.pdfThe Redirect software also includes Kentrox Kickstart application

RedirectSerial-to-IP Virtual COM Port Software

Configuration Guide

Version 4.5x

Part Number 65-000132
© 2013 by Kentrox, Inc. All rights reserved.

Copyright © 2013 by Kentrox, Inc. All Rights Reserved. The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication.

Kentrox is a registered trademark of Kentrox, Inc. Applied Innovation, Applied Innovation Inc., the AI logo, and other names are the intellectual property of Kentrox. All other product names are trademarks or registered trademarks of their respective owners.

Information published here is current as of this document’s date of publication, but is subject to change without notice. You may verify product information by contacting our headquarters in Oregon. Kentrox is an Equal Opportunity/Affirmative Action employer.

Kentrox, Inc.5800 Innovation Dr.

Dublin, Ohio USA 43016-3271Toll Free: (800) 247-9482

International: +1 (614) 798-2000Fax: +1 (614) 798-1770

About this Document

This document explains how to configure and operate the Redirect application.

You should have a working knowledge of the following:

Optima Management System and/or Director Network Navigation Tool

The network devices to be monitored by Optima and/or Director

i

Document ConventionsTable 1 describes the text conventions used in this document.

Table 1 Document Conventions

Convention Meaning

Screen Text, Menu Items, System Prompts, Messages and Reports

This style indicates configuration screen text, menu items, system prompts, messages, and reports.

Static Command Text In a command statement, this style indicates text that should be entered exactly as shown at a command line.

Variable Command Text

In a command statement, this style indicates user-specified text.

... In a command statement, ellipses (...) signify that the preceding parameter can be repeated a number of times.

[ ]

[ | ]

In a command statement, square brackets indicate an optional parameter. Two or more parameters in square brackets with a vertical bar ( | ) between them indicate a choice of optional parameters.

{ | } In a command statement, two or more parameters in braces with a vertical bar ( | ) between them indicate a choice of required parameters.

Menus and Menu Commands

This style indicates menu and menu commands. A vertical bar ( | ) separates the menus from the submenus or menu commands. The vertical bar also indicates the order in which you should click the menus, submenus, and menu commands.

Dialog Boxes, Tabs, Fields, Check Boxes, and Command Buttons

This style indicates dialog boxes, tabs, fields, check boxes, and command buttons.

Variable Field Text This style indicates variable information you type in a dialog box field.

KEYS Uppercase body text indicates keys on a keyboard, such as the TAB or ENTER keys. Keys used in combination are connected with a plus symbol (+).

Labels This style designates physical components on Kentrox products such as jumpers, switches, and cable connectors.

ii

Note:

Note messages emphasize or supplement important points of the main text.

Important: Important messages provide information that is essential to the completion of a task.

Tip:Tip messages provide information that assists users in operating equipment more effectively.

CAUTION:

Caution messages indicate that failure to take a specified action could result in loss of data and/or harm to the software or hardware.

WARNING:

Warning messages indicate that failure to take a specified action could result in physical harm to the user.

Table 1 Document Conventions (Continued)

Convention Meaning

iii

Customer AssistanceAll customers, partners and resellers who have a valid Kentrox Support and Services Agreement have complete access to the technical support resources.

Kentrox offers technical support from 8 a.m. to 8 p.m. Eastern time, Monday - Friday.

Before you contact Kentrox for assistance, please have the following information available:

The version of hardware and software you are currently running

The error number and exact wording of any messages that appeared on your screen

What happened and what you were doing when the problem occurred

How you tried to solve the problem

Kentrox Online Knowledge BaseThe Kentrox Online Knowledge Base provides online documents and tools to help troubleshoot and resolve technical issues with Kentrox products and technologies.

To access the Kentrox Online Knowledge Base, use this URL:

http://kb.kentrox.com

Email SupportEmail support is available. You may send email at any time during the day; however, responses will be only be provided during normal business hours, in accordance with your Service and Support Agreement.

To contact Technical Support, send email to:

[email protected]

Telephone Support

Pre-sales support Available, at no charge, to anyone who needs technical assistance in determining how Kentrox products or solutions can help solve your technical needs.

Phone number: 800-733-5511, option 2

Hours of Operation: 8 a.m. – 8 p.m. Eastern Time

Post-sales supportAvailable to qualified Kentrox customers or partners who have not been able to resolve their technical issue by using our online services. To qualify for support, you must have a valid Support and Services Agreement.

Phone number: 800-733-5511, option 3

iv

http://kb.kentrox.com

Normal Business Hours: 8 a.m. to 8 p.m. Eastern time

After-Hours Support: Available to qualified customers who are experiencing service-affecting outages that cannot wait until the next business day. To qualify for after-hours support, you must have a valid 24x7 Support and Services Agreement. Call the number above, option 3, and follow the prompts for after-hours service.

Product DocumentationYou can also access and view the most current versions of Kentrox product documentation on our Web site at:

http://www.kentrox.com

v

vi

Table of Contents

Chapter 1: Getting Started with Redirect ................................................1-1Product Description ...................................................................................................... 1-2Redirect System Requirements ................................................................................... 1-2Installing Redirect ......................................................................................................... 1-3

Removing Prior Redirect Versions ...................................................................1-3Configuring Windows Permissions for Redirect ...............................................1-4

Chapter 2: Using Redirect ......................................................................2-1Launching Redirect ...................................................................................................... 2-2Using the Redirect GUI ................................................................................................ 2-2

Creating a Connection Profile ..........................................................................2-2Editing a Connection Profile ............................................................................. 2-2Deleting a Connection Profile ........................................................................... 2-3Opening a Connection Profile ..........................................................................2-3Opening a Connection Profile Using the SiteVPN Option ................................2-4Setting a Default Connection Profile ................................................................2-5Using the Redirect Connection Dialog Box ......................................................2-5

Redirect Options .......................................................................................................... 2-6Display message box on hide ..........................................................................2-6Disable real COM ports if present ....................................................................2-6Force Redirect to use the following local IP ports ............................................2-7Local IP port for process communication .........................................................2-7Local IP Port for VPN Management .................................................................2-7Custom OpenVPN Path ................................................................................... 2-7

Redirect Connection Settings ....................................................................................... 2-8Ports Tab .......................................................................................................... 2-8SiteVPN Hosts Dialog Box ............................................................................. 2-10Advanced Tab ................................................................................................ 2-12Control Lines Tab ........................................................................................... 2-14Logging Tab ................................................................................................... 2-15

Applications ................................................................................................................ 2-17Detecting Applications .................................................................................... 2-17Working with Application Entries ....................................................................2-18

Redirect SiteVPN ....................................................................................................... 2-20Auto Login Script Settings .......................................................................................... 2-22

Using the Simple Script Type ......................................................................... 2-22

TOC-1

Table of Contents

Using the Advanced Script Type ....................................................................2-24Redirect Command Line Parameters ......................................................................... 2-26

Chapter 3: Using Kickstart .....................................................................3-1Launching Kickstart ...................................................................................................... 3-2Using the Kickstart GUI ................................................................................................ 3-2Configuring an IP Address for an RMM-1400 Device ..................................................3-4

Appendix A: Integrating Third-Party Software and Devices with Director and Redirect ................................................................................................... A-1

Overview ......................................................................................................................A-2Installing Redirect .........................................................................................................A-2Creating a Redirect Connection Profile ........................................................................A-3Configuring the Director Client .....................................................................................A-5

Copyrights and License Statements 1

TOC-2

1

Getting Started with Redirect

This chapter provides a description of Redirect, system requirements for supporting Redirect and instructions for installing Redirect.

Guide to this Chapter

Product Description

Redirect System Requirements

Installing Redirect

1-1

Redirect Version 4.5x Configuration GuideGetting Started with Redirect: Product Description

Product DescriptionRedirect provides a means for legacy software to communicate with a device over an IP network. Legacy software typically expects to communicate with a device through a serial port. In many cases, this is impractical.

Using Kentrox equipment, the device’s serial connection is mediated onto an IP network. Redirect creates a virtual serial port on a Windows PC that can communicate through a TCP/IP socket over the IP network to the device.

Redirect is used to create VPN connections from the PC to a Kentrox RMX-3200 or RMM-1400 at a customer's site.The VPN connection provides additional secure access to devices.

The Redirect software also includes Kentrox Kickstart application. Kickstart is used to discover Kentrox devices on the local network and configure IP addresses for those devices.

Redirect System RequirementsThe following prerequisites are necessary to run Redirect:

Microsoft Windows 2000, Windows XP, Windows Vista, Windows 7 or Windows Server 2008

Microsoft .NET Framework version 2.0 (included on the Kentrox Redirect Installation CD)

1-2

Redirect Version 4.5x Configuration GuideGetting Started with Redirect: Installing Redirect

Installing RedirectInsert the Redirect CD-ROM on your PC. Redirect installation starts automatically. If the installer does not automatically start when you insert the Redirect CD, run the setup.exe file from the CD. During installation, the Redirect installer verifies the Microsoft .NET Framework is installed and loads the .NET Framework if necessary.

Note: The Redirect installation wizard allows you to select whether you want

Redirect to be available to Everyone or Just me. If you are upgrading from a previous version of Redirect and do not select the same option used in the previous version, the wizard will not remove the previous version. You must then follow the instructions in Removing Prior Redirect Versions to remove the previous version.

When installation is complete, icons for Redirect and Kickstart should display on the computer’s desktop.

Removing Prior Redirect VersionsRedirect will attempt to remove any previously-installed version, but depending on the options selected during installation, it may not be successful.

To manually remove a prior Redirect version from Windows XP/2000:

1. Open the Windows Control Panel.

2. Double-click Add or Remove Programs.

3. Select AIredirect (for versions 3.0 and lower) or Kentrox Redirect (for versions 4.0 and higher) in the list of installed programs.

4. Click Remove.

To manually remove a prior Redirect version from Windows Vista:

1. Open the Windows Control Panel.

2. Select Programs > Programs and Features.

3. Select AIredirect (for versions 3.0 and lower) or Kentrox Redirect (for versions 4.0 and higher)

4. Click Uninstall.

1-3

Redirect Version 4.5x Configuration GuideGetting Started with Redirect: Installing Redirect

Configuring Windows Permissions for RedirectYou must be logged in as a user with Admin privileges to load and run Redirect on a Windows XP PC. If other users on the PC need access to Redirect, manually adjust permissions as follows:

1. In the directory C:\Program Files\Kentrox, right-click the Redirect folder and select Properties.

2. The Redirect Properties dialog box opens (refer to Figure 1-1). Click the Security tab.

Figure 1-1 Redirect Properties Dialog Box

3. In the Name list, click Users. Users may be followed by the specific name of a user, such as Users (JaneDoe\Users) if the user JaneDoe is logged on to this PC.

4. In the Permissions list, select the Full Control checkbox in the Allow column.

5. Click OK to close the Redirect Properties dialog box and save your changes.

1-4

2

Using Redirect

This chapter provides:

Instructions for using the Redirect GUI to create, open and close connection profiles

Instructions for setting Redirect options and connection settings

Descriptions of Redirect commands that can be entered from a command prompt


Launching Redirect

Using the Redirect GUI

Redirect Options

Redirect Connection Settings

Applications

Redirect SiteVPN

Auto Login Script Settings

Redirect Command Line Parameters

2-1

Redirect Version 4.5x Configuration GuideUsing Redirect: Launching Redirect

Launching RedirectLaunch Redirect by either of the following methods:

Select Start > Programs > Kentrox Redirect > Kentrox Redirect

Double-click the Kentrox Redirect icon from the desktop

Redirect launches and the Redirect GUI displays.

Using the Redirect GUIRedirect saves multiple connection profiles and displays them as a list in the main GUI window (refer to Figure 2-1).

Figure 2-1 Redirect GUI

Creating a Connection ProfileCreate new connection profiles by clicking the New button or by selecting Connections > New.... to open the Create New Connection dialog box.

Editing a Connection ProfileOnce created, a connection profile can be modified. Select the connection profile from the list and click the Modify button or select Connections > Modify... to open the Modify Connection dialog box.

Note: Refer to Redirect Connection Settings for instructions on how to use the

Create New Connection and Modify Connection dialog boxes.

2-2

Redirect Version 4.5x Configuration GuideUsing Redirect: Using the Redirect GUI

Deleting a Connection ProfileTo delete a connection profile, select it click the Delete button or select Connections > Delete.

Opening a Connection ProfileTo open a connection profile, select it and click the Open button or select Connections > Open. A Connection dialog box displays (refer to Figure 2-2) and Redirect attempts to create the virtual port. Multiple Redirect Connection dialog boxes can be opened from the main Redirect GUI window.

Figure 2-2 Redirect Connection Dialog Box

Note: If an application has opened a virtual serial port that Redirect created, it is

possible that this virtual port will stay in memory even after closing Redirect. If Redirect is restarted, this virtual port will not be able to be created again. To remove ports, select Tools > Remove Previous Ports to clear all old virtual serial ports from memory.

2-3


Opening a Connection Profile Using the SiteVPN OptionRedirect is used to create VPN connections from the PC to a Kentrox RMX-3200 or RMM-1400 at a customer's site.The VPN connection provides additional secure access to devices at that site.

To open a connection profile using the SiteVPN option, select the profile from the list and click the Open button or select Connections > Open. Redirect will attempt to connect to the configured SiteVPN server.

If a remote SiteVPN server requests authentication, a Login dialog box displays requesting a username and password for the VPN server (refer to Figure 2-3).

Figure 2-3 Kentrox Redirect SiteVPN - Login Dialog Box

Once the connection is established, the SiteVPN status dialog box automatically minimizes and will display as an icon in the system tray (refer to Figure 2-4) indicating that the VPN connection is active.

Figure 2-4 Kentrox Redirect with SiteVPN Option Icon

When the mouse pointer is moved over the icon in the system tray, a tool tip displays indicating the connection status. Right-click on the system icon to display a menu with the following options:

Show Status

Disconnect

Exit

About

2-4


Setting a Default Connection ProfileTo make a connection profile the default entry, select it and select Connections > Set as Default Connection.

Tip: When Redirect launches, press the Enter key on the keyboard to open the default connection profile.

Using the Redirect Connection Dialog BoxThe Redirect Connection dialog box (refer to Figure 2-2) provides the current connection status on the bottom status bar. When a connection is first opened, Redirect immediately attempts to create the virtual port. By default, the connection will wait in an idle state for the port to be opened by another application. When the port is opened, Redirect attempts to contact the configured remote host.

If you click the Close button, the connection to the remote host is broken and the virtual port is closed. The Redirect Connection dialog box will automatically close.

If you click the Hide button, or close the Redirect Connection dialog box without clicking the Close button, the virtual port remains open and the Redirect Connection dialog box “hides” as a small notification icon in the system tray. To redisplay the Redirect Connection dialog box, double-click the notification icon.

The Status/Log tab in the Redirect Connection dialog box displays log messages which can be used for general troubleshooting. You can enable logging by clicking the Enable Log button. To disable logging, click the Disable Log button.

Save the text in the log window as a text (.txt) file by clicking the Save Log button. To clear the log window, click the Clear Log button.

2-5

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect Options

Redirect OptionsTo view or modify the options for Redirect, select Tools > Options.... The Options dialog box displays (refer to Figure 2-5).

Figure 2-5 Options Dialog Box

The Options dialog box options are explained below.

Display message box on hideIf this option is selected, Redirect displays a brief message indicating it has hidden the Redirect Connection dialog box as a small icon in the system tray.

Disable real COM ports if presentIf this option is selected, Redirect disables the system (real hardware) COM port with the same name as the Virtual Serial Port value in the connection settings. When the virtual serial port is closed, Redirect will attempt to re-enable the system COM port.

This option should only be used when the legacy software being used forces the use of a virtual serial port name that conflicts with a real system COM port.

2-6

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect Options

Force Redirect to use the following local IP portsIf this option is selected, Redirect attempts to use local IP ports only from the given list.

If this option is disabled, Redirect asks the operating system for any available port.

After enabling this option, enter one port number per line in the data field provided. Valid port numbers are 0 through 65536. Entering 0 is the same as disabling the Force Redirect to use the following local IP ports option.

Tip: It is recommended that at least three ports be entered into the list because it can take several minutes for a port to become available again after the connection is terminated.

Local IP port for process communicationThe main Redirect GUI window communicates to each Connection dialog box by using a local IP port. The default value should work in most cases. If Redirect reports an error such as Could not listen on port xxx, then change this setting. Valid port numbers are 1 through 65535.

Note: To use this change restart the main Redirect GUI window and all Connection

dialog boxes.

Local IP Port for VPN ManagementIf a Redirect connection requires SiteVPN, Redirect will manage the SiteVPN connection by using a local IP port. The default value should work in most cases. If Redirect reports an error such as Could not listen on port xxx then this setting should be changed. Valid port numbers are 1 through 65535.

Custom OpenVPN Path Redirect SiteVPN requires that the OpenVPN application be installed on the same machine. The OpenVPN application is normally installed with Redirect which enables Redirect to automatically locate the openvpn.exe file. If the OpenVPN application is installed in a custom location, the path where openvpn.exe is located must be configured.

Note: To use a custom OpenVPN path, Redirect SiteVPN must be stopped. Locate

and right-click the Redirect SiteVPN icon in the system tray and select Exit.

2-7

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect Connection Settings

Redirect Connection SettingsThe following section describes the connection settings that are available in the Create New Connection and Modify Connection dialog boxes.

Ports TabThe Ports tab (refer to Figure 2-6) contains the required settings for a connection profile.

Figure 2-6 Modify Redirect Connection Dialog Box - Ports Tab

Profile NameA unique name (may contain spaces) that identifies the connection profile.

Virtual Serial PortThe name of the virtual serial port that the legacy software will open. The name may contain letters and/or numbers but not spaces or other characters.

Host name or IP addressThe host name or IP address of the network host to which Redirect will connect.

2-8


Host TCP PortThe TCP port that the TCP host is listening on. Port 23 is the standard port for Telnet hosts.

ProtocolSelect TCP if the host Redirect is connecting to is listening on a specific TCP port and expects data in raw TCP packets. If TCP is selected, the Host TCP Port value must also be set.

Select Telnet if the host Redirect is connecting to is a Telnet server (such as a Telnet proxy). Login Method values can be specified to automate the process of logging into the proxy server.

Negotiate Binary Mode

Select this option if the legacy software and the remote end device will be communicating using 8-bit characters. Valid for Telnet protocol connections only.

Select SSH (Secure Shell) protocol if the host Redirect is connecting to an SSH server. A login name (username) can be specified in the Login field to automate the process of SSH authentication.

Note: The SSH server must support SSH2 and keyboard-interactive mode.

All other authentication prompts from the server (such as password) will be displayed in the client at connection time.

Note: The login (username) to use for authenticating with the SSH server. If this is

blank, a login as: prompt will be displayed in the client window at connection time. For security purposes, SSH passwords are not configurable and will be prompted for at connection time.

Login MethodThis setting determines what Redirect does after establishing a connection with the remote host.

If None is selected, the communication path between the virtual port and the host is established immediately.

If Client Window is selected, a terminal dialog box displays with text fields for a username, password and other login parameters. This information is used to connect manually to the remote end device via the proxy. After you enter these parameters, click the Continue button to close the client window.

If Auto Login Script is selected, Redirect uses the Auto Login Script settings to automatically log in and enter an optional command to connect to the remote end. Refer to Auto Login Script Settings for a detailed description of these settings.

2-9


Use CR for Login newlineIf this option is selected, Redirect will use a carriage return (ASCII decimal 13) for the newline character for all client window and script communication to the remote host.

If not selected, Redirect will use a line feed (ASCII decimal 10) for the newline character for all client window and script communication to the remote host.

Note: Testing has shown that the Use CR for Login newline option should be

selected for Windows Telnet servers and not selected for SUNOS Telnet servers.

Use SiteVPNIf this option is selected, Redirect will attempt to connect to the specified Site VPN server before connecting to the remote host.

SiteVPN HostsThe hostname or IP address of the SiteVPN server. This setting is only valid if Use SiteVPN is selected. Click the SiteVPN Hosts button to configure SiteVPN server.

SiteVPN Hosts Dialog BoxThe SiteVPN Hosts dialog box (refer to Figure 2-7) displays the servers that Redirect can connect to. You can add, edit and delete profiles from this dialog box. Once a SiteVPN server is created, a Redirect connection can be configured to use that server.

Figure 2-7 SiteVPN Hosts Dialog Box

To create a new SiteVPN server, click the Add New... button. The SiteVPN Entry dialog box displays (refer to Figure 2-8).

2-10


To modify an existing SiteVPN server, locate and select the appropriate host listed in the SiteVPN Hosts dialog box. Click the Edit Selected... button to display the SiteVPN Entry dialog box (refer to Figure 2-8). Make the necessary changes and click the OK button.

To delete an existing SiteVPN server, select the appropriate server and click the Delete Selected button.

Figure 2-8 SiteVPN Entry Dialog Box

HostThe server name or IP address of the SiteVPN server that Redirect will connect to.

PortThe network port on which the SiteVPN server is listening to take SiteVPN connections. The port must match the SiteVPN server configuration.

ProtocolThe protocol that will be used in the connection. The protocol selection must match the SiteVPN server configuration.

CipherThe cipher that will be used in the connection. The cipher selection must match the SiteVPN server configuration.

2-11


Advanced TabThe Advanced tab (refer to Figure 2-9) provides advanced settings for a connection profile, such as timeouts and character padding.

Figure 2-9 Modify Redirect Connection Dialog Box - Advanced Tab

Connection RetriesThis value specifies the number of times Redirect attempts to establish the connection before giving up.

Reconnect Attempt Wait (ms)This value specifies the amount of time (in milliseconds) Redirect will wait after a connection attempt failure before re-attempting to establish the connection.

Reconnect On Send If DisconnectedIf this option is selected, Redirect will not close the virtual serial port when the connection to the host is lost. Instead, Redirect will go into Idle mode and wait for input from the virtual serial port before attempting again to establish a connection to the host.

If this option is not selected, Redirect will attempt to close down the virtual serial port when the connection to the host is lost.

2-12


Hide Window Upon ConnectIf this option is selected, the Redirect Connection dialog box will automatically hide as a small notification icon in the system tray after the virtual port has been created.

Tip: To make the Redirect dialog box visible again, double-click the small notification icon (Kentrox logo) in the system tray. This icon will be a dark green color if Redirect is Connected to or Disconnecting from the remote host. The icon will be a white color if Redirect is Connecting to, Idle, or Disconnected from the remote host.

If this option is not selected, the Redirect Connection dialog box will remain visible after the virtual port has been created. You can manually hide the Redirect Connection dialog box by closing it.

Start In Idle ModeIf this option is selected, Redirect will not attempt to connect to the remote host right away, but will wait first for input from the virtual serial port and then attempt to establish a connection to the host.

If this option is not selected, Redirect will immediately attempt to connect to the remote host.

Idle When Virtual Port is ClosedIf this option is selected, Redirect will disconnect from the remote host when the virtual serial port is closed by the external application. Redirect will remain in Idle state, waiting for the port to be re-opened before attempting to reconnect to the remote host.

If this option is not selected, Redirect will stay connected to the remote host when the virtual serial port is closed.

Display Live TX/RX CountersIf this option is selected, the Status tab will also display the number of bytes transmitted and received by the virtual serial port. The Status tab of the Redirect Connection dialog box displays information about the virtual serial port such as open/closed status, baud rate, parity, stop bits and data bits.

Strict Baud Rate EmulationIf this option is selected, Redirect will force the virtual serial port to emulate the speed of the baud rate assigned for the serial connection.

2-13


Exit On Close Delay (ms)This value specifies the amount of time (in milliseconds) the Redirect Connection dialog box will wait before disconnecting and exiting after the launched application closes the virtual port.

If the virtual port is re-opened (by the launched application or another application), Redirect will not disconnect and exit. If this value is set to zero (0), the Redirect Connection dialog box will disconnect and exit immediately upon the virtual port closing.

Note: This setting has no effect unless the Redirect Connection dialog box is

executed from the command line using the /exit_on_close+ command line parameter.

Character PaddingIn this field, enter the characters that require other characters to be inserted immediately after them before transmission to the remote host.

Enter one character padding sequence per line. Each sequence consists of two character values. Each character value should be represented by its decimal ASCII equivalent. The two values should be separated by a space.

For example, to pad all CR (carriage returns) with a LF (line feed), enter the number 13 followed by a space, followed by the number 10.

Important: If connecting to the remote host via a Telnet proxy, the Telnet client on the proxy will most likely interpret characters 29 and 157 as an escape command. Each of these characters should be padded with itself to ensure that the Telnet client passes the characters through without going into escape mode.

To do this, enter the number 29 followed by a space, followed by another number 29. On the next line, enter the number 157 followed by a space, followed by another number 157.

Control Lines TabThe Control Lines tab (refer to Figure 2-10) can be used to change the default control line behavior of the virtual serial port for DCD, DSR and CTS signals based on certain events.

2-14


Figure 2-10 Modify Redirect Connection Dialog Box - Control Lines Tab

EventsThis is a list of pre-defined events that are triggered by the virtual serial port. If you select one of these events, you can edit a corresponding list of control line responses in the Responses list.

ResponsesThis is a list of the currently defined responses for the selected event in the Events list.

A response consists of the name of the control line signal (DCD, DSR, or CTS), followed by a space, followed by either ON or OFF. Enter one response per line.

If the Response text box is left blank for an event, then no action will be taken for that event.

Logging TabThe Logging tab (refer to Figure 2-11) is used to control what type of logging will be done when the connection profile is opened.

2-15


Figure 2-11 Modify Redirect Connection Dialog Box - Logging Tab

Enable LoggingIf this option is selected, Redirect will display log messages in the Redirect Connection dialog box Log tab. The basic level of logging includes event logging and general messages.

Byte Stream Logging

If this option is selected, Redirect will log a hex dump of every character sent to or received from the remote host. This level of logging should be used sparingly, especially when large amounts of data at high speeds are being transmitted. This can be very useful for debugging auto-login scripts.

Capture Log to fileIf this option is selected, Redirect will capture all text displayed in the Log tab window to the file specified in the corresponding File field. This is useful when large amounts of data need to be logged because the Log tab automatically purges older lines of data from its buffer.

2-16

Redirect Version 4.5x Configuration GuideUsing Redirect: Applications

ApplicationsThe Applications dialog box (refer to Figure 2-12) displays a list of the configured applications that Redirect can launch. To open the Applications dialog box, select Tools > Applications from the Redirect GUI.

Figure 2-12 Applications Dialog Box

From the Applications dialog box, you can add, edit and delete entries from the list. You can also sort the application launch order using the arrow buttons. When you click a hyperlink requesting a protocol, Redirect will launch the topmost application that matches that protocol.

Detecting ApplicationsRedirect can auto-detect if certain known applications (such as Telnet or FTP) are installed on your PC. If any of these applications are detected, you will be presented with the option to add them to the list of applications so that they will be available for launch.

When Redirect is launched from a hyperlink and no applications are configured, you will be presented with the option to detect applications. You can auto-detect applications at any time by clicking the Detect Applications... button.

2-17


If an application that Redirect auto-detects requires a virtual serial port connection, the Redirect profile Required dialog box displays. This dialog box contains a list of available Redirect profiles that can be selected (refer to Figure 2-13). If the desired profile is not available, new profiles can be created by clicking the New Profile button.

Figure 2-13 New Profile Required Dialog Box

Working with Application EntriesTo manually create a new application entry, click the Add... button. The Create Application dialog box displays.

To make changes to an existing application entry, select the entry and click the Edit... button. The Modify Application dialog box displays (refer to Figure 2-14) that is similar to the Create Application dialog box.

To delete an existing application entry, select the entry and click the Delete button.

Figure 2-14 Modify Application Dialog Box

2-18


ApplicationA unique name (may contain spaces) that identifies the application entry.

ProtocolFrom this drop-down list, select the appropriate protocol. The protocol is used by Redirect to identify which application to launch.

TargetIn the Target field, enter the application's address or click the Browse button to locate the application. Add arguments after the application's address as necessary.

Note: If %ipaddr% is present in the target field, it will be replaced with the IP address

of the network element (or its access element) when the application is invoked. If %tcpport% is present in the field, it will be replaced with the port value for that protocol.

Use SiteVPNIf checked, Redirect will attempt to establish a VPN connection to the SiteVPN server before launching the application.

Use virtual portIf the application expects a serial port to be present, select the Use virtual port checkbox.

Profile nameSelect an existing profile from the Profile name drop-down list. Create a new profile by clicking the New Profile button.

Remove COM portThe profile's COM port is created before the application is launched. Select the Remove COM port option for situations in which the port should be removed.

Note: For most applications, the COM port should be removed when the application

exits, but if you encounter errors running the multiple instances of the application simultaneously, try switching this setting to remove the port after it is closed. Some older applications explicitly forbid running multiple copies concurrently regardless of this setting.

2-19

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect SiteVPN

Redirect SiteVPNWhen a connection profile is configured to use SiteVPN, Redirect will attempt to connect to the SiteVPN host to establish a VPN connection (refer to Figure 2-15). During the attempt, Redirect displays the status of the VPN connection.

Figure 2-15 Establishing SiteVPN Dialog Box

VPN HostDisplays the hostname or IP address of the SiteVPN server that Redirect SiteVPN is attempting to connect to.

Note: The SiteVPN server should not be confused with the hostname or IP address

of the connection profile’s configured remote host. The SiteVPN server is typically the Remote (i.e., RMX-3200 or RMM-1400).

Local VPN IP AddressDisplays the local IP address that the VPN server has assigned to the PC once the VPN connection is established.

StatusDisplays the current VPN connection status.

DisconnectManually disconnects from the VPN server. Under normal circumstances, it is not necessary to disconnect from the VPN server manually. Redirect automatically disconnects if it needs to establish a connection to another SiteVPN server.

2-20

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect SiteVPN

If the remote SiteVPN host requests authentication, a Login dialog box displays with fields for the username and password for the VPN server (refer to Figure 2-16).

Figure 2-16 SiteVPN Login Dialog Box

Once the VPN connection is established, the SiteVPN status dialog box will no longer display. The Redirect virtual serial port is opened and/or the configured application will be launched.

Closing the status dialog box will not disconnect the VPN but is minimized as an icon in the system tray and can be displayed at anytime by double-clicking the icon.

UsernameThe username is used to login to the RMX-3200/RMM-1400 to authenticate the client.

PasswordThe password is used to login to the RMX-3200/RMM-1400 to authenticate the client.

2-21

Redirect Version 4.5x Configuration GuideUsing Redirect: Auto Login Script Settings

Auto Login Script SettingsThe Auto Login Script Settings are used by Redirect to log into a Telnet server and execute a given command. This is normally used for connecting to a remote host through a Telnet proxy.

To display the Auto Login Script Settings dialog box, open the Create Redirect Connection or Modify Redirect Connection dialog box. Select the Ports tab and click the Settings button (refer to Figure 2-6).

Using the Simple Script TypeSelect Simple script type when a script needs to enter a username, password and (optionally) a shell command. If the script needs to be more complex (for example, including more than three prompts and responses) select Advanced. Refer to Using the Advanced Script Type for more information.

When you select the Simple script type, the Auto Login Script Settings dialog box contains the following options (refer to Figure 2-17).

Figure 2-17 Auto Login Script Settings Dialog Box - Simple Script Type

2-22


UsernameEnter the string that is transmitted when Redirect is prompted for a username. Redirect automatically appends the return character.

PasswordEnter the string that is transmitted when Redirect is prompted for a password. Redirect automatically appends the return character.

Shell CommandEnter the string that is transmitted when Redirect is prompted for a shell command. Redirect appends the return character automatically. After the shell command is transmitted, the script will end.

Note: Entering a value in the Shell Command field is optional. If it is left blank, the

script will end after the Password value is transmitted.

Username PromptEnter a string that Redirect will scan for and respond with the Username value.

Password PromptEnter a string that Redirect will scan for and respond with the Password value.

Shell PromptEnter a string that Redirect will scan for and respond with the Shell Command value. If Shell Command is left blank, Redirect will not scan for a shell prompt.

Script Timeout (ms)Enter the amount of time (in milliseconds) for Redirect to wait for each prompt. If the prompt is not received in time, Redirect takes the appropriate action depending on the Display Client window on script timeout setting.

Display Client window on script timeoutIf this option is selected, and the script times out waiting for a prompt, a terminal window displays enabling you to manually enter keystrokes to debug the script settings and/or connect manually to the remote host. After entering the correct commands, click the Continue button to close the client window and let Redirect take over with the connection.

If this option is disabled and the script times out waiting for a prompt, the connection will terminate immediately.

2-23


Using the Advanced Script TypeUsing the Advanced script type gives you much closer control over the behavior of the responses. The other options in the Auto Login Script Settings dialog box are replaced by data fields in which to enter script commands (refer to Figure 2-18). These script commands have a defined syntax, as described in Table 2-1.

Figure 2-18 Auto Login Script Settings Dialog Box - Advanced Script Type

A script consists of a series of commands, described in Table 2-2 followed by an argument.

Table 2-1 Advanced Script Type Commands

Command Function

WAITFOR “string” Wait for a string (such as a prompt)

TRANSMIT “string” Send a string out the network (such as a username/password)

PAUSE milliseconds Pause for the specified number of milliseconds

2-24


The string arguments for WAITFOR and TRANSMIT commands must be enclosed in double-quotes. The numeric argument for the PAUSE command must be between 1 and 900000 and is not enclosed in quotes.

Newline characters are not automatically transmitted. They must be specified in the argument string. A linefeed character is specified by the backslash character followed by a lowercase n. ( \n ). A carriage-return character is specified by the backslash character followed by a lowercase r ( \r ). If you require an actual backslash character in your string argument, use two backslash characters ( \\ ).

Below is a typical example of a script:

WAITFOR "ogin:"

PAUSE 3000

TRANSMIT "MyUserName\n"

WAITFOR "assword:"

TRANSMIT "MyPassword\n"

WAITFOR "$"

TRANSMIT "telnet -8 MyRemoteServer\n"

2-25

Redirect Version 4.5x Configuration GuideUsing Redirect: Redirect Command Line Parameters

Redirect Command Line ParametersRedirect Connection dialog boxes can be launched from the command line, without launching the Redirect main GUI window first. Below is a summary of the command line usage for executing a Redirect Connection dialog box from the command line. The associated parameters are explained in Table 2-2.

Notes: Use double quotes around arguments that contain spaces.

Use backslash followed by double quotes to include the double quote character.

Redirect /profile:<string> (short form /p)

Redirect /host:<string> (short form /h)

Redirect /tcpport:<1-65535> (short form /t)

Redirect /file:<string> (short form /f)

Redirect /args:<string> (short form /a)

Redirect /exit_on_close:[+|-] (short form /e)

Table 2-2 Redirect Command Line Parameters

Parameter Description

/profile or /p Profile to use for the connection. Required.

/host or /h Host name or IP address of remote host. Optional. This overrides the profile setting.

/tcpport or /t Remote host TCP Port. Optional. This overrides the profile setting.

/file or /f Filename of application to launch. Optional. If specified, Redirect will start hidden in the system tray and this application will be launched after the virtual serial port is created. When the application exits, Redirect will break the connection, remove the virtual port, and exit. Also, if a fully qualified path/filename is given, the working directory for the application will be set to the path.

/args or /a Arguments to be passed to the application. Ignored if /file is not specified.

2-26


/exit_on_close or /e If this argument is specified by itself or with a + (plus) character, the Redirect Connection dialog box will close the virtual port and exit when the launched application (specified by the / file parameter) closes the virtual port.

Notes: The launched application must open the

virtual port first before the closing of the port can be detected.

If the application closes the port and at a later time attempts to open it, the virtual port will no longer exist because the Redirect Connection dialog box has closed it and exited (refer to exception below).

In the Advanced tab of the Connection Settings for the profile, the Exit on Close Delay (ms) value can be set which will allow an application to reopen the virtual port after it has closed within the delay period of time. If the virtual port is not reopened within the delay period, Redirect will disconnect and exit.If the /exit_on_close parameter is not specified or specified with a - (minus) character, the Redirect Connection dialog box will close the virtual port and exit when the launched application exits.

Note: The /exit_on_close parameter is ignored if

the /file parameter is not specified.

Table 2-2 Redirect Command Line Parameters

Parameter Description

2-27


2-28

3

Using Kickstart

This chapter provides instructions for using the Kentrox Kickstart GUI to discover, connect to, and configure IP addresses for Kentrox devices on the local network.


Launching Kickstart

Using the Kickstart GUI

Configuring an IP Address for an RMM-1400 Device

3-1

Redirect Version 4.5x Configuration GuideUsing Kickstart: Launching Kickstart

Launching KickstartYou can launch Kentrox Kickstart by either of the following methods:

Select Start > Programs > Kentrox Redirect > Kentrox Kickstart

Double-click the Kentrox Kickstart icon from the desktop

Kickstart launches and the Kickstart GUI displays.

Using the Kickstart GUIKickstart discovers Kentrox devices on the local network and displays them as a list in the main GUI window (refer to Figure 3-1).

Figure 3-1 Kickstart GUI

Table 3-1 describes Kickstart GUI menus and associated submenus.

Table 3-1 Kickstart Menu and Submenu Descriptions

Main Menu Description

File Select File > Exit Kentrox Kickstart to quit the Kickstart application.

3-2

Redirect Version 4.5x Configuration GuideUsing Kickstart: Using the Kickstart GUI

Tools Select a device in the main window and select Tools > Connect to connect to the selected device. Available connection types include: SSH Terminal Telnet Terminal Secure Web Access Web Access SFTP File Transfer FTP File Transfer

Note: Not all connection types will be available for

every device.

Select Tools > Refresh List to rediscover devices on the network.Select Tools > Applications to open the Applications dialog box (described in section Applications).

Help Select Help > About Kentrox Kickstart to view the Network Troubleshooting Guide, or to view log files.

Table 3-1 Kickstart Menu and Submenu Descriptions (Continued)

Main Menu Description

3-3

Redirect Version 4.5x Configuration GuideUsing Kickstart: Configuring an IP Address for an RMM-1400 Device

Configuring an IP Address for an RMM-1400 DeviceProvided in this section is an example that involves discovering a Kentrox Remote RMM-1400 device and configuring an IP address for that device.

1. Install Kentrox Redirect software on your laptop or PC. When the installation is complete, Kentrox Redirect and Kentrox Kickstart icons appear on your desktop.

2. Use a standard CAT5 Ethernet cable (such as Kentrox part number CAB182-10) to connect the PC or laptop to an Ethernet port on Remote RMM-1400.

3. Launch Kentrox Kickstart. Kickstart discovers the Remote RMM-1400 device, as refer to Figure 3-2 below.

Note: If the Remote RMM-1400 device is not discovered within one minute,

select Help > About in Kentrox Kickstart, then click the Network Troubleshooting Guide link for instructions.

Figure 3-2 Kentrox Kickstart Dialog Box

4. Click Telnet Terminal (or select Tools > Connect > Telnet Terminal). A Telnet window opens, displaying the Redirect login prompt.

5. At the Remote RMM-1400 login prompt, enter admin. This is the default login.

6. At the password prompt, enter password. This is the default password.

7. At the command prompt, enter config interface bridge switch ip address, followed by the IP address and subnet mask. For example:

config interface bridge switch ip address 10.34.64.222 255.255.255.0

8. At the command prompt, enter config ip route default and the default gateway address. For example:

config ip route default 172.10.11.222

3-4

A

Integrating Third-Party Software and Devices with Director and Redirect

This appendix explains the steps required to configure Redirect and the Director client to work with third-party software and devices.

Guide to this Appendix

Overview

Installing Redirect

Creating a Redirect Connection Profile

Configuring the Director Client

A-1

Redirect Version 4.5x Configuration GuideIntegrating Third-Party Software and Devices with Director and Redirect: Overview

OverviewIf third-party devices are connected to the network via IP connections (such as packet-switched wireless modems), the devices usually can be accessed with standard TCP/IP tools or third-party software.

If the third-party software expects to communicate with the device via a serial connection, it may be necessary to use Redirect. Redirect creates a virtual serial port on the client PC that can communicate through a TCP/IP socket over the IP network to the device. Third-party software that expects to communicate with the device via a serial port will then use a virtual serial port to send and receive serial communication over the IP network.

In order to use third-party software to connect to elements in the Director database, you will need to:

Install Redirect

Create a Redirect connection profile

Configure the Director client to use the Redirect profile

Installing RedirectFollow the instructions in section Installing Redirect on page 1-3 to install Redirect.

A-2

Redirect Version 4.5x Configuration GuideIntegrating Third-Party Software and Devices with Director and Redirect: Creating a Redirect Connection

Profile

Creating a Redirect Connection ProfileAfter you have installed Redirect, start the Redirect application and create a Redirect connection profile as follows:

1. From the Redirect GUI, click the New button (or select Connections > New...).

2. The Create New Connection dialog box opens. Create a virtual port by populating the fields on the Ports tab. An example is shown in Figure A-1.

Figure A-1 Create New Connection Dialog Box - Ports Tab Example

3. Click the Advanced tab and populate its fields appropriately. An example is shown in Figure A-2.

A-3

Redirect Version 4.5x Configuration GuideIntegrating Third-Party Software and Devices with Director and Redirect: Creating a Redirect Connection Profile

Figure A-2 Create New Connection Dialog Box - Advanced Tab Example

4. Click OK to save the connection profile.

Note: For more detailed information about the GUI elements found in the Redirect

Create New Connection dialog box, refer to Redirect Connection Settings.

A-4

Redirect Version 4.5x Configuration GuideIntegrating Third-Party Software and Devices with Director and Redirect: Configuring the Director Client

Configuring the Director ClientAfter creating the new connection profile in Redirect, configure the Director client to use the Redirect profile as follows:

Notes: If you are currently logged into Director, log off, then log back in so Director

can recognize the new Redirect profile.

For detailed instructions regarding Director client configuration, refer to the Director Remote Site Management Platform Configuration Guide.

1. From the Director client GUI, select File > User Preferences...

2. The User Preferences dialog box displays. On the Applications tab, click the Add... button.

3. The New Application dialog box opens. In the Application field, enter a name for the application.

4. In the Protocol field, select the appropriate protocol for the third-party device.

5. In the Target field, enter the path to the third-party software executable file, or click Browse... to browse to the executable file.

6. Select the Use Redirect option. Then, in the Profile name field, select the name of the Redirect connection profile you created earlier. An example configuration is shown in Figure A-3.

Figure A-3 New Application Dialog Box - Example Configuration

7. Click the OK button to save the new application.

A-5

Redirect Version 4.5x Configuration GuideIntegrating Third-Party Software and Devices with Director and Redirect: Configuring the Director Client

The new application now displays in the Applications menu in the Director client. The new application also is available when you right-click a network element that uses the protocol you selected in step 4 above.

A-6

Copyrights and License Statements


Copyright © 1983-2013 by Kentrox, Inc.The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication.

TRADEMARKS:The material discussed in this publication is the proprietary property of Kentrox, Inc. Kentrox retains all rights to reproduction and distribution of this publication.

Kentrox is a registered trademark of Kentrox, Inc. Applied Innovation, Applied Innovation Inc., the AI logo, and other names are the intellectual property of Kentrox. All other product names are trademarks or registered trademarks of their respective owners.

Information published here is current as of this document’s date of publication, but is subject to change without notice.

“.NET Framework” is a registered trademark of the Microsoft Corporation.

Copyrights-1


Copyrights-2