Using the Model 3395/3395A APGEN Utility SynOptics Communications, Inc.
© 1994 by SynOptics Communications, Inc. All rights reserved. Trademarks SynOptics Communications, SynOptics, Optivity, and LattisNet are registered trademarks of SynOptics Communications, Inc. System 3000 and SynOptics Press are trademarks of SynOptics Communications, Inc. Other brand and product names are registered trademarks or trademarks of their respective holders.
Table of Contents Preface Organization................................................................................................................................................ vii Conventions ................................................................................................................................................ viii Related Documentation ..............................................................................................................................
Chapter 4 - Using UNIX Utilities With APGEN Script Files Using the diff Utility to Compare Two APGEN Script Files ..................................................................... 4-1 Creating a File with the diff Utility...................................................................................................... 4-1 Using the grep Utility to Search Through an APGEN file.......................................................................... 4-3 Displaying Command Lines ......................
Figures 1-1 1-2 1-3 Different types of hosts on the network ........................................................................................... 1-1 A portion of an APGEN script file................................................................................................... 1-6 Sending APGEN script files to terminal servers on the network..................................................... 1-7 2-1 2-2 2-3 A network configuration that supports the APGEN utility.............................
Preface This manual introduces some of the tools that you can use to manage the Model 3395 Terminal Server from a host on the network. In particular, it describes how to use the Model 3395 ASCII Parameter File Generator (APGEN) utility. This utility converts a binary terminal server parameter file into an ASCII script file, which you can download from the host to a communications server.
Preface Conventions Throughout this manual, the word “Enter” means type something and then press the , , or key; for example, “Enter the apgen command” means type the word apgen and then press the , , or key. This manual also uses the following conventions: command required [optional] [optional] Where Means command You must enter the command, or its accepted abbreviation, as shown.
Preface Related Documentation The following manuals provide information that you may find useful with this manual: Software Management Guide for the Model 3395/3395A Terminal Server (SynOptics part number 893-158-C) This manual describes the configuration, setup, and management of a terminal server software communications package, supplied by SynOptics Communications, Inc. This manual is written for network managers, and terminal server, UNIX, and VAX system managers.
Chapter 1 Introduction to Model 3395 Host-Based Management The Model 3395 Terminal Server includes several tools that allow you to manage them from a host on the network. Command scripts and the ASCII Parameter File Generator utility (APGEN), are part of the terminal server software package. This chapter briefly describes several different host-based tools and how they can help you manage your Model 3395. It also introduces the APGEN utility, which the remaining chapters of this book describe in detail.
Introduction The host-based management tools that Model 3395 Terminal Server offers to support its product line include the following: • Support for Load Servers and Parameter Servers • SynOptics Network Management Products • Communications Server Host-Based Management Features • The APGEN Utility The remaining chapters of this manual provide detailed information about the APGEN utility.
Introduction SynOptics Network Management Products SynOptics offers its own network management product, called Optivity, as well as support for the Simple Network Management Protocol (SNMP), which is an industry standard protocol. Optivity Optivity is a software package for the management of SynOptics networks. Just as the Model 3395 Terminal Server is integrated into the System 3000 hub, management of the Model 3395 Terminal Server is integrated into the Optivity network management application.
Introduction Terminal Server Host-based Management Features The terminal server software package provides several features that you can use on a host to manage terminal servers on the network. These include the following: • The Csportd daemon • Command scripts • Dial-back scripts • Nested menus The Software Management Guide for the Model 3395/3395A Terminal Server describes these features in detail.
Introduction Dial-back Scripts If a port on a terminal server is a “dial-back” modem port, you can create a dial-back script to enhance security on the modem port. The dial-back script specifies the telephone number to dial when a specific user attempts to log on to the server through a modem. If the terminal server cannot find a script file for that user, it will not permit the user to log in.
Introduction Figure 1-2 represents a part of an APGEN script file for a terminal server. This portion of the script file lists the commands which define terminal server features.
Introduction Model 3000 Hub with Model 3395 Terminal Server UNIX Host with APGEN Script Files Model 3000 Hub with Model 3395 Terminal Server LAN Model 3000 Hub with Model 3395 Terminal Server Figure 1-3. Sending APGEN script files to terminal servers on the network A user at a terminal server on the network in Figure 1-3 can execute the SCRIPT command to download the APGEN script from the script server.
Chapter 2 Installing the APGEN Utility The APGEN utility comes with an installation script and a MAN page. You copy the utility from a Model 3395 UNIX media kit into a directory on the UNIX host, then install it using the installation script. You can install the APGEN utility on any UNIX host running the BSD or the AT&T System V UNIX operating systems. It has also been tested on hosts running the AIX, MIPS, HP/UX, and ULTRIX operating systems.
Installing the APGEN Utility VAX/ULTRIX Host Backup Parameter Server UNIX Host Running APGEN Model 3000 Hub with Model 3395 Terminal Server Parameter Server Script Server LAN Model 3000 Hub with Model 3395 Terminal Server Figure 2-1. A network configuration that supports the APGEN utility In Figure 2-1, the UNIX host running the APGEN utility is also a parameter server and a script server for the terminal servers in the System 3000 hubs.
Installing the APGEN Utility The following are examples of these commands: TS3395>> define parameter server xip internet address 140.179.82.6 TS3395>> set parameter server xip internet address 140.179.82.6 TS3395>> You can use other types of hosts as back-up parameter servers.
Installing the APGEN Utility /tftpboot /apgen Figure 2-2. An example of a script server directory structure The following command creates the apgen directory on a UNIX host: % cd /tftpboot % mkdir apgen % Directory Requirements The script server downloads APGEN script files to the terminal server through the Trivial File Transfer Protocol (TFTP). UNIX systems usually require that you locate all files that TFTP will transfer on the network in the TFTP “home directory” of the UNIX system.
Installing the APGEN Utility The following example applies to Sun Workstations. The default TFTP home directory is /tftpboot and the scripts reside in a directory named scripts. The following commands create a link from /tftpboot to scripts: % cd /tftpboot % ln -s /usr/synoptics/scripts scripts # You may need to enable superuser mode to enter these commands. The Secure TFTP Option A UNIX system may be configured for secure TFTP operation.
Installing the APGEN Utility On Sun workstations, for example, use the following command to extract the apgen.tar archive from a QIC24 tape: % tar xvf /dev/rst8 apgen.tar • Unpack the apgen.tar archive, using a tar command of this form: % tar xvf apgen.tar You can delete the apgen.tar archive when the command completes and the files have been extracted from the archive. The tar utility automatically copies files and subdirectories from the apgen.tar archive into the appropriate directories.
Installing the APGEN Utility • Run the APGEN installation script. Unless you use the -d argument with the Install command, the script prompts you for information while it is executing. This information helps to determine the best way to install or compile the source file. The prompts vary according to the UNIX implementation, the particular C compiler and libraries, and the directory structure on the host. In most situations, you can accept the defaults.
Installing the APGEN Utility • The script displays the message “Install Done” when the APGEN installation is complete. The script generates a log file called Install.out, which includes a record of the libraries and directories used for the installation, as well as any errors which prevented the installation. When the APGEN installation successfully completes, the output is an executable APGEN image. You can use this to convert parameter files into executable script files.
Chapter 3 Using the APGEN Utility The APGEN utility creates an ASCII text file from a compressed or an uncompressed binary parameter file. This script file contains a list of DEFINE commands that specify the characteristics of features and protocols available on a terminal server.
Using the APGEN Utility Using the apgen Command and Options You execute the APGEN utility on a UNIX host with the apgen command. The command supports several options which determine how much of the parameter file it converts: all of the file, or only a portion that controls a specific feature or group of features. For example, you can convert only Kerberos characteristics or only port-specific characteristics. The syntax for the apgen command is the following: apgen Where [-option ...-option...
Using the APGEN Utility Option Converts this part of the parameter file: -all The entire parameter file. -arap AppleTalk Remote Access Protocol (ARAP) data. -daemons UNIX daemons data. -domain All domain data. -features Terminal server features. -ip Internet data. -kerberos Kerberos data. -lineedit Port line editing data. -lpd UNIX LPD daemon data. -manager Manager data. -menu Menu and nested menu data. -nvs nonVolatile Storage (NVS) data. -parameter Parameter server data.
Using the APGEN Utility Creating the APGEN Script File An APGEN script file has two parts: a header, which includes the line #control_script and information that describes the parameter file, and the set of DEFINE commands which specify terminal server parameters. Figure 3-1 shows a parameter file header from an APGEN script file. The header includes information such as the software version number, the hardware type, and whether or not the parameter file is compressed.
Using the APGEN Utility About Comment Lines in the Script The pound sign # that begins some lines in a script file indicates that the following text is a comment rather than an executable command. The command processor on the terminal server ignores these lines when it executes the script file. The APGEN utility creates comment lines for commands associated with disabled features and protocols that are configurable or keyed.
Using the APGEN Utility # # #echo Manager Load Data # # Products that use version 1 flash or ROM cards: GLOBAL, NODE # Products that use version 2 flash or ROM cards: NODE # Products that use version 3 flash or ROM cards: NODE # . . . #echo Script Server(s) # DEFINE SERVER SCRIPT SERVER 140.179.248.209 "/tftpboot" "/" # #echo Menu Prompt Information # # DEFINE SERVER MENU PROMPT "Enter number of selection or use arrow keys: " # DEFINE SERVER MENU CONTINUE PROMPT "press to continue... " # . . .
Using the APGEN Utility . . . #echo Server Kerberos Information # DEFINE SERVER KERBEROS SECURITY NONE # #echo Server Menu Information # DEFINE SERVER MENU ENABLED DEFINE SERVER NESTED MENU SIZE 5000 DEFINE SERVER NESTED MENU NAME "mymenu3" # #echo Server PPP Information # # DEFINE SERVER PPP PAP REMOTE PASSWORD # #echo IP Data # DEFINE SERVER INTERNET ADDRESS 140.179.248.218 DEFINE SERVER INTERNET BROADCAST ADDRESS 255.255.255.255 DEFINE SERVER INTERNET PRIMARY DOMAIN ADDRESS 0.0.0.
Using the APGEN Utility DEFINE SERVER IPX PROTOCOL MAC DISABLED DEFINE SERVER KERBEROS DISABLED . . .
Using the APGEN Utility DEFINE PORT ALL DTRWAIT DISABLED . . .
Using the APGEN Utility Converting a Portion of a Parameter File You can create a script file that contains only those commands that define a particular feature or group of features. These scripts are smaller and more efficient to use if you want to update the status of one particular feature on a terminal server, rather than the entire parameter file. To create these scripts, use the appropriate option on the apgen command line.
Using the APGEN Utility Editing the Script File to Modify Command Lines Once you create the script file, you may want to change the values in some of the command lines that define characteristics, features, protocols, and passwords. To do this, edit the file with any ASCII text editor.
Using the APGEN Utility Prompting the User for the Password To have the terminal server user interface prompt the user for the password during script execution, remove the pound sign # and delete . The following example modifies the command line for the privileged password in this way: DEFINE SERVER PRIVILEGED PASSWORD When you execute the script from the terminal server, the script displays the following prompt: Password> Enter the password, which does not appear on the screen.
Using the APGEN Utility Note: If you need to enable only one or two configurable features on one or two terminal servers, you may want to do it directly through the Model 3395 command interface. The following two sections show examples of how to enable Kerberos, which is a configurable feature, and how to enable TN3270, which is a keyed feature. Enabling the Kerberos Feature Kerberos, an Internet network authentication service, is a configurable feature.
Using the APGEN Utility Enabling the TN3270 Protocol TN3270, a protocol which allows users to communicate with an IBM host over the LAN, is a keyed feature. Follow these steps to enable TN3270 or any other keyed feature: • Edit the script file to enable the TN3270 protocol. DEFINE SERVER PROTOCOL TN3270 ENABLED • Execute the script file on the terminal server. The interface will prompt you for the software “key,” or password, for the feature. Enter the password and press the key.
Using the APGEN Utility Executing the APGEN Script File To execute the APGEN script file from the terminal server command interface, enter the SCRIPT command with the pathname and filename of the script. If the script file resides in the tftp root directory on the script server, usually /tftpboot, you can simply enter the filename. If the script file resides in some other directory on the script server, include the pathname and the filename.
Using the APGEN Utility TS3395>> script "everything.apg" Searching for script file. Please wait . . .
Using the APGEN Utility If you are not sure of the location of the script server or the default (root) script server directory path, use the SHOW SCRIPT SERVER command: TS3395> show script server TS/720 V5.2 Rom 470003 HW 00.02.00 Lat Protocol V5.2 Uptime: 118 23:21:23 Address:00-00-81-FF-4B-15 Name:XFF4B15 Ethernet:A Number: 0 Script Servers: Entry 1: 140.179.305.248 /tftpboot/scripts / The display shows the domain name or Internet address of the script server and the location of the script file.
Using the APGEN Utility The position of the error message relative to the comment lines on the screen indicates where the error occurred: in the section that defines Internet characteristics (Ip Data). To correct the error, open the script file and find the section on Ip data. Then locate the invalid value. In this example, the following command has the invalid value: DEFINE SERVER INTERNET SUBNET MASK 1288.3.0.100 Edit the command line to correct the error.
Chapter 4 Using UNIX Utilities with APGEN Script Files Several UNIX utilities allow you to search through, edit, and compare APGEN script files. These tools are particularly useful when you need to manage large scripts with many commands created with the -all or verbose options.
Using UNIX Tools With APGEN Script Files Use the diff command to create a file which lists the differences between the two files. This examples sends the output to a file called result.file. If you do not specify an output file, the utility displays the commands on the screen. In this example the dots (. . .) indicate a break in the file: % diff param.now param.old >result.file % % more result.file . . .
Using UNIX Tool With APGEN Script Files The result of the diff command shows a list of lines from both scripts. Lines preceded with the < character appear in the first file, but not the second. Lines preceded with the > character appear in the second file, but not the first. From this information, you can determine which features are enabled in one file but not the other, or the value of a particular feature in one file and in the other if they are different.
Using UNIX Tools With APGEN Script Files Creating a Script File The APGEN utility provides several command options which allow you to create a script with only certain commands. For example -menu, -ppp, and -slip create script files with only commands that define characteristics of those features. Chapter 3 describes each option in detail. You may want to create a script file with a set of commands that do not have a specific APGEN option to extract them.
Appendix A A Sample APGEN -all Script The following is a sample APGEN script created from the parameter file of a Model 3395 Terminal Server with the -all option. % apgen -all /tftpboot/xff4b15.prm apg.file #control_script # # APGEN Version 1.1 # # Parameter File Header # # Version : 0x6A # Date : 25 Oct 1993 # Time : 18:59:02 # Parameter Load Type : 1 # Compressed : Yes # Software Type : 1 # Stored Format : 7 # Oldest Format : 3 # Hardware Type : 77 # Software Version : V5.
A Sample APGEN -all Script # DEFINE SERVER SECURID ACMMAXRETRIES 5 # DEFINE SERVER SECURID ACMBASETIMEOUT 3 # DEFINE SERVER SECURID ACM_PORT 755 # DEFINE SERVER SECURID QUERY LIMIT 3 # DEFINE SERVER SECURID ENCRYPTION MODE DES # #echo XRemote Information # # XRemote is not enabled, commands are commented out # # DEFINE SERVER XREMOTE PRIMARY FONT SERVER NONE # DEFINE SERVER XREMOTE PRIMARY FONT SERVER 0.0.0.0 # DEFINE SERVER XREMOTE SECONDARY FONT SERVER NONE # DEFINE SERVER XREMOTE SECONDARY FONT SERVER 0.
A Sample APGEN -all Script #echo Timers # DEFINE SERVER KEEPALIVE 20 DEFINE SERVER INACTIVITY 30 DEFINE SERVER MULTICAST 30 # #echo Server Kerberos Information # DEFINE SERVER KERBEROS SECURITY NONE # #echo Server Menu Information # DEFINE SERVER MENU ENABLED DEFINE SERVER NESTED MENU SIZE 5000 DEFINE SERVER NESTED MENU NAME "mymenu3" # #echo Server PPP Information # # DEFINE SERVER PPP PAP REMOTE PASSWORD # #echo IP Data # DEFINE SERVER INTERNET ADDRESS 140.179.248.
A Sample APGEN -all Script #echo Parameter Server Information # DEFINE SERVER PARAMETER SERVER CHECK ENABLED DEFINE SERVER PARAMETER SERVER CHECK 30 DEFINE SERVER PARAMETER SERVER RETRANSMIT 3 DEFINE SERVER PARAMETER SERVER RETRANSMIT TIMER 5 DEFINE SERVER PARAMETER SERVER LIMIT 4 DEFINE SERVER PARAMETER SERVER PATH "" # #echo Server Features # # DEFINE SERVER PROTOCOL TELNET ENABLED LAT ENABLED # DEFINE SERVER PROTOCOL MX800 DISABLED DEFINE SERVER PROTOCOL PPP ENABLED # DEFINE SERVER PROTOCOL SNMP ENABLED
A Sample APGEN -all Script DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE DEFINE PORT PORT PORT PORT PORT PORT PORT PORT PORT PO
A Sample APGEN -all Script DEFINE PORT ALL PROMPT "TS3395" DEFINE PORT 0-10, 13-16 TYPE SOFTCOPY DEFINE PORT 11-12 TYPE ANSI # #echo Port Internet Information # DEFINE PORT 0 INTERNET CONNECTIONS ENABLED DEFINE PORT ALL INTERNET CONNECTIONS ENABLED DEFINE PORT 0 INTERNET TCP KEEPALIVE 0 DEFINE PORT ALL INTERNET TCP KEEPALIVE 0 DEFINE PORT 0 INTERNET TCP WINDOW SIZE 256 DEFINE PORT ALL INTERNET TCP WINDOW SIZE 256 # #echo Port Session Information # DEFINE PORT 0 BACKWARD SWITCH NONE DEFINE PORT ALL BACKWARD
A Sample APGEN -all Script DEFINE PORT ALL LINE EDITOR PREVIOUS LINE DEFINE PORT 0 LINE EDITOR NEXT LINE DEFINE PORT ALL LINE EDITOR NEXT LINE DEFINE PORT 0 LINE EDITOR REDISPLAY DEFINE PORT ALL LINE EDITOR REDISPLAY DEFINE PORT 0 LINE EDITOR QUOTING CHARACTER DEFINE PORT ALL LINE EDITOR QUOTING CHARACTER DEFINE PORT 0 LINE EDITOR INSERT TOGGLE DEFINE PORT ALL LINE EDITOR INSERT TOGGLE DEFINE PORT 0 LINE EDITOR CANCEL DEFINE PORT ALL LINE EDITOR CANCEL # #echo Port Kerberos Information # DEFINE PORT 0 KERBE
A Sample APGEN -all Script DEFINE PORT 11 TELNET REMOTE 3100 DEFINE PORT 12 TELNET REMOTE 3200 DEFINE PORT 13 TELNET REMOTE 3300 DEFINE PORT 14 TELNET REMOTE 3400 DEFINE PORT 15 TELNET REMOTE 3500 DEFINE PORT 16 TELNET REMOTE 3600 DEFINE PORT 0 TELNET SYNCHRONIZE NONE DEFINE PORT ALL TELNET SYNCHRONIZE NONE DEFINE PORT 0 TELNET TERMINALTYPE NONE DEFINE PORT ALL TELNET TERMINALTYPE NONE DEFINE PORT 0 TELNET TN3270 DEVICE NONE DEFINE PORT ALL TELNET TN3270 DEVICE NONE DEFINE PORT 0 TELNET TN3270 EOR DISABLED
A Sample APGEN -all Script #echo Port CCL Information # DEFINE PORT ALL CCL NAME NONE DEFINE PORT ALL CCL MODEM INAUDIBLE # #echo Port Secure ID Information # # DEFINE PORT 0 SECURID DISABLED # DEFINE PORT ALL SECURID DISABLED # #echo Port ControlledPort Information # # DEFINE PORT 0 CONTROLLED PORT LOGIN "" # DEFINE PORT ALL CONTROLLED PORT LOGIN "" # DEFINE PORT 0 CONTROLLED PORT LOGOUT "" # DEFINE PORT ALL CONTROLLED PORT LOGOUT "" # DEFINE PORT 0 CONTROLLED SESSION INITIALIZE "" # DEFINE PORT ALL CONTRO
Appendix B A Sample APGEN -verbose Script The following is a sample APGEN script created with the -verbose and -session options. It includes the port session information for each port on a 16-port terminal server. % apgen -verbose -session /tftpboot/xff4b15.prm verb.file #control_script # # APGEN Version 1.
A Sample APGEN -verbose Script #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # B-2 Port Session PORT PORT PORT PORT PORT 3 3 3 3 3 BACKWARD FORWARD LOCAL DEFAULT SESSION Information - Port 3 SWIT
A Sample APGEN -verbose Script #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE # #echo # DEFINE DEFINE DEFINE DEFINE DEFINE Port Session PORT PORT PORT PORT PORT 11 11 11 11 11 BACKWARD FORWARD LOCAL DEFAULT SESSION Port Session PORT PORT PORT PORT PORT 12 12 12 12 12 BACKWARD FORWARD LOCAL DEFAULT SESSION Port Session PORT PORT
Index < and > characters, 4-3 # character, 3-5 A AIX operating system, 2-1 -all option, 3-5, A-1 apgen command, 1-6, 3-2 options for, 3-3 syntax of, 3-2 using to convert a portion of a parameter file, 3-9 using with -all option, 3-5 using without options, 3-2, 3-4 APGEN installation script, running, 2-5 APGEN script file, 1-6 comment lines in, 3-5 creating an, 3-4 with the grep utility, 4-4 examples of with -all option, 3-5, A-1 with -session option, 3-9 with -verbose option, B-1 executing an, 3-14 header
Index directory requirements for script servers, 2-4 directory structure, script server, 2-4 E #echo, in a script file, 3-5 errors in a script file, correcting 3-16 F features, keyed, enabling, 3-11 file APGEN script, creating, 3-4 creating with the diff utility, 4-1 creating with the grep utility, 4-4 G grep utility, UNIX, 1-7, 4-1, 4-3 H header, in script file, 3-4 HP/UX operating system, 2-1 I Install command, 2-7 -d option with, 2-7 Install script, APGEN, running the, 2-5 default choices for, 2-7
Index R running the APGEN installation script, 2-5 S SCRIPT command, 1-4, 1-5, 1-7, 2-2 using to execute an APGEN file, 3-14–3-17 script, dialback, 1-5 script file, APGEN, 1-6 comment lines in, 3-5 creating an, 3-4 with the grep utility, 4-4 examples of with -all option, 3-5f, A-1ff with -session option, 3-9 with -verbose option, B-1ff executing an, 3-14ff header, 3-2, 3-4 initializing the communications server after running, 3-16 that includes a portion of a parameter file, 39 troubleshooting, 3-16 updati
