Tut Systems SMS2000 User Manual
TUT Systems
SMS2000 User Guide
TUT Systems, Inc Page 1 of 104 P/N 220-06288-20
No part of this publication may be reproduced or transmitted, in any form or by any means, electronic,
mechanical, photocopying, recording, or otherwise, without the prior written consent of the publisher.
Information in this manual is furnished under license and may only be used in accordance with the
terms of the software license. This publication and the information herein is furnished AS IS, is subject
to change without notice, and should not be construed as a commitment by Tut Systems. Tut Systems
assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind
(expressed, implied, or statutory) with respect to this publication, and expressly disclaims any and all
warranties of merchantability, fitness for particular purposes, and noninfringement of third-party rights.
Companies, names, and data used in the examples herein are fictitious unless otherwise noted.
Apache Copyright © 1995-1999 The Apache Group. All rights reserved.
agetty Copyright © 1989 The Regents of the University of California. All rights reserved.
Busybox mkswap Copyright © 1991 Linus Torvalds. tiny-ls(ls) Copyright © 1996 Brian Candler. cmu snmpd
Copyright © 1988, 1989 by Carnegie Mellon University. All Rights Reserved.
klogd.h Copyright © 1995 Dr. G.W. Wettstein. (Main header file for Linux kernel log daemon.)
inetd Copyright © 1983,1991 The Regents of the University of California. All rights reserved.
lilo Copyright © 1992-1998 Werner Almesberger. All rights reserved. Program code, documentation and auxiliary
programs.
Linux Kernel snarf Copyright © Linus Torvalds and others. Linux GNU General Public License Version 2, June
1991 Copyright © 1989, 1991 Free Software Foundation, Inc.
Linux kernel src (/usr/src/linux/drivers/net) Copyright © 1993 United States Government as represented by the
Director, National Security Agency.
loadkmap, tarcat, various fixes Copyright © 1998 Enrique Zanardi. more (v2), various fixes Copyright © 1998
Dave Cinege. Remaining code Copyright © 1995, 1996 Bruce Perens (unless otherwise noted).
logd Copyright © 1995 by Wietse Venema. All rights reserved. Individual files may be covered by other copyrights.
Microsoft Windows, MS-DOS, Windows NT, and Windows 2000 are registered trademarks of Microsoft
Corporation.
pax Copyright © 1989 Mark H. Colburn. All rights reserved.
ping Copyright © 1989 The Regents of the University of California. All rights reserved.
php Copyright © 1998 The PHP Development Team. All rights reserved.
RADIUS Copyright © 1992 Livingston Enterprises, Inc.
sstrip, version 1.0 Copyright © 1999 by Brian Raiter, under the GNU General Public License.
telnetd Copyright © 1983, 1986 Regents of the University of California. All rights reserved.
thttpd Copyright © 1995 by Jef Poskanzer. All rights reserved.
SMS2000 is a registered trademark of Tut Systems in the United States and other countries.
OCS is a registered trademark of Tut Systems in the United States and other countries.
Tut Systems, Inc. ™ is registered trademarks of Tut Systems in the United States and other countries.
Copyright © 2000-2002 Tut Systems, Inc. All rights reserved.
Tut Systems, Inc.™, IntelliPOP™, SMS2000™, and OCS™are registered tradmarks of Tut Systems in
the United States and other countries.
Printed in the United States of America
SMS2000 Firmware Version: 2.3.6 and OCS software version 2.0.0
June 14, 2003
SMS2000 User’s Guide
Text part number: P/N
220-06288-20
TUT Systems, Inc Page 2 of 104 P/N 220-06288-20
SMS™User’s Guide
SMS Software Release 2.3.6
TUT Systems, Inc Page 3 of 104 P/N 220-06288-20
Contents
Contents ............................................................................................................................. 4
List of Tables.................................................................................................................................... 9
List of Figures .................................................................................................................................. 9
Preface.............................................................................................................................. 10
Audience......................................................................................................................................... 10
Documentation available for this Release...................................................................................... 10
Related Documentation.................................................................................................................. 10
Chapter1 - Introduction ................................................................................................. 11
Subscriber Management Features..................................................................................................11
Subscriber Management Components............................................................................................ 13
SMS2000 ........................................................................................................................................ 14
OCS ................................................................................................................................................ 14
Chapter 2 - Getting Started ........................................................................................... 16
The User Interface.......................................................................................................................... 16
Style Conventions........................................................................................................................... 17
Accessing Help for Commands ...................................................................................................... 17
Cursor Movement ............................................................................................................ 18
Chapter 3 - Initial Configuration .................................................................................. 19
Establishing a Connection with the SMS2000................................................................................ 19
Establishing a Connection Via a Serial Interface............................................................. 19
Establishing a Connection Via Telnet.............................................................................. 20
Initial Configuration ...................................................................................................................... 22
Changing Your Password ................................................................................................ 22
Setting the Quick Configuration ...................................................................................... 22
Disabling Authentication ................................................................................................. 23
Saving the Configuration................................................................................................. 23
Rebooting the System ...................................................................................................... 24
Verifying the Configuration............................................................................................. 24
Chapter4 - System Administration................................................................................ 25
Configuration E-Mail Settings ....................................................................................................... 25
Setting the Default Configuration E-mail ........................................................................ 25
Mailing the Current Configuration .................................................................................. 26
Deleting the Configuration E-mail................................................................................... 26
Configuration and System File Tools.............................................................................................26
Committing Configuration Changes................................................................................ 26
Automatically Committing Configuration Changes ........................................................ 27
TUT Systems, Inc Page 4 of 104 P/N 220-06288-20
Disabling Automatic Configuration Changes .................................................................. 27
Saving a Configuration .................................................................................................... 28
Loading a Configuration File........................................................................................... 28
Restoring a Previous Configuration................................................................................. 28
Restoring the Default Configuration................................................................................ 29
Configuring SMTP ......................................................................................................................... 29
Setting the SMTP Server ................................................................................................. 29
Deleting the SMTP Server............................................................................................... 29
Setting the SMTP ID........................................................................................................ 30
Configuring NTP............................................................................................................................ 30
Setting the Timezone ....................................................................................................... 30
Configuring the NTP server............................................................................................. 31
Setting the Time............................................................................................................... 31
Configuring SNMP Polling ............................................................................................................ 31
Enabling SNMP Polling................................................................................................... 31
Testing to See if SNMP Polling will Work...................................................................... 32
Disabling SNMP Polling.................................................................................................. 32
Connectivity and Testing................................................................................................................ 33
Traceroute ........................................................................................................................ 33
Testing Connectivity........................................................................................................ 33
System Tools................................................................................................................................... 33
Setting Specialized System Options ................................................................................ 33
Defining Ports..................................................................................................................34
Setting and Deleting Static Ports ..................................................................................... 34
Disconnecting a Session on a Port ................................................................................... 35
Event Tracking ............................................................................................................................... 35
Setting the Syslog Server................................................................................................. 35
Displaying Log Messages................................................................................................ 35
System Administration Tools.......................................................................................................... 36
Displaying Version Information ...................................................................................... 36
Exiting the Management Session..................................................................................... 36
Rebooting the System ...................................................................................................... 36
Changing a Password....................................................................................................... 37
Displaying Control Keys.................................................................................................. 37
SNMP Management ....................................................................................................................... 38
SNMP Agent.................................................................................................................... 38
SNMP System Contact .................................................................................................... 38
SNMP System Location................................................................................................... 38
SNMP Community .......................................................................................................... 39
SNMP Trap Recipient...................................................................................................... 39
Troubleshooting Tools ................................................................................................................... 40
System Information Tools................................................................................................ 40
Setting the System Information Dump ..................................................................... 40
Setting a Software Watchdog ................................................................................... 40
Subscriber Connectivity Commands .............................................................................................. 41
Setting the ARP Failure Limit ......................................................................................... 41
Setting the ARP Polling Period........................................................................................ 41
Upgrades........................................................................................................................................ 41
Upgrading from Tut Systems’ Website............................................................................ 42
Downloading the SMS2000 Firmware from the Tut Systems' Website........................... 42
TUT Systems, Inc Page 5 of 104 P/N 220-06288-20
Archiving SMS2000 Firmware and distributing it from a Server.................................... 42
Verifying a Successful Upgrade ...................................................................................... 43
Returning to an Older Firmware Version......................................................................... 43
Loading Another Image ................................................................................................... 43
Chapter 5 - Authentication ............................................................................................ 45
Authentication ................................................................................................................................ 45
Configuring the Command Server..................................................................................................46
Setting the Command Server for OCS Interaction........................................................... 46
Deleting the Command Server......................................................................................... 46
Authentication ................................................................................................................................ 46
Adding the OCS as the Authentication Server................................................................. 46
Deleting an Authentication Server................................................................................... 47
Testing Authentication..................................................................................................... 47
Disabling Authentication ................................................................................................. 48
Setting the Authentication Interval .................................................................................. 48
Bypassing Authentication ................................................................................................ 48
HTTP Request Throttle .................................................................................................................. 49
Setting the HTTP Request Throttle.................................................................................. 49
Deleting the HTTP Request Throttle ............................................................................... 49
Allow-Nets...................................................................................................................................... 49
Setting an Allow-Net ....................................................................................................... 50
Deleting an Allow-Net..................................................................................................... 51
Automatic Redirection URLs.......................................................................................................... 51
Setting the Automatic Redirection URL.......................................................................... 51
Deleting the authok Page ................................................................................................. 52
Authentication with RADIUS ......................................................................................................... 52
Adding a RADIUS Server ............................................................................................... 52
Set NAS port type parameter ........................................................................................... 55
show status radius ............................................................................................................ 56
Testing Authentication on the RADIUS Server............................................................... 56
Configuring a RADIUS SSL Back Channel .................................................................... 56
Chapter 6 - Authorization.............................................................................................. 57
Authorization.................................................................................................................................. 57
Chapter 7 - Accounting .................................................................................................. 58
Accounting ..................................................................................................................................... 58
Sending Accounting Messages to a Syslog Server .......................................................... 58
Radius Accounting Configuration.................................................................................................. 59
Sending Accounting Messages to a RADIUS Server ...................................................... 59
Deleting a RADIUS Accounting Server.......................................................................... 59
Configuring Accounting Parameters................................................................................ 59
Chapter 8 - Provisioning ................................................................................................ 60
Chapter 9 - Billing........................................................................................................... 61
Billing............................................................................................................................................. 61
TUT Systems, Inc Page 6 of 104 P/N 220-06288-20
Chapter 10 - Service Creation Using Groups and Rules............................................. 62
Groups............................................................................................................................................ 62
Adding a Group ............................................................................................................... 62
Deleting a Group.............................................................................................................. 63
Setting the Active Group Context.................................................................................... 63
Subscribers that Cannot Support Authentication ............................................................. 63
Setting Maximum Users Per Port..................................................................................... 63
SMS2000 Rules .............................................................................................................................. 64
Adding a Rule .................................................................................................................. 64
Deleting a Rule ................................................................................................................ 64
Rule Expression Components......................................................................................................... 65
IP Address........................................................................................................................ 65
MAC Address .................................................................................................................. 65
VLAN .............................................................................................................................. 66
SNMP-INFO.................................................................................................................... 66
The NOT Operator........................................................................................................... 66
The AND Operator .......................................................................................................... 67
The OR Operator ............................................................................................................. 67
Parenthesis ....................................................................................................................... 67
Using Rule Priorities...................................................................................................................... 68
Chapter 11 - IP Addressing............................................................................................ 69
IP Addressing................................................................................................................................. 69
Plug and Play With NAT ................................................................................................. 69
Static Routable Addresses................................................................................................ 70
DHCP Pools..................................................................................................................... 70
Static Non-Routable Addresses ....................................................................................... 71
IP Multicasting.................................................................................................................71
Configuring a Control Network for Additional Client IP Addresses............................... 72
Understanding 1to1 and 1to1 Unique IP Types............................................................... 72
Configuring IP Types....................................................................................................... 72
Source-Nets .................................................................................................................................... 73
Setting a Source-Net ........................................................................................................ 73
Deleting a Configured Source-Net................................................................................... 73
DHCP............................................................................................................................................. 74
Creating DHCP Pools ...................................................................................................... 74
Removing a DHCP Assignment ...................................................................................... 74
DNS ................................................................................................................................................ 74
Setting the DNS Server Address...................................................................................... 74
Deleting the DNS Server Address ................................................................................... 75
Static Routes................................................................................................................................... 75
Adding Routes ................................................................................................................. 75
Chapter 12 - Printing...................................................................................................... 76
Setting up the LPR Host .................................................................................................. 76
Chapter 13 - Using SMS2000 with a RADIUS Server................................................. 77
Configuring RADIUS ..................................................................................................................... 77
Obtaining the RADIUS Server Software......................................................................... 77
TUT Systems, Inc Page 7 of 104 P/N 220-06288-20
Adding the SMS2000 as a Client on the RADIUS Server............................................... 78
Adding Users to the RADIUS Server .............................................................................. 78
Configuring Service Parameters ...................................................................................... 78
Using Real IP Addresses.................................................................................................. 79
RADIUS Ports ................................................................................................................. 79
SMS2000 NAS File ......................................................................................................... 80
SMS2000 Status Attributes and Statistics....................................................................................... 80
RADIUS Attributes Sent in Accounting Messages.......................................................... 80
RADIUS Attributes Sent In Access-Request Packets...................................................... 81
RADIUS Attributes Received in Access-Accept Packets................................................ 81
Using Both RADIUS and OCS Authentication............................................................................... 81
Setting Traffic Shaping.................................................................................................... 82
Deleting Traffic Shaping.................................................................................................. 82
Chapter 14 - SMS2000 and Property Management Systems (PMS).......................... 83
Setting the PMS Server.................................................................................................... 83
Protocol Modes.............................................................................................................................. 84
TTY MODE..................................................................................................................... 84
ACK-NAK MODE .......................................................................................................... 84
ENQ-ACK-NAK MODE................................................................................................. 85
Chapter 15 - Customizing SMS2000 Web Authentication with RADIUS................. 86
Loading and Deleting Customized Web Pages .............................................................................. 86
Files For Groups .............................................................................................................. 86
Loading Web Pages or Files ............................................................................................ 86
Path Components ............................................................................................................. 87
Image Links .....................................................................................................................87
Upgrading ........................................................................................................................ 88
Deleting Web Pages or Files............................................................................................ 88
Customizing Web Pages................................................................................................................. 88
Preserving the Web Form ................................................................................................ 88
Size For Web Pages and External Links.......................................................................... 89
Web Page Redirection...................................................................................................... 89
Active Page Components................................................................................................. 90
Viewing Customizations.................................................................................................. 90
Chapter 16 - Configuring Web Proxy Settings ............................................................ 91
Web Proxy Settings ........................................................................................................................ 91
Setting the WPAD CURL................................................................................................ 91
Setting the WPAD Timeout............................................................................................. 91
Web Proxy Server............................................................................................................ 92
Enable Proxy Server Support.................................................................................... 92
Disable Proxy Server Support................................................................................... 92
Viewing Proxy Server Support Status ...................................................................... 92
Adding TCP Proxy Ports .......................................................................................... 93
Deleting TCP Proxy Ports......................................................................................... 93
Viewing TCP Proxy Ports......................................................................................... 93
Chapter 17 - SMS2000 Troubleshooting....................................................................... 94
SMS2000 Troubleshooting Procedures.......................................................................................... 94
TUT Systems, Inc Page 8 of 104 P/N 220-06288-20
Appendix A - RADIUS Access-Accept Dictionary File ............................................... 97
RADIUS Attributes in Access-Accept Packets................................................................................ 97
Appendix B - Technical Assistance and Customer Support ..................................... 101
Technical Support ........................................................................................................................ 101
Internet......................................................................................................................................... 101
Telephone..................................................................................................................................... 101
Equipment Return and Repair...................................................................................................... 101
Appendix C - SMS2000 Limited Warranty................................................................ 102
Hardware Limited Warranty........................................................................................................ 102
Limitations of Warranty................................................................................................. 102
Exclusive Remedies....................................................................................................... 102
Assistance ...................................................................................................................... 103
FCC Radio Frequency Interference Statement .............................................................. 103
Electrical Safety Advisory ............................................................................................. 103
Tut Systems, Inc., Customer Service Department ......................................................... 103
List of Tables
Table 2-1 Documentation Conventions........................................................................................................ 17
Table 2-2 Cursor Motion Keystrokes ........................................................................................................... 18
Table 5-1 Authentication.............................................................................................................................. 45
Table 6-1 Authorization ............................................................................................................................... 57
Table 7-1 Accounting................................................................................................................................... 58
Table 8-1 Provisioning ................................................................................................................................. 60
Table 9-1 Billing .......................................................................................................................................... 61
Table 11-1 Static Non-routable Addresses................................................................................................... 71
Table 17-3 SMS2000 Troubleshooting Procedures...................................................................................... 94
List of Figures
Figure 1-1 Subscriber Management Components ........................................................................................ 13
Figure 11-1 Plug and Play with NAT........................................................................................................... 70
TUT Systems, Inc Page 9 of 104 P/N 220-06288-20
Preface
This guides in this series provide detailed information and procedures that will allow you
to communicate and interface with your SMS2000 and OCS products, complete basic
system and network configuration, and manage your systems using system
administration tools.
For further information, use the release notes, frequently asked questions (FAQs),
product and technology overviews, and troubleshooting tips in the support area of Tut
Systems’ website http://www.tutsystems.com, or you can reach us at 1-800-998-4888.
Audience
The audience includes:
• Network architects who design Internet services
• Network administrators who manage networks
• Network operations center (NOC) operators who handle subscriber calls and manage
customer service related calls
Documentation available for this Release
The following documentation is available for the SMS2000 and OCS systems
• SMS2000 Command Reference
• SMS2000 User’s Guide
• OCS User’s Guide
• OCS Quick Start Guide
• SMS2000 Release Notes
• OCS Release Notes
Related Documentation
The following documentation is available from www.tutsystems.com
• Expresso GS/MDU Installation and Operation Manual
• Expresso MDU Lite Multiplexing Switch
• IntelliPOP 5000 Hardware Manual
• IntelliPOP 5000 User’s Guide
• IntelliPOP 5000 Command Reference
• IntelliPOP 5000 Tutorials
TUT Systems, Inc Page 10 of 104 P/N 220-06288-20
Introduction
Chapter1 - Introduction
Tut Systems’ Expresso Subscriber Management System (SMS2000)and Operation
Center Software (OCS) offer a complete solution for delivering and controlling Internet
Protocol (IP) based services to subscribers. The SMS2000 delivers powerful subscriber
management features to service providers.
The SMS2000 allows almost any type of in-building network infrastructure to be
transformed into a robust public network, dramatically reducing configuration
headaches, minimizing undesirable interactions between subscribers, and allowing the
service provider to deliver a flexible suite of IP services over a common infrastructure.
Authentication, authorization, accounting, provisioning, and a wide range of billing
options complete the package, which allows service providers to get subscribers up and
running quickly.
Subscriber Management Features
The features supported by Tut Systems’ Expresso Subscriber Management System
are briefly described below:
• Plug-and-play networking—Clients that are misconfigured or have
configurations from other networks can connect to the SMS2000 without any
reconfiguration of IP address, netmask, or gateway address required. That means,
for example, laptops hooked up in hotel rooms by guests need not be reconfigured
prior to use.
• Firewall protection—Clients attached to the SMS2000 can be protected from
many types of Internet hacking by making them invisible from the outside using
Network Address Translation (NAT).
• Authentication, authorization, accounting—Using the SMS2000 with traditional
RADIUS servers or Tut Systems’ included OCS server software, service providers are
able to authenticate individual users, authorize particular services, and track usage.
• Provisioning and billing—OCS adds a number of functions that allow simple
provisioning by the service provider or the subscriber. Billing can be applied to credit
cards or to hospitality PMS interfaces for direct room billing on a guest’s folio.
• Bandwidth management—Each individual client can have a separate maximum
bandwidth allowance as part of the “user policies.”
• IP address management—Individual clients can use one of the following:
— A fixed (static) IP address suitable for operating servers visible to the Internet.
— DHCP to retrieve an IP address suitable for using protocols unfriendly to NAT.
— An invisible shared address through the use of NAT.
— IP type 1 to 1 for subscriber accountability with plug and play networking.
— IP type 1 to 1 unique for maximum subscriber accountability with plug and play
networking.
TUT Systems, Inc Page 11 of 104 P/N 220-06288-20
Introduction
• Portal redirection—Clients can be directed to a “forced portal” for authentication or
to deliver dynamic content. The service provider is able to control and differentiate
network service better.
• IP multicast—Multimedia content can be delivered to subscribers. By using IGMP
snooping, the SMS2000 facilitates multicast delivery.
• PPTP passthrough—Point-to-point tunneling protocol can be used by subscribers
even if the subscriber’s IP address is shared via NAT.
• Service management—Service providers can use the OCS to offer multiple custom
service levels to entice customers with a diverse set of connectivity needs and
demands, targeted specifically to individual users and/or time periods.
• Reports—OCS is equipped with many useful reports designed to assist users in
managing their networks.
• Self provisioning—Using the OCS, subscribers can choose their own level of service,
including bandwidth and IP type (NAT, static, DHCP).
TUT Systems, Inc Page 12 of 104 P/N 220-06288-20
Introduction
Subscriber Management Components
The SMS2000 can interact with a number of external software and hardware
components. Figure 1-1 shows the subscriber management components, which are
described in SMS2000 Tutorials.
Figure 1-1 Subscriber Management Components
TUT Systems, Inc Page 13 of 104 P/N 220-06288-20
Introduction
SMS2000
The SMS2000 consists of hardware and embedded software generally placed on a
property to control public network access. The SMS2000 handles packet switching
functions, traffic shaping, and address translations for a single property. The SMS2000
has a very small internal configuration database and stores no permanent data about
users, policies, or billing information. However, it can conduct “machine authentication”
using groups and rules including the MAC address, location (with SNMP or VLAN ID),
and/or IP address of the subscriber.
• The SMS2000 hardware and embedded software perform the following functions:
• Physically connects via two 10/100Base-T ports to the subscriber network and
the Internet.
• Routes IP unicast and multicast traffic.
• Optionally translates addresses of IP packets between the network and clients.
• Monitors and controls the bandwidth utilization for each client.
OCS
• Authenticates and authorizes clients (with RADIUS or through OCS).
• Directs Web requests to a service provider-specified Web server.
• Connects to a local Property Management System (PMS) via asynchronous
serial interface.
The OCS software runs on either a Microsoft Windows 2000 Server or on a Linux server.
It handles authorization, authentication, accounting, provisioning, and billing for up to
300 SMS2000s simultaneously.
OCS is normally deployed in a service provider’s data center, although it can be placed
directly on a property. OCS can be configured and managed entirely from any location
through its advanced HTML interface using any browser.
OCS is implemented as a Web server running active PHP 4 pages. Microsoft SQL
Standard or MySQL Win32 is used as the back-end database on Microsoft Windows
2000. PostgreSQL is used as the back-end database on Linux.
The Linux based solution requires no additional software licenses.
The Windows based solution requires that the system administrator obtain a copy of
Microsoft Windows 2000 Server as well as a copy of MS SQL Server. If MySQL Win32
is used on a Microsoft Windows operating system, no additional licensing is required for
the MySQL database.
The SMS2000 and OCS communicate using an HTML-based protocol. OCS can “push”
policy information about an entire network configuration, telling the SMS2000 how to
handle addressing and bandwidth management for a particular property, and how to
provide individual policy for subscribers as they gain access to the network. These
methods correspond to the evolving IETF standards for policy-based networks known as
TUT Systems, Inc Page 14 of 104 P/N 220-06288-20
Introduction
“provisioning” and “outsourcing.” OCS can perform numerous billing functions. It can
bill a subscriber’s credit card periodically (such as, monthly fixed service charges from
an apartment dweller) or as services are delivered (such as a daily charge in a hotel room
once a guest requests Internet service). OCS can handle billing through a credit card
service bureau, or it can send its billing information to an SMS2000 connected via a
serial interface to a hotel Property Management System (PMS).
The OCS software performs various functions:
• Authenticates and authorizes individual users.
• Manages specific policies for users and properties.
• Handles self-subscription, allowing users to choose their own service levels.
• Handles credit card billing.
• Stores accounting information.
• Delivers Web content.
• Sends billing information to a hotel PMS connected to an SMS2000.
• Offers subscribers multiple service levels as configured by the service provider.
• Provides service offerings that are configurable by properties, room types, and
rooms.
• Is completely service provider customizable and brandable.
The SMS2000 and OCS do not have to be connected to the same network. They can
communicate with each other over the Internet.
TUT Systems, Inc Page 15 of 104 P/N 220-06288-20
Getting Started
Chapter 2 - Getting Started
Before beginning this chapter, you must have already installed your hardware, completed
your cable and power connections, and successfully powered up your system following
the instructions in the SMS2000 Quick Start Guide.
This chapter presents information and procedures to help you:
• Communicate and interface with your system
• Use the online help system
• Use the CLI to navigate through the system
• Become familiar with the CLI conventions used in this guide
The User Interface
The command line interface (CLI) allows you configure your SMS2000 system. The
interface looks the same whether you are communicating with the SMS2000 through the
console port, a modem, or a telnet connection. Listed below are other things to consider
when using the SMS2000 CLI:
• The Command Line Interface (CLI) is not case-sensitive.
• Commands can be truncated so that only the first few unique characters need to be
entered.
For example, the command show configuration may be entered as show conf, sho
conf, or show configuration.
TUT Systems, Inc Page 16 of 104 P/N 220-06288-20
Getting Started
Style Conventions
To facilitate the proper interpretation of command syntax and parameters as you read this
guide, we’ve applied style conventions to distinguish various elements of the commands,
as well as to show how to use the commands. The style conventions used throughout this
document are described in Table 2-1.
Table 2-1 Documentation Conventions
Convention Description
boldbase
italic Italic treatment indicates that the text is a variable. You must
[ ] Square brackets delimit optional keywords or arguments.
{x | y}
Courier
boldface Courier
Ranges Ranges of numbers are separated by a dash (1 — 7).
/ Slash separators, with no spaces are used in some commands,
Boldface treatment show the actual text that you must enter
For example: show logins
Press Enter to accept the completed command string
supply the actual value.
For example:
For example: [file file]
Curly braces delimit two or more required keywords.
For example:
You must use one of the keywords inside the braces. The vertical
bar separates the choices.
show status dhcp poolname
restore {config | web} | original-config
Note: In the above case, the keywords are the actual values that
you type. If they were in italic, the words are variables for which
you supply the actual values.
Courier plain shows an example of information displayed on the
screen.
Boldface courier shows an example of information you must
type. For example: sms2000% port-definition tut
typically with the variable
masklen, for example:
ifconfig port_number ip_address/masklen
sms2000% ifconfig 192.168.254.224/31
Accessing Help for Commands
There are three ways to access help for commands when you are configuring the
SMS2000:
• At the command line, enter the command and press <Enter>. If parameters are
required, the command and listed parameters are described.
• For definitions of the commands, enter help at the prompt.
• Enter command-name help for additional help.
Note:
The ? character can be used interchangeably with the help command.
TUT Systems, Inc Page 17 of 104 P/N 220-06288-20
Getting Started
.
Cursor Movement
To save time, you can use the arrow keys on your keyboard to navigate between levels.
The command keystrokes are used to move the cursor around on the command line and
within the command history buffer. The arrow keys can also be used for cursor
movement.
Navigation and cursor movement for the SMS2000 system is described in Table 2-2.
Table 2-2 Cursor Motion Keystrokes
Keystroke Operation
Backspace Deletes the character behind the cursor
Delete Deletes the character under the cursor
Left arrow Moves the cursor back one character
Right arrow Moves the cursor forward one character
Up arrow Recalls the previous command in the command history
Down arrow Recalls the next command in the command history
Control+A Moves cursor to the first character at the beginning of the line.
Control+B Moves cursor backward to the beginning of the previous word to
the first character at the beginning of the line.
Control+C Interrupts the currently executing command
Control+E Moves the cursor to end of line
Control+K Deletes the characters from the cursor to the end of the line.
Control+R Reprint the current line to the screen
Control+W Moves cursor forward to the end of the next word
Control+X Deletes from the current cursor position to the beginning
TUT Systems, Inc Page 18 of 104 P/N 220-06288-20
Initial Configuration
Chapter 3 - Initial Configuration
You may configure the SMS2000 via a serial interface or a Telnet connection as
described in the following sections.
Establishing a Connection with the SMS2000
Establishing a Connection Via a Serial Interface
Note: Verify you have installed the SMS2000 on a rack or shelf with air
circulating above and below the SMS2000.
Perform the following steps to configure the SMS2000 via a serial interface connection:
1. If you have not already done so, connect a PC to the DB-9 RS-232 console port
connector on the SMS2000 using the DB-9 RS-232 null modem cable supplied.
2. Using Microsoft Windows 95 or later, from the Windows task bar, click Start.
3. From the Start menu, select Programs.
4. From the Programs menu, select the Accessories/Communication menu and then
select the HyperTerminal folder.
5. Click the HyperTerminal icon.
The Connection Description dialog box displays.
6. Enter a name (for example, SMS2000) and select an icon for the connection, then
click OK.
The Connect To dialog box displays.
7. Select Connect Using Direct to COM 1 or 2 (the COM port on this PC).
8. Click OK.
9. Click Configure.
10. Set the following parameters in the Connection tab:
• Set Bits per second to 9600.
• Set Data bits to 8.
• Set Parity to None.
• Set Stop bits to 1.
• Set Flow control to None.
TUT Systems, Inc Page 19 of 104 P/N 220-06288-20
Initial Configuration
11. Click OK.
12. Set the following parameters in the Settings tab:
• Select Terminal keys.
• From the Emulation pull-down menu, select Auto Detect.
• Set Backscroll buffer lines to 500.
13. Click OK to close the dialog box.
Note: To avoid cutting off a section of the display, set the window to full screen
size.
14. To save this configuration for the future, select File/Save As and enter the name of
the file for this configuration.
Perform the following steps to log on to the SMS2000:
1. Power up the SMS2000 when the system is finished rebooting (1 to 5 minutes). You
will hear three consecutive beeps when ready.
2. From the Hyperterm Call menu, select Connect.
3. To verify that you have correctly configured your console port, press <Enter>.
• If the Login Display screen does not appear:
• Make sure that you entered the correct settings.
• Verify that you are using the correct cable and that the cable is not
damaged.
• Check that you have good cable connections and connector.
If you are still unable to view the Login Display screen, call your Tut Systems
Customer Service representative.
4. Log on using the username “manager” and the password “manager.”
Note: The password “manager” is the factory default password for the
SMS2000. You are strongly encouraged to change your initial logon password
as soon as possible to ensure security. For instructions on changing your
password, see the Changing Your Password section of this chapter.
Warning Security is a critical component of this system. As the system administrator, it
is your responsibility to manage the security of this system.
Establishing a Connection Via Telnet
Perform the following steps to gain Telnet access to an unconfigured SMS2000 from the
subscriber port:
To connect directly to the subscriber port:
TUT Systems, Inc Page 20 of 104 P/N 220-06288-20
Initial Configuration
If you have not already done so, connect the PC to the SMS2000 subscriber port, by
plugging one end of a cross-over Ethernet cable into the Ethernet port on the PC and the
other end into the subscriber port on the back of the SMS2000.
Note: If you are not using a hub to connect to the subscriber port, you must use
a crossover cable.
To connect using a hub:
5. Plug one end of a straight-through Ethernet cable into the PC’s Ethernet port and the
other into the hub.
6. Plug one end of another Ethernet cable into the subscriber port on the back of the
SMS2000 and the other into the hub.
7. Ensure the hub is not connected to any other network.
Note: Do not plug the subscriber port of the SMS2000 into your network.
Isolate the PC and SMS2000 from the rest of your network.
Perform the following steps to gain access to an unconfigured SMS2000:
1. From the Windows task bar, click Start.
2. From the Start menu, select Run.
3. In the Run dialog box, enter Telnet.
4. Click OK.
5. Click Connect and select Remote System.
The Connect dialog box displays.
6. Enter 35.42.42.42 for the host name.
Note: 35.42.42.42 is the internal factory default IP address for the SMS2000.
Once you configure the IP address on your SMS2000, use the IP address that
you have assigned instead.
7. Enter 4242 for the port number.
8. Select vt100 for the TermType.
9. Click Connect.
At this point you will be presented with the logon prompt.
10. Log on using the login name “manager” and password “manager.”
Note:
The password “manager” is the default password for the SMS2000.
You are strongly encouraged to change your initial logon password as soon as
possible to ensure security.
Once you have successfully logged on to the SMS2000, you can proceed with the basic
configuration of your system.
TUT Systems, Inc Page 21 of 104 P/N 220-06288-20
Initial Configuration
Initial Configuration
There are five steps required for the initial configuration of the SMS2000:
1.
Step 1 Change the password for security purposes.
2.
Step 2 Set the Quick Configuration.
3.
Step 3 Change the system hostname to identify the system on the network.
4.
Step 4 Disable authentication.
5.
Step 5 Save the configuration.
6.
Step 6 Reboot the system.
7.
Step 7 Verify connectivity.
For advanced configuration information, see the SMS2000 User’s Guide.
For information on using OCS with the SMS2000, see the OCS User’s Guide.
Changing Your Password
You are encouraged to change the initial configuration password, “manager,” after your
initial login to the SMS2000. Perform the following steps to change your password:
1. At the system prompt enter:
sms2000% passwd
2. Press <Enter>.
3. Enter your new password.
4. Press <Enter>.
The system asks you to verify your password.
5. Reenter your password.
6. Press <Enter>.
Note:
If you forget your password at any time, please call your Tut Systems
Customer Service representative to assist you in logging on again.
You must have access to the serial port and have a phone nearby when contacting
Customer Service to bypass your password.
Setting the Quick Configuration
To reset the entire system configuration, using the IP address, network mask, default
gateway, and DNS servers specified in the basic system configuration, use this command:
set quick-config {ip_address/masklen | ip_address netmask ip_mask} gateway
dns[dns] [dns]
TUT Systems, Inc Page 22 of 104 P/N 220-06288-20
Initial Configuration
This example resets the system configuration, setting the local IP address to
192.168.1.244 with a 24-bit subnet mask (255.255.255.0) and the default gateway is
192.168.1.1.
There are two DNS servers; the first is 192.168.1.42, and the second is 192.168.1.1.
sms2000% set quick-config 192.168.1.244/24 192.168.1.1
192.168.1.42 192.168.1.1
Setting the Hostname
Use the set hostname command to immediately change the host name at the command
prompt. SMS2000 uses the specified host name when communicating with the OCS and
as the SMS2000 command prompt. Each SMS2000 in a network should have a unique
host name.
Note: Host names cannot contain spaces, unprintable characters, quotation
marks (“ ”), or apostrophes (’).
To set the system hostname, use this command:
set hostname hostname
For example, to set the host name of the local system to ParkPlace,type:
sms2000% set hostname ParkPlace
Disabling Authentication
The command auth off disables authentication.
Note:
Additional options for forced web pages are available in the SMS2000
Command Reference.
To disable authentication for the current group and remove the server IP, use this
command:
auth off
For example, to disable authentication for the current group, type:
sms2000% auth off
Saving the Configuration
To save the configuration, use this command.
Save
TUT Systems, Inc Page 23 of 104 P/N 220-06288-20
Initial Configuration
for example, to save the current configuration, type:
sms2000% save
Rebooting the System
In order for saved configuration changes to take effect, you must reboot the system.
To force the system to shut down completely and then restart, use this command:
reboot
For example, to reboot the system, type:
sms2000% reboot
Verifying the Configuration
1. Login to the system.
2. Ping a known site.
sms2000% ping www.yahoo.com
3. Press CTRL-C to stop the pinging.
4. Ping another known site.
sms2000% ping www.apple.com
5. Press CTRL-C to stop the pinging.
If the SMS2000 cannot ping these sites, try to ping a known external IP Address, check
your configuration and the local network to verify that you have connectivity to the
Internet.
TUT Systems, Inc Page 24 of 104 P/N 220-06288-20
System Administration
Chapter4 - System Administration
This chapter describes the system administration activities and commands, including:
•
Configuration E-Mail Settings
• Configuration and System File Tools
• Configuring SMTP
• Configuring NTP
• Configuring SNMP Polling
• Connectivity and Testing
• System Tools
• Event Tracking
• System Administration Tools
• Troubleshooting Tools
• Subscriber Connectivity Commands
• Upgrades
Configuration E-Mail Settings
Setting the Default Configuration E-mail
Each time you save a new configuration, the SMS2000 can automatically send an e-mail
with the new configuration to a specified recipient. The set config-mail command allows
you to specify the recipient.
The SMTP server must be the DNS name or IP address of the destination
Note:
mail server. If the IP address is not provided, the server name in the e-mail
address is used, which is normally not the desired behavior.
To configure the SMS2000 to send its configuration file to a specified e-mail address
each time the configuration is saved, use this command:
set config-mail recipient@SMTPserver [SMTPserver]
For example, to configure the SMS2000 to send an e-mail with the new configuration file
attached to ted@smith.com, using smith.com as the e-mail server, type:
sms2000% set config-mail ted@smith.com mail.smith.com
TUT Systems, Inc Page 25 of 104 P/N 220-06288-20
System Administration
Mailing the Current Configuration
The config-mail command mails the current configuration to the address specified. The
SMS2000 uses the SMTP (Simple Mail Transfer Protocol) server specified by the e-mail
address or SMTP-server command line parameter. If you enter config-mail with no
parameters, the SMS2000 uses the server last configured with set config-mail.
Once connected, the SMS2000 sends an e-mail message to the specified (or default - if
none is entered) recipient. The message includes a brief explanation of why it was sent
with the SMS2000 configuration file attached.
The manager can store the configuration file on an FTP or HTTP server, and later recover
it using the load config command.
To temporarily override the default e-mail configuration settings and mail the SMS2000
configuration to the specified e-mail address using the given local email server, use this
command:
config-mail [recipient_e-mail [SMTP_server]]
For example, to override the default configuration e-mail settings and send the config email to billy@chung.com, using chung.com as a valid e-mail server that accepts e-mail
directly from the SMS2000, type:
sms2000% config-mail billy@chung.com mail.chung.com
Deleting the Configuration E-mail
To delete the configured e-mail address and mail server to be notified when saving the
system configuration, use this command:
delete config-mail
For example, to disable e-mail notification of configuration changes, use this command:
sms2000% delete config-mail
Configuration and System File Tools
Committing Configuration Changes
To immediately commit configuration changes to the running system and synchronize the
running system with the state of the configuration, use this command:
commit
For example, to immediately commit a configuration change, type:
sms2000% commit
TUT Systems, Inc Page 26 of 104 P/N 220-06288-20
System Administration
Some types of changes, including adding a static port with the set port
Note:
command or resetting the system configuration with the set quick config
command require that you reboot the SMS2000 before continuing.
Automatically Committing Configuration Changes
To commit configuration changes to the running system immediately after they are
entered without having to enter the commit command, use this command:
commit auto
For example to force all configuration changes to be executed immediately, type:
sms2000% commit auto
Some commands cannot be committed without saving and rebooting.
Note:
When one of these commands is issued, the SMS2000 displays a warning to the
system administrator and disables the automatic commitment of commands.
Note:
You can determine the state of the autocommit feature by checking its
value at the bottom of the show config screen.
Disabling Automatic Configuration Changes
Use the commit noauto command to disable the commit auto command and revert to
using commit manually. This allows commands that are not already
dynamic/instantaneous to be queued for batch mode execution.
For example, some of the commands that are not dynamic are:
delete dns load sys set quick-config
dump-info set default set time
system set dns set timezone
load config set port
To disable the automatic commitment of configuration commands, use this command:
commit noauto
For example, to set the systemto not commit changes until the commit command is
issued, type:
sms2000% commit noauto
Changes to the running system will be lost upon reboot, unless you enter
Note:
the save command.
TUT Systems, Inc Page 27 of 104 P/N 220-06288-20
System Administration
Saving a Configuration
After committing configuration changes to the running system, the save command is used
to store the current configuration to a startup script, which is executed the next time the
system boots.
To save the current configuration for use on the next reboot, use this command:
save
For example, to save configuration changes made in the current session to permanent
storage and for use on the next reboot, type:
sms2000% save
You must reboot the system for the saved configuration changes to take
Note:
effect.
Loading a Configuration File
The command load config can be used for system recovery. If a SMS2000 fails and you
have saved the old configuration file to an external server, you can use the set quick-
config command to get the SMS2000 up and running and load config to restore the
complete old configuration file. This minimizes the risk associated with missing a minor
configuration parameter when you replace a SMS2000.
Note:
No integrity checking is performed besides checking the file header. A
corrupt configuration file can be loaded and hang the system. To troubleshoot
possible system failure, use the show startup command.
To load a configuration file from a remote FTP or HTTP server, use this command:.
load config url
Note:
Once the file is loaded, you must reboot the SMS2000 so that the new
configuration takes effect.
For example, to load the configuration file previously saved for the Connie Hotel from an
FTP server, type:
sms2000% load config
ftp://ftp.local.com/Connie_Hotel/config_file
Restoring a Previous Configuration
To restore the SMS2000 configuration to the last one that was active before you saved
the image, use this command:
restore {config | web | original-config}
For example, to restore the last configuration you saved with the save command, type:
TUT Systems, Inc Page 28 of 104 P/N 220-06288-20
System Administration
sms2000% restore config
You must reboot the SMS2000 for the restored configuration to take
Note:
effect.
Restoring the Default Configuration
To restore the SMS2000 to the default configuration (with no functions configured), use
this command:
set default
For example, to reset the SMS2000 configuration to default, type:
sms2000% set default
Note: This command does not change the password.
Configuring SMTP
Setting the SMTP Server
The command set smtp-server starts proxying SMTP sends to the specified SMTP
server. Many mail (SMTP) servers reject mail sent from users who are behind a NAT
device. To compensate for this, an ISP can install a mail server that accepts mail from
each SMS2000. When a subscriber wants to send mail, the SMS2000 can automatically
proxy the mail to the ISP’s mail server, which can then cleanly forward it to its final
destination. Many SMTP servers do not forward e-mail from hosts outside the local
network. It is recommended that you use a local SMTP server. For example, if you have a
computer with an IP address in the same subnet as the SMS2000 that can send e-mail, use
the SMTP server configured for your e-mail program.
To redirect Simple Mail Transfer Protocol (SMTP) sends to a specified SMTP server, use
this command:
set smtp-server {server_name | ip_address}
For example, to route all outgoing mail messages through an SMTP server with the IP
address 1.2.3.4, type:
sms2000% set smtp-server 1.2.3.4
Deleting the SMTP Server
To stop SMTP proxy sends to the specified SMTP server, use this command:
TUT Systems, Inc Page 29 of 104 P/N 220-06288-20
System Administration
delete smtp-server {server_name | ip_address}
For example, to stop forwarding mail to the mail server 1.2.3.4, type:
sms2000% delete smtp-server 1.2.3.4
Setting the SMTP ID
To configure the SMS2000 to modify the header of outbound e-mail messages from
subscribers to ensure that the configured SMTP server will accept their messages when
they are connected behind SMS2000, use this command:
set smtpid {on | off}
For example, to enable SNMP messages to be sent to the SMTP server, type:
sms2000% set smtpid on
The commands set smtpid and set smtp-server are each independently
Note:
configurable mechanisms to help subscribers send e-mail messages without
changing any configuration items on their PCs.
Configuring NTP
The Network Time Protocol (NTP) server is used to synchronize the clock on the
SMS2000 with the true time. Using an NTP server ensures that the SMS2000 accurately
time stamps data to other servers, such as syslog. If an NTP server is not configured, the
SMS2000 (like many other devices) may experience clock drift and you may later need to
reset the time.
Setting the Timezone
Use the set timezone command to configure the timezone. You must configure a
timezone before you can synchronize system time using NTP.
To set the local time to a specified time zone, use this command:
set timezone timezone_name
For example, to set the time zone to Michigan time, type:
sms2000% set timezone US/Michigan
To list the valid time zones, enter set timezone with no arguments
Note:
TUT Systems, Inc Page 30 of 104 P/N 220-06288-20
Loading...