Page 1
SmartNode Series
SmartWare Release 2.20
Software Configuration Guide
Sales Office: +1 (301) 975-1000
Technical Support: +1 (301) 975-1007
E-mail: support@patton.com
URL: www.patton.com
Document Number: 132111U Rev. B
Part Number: 07MDSW_SCG_2_20
Revised: December 1, 2003
Page 2
Patton Electronics Company, Inc.
7622 Rickenbacker Drive
Gaithersburg, MD 20879 USA
tel: +1 (301) 975-1000
fax: +1 (301) 869-9293
support: +1 (301) 975-1007
url: www.patton.com
e-mail: support@patton.com
Copyright Statement
Copyright © 2003, Patton Electronics Company. All rights reserved.
Trademark Statement
The terms SmartWare, SmartView, and SmartNode are trademarks of Patton
Electronics Company. All other trademarks presented in this document are the property of their respective owners.
Notices
The information contained in this document is not designed or intended for use as
critical components in human life-support systems, equipment used in hazardous
environments, or nuclear control systems. Patton Electronics Company disclaims any
express or implied warranty of fitness for such uses.
The information in this document is subject to change without notice. Patton Electronics assumes no liability for errors that may appear in this document.
Any software described in this document is furnished under license and may be used
or copied only in accordance with the terms of such license.
Page 3
Contents
Contents ......................................................................................................................................................... 1
About this guide ........................................................................................................................................... 15
Audience............................................................................................................................................................... 15
How to read this guide ......................................................................................................................................... 15
Structure............................................................................................................................................................... 15
Typographical conventions used in this document................................................................................................ 18
General conventions .......................................................................................................................................18
Mouse conventions .........................................................................................................................................19
Service ............................................................................................................................................................19
1 System overview ............................................................................................................................................ 21
Introduction..........................................................................................................................................................22
SmartNode hardware platforms.............................................................................................................................23
SmartWare embedded software .............................................................................................................................24
SmartView management center tools.....................................................................................................................25
Applications...........................................................................................................................................................25
Carrier networks .............................................................................................................................................26
Enterprise networks ........................................................................................................................................26
LAN telephony ...............................................................................................................................................28
2 Configuration concepts ................................................................................................................................. 29
Introduction..........................................................................................................................................................30
Contexts and Gateways..........................................................................................................................................32
Context ...........................................................................................................................................................32
Gateway ..........................................................................................................................................................32
Interfaces, Ports, and Bindings...............................................................................................................................32
Interfaces ........................................................................................................................................................32
Ports and circuits ............................................................................................................................................33
Bindings ..........................................................................................................................................................33
Profiles and Use commands...................................................................................................................................34
Profiles ............................................................................................................................................................34
Use Commands ..............................................................................................................................................34
3 Command line interface (CLI) ...................................................................................................................... 35
Introduction..........................................................................................................................................................36
Command modes ..................................................................................................................................................36
System Prompt ...............................................................................................................................................39
Navigating the CLI .........................................................................................................................................39
Initial Mode ..............................................................................................................................................39
System Changes ........................................................................................................................................39
Configuration ...........................................................................................................................................39
Changing Modes .......................................................................................................................................39
1
Page 4
Contents
Model 4520 & 4110 Series Getting Started Guide
Command Editing.................................................................................................................................................40
Command Help ..............................................................................................................................................40
The No Form .................................................................................................................................................40
Command Completion ...................................................................................................................................40
Command History ..........................................................................................................................................40
Command Editing Shortcuts ..........................................................................................................................40
4 Accessing the CLI.......................................................................................................................................... 43
Introduction..........................................................................................................................................................44
Accessing the SmartWare CLI task list...................................................................................................................44
Accessing via the console port .........................................................................................................................45
Console port procedure .............................................................................................................................45
Accessing via a Telnet session ..........................................................................................................................46
Telnet Procedure .......................................................................................................................................47
Log onto SmartWare .......................................................................................................................................47
Selecting a secure password .............................................................................................................................48
Configure operators and administrators ..........................................................................................................48
Factory preset administrator account .........................................................................................................48
Creating an operator account ....................................................................................................................48
Creating an administrator account ............................................................................................................49
Displaying the CLI version .............................................................................................................................50
Displaying account information ......................................................................................................................50
Switching to another account ..........................................................................................................................50
Checking identity and connected users ...........................................................................................................51
Ending a Telnet or console port session ..........................................................................................................52
5 Establishing basic IP connectivity ................................................................................................................. 53
Introduction..........................................................................................................................................................54
IP context selection and basic interface configuration tasks....................................................................................54
Entering the IP context, creating IP interfaces and assigning an IP address .....................................................54
Defining IP Ethernet encapsulation and binding an IP interface to a physical port .........................................55
Activating a physical port ................................................................................................................................55
Displaying IP interface information ................................................................................................................56
Deleting IP interfaces ......................................................................................................................................57
Examples ...............................................................................................................................................................58
Setting up an IP interface on an Ethernet port ................................................................................................58
6 System image handling.................................................................................................................................. 61
Introduction..........................................................................................................................................................62
Memory regions in SmartWare..............................................................................................................................62
Boot procedure......................................................................................................................................................64
Bootloader (for SmartNode 1000 and 2000 Series) ...............................................................................................65
Start Bootloader and login ..............................................................................................................................65
Main shell and domains ..................................................................................................................................65
Route Table Manager (RTM) .........................................................................................................................66
Download Agent .............................................................................................................................................67
2
Page 5
3
Model 4520 & 4110 Series Getting Started Guide
Contents
Diagnostic .......................................................................................................................................................68
Bootloader (for SmartNode 4110/4520 Series)......................................................................................................69
Start Bootloader ..............................................................................................................................................69
Start-up with factory configuration .................................................................................................................70
Load a new application image (SmartWare) via TFTP...........................................................................................70
Load a new application image (SmartWare) via serial link .....................................................................................72
Factory configuration ............................................................................................................................................72
System image handling task list .............................................................................................................................73
Displaying system image information ..............................................................................................................73
Copying system images from a network server to Flash memory .....................................................................74
Copying driver software from a network server to Flash memory ....................................................................75
7 Configuration file handling........................................................................................................................... 77
Introduction..........................................................................................................................................................78
Understanding configuration files ...................................................................................................................78
Factory configuration ............................................................................................................................................80
Configuration file handling task list.......................................................................................................................81
Copying configurations within the local memory ............................................................................................82
Replacing the startup configuration with a configuration from Flash memory ................................................83
Copying configurations to and from a remote storage location ........................................................................85
Replacing the startup configuration with a configuration downloaded from TFTP server ...............................86
Displaying configuration file information .......................................................................................................87
Modifying the running configuration at the CLI .............................................................................................87
Modifying the running configuration offline ...................................................................................................88
Deleting a specified configuration ...................................................................................................................89
8 Basic system management ............................................................................................................................. 91
Introduction..........................................................................................................................................................92
Basic system management configuration task list ...................................................................................................92
Setting system information .............................................................................................................................92
Setting the system banner ................................................................................................................................94
Setting time and date ......................................................................................................................................94
Display clock information ...............................................................................................................................95
Display time since last restart ..........................................................................................................................95
Configuring and starting the Web server .........................................................................................................96
Determining and defining the active CLI version ............................................................................................96
Restarting the system ......................................................................................................................................97
Displaying the system logs ..............................................................................................................................97
Controlling command execution .....................................................................................................................98
Displaying the checksum of a configuration ....................................................................................................99
Configuration of Telnet sessions ...................................................................................................................100
9 IP context overview ..................................................................................................................................... 101
Introduction........................................................................................................................................................102
IP Context Overview Configuration Task List.....................................................................................................103
Planning your IP configuration ...........................................................................................................................104
Page 6
Contents
Model 4520 & 4110 Series Getting Started Guide
IP interface related information .....................................................................................................................104
Serial interface related information ................................................................................................................105
QoS related information ...............................................................................................................................105
Configuring Ethernet and serial ports..................................................................................................................105
Creating and configuring IP interfaces.................................................................................................................105
Configuring NAPT .............................................................................................................................................106
Configuring Static IP Routing.............................................................................................................................106
Configuring RIP..................................................................................................................................................106
Configuring Access Control Lists.........................................................................................................................107
Configuring quality of service (QoS) ...................................................................................................................107
10 IP interface configuration ........................................................................................................................... 109
Introduction........................................................................................................................................................110
Software IP interface configuration task list .........................................................................................................110
Creating an IP interface ................................................................................................................................110
Deleting an IP interface ................................................................................................................................111
Setting the IP address and netmask ...............................................................................................................112
ICMP message processing .............................................................................................................................112
ICMP redirect messages ................................................................................................................................112
Router advertisement broadcast message .......................................................................................................113
Defining the MTU and MSS of the interface ................................................................................................114
Configuring an interface as a point-to-point link ..........................................................................................114
Displaying IP interface information ..............................................................................................................115
Testing connections with the ping command ................................................................................................115
Traceroute ....................................................................................................................................................116
Examples .............................................................................................................................................................116
Deleting an IP interface ................................................................................................................................116
11 NAT/NAPT configuration........................................................................................................................... 119
Introduction........................................................................................................................................................120
Dynamic NAPT ...........................................................................................................................................120
Static NAPT .................................................................................................................................................121
Dynamic NAT ..............................................................................................................................................122
Static NAT ...................................................................................................................................................122
NAPT Traversal ............................................................................................................................................123
NAT/NAPT configuration task list .....................................................................................................................123
Creating a NAPT profile ...............................................................................................................................123
Activate NAT/NAPT ....................................................................................................................................124
Displaying NAT/NAPT configuration information ......................................................................................125
12 Ethernet port configuration ........................................................................................................................ 127
Introduction........................................................................................................................................................128
Ethernet port configuration task list ....................................................................................................................128
Entering the Ethernet port configuration mode ............................................................................................129
Configuring medium for an Ethernet port ....................................................................................................129
Configuring Ethernet encapsulation type for an Ethernet port ......................................................................130
4
Page 7
5
Model 4520 & 4110 Series Getting Started Guide
Contents
Binding an Ethernet port to an IP interface ..................................................................................................130
Selecting the frame format for an Ethernet port ............................................................................................131
Configuring layer 2 CoS to service class mapping for an Ethernet port .........................................................132
Adding a receive mapping table entry ......................................................................................................133
Adding a transmit mapping table entry ...................................................................................................133
Closing an Ethernet port ...............................................................................................................................134
13 Link scheduler configuration ...................................................................................................................... 137
Introduction........................................................................................................................................................138
Quick references..................................................................................................................................................139
Setting the modem rate .................................................................................................................................140
Command cross reference .............................................................................................................................141
Link scheduler configuration task list...................................................................................................................141
Defining the access control list profile ...........................................................................................................141
Packet classification .................................................................................................................................141
Creating an access control list ..................................................................................................................142
Assigning bandwidth to traffic classes ............................................................................................................144
Priority ....................................................................................................................................................144
Weighted fair queuing .............................................................................................................................145
Shaping ...................................................................................................................................................145
Burst tolerance ........................................................................................................................................145
Hierarchy ................................................................................................................................................145
Creating a top-level service policy profile ......................................................................................................147
Specifying source classes or lower level source policy profiles .........................................................................150
Defining fair queuing weight ...................................................................................................................150
Defining the bit-rate ...............................................................................................................................150
Defining absolute priority .......................................................................................................................150
Defining the maximum queue length ......................................................................................................151
Specifying the type-of-service (TOS) field ...............................................................................................151
Specifying the precedence field ................................................................................................................152
Specifying differentiated services codepoint marking ...............................................................................152
Specifying layer 2 marking ......................................................................................................................154
Defining random early detection .............................................................................................................154
Discarding Excess Load ...........................................................................................................................155
Devoting the service policy profile to an interface .........................................................................................156
Displaying link arbitration status ..................................................................................................................157
Displaying link scheduling profile information .............................................................................................157
Enable statistics gathering .............................................................................................................................158
14 Serial port configuration ............................................................................................................................. 159
Introduction........................................................................................................................................................160
Serial port configuration task list .........................................................................................................................160
Disabling an interface ...................................................................................................................................161
Enabling an interface ....................................................................................................................................161
Configuring the serial encapsulation type ......................................................................................................162
Page 8
Contents
Model 4520 & 4110 Series Getting Started Guide
Configuring the hardware port protocol ........................................................................................................163
Configuring the active clock edge ..................................................................................................................164
Enter Frame Relay mode ...............................................................................................................................165
Configuring the LMI type .............................................................................................................................165
Configuring the keep-alive interval ...............................................................................................................166
Enabling fragmentation ................................................................................................................................167
Entering Frame Relay PVC configuration mode ...........................................................................................168
Configuring the PVC encapsulation type ......................................................................................................169
Binding the Frame Relay PVC to IP interface ...............................................................................................169
Disabling a Frame Relay PVC .......................................................................................................................170
Displaying Frame Relay information .............................................................................................................171
Examples .............................................................................................................................................................172
Displaying serial port information .................................................................................................................172
Displaying Frame Relay information .............................................................................................................173
Integrated service access ................................................................................................................................173
15 Basic IP routing configuration.................................................................................................................... 177
Introduction........................................................................................................................................................178
Routing tables ...............................................................................................................................................178
Static routing ................................................................................................................................................178
Basic IP routing configuration task list ................................................................................................................178
Configuring static IP routes ..........................................................................................................................178
Deleting static IP routes ................................................................................................................................179
Displaying IP route information ...................................................................................................................180
Examples .............................................................................................................................................................181
Basic static IP routing example ......................................................................................................................181
16 RIP configuration........................................................................................................................................ 183
Introduction........................................................................................................................................................184
Routing protocol .................................................................................................................................................184
RIP configuration task list ...................................................................................................................................185
Enabling send RIP ........................................................................................................................................185
Enabling an interface to receive RIP ..............................................................................................................186
Specifying the send RIP version ....................................................................................................................186
Specifying the receive RIP version .................................................................................................................187
Enabling RIP learning ...................................................................................................................................187
Enabling an interface to receive RIP ..............................................................................................................188
Enabling RIP announcing .............................................................................................................................188
Enabling RIP auto summarization ................................................................................................................189
Specifying the default route metric ................................................................................................................189
Enabling RIP split-horizon processing ...........................................................................................................190
Enabling the poison reverse algorithm ...........................................................................................................190
Enabling holding down aged routes ..............................................................................................................191
Displaying RIP configuration of an IP interface ............................................................................................191
Displaying global RIP information ................................................................................................................192
6
Page 9
7
Model 4520 & 4110 Series Getting Started Guide
Contents
17 Access control list configuration.................................................................................................................. 193
Introduction........................................................................................................................................................194
About access control lists .....................................................................................................................................194
What access lists do .......................................................................................................................................194
Why you should configure access lists ...........................................................................................................194
When to configure access lists .......................................................................................................................195
Features of access control lists .......................................................................................................................195
Access Control List configuration task list ...........................................................................................................196
Map out the goals of the access control list ....................................................................................................196
Create an access control list profile and enter configuration mode .................................................................197
Add a filter rule to the current access control list profile ................................................................................197
Add an ICMP filter rule to the current access control list profile ...................................................................199
Add a TCP, UDP or SCTP filter rule to the current access control list profile ..............................................201
Bind and unbind an access control list profile to an IP interface ....................................................................203
Display an access control list profile ..............................................................................................................204
Debug an access control list profile ...............................................................................................................204
Examples .............................................................................................................................................................206
Deny a specific subnet ...................................................................................................................................206
18 SNMP Configuration .................................................................................................................................. 207
Introduction........................................................................................................................................................208
Simple Network Management Protocol (SNMP) ................................................................................................208
SNMP basic components ..............................................................................................................................208
SNMP basic commands ................................................................................................................................208
SNMP management information base (MIB) ...............................................................................................209
Network management framework .................................................................................................................209
Identification of the SmartNode 1000, 2000 and 4000 Series via SNMP ............................................................210
SNMP tools.........................................................................................................................................................211
SNMP configuration task list ..............................................................................................................................211
Setting basic system information..........................................................................................................................212
Setting access community information ................................................................................................................214
Setting allowed host information.........................................................................................................................215
specifying the default snmp trap target ................................................................................................................215
Displaying SNMP related information ................................................................................................................216
Using the AdventNet SNMP utilities ..................................................................................................................217
Using the MibBrowser ..................................................................................................................................217
Using the TrapViewer ...................................................................................................................................218
Standard SNMP version 1 traps...........................................................................................................................220
SNMP interface traps ..........................................................................................................................................222
19 SNTP client configuration .......................................................................................................................... 223
Introduction........................................................................................................................................................224
SNTP client configuration task list......................................................................................................................224
Selecting SNTP time servers .........................................................................................................................225
Defining SNTP client operating mode ..........................................................................................................225
Page 10
Contents
Model 4520 & 4110 Series Getting Started Guide
Defining SNTP local UDP port ....................................................................................................................226
Enabling and disabling the SNTP client .......................................................................................................227
Defining SNTP client poll interval ...............................................................................................................227
Defining SNTP client constant offset to GMT .............................................................................................227
Defining the SNTP client anycast address .....................................................................................................228
Enabling and disabling local clock offset compensation .................................................................................229
Showing SNTP client related information ....................................................................................................230
Debugging SNTP client operation ................................................................................................................230
Recommended public SNTP time servers............................................................................................................231
NIST Internet time service ............................................................................................................................231
Other public NTP primary (stratum 1) time servers .....................................................................................232
Additional information on NTP and a list of other NTP servers ...................................................................233
Recommended RFC .....................................................................................................................................233
20 DHCP configuration................................................................................................................................... 235
Introduction........................................................................................................................................................236
DHCP-client configuration tasks.........................................................................................................................237
Enable DHCP-client on an IP interface ........................................................................................................237
Release or renew a DHCP lease manually (advanced) ...................................................................................238
Get debug output from DHCP-client ...........................................................................................................239
DHCP-server configuration tasks ........................................................................................................................240
Configure DHCP-server profiles ...................................................................................................................240
Use DHCP-server profiles and enable the DHCP-server ...............................................................................242
Check DHCP-server configuration and status ...............................................................................................243
Get debug output from the DHCP-server .....................................................................................................243
21 PPP configuration....................................................................................................................................... 245
Introduction........................................................................................................................................................246
PPP configuration task list...................................................................................................................................247
Creating an IP interface for PPP ...................................................................................................................247
Creating a PPP subscriber .............................................................................................................................249
Configuring a PPPoE session ........................................................................................................................250
Configuring a serial port for PPP ..................................................................................................................252
Creating a PPP profile ...................................................................................................................................253
Displaying PPP configuration information ...................................................................................................254
Debugging PPP ............................................................................................................................................256
Sample configurations .........................................................................................................................................260
PPP over Ethernet (PPPoE) ..........................................................................................................................260
Without authentication, encapsulation multi, with NAPT ......................................................................260
With authentication, encapsulation PPPoE .............................................................................................260
PPP over serial link .......................................................................................................................................261
Without authentication, numbered interface ...........................................................................................261
With authentication, unnumbered interface ............................................................................................261
22 VPN configuration ...................................................................................................................................... 263
Introduction........................................................................................................................................................264
8
Page 11
9
Model 4520 & 4110 Series Getting Started Guide
Authentication ..............................................................................................................................................264
Encryption ....................................................................................................................................................264
Transport and tunnel modes .........................................................................................................................265
Key management ..........................................................................................................................................265
VPN configuration task list .................................................................................................................................265
Creating an IPsec transformation profile .......................................................................................................265
Creating an IPsec policy profile .....................................................................................................................266
Creating/modifying an outgoing ACL profile for IPsec .................................................................................268
Configuration of an IP interface and the IP router for IPsec ..........................................................................269
Displaying IPsec configuration information ..................................................................................................269
Debugging IPsec ...........................................................................................................................................270
Sample configurations .........................................................................................................................................271
IPsec tunnel, DES encryption .......................................................................................................................271
SmartNode configuration ........................................................................................................................271
Cisco Router Configuration ....................................................................................................................272
IPsec Tunnel, AES Encryption at 256 Bit Key Length, AH Authentication with HMAC-SHA1-96 .............272
SmartNode Configuration ......................................................................................................................272
Cisco Router Configuration ....................................................................................................................273
IPsec Tunnel, 3DES Encryption at 192 Bit Key Length, ESP Authentication with HMAC-MD5-96 ..........273
SmartNode Configuration ......................................................................................................................273
Cisco Router Configuration ....................................................................................................................273
Contents
23 CS context overview .................................................................................................................................... 275
Introduction........................................................................................................................................................276
CS context configuration task list ........................................................................................................................277
Plan the CS configuration .............................................................................................................................277
Configure general CS settings .......................................................................................................................280
Configure call routing .............................................................................................................................281
Create and configure CS interfaces ..........................................................................................................282
Specify call routing ..................................................................................................................................282
Configure dial tones ......................................................................................................................................282
Configure Voice over IP parameters ..............................................................................................................283
Configure ISDN ports ..................................................................................................................................283
Configure an ISoIP VoIP connection ............................................................................................................283
Configure a H.323 VoIP Connection ...........................................................................................................284
Activate CS Context Configuration ..............................................................................................................284
Situation .................................................................................................................................................286
Plan the CS context .................................................................................................................................287
Configure general CS settings .......................................................................................................................288
Configure call routing ...................................................................................................................................288
Configure Voice over IP settings ...................................................................................................................289
Configure ISDN ports ..................................................................................................................................289
Configure H.323 VoIP connection ...............................................................................................................290
Activate CS context configuration .................................................................................................................291
Page 12
Contents
Model 4520 & 4110 Series Getting Started Guide
Show the running configuration ...................................................................................................................292
24 CS interface configuration........................................................................................................................... 295
Introduction........................................................................................................................................................296
CS interface configuration task list ......................................................................................................................297
Create and configure CS interfaces ................................................................................................................297
Configure call routing ...................................................................................................................................298
Configure digit collection .............................................................................................................................299
Configure direct call signaling on VoIP interfaces .........................................................................................300
Specify the port address on VoIP interfaces ...................................................................................................301
Bind PSTN interfaces to PSTN ports and create line hunt groups ................................................................303
Examples .............................................................................................................................................................303
V5 carrier access ............................................................................................................................................303
Q.SIG PBX networking ................................................................................................................................306
25 Session router configuration ....................................................................................................................... 311
Introduction........................................................................................................................................................312
Routing table structure .................................................................................................................................313
Session router configuration task list....................................................................................................................313
Map out the goals for the session router ........................................................................................................314
Configure the entry table on circuit interfaces ...............................................................................................314
Configure session routing tables ....................................................................................................................315
Broadcast handling in the session router ..................................................................................................315
Configure number prefix for ISDN number types ...................................................................................315
Create a called party number routing table ..............................................................................................316
Create a calling party number routing table .............................................................................................317
Create a bearer capability routing table ....................................................................................................317
Create a time of day routing table ...........................................................................................................318
Create a day of week routing table ...........................................................................................................319
Create a date routing table ......................................................................................................................319
Create a presentation indicator routing table .................................................................................................320
Create a screening indicator routing table .....................................................................................................321
Configure number manipulation functions ...................................................................................................321
Create a Number Replacement Table ......................................................................................................323
Create complex number manipulation functions .....................................................................................324
Deleting Routing tables and functions ..........................................................................................................324
Activate the session router configuration .......................................................................................................325
Example ..............................................................................................................................................................326
Enterprise network with local breakout and IP carrier access .........................................................................326
26 Tone configuration...................................................................................................................................... 331
Introduction........................................................................................................................................................332
Tone-set profiles ...........................................................................................................................................332
Tone configuration task list .................................................................................................................................333
Configure call-progress-tone profiles .............................................................................................................333
Configure tone-set profiles ............................................................................................................................335
10
Page 13
11
Model 4520 & 4110 Series Getting Started Guide
Contents
Enable generation of local in-band tones .......................................................................................................335
Show call-progress-tone and tone-set profiles ................................................................................................336
Example ..............................................................................................................................................................338
27 ISDN port configuration............................................................................................................................. 341
Introduction........................................................................................................................................................342
ISDN reference points ..................................................................................................................................342
Possible SmartNode port configurations .......................................................................................................344
ISDN UNI signaling .....................................................................................................................................344
ISDN port configuration task list ........................................................................................................................346
Shutdown and enable ISDN ports ................................................................................................................346
Configure common BRI and PRI parameters ................................................................................................346
Configure BRI port parameters .....................................................................................................................349
Configure PRI port parameters .....................................................................................................................350
Example ..............................................................................................................................................................351
28 POTS port configuration ............................................................................................................................ 353
Introduction........................................................................................................................................................354
POTS signaling .............................................................................................................................................354
Shutdown and enable POTS ports ......................................................................................................................355
Configure common POTS port parameters.........................................................................................................356
Configure POTS port parameter .........................................................................................................................356
29 Gateway configuration ................................................................................................................................ 359
Introduction........................................................................................................................................................360
Gateway configuration task list............................................................................................................................360
Configure codec selection and fast connect ...................................................................................................361
Introduction ............................................................................................................................................361
Configure used codec for an ISoIP connection ........................................................................................362
Configure used codec for an H.323 connection and enable fast connect .................................................363
Enable T.38 fax over IP relay ........................................................................................................................365
Configure registration authentication service in an H.323 gateway ...............................................................365
H.323 registration authentication service gatekeeper registration type ...........................................................366
Enable Q.931 tunneling for an H.323 connection ........................................................................................367
Disabling the H.225 status enquiry ...............................................................................................................368
Disabling the H.245 Tunneling ....................................................................................................................368
H.323 transmission of Q.931 presentation and screening indicators (octet 3A) ............................................368
Configure H.235 security for H.323 .............................................................................................................368
Show and enable the gateway configuration ..................................................................................................371
Examples .............................................................................................................................................................373
Branch offices in an enterprise network .........................................................................................................373
Gatekeeper in LAN based telephony .............................................................................................................375
30 VoIP profile configuration .......................................................................................................................... 377
Introduction........................................................................................................................................................378
VoIP profile configuration task list ......................................................................................................................379
Page 14
Contents
Model 4520 & 4110 Series Getting Started Guide
Create a VoIP profile ....................................................................................................................................379
Enable DTMF relay ......................................................................................................................................380
Enable echo canceller ....................................................................................................................................380
Enable silence compression ...........................................................................................................................381
Configure voice volume ................................................................................................................................382
Configure dejitter buffer (advanced) .............................................................................................................383
Enable/disable filters (advanced) ...................................................................................................................386
Configure Fax and modem handling .............................................................................................................386
Show VoIP profile configuration and assign it to a VoIP gateway .................................................................390
Example ..............................................................................................................................................................392
Home office in an enterprise network ...........................................................................................................392
31 VoIP debugging........................................................................................................................................... 395
Introduction........................................................................................................................................................396
Debugging strategy..............................................................................................................................................396
Debugging task list ..............................................................................................................................................396
Verify IP connectivity ...................................................................................................................................397
Verify circuit switch connectivity ..................................................................................................................398
Debug ISDN data .........................................................................................................................................401
Debug H.323 data ........................................................................................................................................401
Debug session control data ............................................................................................................................401
Debug ISoIP data .........................................................................................................................................402
Debug Voice over IP data .............................................................................................................................402
Check system logs .........................................................................................................................................405
How to submit trouble reports to Patton ......................................................................................................405
A Terms and definitions ................................................................................................................................ 407
Introduction........................................................................................................................................................408
SmartWare architecture terms and definitions .....................................................................................................408
B Configuration mode overview .................................................................................................................... 415
Introduction........................................................................................................................................................417
SmartWare 2.20 command summary ..................................................................................................................417
operator_exec ................................................................................................................................................419
administrator_exec ........................................................................................................................................420
configure .......................................................................................................................................................422
system ...........................................................................................................................................................422
ic_voice .........................................................................................................................................................423
profile_acl .....................................................................................................................................................423
profile_service-policy ....................................................................................................................................423
source ............................................................................................................................................................423
profile_napt ..................................................................................................................................................424
profile_ppp ...................................................................................................................................................424
ipsec manual policy .......................................................................................................................................424
profile_call-progress-tone ..............................................................................................................................424
profile_tone-set .............................................................................................................................................425
12
Page 15
13
Model 4520 & 4110 Series Getting Started Guide
profile_voip ...................................................................................................................................................425
profile_dhcp-server .......................................................................................................................................425
context_ip .....................................................................................................................................................426
interface ........................................................................................................................................................426
subscriber_ppp ..............................................................................................................................................426
context_cs .....................................................................................................................................................427
interface_pstn ...............................................................................................................................................427
interface_h323 ..............................................................................................................................................428
interface_isoip ...............................................................................................................................................428
gateway_isoip ................................................................................................................................................429
gateway_h323 ...............................................................................................................................................429
port_ethernet ................................................................................................................................................429
pppoe ............................................................................................................................................................429
pppoe_session ...............................................................................................................................................429
port_serial .....................................................................................................................................................430
framerelay .....................................................................................................................................................430
pvc ................................................................................................................................................................430
port_virtual ...................................................................................................................................................430
port_pstn_all .................................................................................................................................................430
port_isdn ......................................................................................................................................................431
RedBoot Bootloader command set ......................................................................................................................431
Show help .....................................................................................................................................................431
Show command history ................................................................................................................................431
Show RedBoot version ..................................................................................................................................432
Restart system ...............................................................................................................................................432
Display memory content ...............................................................................................................................432
Set IP addresses .............................................................................................................................................432
Check network connection to remote system ................................................................................................433
Load a program to memory, so that it can be executed or stored in the Flash memory ..................................433
Execute a program loaded into memory ........................................................................................................434
Manage program images in Flash memory ....................................................................................................434
Display images stored in Flash memory ...................................................................................................434
Load an image into RAM so that it can be started ...................................................................................435
Re-initialize Flash image store .................................................................................................................435
Create a new image in the Flash image store ............................................................................................435
Delete an image from the Flash image store ............................................................................................436
RedBoot Configuration ................................................................................................................................436
Displaying current configuration .............................................................................................................436
Modify configuration ..............................................................................................................................437
Re-initialize configuration to default values .............................................................................................437
Read data from EEPROM ......................................................................................................................437
Enable/Disable cache ...............................................................................................................................437
Contents
C Internetworking terms & acronyms ........................................................................................................... 439
Page 16
Contents
Model 4520 & 4110 Series Getting Started Guide
Abbreviations.......................................................................................................................................................440
D Used IP ports & available voice codecs in SmartWare ............................................................................... 445
Used IP ports in SmartWare................................................................................................................................446
Available voice codecs in SmartWare ...................................................................................................................447
14
Page 17
About this guide
The objective of this SmartWare Command Configuration Guide is to provide information concerning the syntax and usage of the command set. The aim is to enable you to be able to consult a more detailed command
description than is given in the Software Configuration Guide . For hardware configuration information refer to
the getting started guide that came with your SmartNode systems .
This section describes the following:
• Who should use this guide (see “Audience”)
• How this document is organized (see “Structure”)
• Typographical conventions and terms used in this guide (see “Typographical conventions used in this docu-
ment” on page 18)
Audience
This guide is intended for the following users:
• System administrators who are responsible for installing and configuring networking equipment and who
are familiar with the SmartNode.
• System administrators with a basic networking background and experience, but who might not be familiar
with the SmartNode.
• Operators
• Installers
• Maintenance technicians
How to read this guide
SmartWare is a complex and multifaceted operating system running on your SmartNode device. Without the
necessary theoretical background you will not be able to understand and consequently use all the features available. Therefore we recommend reading at least the chapters listed below to get a general idea about SmartWare
and the philosophy of contexts used for IP and circuit switching related configuration.
• Appendix A, "Terms and definitions" on page 407 contains the terms and their definitions that are used
throughout this SmartWare Software Configuration Guide
• Chapter 1, "System overview" on page 21 provides an overview of the main elements of a SmartNode sys-
tem.
• Chapter 9, "IP context overview" on page 101
• Chapter 23, "CS context overview" on page 275
Structure
This guide contains the following chapters and appendices:
• Chapter 1, “System overview” on page 21 provides an overview of the main elements of a SmartNode system.
• Chapter 2, “Configuration concepts” on page 29 introduces basic SmartWare configuration concepts.
15
Page 18
About this guide
SmartWare Software Configuration Guide
• Chapter 3, “Command line interface (CLI)” on page 35 gives an overview of the CLI and the basic features
that allow you to navigate the CLI and edit commands effectively.
• Chapter 4, “Accessing the CLI” on page 43 describes the procedures for entering SmartWare commands via
the command line interface (CLI), to obtain help, to change operator mode and to terminate a session.
• Chapter 5, “Establishing basic IP connectivity” on page 53 explains how to establish network-based con-
nections to and from your SmartNode using IP interfaces and Ethernet ports.
• Chapter 6, “System image handling” on page 61 describes how to load and maintain system images and
driver software.
• Chapter 7, “Configuration file handling” on page 77 describes how to upload and download configuration
files from and to a SmartNode 1000, 2000, or 4000 Series devices.
• Chapter 8, “Basic system management” on page 91 describes parameters that report basic system informa-
tion to the operator or administrator, and their configuration.
• Chapter 9, “IP context overview” on page 101 outlines the SmartWare Internet protocol (IP) context ,
together with its related components.
• Chapter 10, “IP interface configuration” on page 109 provides a general overview of SmartNode interfaces
and describes the tasks involved in configuring them.
• Chapter 11, “NAT/NAPT configuration” on page 119 provides a general overview of Network Address
Port Translation and describes the tasks involved in configuring it.
• Chapter 12, “Ethernet port configuration” on page 127 provides an overview of Ethernet ports and
describes the tasks involved in configuring Ethernet ports through the Patton SmartWare.
• Chapter 13, “Link scheduler configuration” on page 137 describes how to use and configure the Smart-
Ware, Quality of Service (QoS) features.
• Chapter 14, “Serial port configuration” on page 159 provides an overview of the serial port and describes
the tasks involved in configuring the serial port through the Patton SmartWare.
• Chapter 15, “Basic IP routing configuration” on page 177 provides an overview of IP routing and describes
the tasks involved in configuring static IP routing in SmartWare.
• Chapter 16, “RIP configuration” on page 183 provides an overview of the Routing Information Protocol
(RIP) and describes the tasks involved in configuring RIP features within SmartWare.
• Chapter 17, “Access control list configuration” on page 193 provides an overview of IP Access Control Lists
and describes the tasks involved in configuring them through the Patton SmartWare.
• Chapter 18, “SNMP Configuration” on page 207 provides overview information about Simple Network
Management Protocol (SNMP) and describes the tasks used to configure those of its features supported by
the Patton SmartWare.
• Chapter 19, “SNTP client configuration” on page 223 describes how to configure Simple Network Time
Protocol (SNTP) client.
• Chapter 20, “DHCP configuration” on page 235 provides an overview of the Dynamic Host Configuration
Control Protocol (DHCP) and describes the tasks involved in configuring them.
16
Page 19
17
SmartWare Software Configuration Guide
About this guide
• Chapter 21, “PPP configuration” on page 245 describes how to configure the Point-to-Point Protocol over
different link layers.
• Chapter 22, "VPN configuration" on page 263 describes how to configure the Point-to-Point Protocol over
different link layers.
• Chapter 23, “CS context overview” on page 275 gives an overview of the SmartWare circuit-switching (CS)
context and its associated components and describes the tasks involved in its configuration.
• Chapter 24, “CS interface configuration” on page 295 provides an overview of interfaces in the CS context
and describes the tasks involved in configuring them.
• Chapter 25, “Session router configuration” on page 311 provides an overview of Session Router tables and
number manipulation functions and describes the tasks involved in configuring the Session Router in
SmartWare.
• Chapter 26, “Tone configuration” on page 331 gives an overview of SmartWare call-progress-tone profiles
and tone-set profiles and describes the tasks involved in their configuration.
• Chapter 27, “ISDN port configuration” on page 341 provides an overview of SmartNode ISDN ports and
describes the tasks involved in configuring ISDN ports in SmartWare.
• Chapter 28, “POTS port configuration” on page 353 provides an overview of SmartNode POTS ports and
describes the tasks involved in configuring POTS ports in SmartWare.
• Chapter 29, “Gateway configuration” on page 359 provides an overview of ISoIP and H.323 gateways and
describes the tasks involved in configuring them.
• Chapter 30, “VoIP profile configuration” on page 377 gives an overview of SmartWare VoIP profiles, how
they are used and describes the tasks involved in VoIP profile configuration.
• Chapter 31, “VoIP debugging” on page 395 helps you to localize a system component that is responsible for
faults during operation of a SmartNode device.
• Appendix A, “Terms and definitions” on page 407 contains the terms and their definitions that are used
throughout this SmartWare Software Configuration Guide .
• Appendix B, “Configuration mode overview” on page 415 illustrates the configuration modes hierarchy.
• Appendix C, “Internetworking terms & acronyms” on page 439 contains terms and definitions relating to
internetworking.
• Appendix D, “Used IP ports & available voice codecs in SmartWare” on page 445.
Page 20
About this guide
SmartWare Software Configuration Guide
Typographical conventions used in this document
This section describes the typographical conventions and terms used in this guide.
General conventions
In this guide we use certain typographical conventions to distinguish elements of commands and examples. In
general, the conventions we use conform to those found in IEEE POSIX publications. The procedures
described in this manual use the following text conventions:
Table 1. General conventions
Convention Meaning
Garamond blue type
Futura bold type Commands and keywords are in boldface font.
Futura bold-italic type
Italicized Futura type
Futura type Indicates the names of fields or windows.
Garamond bold type Indicates the names of command buttons that execute an action.
< > Angle brackets indicate function and keyboard keys, such as <SHIFT>,
[ ] Elements in square brackets are optional.
{a | b | c} Alternative but required keywords are grouped in braces ({ }) and are sepa-
blue screen Information you enter is in blue screen font.
screen Terminal sessions and information the system displays are in screen font.
node
SN The leading SN on a command line represents the nodename of the Smart-
# An hash sign at the beginning of a line indicates a comment line.
Indicates a cross-reference hyperlink that points to a figure, graphic, table, or
section heading. Clicking on the hyperlink jumps you to the reference. When
you have finished reviewing the reference, click on the Go to Previous
View button in the Adobe® Acrobat® Reader toolbar to return to your
starting point.
Parts of commands, which are related to elements already named by the
user, are in
Variables for which you supply values are in
<CTRL>, <C>, and so on.
rated by vertical bars ( | )
The leading IP address or nodename of a SmartNode is substituted with
node
Node
boldface italic
in
boldface italic
font.
font.
italic
font
18
Page 21
SmartWare Software Configuration Guide About this guide
Mouse conventions
The following conventions are used when describing mouse actions:
Table 2. Mouse conventions
Convention Meaning
Left mouse button This button refers to the primary or leftmost mouse button (unless you have
changed the default configuration).
Right mouse button This button refers the secondary or rightmost mouse button (unless you have
changed the default configuration).
Point This word means to move the mouse in such a way that the tip of the pointing
arrow on the screen ends up resting at the desired location.
Click Means to quickly press and release the left or right mouse button (as instructed in
the procedure). Make sure you do not move the mouse pointer while clicking a
mouse button.
Double-click Means to press and release the same mouse button two times quickly
Drag This word means to point the arrow and then hold down the left or right mouse but-
ton (as instructed in the procedure) as you move the mouse to a new location.
When you have moved the mouse pointer to the desired location, you can release
the mouse button.
Service
All warranty and non-warranty repairs must be returned freight prepaid and insured to Patton Electronics. All
returns must have a Return Materials Authorization number on the outside of the shipping container. This
number may be obtained from Patton Electronics Technical Services at:
• Tel: +1 (301) 975-1007
• Email: support@patton.com
• URL: http://www.patton.com
Note Packages received without an RMA number will not be accepted.
19
Page 22
About this guide SmartWare Software Configuration Guide
20
Page 23
Chapter 1 System overview
Chapter contents
Introduction..........................................................................................................................................................22
SmartNode hardware platforms.............................................................................................................................23
SmartWare embedded software .............................................................................................................................24
SmartView management center tools.....................................................................................................................25
Applications...........................................................................................................................................................25
Carrier networks .............................................................................................................................................26
Enterprise networks ........................................................................................................................................26
LAN telephony ...............................................................................................................................................28
21
Page 24
1 • System overview SmartWare Software Configuration Guide
Introduction
This chapter provides an overview of the main elements of a SmartNode system and includes the following sections:
• SmartNode hardware platforms (see page 23)
• SmartWare embedded software (see page 24)
• SmartView Management Center tools (see page 25)
A complete SmartNode system or network, as installed in any of the application scenarios introduced in section
“Applications” on page 25, is typically composed of three main elements plus a third-party network infrastruc-
ture:
• The first and most obvious element is the SmartNode devices (also referred to as hardware platforms or net-
work nodes) that provide the physical connectivity, the CPU and DSP resources. All SmartNode models
support packet-routed and circuit-switched traffic equally well.
• The second element comprises the embedded software—called SmartWare—running on the SmartNode
hardware platforms.
• The third element is the set of SmartView Management Center tools for configuring and controlling
SmartWare and SmartNodes in a network. Complementing the management interfaces provided in
SmartWare, the SmartView tools enable network administrators and operators to handle large numbers
of SmartNode devices.
• Finally, a third-party IP network and transmission infrastructure provides IP connectivity between the
above elements. This infrastructure can range from a simple Ethernet hub or switch to highly complex networks including multiple access technologies, backbone transmission, and services nodes.
22 Introduction
Page 25
SmartWare Software Configuration Guide 1 • System overview
Figure 1. System overview with a SmartView Management Center
SmartNode hardware platforms
The SmartNode series of devices covers a performance range varying from that suitable for small office/home
office (SOHO) applications to large corporate sites, or in terms of voice channels from 2 channels (one BRI/So
or 2 FXS) to 120 (two PRI/S2m). The SmartNodes comprise the following classes:
• The SmartNode 1000 series compact devices with fixed configured on-board BRI/So ports
• The SmartNode 2000 series with on-board ports plus expansion slots for individual interface configurations
using a range of optional interface cards (IC).
• The SmartNode 4000 series compact devices with fixed on-board analog ports
The basic system model of a Patton SmartNode is depicted in figure 2. All SmartNode devices have the following main components:
• 64k circuit switching between on-board ISDN ports and between ISDN and PSTN interface cards. The
circuit switching engine uses dedicated hardware resources and therefore can bypass the VoIP gateway and
packet routing engine.
• A gateway (GW) that converts telephone circuits into Internet protocol (IP) packet streams and vice versa.
H.323-compliant Voice over IP (VoIP) is supported via Patton’s patented ISDN over IP (ISoIP) protocol.
• An IP router with on-board ports and optional data interface cards is QoS enabled, thereby allowing classi-
fication, shaping, and scheduling of multiple service classes.
For more detailed hardware information, refer to the getting started guide that came with your SmartNode system.
SmartNode hardware platforms 23
Page 26
1 • System overview SmartWare Software Configuration Guide
Figure 2. SmartNode System Model
SmartWare embedded software
SmartWare is the application software that runs on the SmartNode hardware platforms. SmartWare is available
in several releases that support all available SmartNode models. Refer to the SmartWare release notes for
detailed information about hardware support.
For each SmartWare release there are platform-specific build numbers. There may be more than one build per
release and platform as updates become available. Refer to the SmartWare release notes for build numbers and
build-specific enhancements and limitations.
A SmartWare build is a binary image file. A SmartWare build is usually divided into several checksumprotected files to improve download efficiency and security. The download to the SmartNode is handled in
sequence using a download batchfile. Refer to chapter 6, “System image handling” on page 61 for details on
SmartWare image downloads.
In addition to the actual SmartWare images there are several additional embedded software components that
you will encounter:
• The boot loader is a “mini” application that performs basic system checks and starts the SmartWare applica-
tion. The boot loader also provides minimal network services, allowing the SmartNode to be accessed and
upgraded over the network even if the SmartWare application should not start. The boot loader is installed
in the factory and requires no upgrading.
• The PMC loader initializes PMC interface cards when mounted in SmartNode 2000 series devices. It checks
hardware versions and determines whether compatible PMC drivers are available. The PMC loader may be
upgraded together with a SmartWare release.
• PMC driver software performs the runtime tasks on PMC interface cards mounted in SmartNode 2000
series devices. The PMC drivers are interface card specific and also have build numbers. Refer to the Smart-
24 SmartWare embedded software
Page 27
SmartWare Software Configuration Guide 1 • System overview
Ware release notes for PMC driver software compatibility. The PMC drivers may be upgraded together with
a SmartWare release or they can be downloaded individually onto the device flash memory file system.
Figure 3. SmartNode Management System
SmartView management center tools
SmartWare provides two management interfaces:
• The Command Line Interface (CLI), which supports full online configuration and monitoring access for the
operator
• The SNMP agent and MIB, with an emphasis on inventory and alarm management for integration in a
third-party Network Management System (NMS)
With the aid of configuration files and TFTP up and downloads, the SmartNodes can also be managed offline
using standard text editors and file systems.
A number of host-based management applications are available to facilitate generating, editing, and maintaining configuration files. Tools are also available for integrating SmartNode management into standard network
management platforms such as HP OpenView.
Applications
The Patton SmartNode product family consists of highly flexible multi-service IP network devices, which fit a
range of networking applications. This section provides an overview of the following SmartNode applications
and the main elements in a SmartNode network.
• Carrier networks—SmartNodes are used as customer gateways or integrated access devices at the customer
premises. These applications are also called Integrated Service Access (ISA).
• Enterprise networks—SmartNodes are used as WAN routers and voice gateways for inter-site networking.
These applications are also called Multiservice Intranets (MSI).
SmartView management center tools 25
Page 28
1 • System overview SmartWare Software Configuration Guide
• LAN telephony—SmartNodes serve as gateways between the LAN and the local PBX or PSTN access.
These applications are also called LAN voice gateway (LVG).
Carrier networks
The network termination (NT) device in a multi-service IP based provider network plays a vital role. It provides the service access point for the subscriber with respect to physical connectivity and protocol interoperability.
Since the access bandwidth in most cases represents a network bottleneck, the NT must also ensure traffic classification and the enforcement of service level agreements (SLA) on the access link. In broadband access networks this NT is also called an Integrated Access Device (IAD) or customer gateway.
SmartNode products offer unique features as customer gateways for business services. It provides amongst others full ISDN feature support, local switching and breakout options and mass provisioning support.
Figure 4. Typical carrier network application with a SmartNode 2300
Figure 4 shows the deployment of SmartNodes in carrier networks. Each subscriber site is equipped with a
SmartNode that connects the subscriber CPE on one side with the provider network and services on the other.
Typical services in these networks are softswitch based telephony, PSTN access through V5.2 gateways, PBX
networking services, and LAN interconnection.
Typical access technologies for these networks include xDSL, WLL, PowerLine and conventional leased lines.
With the use on an external modem (M) the SmartNode can connect to leased lines or any bridged-Ethernet
broadband access.
Enterprise networks
In company owned and operated wide are networks SmartNodes can be used to converge voice and data communications on the same IP link.
In combination with centralized services such as groupware and unified messaging the SmartNodes provide
migration and investment protection for legacy telephony systems.
26 Applications
Page 29
SmartWare Software Configuration Guide 1 • System overview
Figure 5. Typical Enterprise network with a SmartNode 1400 and 2300
Figure 5 shows the deployment of SmartNodes in enterprise networks. Each site (headquarter, branch or home
office) is equipped with a SmartNode that connects the local LAN and telephony infrastructure with the IP
WAN and the local PSTN carrier.
Applications 27
Page 30
1 • System overview SmartWare Software Configuration Guide
Figure 6. Typical LAN telephony system with a SmartNode 1400 gateway
LAN telephony
With its Voice-over-IP gateway features the SmartNode can be used as a standalone gateway for H.323 LAN
voice systems such as LAN based PBXs or call centers (see figure 6).
A standalone gateway has performance reliability and scalability advantages compared with PC -based gateway
cards. In this application the SmartNode also offers a migration path to enterprise or carrier networking.
shows the deployment of a SmartNode as a LAN voice gateway.
The PSTN connections can be scaled from a single ISDN basic rate access to multiple primary rate lines. With
Q.SIG integration in private PBX networks is also supported.
28 Applications
Page 31
Chapter 2 Configuration concepts
Chapter contents
Introduction..........................................................................................................................................................30
Contexts and Gateways..........................................................................................................................................32
Context ...........................................................................................................................................................32
Gateway ..........................................................................................................................................................32
Interfaces, Ports, and Bindings...............................................................................................................................32
Interfaces ........................................................................................................................................................32
Ports and circuits ............................................................................................................................................33
Bindings ..........................................................................................................................................................33
Profiles and Use commands...................................................................................................................................34
Profiles ............................................................................................................................................................34
Use Commands ..............................................................................................................................................34
29
Page 32
2 • Configuration concepts SmartWare Software Configuration Guide
Introduction
This chapter introduces basic SmartWare configuration concepts. A good understanding of these concepts is
vital for the configuration tasks explained in the remaining chapters of this guide.
Even if you do not like to read manuals and user guides, nevertheless we strongly recommend that you read
through this chapter because it introduces the fundamental ideas behind the structure of the command line
interface. Once you understand and know this structure you will find it much more intuitive to navigate
through the CLI and configure specific features.
The chapter includes the following sections:
• Contexts and gateways (see page 32)
• Interfaces, ports, and bindings (see page 32)
• Profiles and Use commands (see page 34)
Patton SmartNodes are multi-service network devices that offer high flexibility for the inter-working of circuit
switched and packet routed networks and services. In order to consistently support a growing set of functions,
protocols and applications, SmartWare configuration is based on a number of abstract concepts that represent
the various SmartWare components.
30 Introduction
Page 33
SmartWare Software Configuration Guide 2 • Configuration concepts
The various elements of a complete SmartNode configuration are shown in figure 7. Each of these elements
implements one of the configuration concepts described in this chapter. The figure also shows the relationships
and associations between the different elements. The relations are specified through bind (arrow) and use (bullet-lines) commands. For example, you need bind commands to bind a physical port to a logical interface, and
use commands to assign profiles to contexts.
The chapter sections that follow refer to figure 7 on page 31 and describe the concepts and elements in
more detail
Introduction 31
Figure 7. Configuration concept overview
Page 34
2 • Configuration concepts SmartWare Software Configuration Guide
Contexts and Gateways
Context
A SmartWare context represents one specific networking technology or protocol, namely IP (Internet Protocol)
or CS (circuit-switching). A context can be seen as ”virtual dedicated equipment” within the SmartNode. For
example:
• A CS context contains the circuit-switching functions of the SmartNode. It can be thought of as an embed-
ded multiplexer or cross-connect within the SmartNode
• An IP context contains the routing functions of the SmartNode. It can be thought of as an embedded
router within the SmartNode
The contexts are identified by a name, and contain the configuration commands that are related to the technology
they represent. By means of the context concept a separate configuration can be built for newly supported network layer technologies without complicating the configuration methods of existing features. For example, as
bridging, ATM or FR switching become available so can a bridging, ATM, or FR context be introduced.
Each context contains a number of interfaces, which build the connections to other SmartWare elements and
the outside world. Two contexts are shown in figure 7 on page 31: one of type IP named “router”, and one of
type CS named “switch”. This corresponds to the default configuration of all SmartNodes.
Note SmartWare currently supports only one instance of the CS and IP context types.
Example
The IP context named “router” can contain static routes, RIP and NAT configuration parameters. The circuitswitching context named “switch” can contain number translations, local breakout conditions, and least-cost
routing parameters.
Gateway
For the communication between contexts of different types the concept of a gateway is introduced. A gateway
handles connections between different technologies or protocols. For example, an H.323-gateway can connect
an IP context to a circuit-switching context.
The gateways are each of a specific type and are identified by a name. Each named gateway contains its configuration parameters. With this concept, a separate gateway can be built for newly-supported technology such as
MGCP or SIP without complicating the configuration methods of existing software parts. figure 7 on page 31
shows two gateways, one of type h323 named “h323gw” and one of type ISoIP named “isoipgw”.
Example
An H.323 gateway named “h323-gw” has an H.323 gateway ID and an associated gatekeeper configuration. It
is connected to the interface “ip-trunk” on the circuit-switch context “switch” and the interface “global-wan”
on the IP context “router”.
Interfaces, Ports, and Bindings
Interfaces
The concept of an interface in SmartWare differs from that in traditional networking devices. Traditionally, the
term interface is often synonymous with port or circuit, which are physical entities. In SmartWare however, an
32 Contexts and Gateways
Page 35
SmartWare Software Configuration Guide 2 • Configuration concepts
interface is a logical construct that provides higher-layer protocol and service information, such as layer 3
addressing. Interfaces are configured as part of a context, and are independent of physical ports and circuits.
The decoupling of the interface from the physical layer entities enables many of the advanced features offered
by SmartWare.
In order for the higher-layer protocols to become active, you must associate an interface with a physical port or
circuit. This association is referred to as a binding in SmartWare. Refer to the “Bindings” section for more
information. In figure 7 on page 31, the IP context shows three interfaces and the CS context shows four interfaces. These interfaces are configured within their contexts. The bindings shown in the figure are not present
when the interfaces are configured; they are configured later.
Ports and circuits
Ports and circuits in SmartWare represent the physical connectors and channels on the SmartNode hardware.
The configuration of a port or circuit includes parameters for the physical and data link layer such as line
clocking, line code, framing and encapsulation formats or media access control. Before any higher-layer user
data can flow through a physical port or circuit, you must associate that port or circuit with an interface on a
context. This association is referred to as a binding. Refer to the “Bindings” section for an introduction to the
binding concept.
Examples of SmartNode ports are: 10Base-T Ethernet, Serial ISDN BRI, and ISDN PRI, analog FXS and
FXO. Ports are numbered according to the SmartNode port numbering scheme. The port name corresponds to
the label (or abbreviation) printed on the hardware.
Example: Ethernet 0/1, Serial 0/0, BRI 3/2
Some ports may contain multiple circuits. For example serial ports can contain one or more Frame Relay Permanent Virtual Circuits (PVC). If a port has one or more circuits configured, the individual circuits are bound
to interfaces on a context. The port itself may not be bound in that case.
Example: frame-relay pvc 112.
Eight ports are shown in figure 7 on page 31. Three ports are bound directly to an IP interface, one port has a
single circuit configured, which is bound to the IP context. Four ISDN ports are bound to CS interfaces.
Bindings
Bindings form the association between circuits or ports and the interfaces configured on a context. No user
data can flow on a circuit or Ethernet port until some higher-layer service is configured and associated with it.
In the case of IP interfaces, bindings are configured statically in the port or circuit configuration. The binding
is created bottom-up, that is from the port to the interface.
In the case of CS interfaces, bindings are configured in the interface configuration. The binding is created topdown, that is from the interface to the port. CS interfaces can bind one ore more ISDN or PSTN ports. If
more than one port is bound, the CS interface is responsible for performing channel hunting on all bound
ports. This creates a channel hunt group.
Bindings from ports to IP interfaces and from CS interfaces to ISDN ports are shown in figure 7 on page 31.
Interfaces, Ports, and Bindings 33
Page 36
2 • Configuration concepts SmartWare Software Configuration Guide
Profiles and Use commands
Profiles
Profiles provide configuration shortcuts. They contain specific settings which can be used in multiple contexts,
interfaces or gateways. This concept allows to avoid repetitions of groups of configuration commands that are
the same for multiple elements in a configuration.
Profiles used in the IP and CS contexts are shown in figure 7 on page 31.
Use Commands
Use commands form the association between profiles and contexts, gateways or interfaces. For example when a
profile is used in a context all the configuration settings in that profile become active within the context.
34 Profiles and Use commands
Page 37
Chapter 3 Command line interface (CLI)
Chapter contents
Introduction..........................................................................................................................................................36
Command modes ..................................................................................................................................................36
System Prompt ...............................................................................................................................................39
Navigating the CLI .........................................................................................................................................39
Initial Mode ..............................................................................................................................................39
System Changes ........................................................................................................................................39
Configuration ...........................................................................................................................................39
Changing Modes .......................................................................................................................................39
Command Editing.................................................................................................................................................40
Command Help ..............................................................................................................................................40
The No Form .................................................................................................................................................40
Command Completion ...................................................................................................................................40
Command History ..........................................................................................................................................40
Command Editing Shortcuts ..........................................................................................................................40
35
Page 38
3 • Command line interface (CLI) SmartWare Software Configuration Guide
Introduction
The primary user interface to SmartWare is the command line interface (CLI). You can access the CLI either
via the SmartNode console port or through a Telnet session. The CLI lets you configure the complete SmartWare functionality, in contrast to other management interfaces (SNMP, HTTP), which are limited to a subset
of the functions. CLI commands can be entered on-line or as a configuration script in the form of a text file.
The CLI also includes monitoring and debugging commands. CLI commands are simple strings of keywords
and user-specified arguments.
This chapter gives an overview of the CLI and the basic features that allow you to navigate the CLI and edit
commands effectively. The following topics are covered:
• Command Modes
• Command Editing (see page 40)
Command modes
The CLI is composed of modes. There are two mode groups, the exec mode group and the configuration mode
group. Within the exec mode group there are two modes: operator exec and administrator exec. The configuration mode group contains all of the remaining modes. A command mode is an environment within which a
group of related commands is valid. All commands are mode-specific, and certain commands are valid in more
than one mode. A command mode provides command line completion and context help within the mode. The
command modes are organized hierarchically.
The operator’s current working mode is indicated by the CLI prompt. An overview of all command modes is
given in figure 8 on page 37 and table 3 on page 38.
Appendix B, “Configuration mode overview” on page 415 contains a detailed overview of all command modes
and the CLI commands that are valid in each mode.
36 Introduction
Page 39
SmartWare Software Configuration Guide 3 • Command line interface (CLI)
Command modes 37
Figure 8. Command line modes
Page 40
3 • Command line interface (CLI) SmartWare Software Configuration Guide
Table 3. Command mode entry and prompts
Mode name Commands used to access Command-line prompt
operator exec (user log-on)
administrator exec enable command from operator exec mode
configure configure command from administrator exec mode
system system command from configure mode
ic-voice ic voice <slot> command from system mode
context_ip context ip [router] command from configure mode
interface interface <name> command from context_ip mode
context_cs context cs [switch] command from configure mode
interface_pstn interface pstn <name> command from context cs
node
>
node
#
node
(config)#
node
(sys)#
node
(ic-voice) [<slot>]#
node
(ctx-ip) [router]#
node
(if-ip) [<name>]#
node
(ctx-cs) [switch]#
node
(if-pstn) [<name>]#
config mode
interface_isoip interface isoip <name> command from context cs
node
(if_isoip) [<name>]#
config mode
interface_h323 interface h323 <name> command from context
node
(if-h323) [<name>]#
cs config mode
gateway_isoip gateway isoip [isoip] command from configure
node
(gw-isoip) [isoip]#
mode
gateway_h323 gateway h323 [h323] command from configure
node
(gw-h323) [h323]#
mode
port_ethernet port ethernet <slot> <port> command from con-
node
(prt-eth) [slot/port]#
figure mode
port_serial port serial <slot> <port> command from config-
node
(prt-ser) [slot/port]#
ure mode
framerelay framerelay command from port_serial mode
pvc pvc <dlci> command from framerelay mode
port_isdn port isdn command from configure mode
profile_acl profile acl <name>command from configure mode
profile_napt profile napt <name> command from configure
node
(frm-rel) [<name>]#
node
(pvc) [<name>]#
node
(prt-isdn) [<name>]#
node
(pf-acl) [<name>]#
node
(pf-napt) [<name>]#
mode
profile_service-policy profile policy-map <name> command from con-
node
(pf-srvpl) [<name>]#
figure mode
source source {class_policy} <name> command from
node
(src) [<name>]#
profile_service-policy mode
profile_voip profile voip <name> command from configure
node
(pf-voip) [<name>]#
mode
profile_tone-set profile tone-set <name> command from config-
node
(pf-tones) [<name>]#
ure mode
profile_call-progress-tone profile call-progress-tone command from config-
node
(pf-callp) [<name>]#
ure mode
38 Command modes
Page 41
SmartWare Software Configuration Guide 3 • Command line interface (CLI)
System Prompt
For interactive (on-line) sessions the system prompt is of the form:
nodename>
In the operator exec mode:
nodename#
In the administrator exec mode and in the different configuration modes:
nodename(mode)#
Where:
• nodename is the currently configured name of the node (SmartNode), the IP address or the hardware type of
the device that is being configured
• mode is a string indicating the current configuration mode, if applicable.
Example: the prompt in configuration mode, assuming the nodename SN is:
SN(config)#
The CLI commands used to enter each mode and the system prompt that is displayed when you are working
within each mode is shown in Table 3 on page 38.
Navigating the CLI
Initial Mode
When you initiate a session you may login with either operator or administrator privileges. Whichever login
you use, on starting the CLI is always set to the operator exec (non-privileged exec) mode by default. This
mode allows you to examine the state of the system using a subset of the available CLI commands.
System Changes
In order to make any changes to the system, the administrator exec (privileged exec) mode must be entered.
The enable user interface command is used for this purpose. Once in administrator exec mode, all of the system commands are available to you. The enable command is only accessible if you are logged in as an administrator.
Configuration
To make configuration changes the configuration mode must be entered by using the configure command in
the administrator exec mode. From here the other configuration modes are accessible as diagrammed in the
overview in figure 8 on page 37.
Changing Modes
Within any configuration mode, the exit command brings the user up one level in the mode hierarchy. For
example, when in pvc configuration mode, typing exit will take you to framerelay configuration mode.
The exit command terminates a CLI session when typed from the operator exec mode.
A session can also be terminated using the logout command within any mode.
Command modes 39
Page 42
3 • Command line interface (CLI) SmartWare Software Configuration Guide
Command Editing
Command Help
To see a list of all CLI commands available within a mode, type a question mark “?” at the system prompt in
the mode of interest. A list of all available commands is displayed. Commands that have become available in
the current mode are displayed at the bottom of the list, separated by a line. Commands from higher hierarchy
levels are listed at the top.
You can also type the question mark while in the middle of entering a command. Doing so displays the list of
allowed choices for the current keyword in the command. Liberal use of the question mark functionality is an
easy and effective way to explore the command syntax.
The No Form
Almost every command supports the keyword no. Typing the no keyword in front of a command disables the
function or “deletes” a command from the configuration. For example, to enable the Session Router trace tool,
enter the command debug session-router. To subsequently disable the Session Router trace, enter the command no debug session-router.
Command Completion
You can use the <tab> key in any mode to carry out command completion. Partially typing a command name
and pressing the <tab> key causes the command to be displayed in full up to the point where a further choice
has to be made. For example, rather than typing configure, typing conf and pressing the <tab> key causes the
CLI to complete the command at the prompt. If the number of characters is not sufficient to uniquely identify
the command, the CLI will provide a list with all commands starting with the typed characters. For example if
you entered the string co in the configure mode and press <tab>, the selections configure, copy, and context are
displayed.
Command History
SmartWare maintains a list of previously entered commands that you can through by pressing the <up-arrow>
and <down-arrow> keys, and then pressing <enter> to enter the command.
The show history command displays a list of the commands you can through using the arrow keys.
Command Editing Shortcuts
The SmartWare CLI provides a number of Emacs-style command shortcuts that facilitate editing of the command line. Command editing shortcuts are summarized in table 4 on page 41. The syntax Ctrl-p means press
the p key while holding down the keyboard’s “Control” key (sometimes labeled Ctl or Ctrl, depending on the
keyboard and operating system of your computer).
40 Command Editing
Page 43
SmartWare Software Configuration Guide 3 • Command line interface (CLI)
Esc f is handled differently; press and release the “Escape” key (often labeled Esc on many keyboards) and then
press the f key.
Table 4. Command edit shortcuts
Keyboard Description
Ctrl-p and <up-arrow> Recall previous command in the command history.
Ctrl-n and <down-arrow> Recall next command in the command history.
Ctrl-f and <right-arrow> Move cursor forward one character.
Ctrl-b and <left-arrow> Move cursor backward one character.
Esc f Move cursor forward one word.
Esc b Move cursor backward one word.
Ctrl-a Move cursor to beginning of line.
Ctrl-e Move cursor to end of line.
Ctrl-k Delete to end of line.
Ctrl-u Delete to beginning of line.
Ctrl-d Delete character.
Esc d Delete word.
Ctrl-c Quit editing the current line.
Ctrl-l Refresh (redraw) the display.
Ctrl-t Transpose characters.
Command Editing 41
Page 44
3 • Command line interface (CLI) SmartWare Software Configuration Guide
42 Command Editing
Page 45
Chapter 4 Accessing the CLI
Chapter contents
Introduction..........................................................................................................................................................44
Accessing the SmartWare CLI task list...................................................................................................................44
Accessing via the console port .........................................................................................................................45
Console port procedure .............................................................................................................................45
Accessing via a Telnet session ..........................................................................................................................46
Telnet Procedure .......................................................................................................................................47
Log onto SmartWare .......................................................................................................................................47
Selecting a secure password .............................................................................................................................48
Configure operators and administrators ..........................................................................................................48
Factory preset administrator account .........................................................................................................48
Creating an operator account ....................................................................................................................48
Creating an administrator account ............................................................................................................49
Displaying the CLI version .............................................................................................................................50
Displaying account information ......................................................................................................................50
Switching to another account ..........................................................................................................................50
Checking identity and connected users ...........................................................................................................51
Ending a Telnet or console port session ..........................................................................................................52
43
Page 46
4 • Accessing the CLI SmartWare Software Configuration Guide
Introduction
SmartNode products are engineered for remote management and volume deployment. SmartNode management and configuration is therefore based on IP network connectivity. Once a SmartNode is connected to, and
addressable in, an IP network then all configuration, management and maintenance tasks can be performed
remotely.
This chapter describes the procedures for entering SmartWare commands via the command line interface (CLI),
to obtain help, to change operator mode and to terminate a session. You can access a SmartNode as follows:
• Directly, via the console port (using a terminal directly connected to a SmartNode)
• Remotely, via the IP network (using a Telnet application)
The ports available for connection and their labels are shown for each SmartNode model in the getting started
guide that came with your SmartNode system.
Remember that the CLI supports a command history and command completion. By scrolling with the Up and
Down arrow keys, you can find many of your previously entered commands. Another timesaving tool is command completion. If you type part of a command and then press the <tab> key, the SmartWare shell will
present you with either the remaining portion of the command or a list of possible commands. These features
are described in chapter 3, “Command line interface (CLI)” on page 35.
Although SmartWare supports concurrent sessions via Telnet or
the console port, we do not recommend working with more than
one session to configure a specific SmartNode.
Accessing the SmartWare CLI task list
The basic tasks involved in accessing the SmartWare command line interface are described in the following sections. Depending on your application scenario, some tasks are mandatory while others could be optional.
• Accessing via the console port (see page 45)
• Accessing via a telnet session (see page 46)
• Log on to SmartWare (see page 47)
• Selecting a secure password (see page 48)
• Configure operators and administrators (see page 48)
• Displaying the CLI version (see page 50)
• Display account information (see page 50)
• Switching to another log-in account (see page 50)
• Checking identity and connected users (see page 51)
• Ending a Telnet or console port session (see page 52)
44 Introduction
Page 47
SmartWare Software Configuration Guide 4 • Accessing the CLI
Accessing via the console port
To access a SmartNode via its console port the host computer must be connected directly to the console port
(labeled CONSOLE) with a serial cable (see figure 9). On the host, a terminal emulation application that supports serial interface communication must be used.
Figure 9. Setup for initial configuration via the console port
Note IP settings do not need to be configured if you access the SmartNode via the
console port.
Console port procedure
Before using the CLI to enter configuration commands, do the following:
1. Set up the hardware as described in the getting started guide that came with your SmartNode system.
2. Configure your serial terminal for 9600 baud, 8 data bits, no parity, 1 start bit, 1 stop bit, and no flow control.
3. Connect the serial terminal to your SmartNode. Use a serial cable according to Appendix A of the getting
started guide included with your SmartNode device.
4. Power on your SmartNode. A series of boot messages are displayed on the terminal screen. At the end of
the boot sequence press the “Return” key and the login screen will be displayed.
5. Proceed with logging in.
Accessing the SmartWare CLI task list 45
Page 48
4 • Accessing the CLI SmartWare Software Configuration Guide
Accessing via a Telnet session
This is the most commonly used method for connecting to a SmartNode. The Telnet host accesses the SmartNode via its network interface. A host can be connected directly to the ETH 1 port (LAN) with a crossover
cable (see figure 10, part A) or through an Ethernet hub with two straight cables (see figure 10, part B).
Figure 10. Setup for initial configuration via an Ethernet port
Note If the IP configuration of the Ethernet port (LAN port) is not known or is
incorrectly configured, you will have to use the console interface.
The host must have a valid IP address configured in the same subnet as the SmartNode. The default IP address
and network mask of the Ethernet ports of the SmartNode are shown in table 5.
Table 5. Default IP address configuration
Port IP Address Network Mask
ETH 0 172.16.40.1
(formerly 10.0.0.10)
ETH 1 192.168.1.1
(formerly 10.0.0.10)
Note The default IP addresses listed in table 5 apply to an operating scenario com-
255.255.0.0/16
255.255.0.0/24
(formerly 244.255.0.0/16)
patible with the factory configured settings of the SmartNode. If your operating
requirements are significantly different, your SmartNode may have different
default IP addresses. Check the SmartWare release note for more details.
46 Accessing the SmartWare CLI task list
Page 49
SmartWare Software Configuration Guide 4 • Accessing the CLI
Telnet Procedure
Before you begin to use the CLI to input configuration commands, do the following:
1. Set up the SmartNode as described in the getting started guide included with your SmartNode device.
2. Connect the host (PC) or hub to the ETH 1 (LAN) port of your SmartNode with crossover or straight-
thru cables, according to Appendix A of the getting started guide included with your SmartNode device.
3. Power on your SmartNode and wait until the ”Run” LED lights.
4. Be sure that the IP address and subnet mask of your host are in the same address range as the ETH 1
(LAN) port of your SmartNode.
5. Open a Telnet session to the ETH 1 (LAN) port with the IP address 10.1.0.10 of your SmartNode.
6. Proceed with logging in.
Log onto SmartWare
Accessing your SmartNode via the local console port or via a Telnet session will open a login screen. The following description of the login process is based on a Telnet session scenario but is identical to that used when
accessing via the local console port.
The opening Telnet screen you see will resemble that shown in figure 11. The window header bar shows the IP
address of the target SmartNode.
A factory preset administrator account with name administrator and an empty password is programmed into
the SmartWare at the factory. For that reason use the name administrator after the login prompt and simply
press the “Enter” key after the password prompt.
Figure 11. Login display
Upon logging in you are in operator execution mode, indicated by the “>” as command line prompt. Now you
can enter system commands.
Note Details on screen in figure 11, such as the IP address in the system prompt
and window header bar, may be different on your SmartNode device.
Accessing the SmartWare CLI task list 47
Page 50
4 • Accessing the CLI SmartWare Software Configuration Guide
You are responsible for creating a new administrator account to
maintain system security. Patton Electronics accepts no responsibility for losses or damage caused by loss or misuse of passwords. Please read the following sections to secure your network
equipment properly.
Selecting a secure password
It is not uncommon for someone to try to break into (often referred to as hacking) a network device. The network administrator should do everything possible to make the network secure. Carefully read the questions
below and see if any apply to you:
• Do your passwords consist of a pet’s name, birthdays or names of friends or family members, your license
plate number, social security number, favorite number, color, flower, animal, and so on?
• Do you use the same password repeatedly? (Example: Your ATM PIN, cell phone voice mail, house alarm
setting code, etc.)
• Could your password or a portion thereof be found in the dictionary?
• Is your password less than six characters long?
To prevent unauthorized access you should select passwords that are not dictionary words or any of the abovementioned examples. Every password should be at least 6 characters long and include at least one capital letter,
one number, and one lowercase letter.
A good example of a password is: 3Bmshtr
Right now you are probably asking yourself, “How am I going to remember that?” It’s easy, the password above
is an acronym taken from: “3 blind mice see how they run.” Making a good password is that easy! But please,
don’t use the above example password for your smartnode device.
Configure operators and administrators
To secure the system, as well as to enable remote access to the system, you must create operator and administrator login accounts. These accounts are valid system-wide. Operators and administrators can log in to the
SmartWare via the console or through Telnet.
Note Only administrators are allowed to create new administrator and operator
accounts.
Factory preset administrator account
At the beginning of setup, a factory preset administrator account with name administrator and an empty password exists in SmartWare. After adding a new administrator account, the factory preset administrator account
will be automatically deleted and only the newly created administrator account is available. More than one
administrator account can be created, but there has to be at least one administrator account defined. If for
some reason the last administrator account is deleted, the factory preset administrator account with name
administrator and an empty password will automatically be recreated by SmartWare.
Creating an operator account
Operators do not have privileges to run the enable command and therefore cannot modify the system configuration. Operators are able to view partial system information.
48 Accessing the SmartWare CLI task list
Page 51
SmartWare Software Configuration Guide 4 • Accessing the CLI
Creating a new operator account is described in the following procedure:
Mode: Operator execution
Step Command Purpose
1
node>
2
node#
3
node(cfg)#
4 copy running-config startup-config The change made to the running configura-
enable Enters administration execution mode
configure Enters configuration mode
operator
name
password
password
Creates new operator account
password
tion of the SmartNode is saved, so that it will
be used following a reload
password
name
and
Example: Create an operator account
The following example shows the commands used to add a new operator account with a login name “support”
and a matching password of “s4DF&qw”. The changed configuration is then saved.
SN>enable
SN#configure
SN(cfg)#operator support password s4DF&qw
SN(cfg)#copy running-config startup-config
Creating an administrator account
Administrators can run the enable command and access additional information within the SmartWare configuration modes. Therefore administrators can modify the system configuration, as well as view all relevant system information.
Creating a new administrator account is decribed in the following procedure:
Mode: Operator execution
Step Command Purpose
1
node
>enable Enters administration execution mode
2
node#
3
node(cfg)#
4
node(cfg)#
configure Enters configuration mode
administrator
copy running-config startup-config Permanently stores the new administrator
name
password
password
Creates new administrator account
name
and password
account parameters.
password
Example: Create an administrator account
The following example shows the commands used to add a new administrator account with a login name
“super” and a matching password of “Gh3*Ke4h”.
SN>enable
SN#configure
SN(cfg)#administrator super password Gh3*Ke4h
SN(cfg)#copy running-config startup-config
Accessing the SmartWare CLI task list 49
Page 52
4 • Accessing the CLI SmartWare Software Configuration Guide
Displaying the CLI version
This procedure displays the version of the currently running SmartWare CLI.
Mode: Operator execution
Step Command Purpose
1
node>
show version cli Displays CLI version
Example: Displaying the CLI version
The following example shows how to display the version of the current running SmartWare CLI on your
device, if you start from the operator execution mode.
SN>show version cli
CLI version : 2.00
Displaying account information
The show command in SmartWare can be used to display information about existing administrator and operator accounts. This command is not available for an operator account.
Displaying account information is described in the following procedure:
Mode: Administrator execution
Step Command Purpose
1
node#
show accounts Displays the currently-configured administrator and operator
accounts
Example: Display account information
The following example shows how to display information about existing administrator and operator accounts.
SN#show accounts
administrator accounts:
super
operator accounts:
support
Switching to another account
To switch from one user account to working in another the su command is used. With this command a user
can change from his current account to another existing account ‘name’. After executing su with the account
name to which the user wants to change as argument, the password of the particular account has to be entered
to get privileged access.
Mode: Administrator or operator execution
Step Command Purpose
1
node>
su account-name Change to the user user account account-name
50 Accessing the SmartWare CLI task list
Page 53
SmartWare Software Configuration Guide 4 • Accessing the CLI
Example: Switching to Another Account
The following example shows how to change from your current user account to an administrator account,
starting from operator execution mode. In the example below the who command is used to check the identity
within both accounts
login: support
password: <password>
SN>who
You are operator support
SN>su super
Enter password: <password>
SN>who
You are administrator super
Checking identity and connected users
To display who is logged in or to see more detailed information about users and process states the who command provides this information. Depending on execution mode the command displays varying information.
In administrator execution mode the command output is more detailed and shows information about the ID,
user name, state, idle time and location. In operator execution mode only the user name being used at the
moment is reported, which helps checking the identity.
Mode: Administrator or operator execution
Step Command Purpose
1
node#
who Shows more detailed information about the users ID, name, state, idle time and
location
or
node>
who Shows the user login identity
Example: Checking identity and connected users
The following example shows how to report who is logged in or more detailed information about users and
process states, depending on the execution mode working in.
Used in administrator execution mode:
SN#who
ID User name State Idle Location
* 0 administrator exec 00:00:00 172.16.224.44:1160
1 support exec 00:01:56 172.16.224.44:1165
Note The “*” character identifies the identity of the user executing the who com-
mand. ID represents the ID of the account. State represents the actual running condition of the user, which can be logout, login, exec and config.
Used in operator execution mode:
SN>who
You are operator support
Accessing the SmartWare CLI task list 51
Page 54
4 • Accessing the CLI SmartWare Software Configuration Guide
Ending a Telnet or console port session
To end a Telnet or console port session you use the logout command in the operator or administration execution
mode. To confirm the logout command you have to enter “yes” on the dialog line as show in the example below.
Mode: Operator execution
Step Command Purpose
1
node>
logout Terminates session after a confirmation by user.
Example: End a Telnet or console port session
The following example shows how to terminate a session from the administrator execution configuration
mode.
SN>logout
Press ’yes’ to logout, ’no’ to cancel :
After confirming the dialog with “yes” the Telnet session to the SmartNode is terminated and the Telnet application window on your host closes.
Note Using the command exit in the operator execution mode also terminates a
Telnet or console port session, but without any confirmation dialog.
52 Accessing the SmartWare CLI task list
Page 55
Chapter 5 Establishing basic IP connectivity
Chapter contents
Introduction..........................................................................................................................................................54
IP context selection and basic interface configuration tasks....................................................................................54
Entering the IP context, creating IP interfaces and assigning an IP address .....................................................54
Defining IP Ethernet encapsulation and binding an IP interface to a physical port .........................................55
Activating a physical port ................................................................................................................................55
Displaying IP interface information ................................................................................................................56
Deleting IP interfaces ......................................................................................................................................57
Examples ...............................................................................................................................................................58
Setting up an IP interface on an Ethernet port ................................................................................................58
53
Page 56
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
Introduction
This chapter explains how to establish network-based connections to and from your SmartNode using IP interfaces and Ethernet ports. Configuring basic IP connectivity is carried out in both the context IP and the subsidiary interface command modes. For a complete description of the IP context and interface configuration related
commands referred to in this chapter, see chapter 9, “IP context overview” on page 101, and chapter 10, “IP
interface configuration” on page 109.
The chapter includes the following sections:
• IP context selection and basic interface configuration tasks
• Examples (see page 58)
The predefined IP context in SmartWare contains the functionality of a classic IP router. Within the IP context
packets are routed between IP interfaces in accordance with the routing table. The following sections guide you
through all the steps necessary to establish network-based IP connectivity to and from your smartnode.
IP context selection and basic interface configuration tasks
The basic tasks involved in configuring an IP context, the related interfaces and ports are:
• Entering the IP context, creating IP interfaces and assigning an IP address
• Defining IP Ethernet encapsulation and binding an IP interface to a physical port (see page 55)
• Activating the physical port (see page 55)
• Displaying IP interface information (see page 56)
• Deleting IP interfaces (see page 57)
After you have entered the IP context and performed the basic configuration tasks, configuration of additional
protocols and services such as RIP, ICMP and NAPT is possible for your IP context.
Entering the IP context, creating IP interfaces and assigning an IP address
The SmartWare application software running on your SmartNode has a predefined IP context, which has to be
selected for the configuration procedure. An IP interface name can be any arbitrary string of not more than 25
characters. Use self-explanatory names for your IP interfaces which reflect their usage. Each IP interface needs
its explicit IP address and an appropriate net mask to be set.
Mode: Configure
Step Command Purpose
1
node
(cfg)#context ip router Enters the predefined IP context configuration
mode.
2
node
(ctx-ip)[router]#interface
3
node
(if-ip)[
name
]#ipaddress
name
ip-address netmask
Creates the new interface
sents an IP interface. This command also
places you in interface configuration mode
for the interface
Sets the IP address
netmask for interface
name
ip-address
name
, which repre-
you have just created.
and
netmask
name
54 Introduction
Page 57
SmartWare Software Configuration Guide 5 • Establishing basic IP connectivity
Example: Enter IP context, create IP interfaces and set IP address and netmask
The procedure below assumes that you want to create an IP interface named lan, with an IP address of
192.168.1.3 and a net mask of 255.255.255.0. Use the following commands in configuration mode to select
the IP context and create the IP interface.
SN(cfg)#context ip router
SN(ctx-ip)[router]#interface lan
SN(if-ip)[lan]#ipaddress 192.168.1.3 255.255.255.0
Defining IP Ethernet encapsulation and binding an IP interface to a physical port
Before an IP interface is accessible the IP Ethernet encapsulation has to be defined for the related port. It is
assumed that you would like to define IP Ethernet encapsulation for port port on slot slot. Before an IP interface can be used, it needs to be bound to a physical port of your SmartNode. The SmartNode has one or more
expansion slots that can have one or more ports. Specifying a port unambiguously means that you must define
the slot in which it is located. We assume you would like to bind the IP interface name to port port of slot slot.
Mode: Configure
Step Command Purpose
1
node
2
3
(cfg)#port ethernet
node
(prt-eth)[
node
(prt-eth)[
slot/port
slot/port
slot port
]#encapsulation ip Sets IP Ethernet encapsulation for port
]#bind interface
name
router Binds interface name to port port on
Enters port configuration mode and
selects the Ethernet port port on slot
slot, on which IP Ethernet encapsulation shall be used and to which an IP
interface shall be bound.
port on slot slot
slot slot to the IP context named router,
which is the IP router context
Example: Define IP Ethernet encapsulation and bind IP interface to physical port
We assume you would like to set IP encapsulation for Ethernet port 0 on slot 0 and bind the already defined IP
interface lan to the same physical port. Use the following commands in port Ethernet mode.
SN(ctx-ip)[router]#port ethernet 0 0
SN(prt-eth)[0/0]#encapsulation ip
SN(prt-eth)[0/0]#bind interface lan router
Activating a physical port
After all the settings for the IP interface are completed the physical port has to be activated. The SmartWare
default status for any port is disabled. In the SmartWare terminology any port is in the shutdown state unless it
is activated by command.
IP context selection and basic interface configuration tasks 55
Page 58
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
Using the command show port ethernet slot port lists the actual status for the selected physical port. The following listing shows the port Ethernet information for port 0 on slot 0, which is in the shutdown state as indicated by CLOSED for the current state.
SN(prt-eth)[0/1]#show port ethernet 0 0
Ethernet Configuration
-------------------------------------
Port : ethernet 0 0 0
State : CLOSED
MAC Address : 00:30:2B:00:1D:D4
Speed : 10Mbps
Duplex : Half
Encapsulation : ip
Binding : wan@router
Frame Format : standard
Default Service: 0
To activate a port for operation the shutdown status of the port has to be removed. That means, the state of the
port has to be changed to OPENED. To activate a physical port use the no shutdown command in port configuration mode.
Step Command Purpose
1
node
(ctx-ip)[router]#port ethernet
slot port
Enters port configuration mode and selects the
Ethernet port
port
on slot
slot
, which is to be acti-
vated
2
node
(prt-eth)[
slot/port
]#no shutdown Activates the physical port
port
on slot
slot
for
operation
Example: Activating the physical port
We assume you would like to activate the physical port 0 on slot 0, for which you use the following commands
in port configuration mode.
SN(cfg)#port ethernet 0 0
SN(prt-eth)[0/0]#no shutdown
At this point your SmartNode has a running IP interface on Ethernet port 0 on slot 0, which uses IP encapsulation.
Displaying IP interface information
Information for all the configured IP interfaces can be displayed by the show command. The command lists
relevant information for every IP interface. The IP interfaces are identified by the name.
Mode: Configure
Step Command Purpose
1
node
(cfg)#show ip interface Displays IP interface information
56 IP context selection and basic interface configuration tasks
Page 59
SmartWare Software Configuration Guide 5 • Establishing basic IP connectivity
Example: List existing IP interfaces
Displaying IP interface information using the show ip interface command in configuration mode. In the fol-
lowing example only the information available for IP interface lan is displayed. Depending on the number of
defined IP interfaces the output of the show ip interface command can be longer.
SN(ctx-ip)[router]#show ip interface
-----------------------------------------------------------Context: router
Name: lan
IP Address: 192.168.1.3 255.255.255.0
P2P: point-to-point
MTU: 1500
ICMP router-discovery: enabled
ICMP redirect: send only
State: OPENED
Binding: ethernet 0 0 0/ethernet/ip
An easy way to list existing interfaces is by using the interface command followed by a “?” in the IP context
configuration mode, which creates a list of all the defined IP interfaces.
SN(cfg)#context ip router
SN(ctx-ip)[router]#interface <?>
<interface> New interface
external Existing interface
internal Existing interface
lan Existing interface
wan Existing interface
Deleting IP interfaces
Deleting an existing interface in the IP context is often necessary. The procedure illustrated below assumes that
you would like to delete the IP interface name. Use the no argument to the interface command as in the following demonstration in IP context configuration mode.
Mode: Context IP
Step Command Purpose
1
node
(ctx-ip)[router]#no interface
name
Deletes the existing IP interfaces
name
Example: Delete IP interfaces
The illustrated procedure below assumes that you would like to delete the IP interface named external. Use the
following commands in IP context mode.
IP context selection and basic interface configuration tasks 57
Page 60
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
First list the existing interfaces:
SN(ctx-ip)[router]#interface <?>
<interface> New interface
external Existing interface
internal Existing interface
lan Existing interface
wan Existing interface
Now delete the interfaces named “external” with the no interface command with the interface name as argument:
SN(ctx-ip)[router]#no interface external
Finally list the interfaces again to check if the IP interface external has been deleted:
SN(ctx-ip)[router]#interface <?>
<interface> New interface
internal Existing interface
lan Existing interface
wan Existing interface
Examples
Setting up an IP interface on an Ethernet port
The following example shows all required configuration steps, which end in an activated IP interface on Ethernet port 0 on slot 0. The relation between the IP interface lan and the Ethernet port 0 on slot 0 is shown in
figure 12. The configuration procedure below starts in the operator execution mode:
Figure 12. Relation between IP Interface
lan
and Ethernet port 0 on slot 0
58 Examples
Page 61
SmartWare Software Configuration Guide 5 • Establishing basic IP connectivity
First the context IP mode is selected for the required IP interface configuration.
SN>enable
SN#configure
SN(cfg)#context ip router
After that a new interface lan is created, for which both the IP address and net mask are specified.
SN(ctx-ip)[router]#interface lan
SN(if-ip)[lan]#ipaddress 192.168.1.3 255.255.255.0
Next the Ethernet port 0 on slot 0 is selected, the medium is set to 10 Mbps in half-duplex mode, and IP
encapsulation for this port is chosen.
SN(if-ip)[lan]#port ethernet 0 0
SN(prt-eth)[0/0]#medium 10 half
SN(prt-eth)[0/0]#encapsulation ip
Afterwards the just defined interface lan is bound to the Ethernet port, and then the port is activated.
SN(prt-eth)[0/0]#bind interface lan router
SN(prt-eth)[0/0]#no shutdown
As a final point the configuration settings are stored in the startup configuration so as to be available after the
next system reboot.
SN(prt-eth)[0/0]#copy running-config startup-config
Examples 59
Page 62
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
60 Examples
Page 63
Chapter 6 System image handling
Chapter contents
Introduction..........................................................................................................................................................62
Memory regions in SmartWare..............................................................................................................................62
Boot procedure......................................................................................................................................................64
Bootloader (for SmartNode 1000 and 2000 Series) ...............................................................................................65
Start Bootloader and login ..............................................................................................................................65
Main shell and domains ..................................................................................................................................65
Route Table Manager (RTM) .........................................................................................................................66
Download Agent .............................................................................................................................................67
Diagnostic .......................................................................................................................................................68
Bootloader (for SmartNode 4110/4520 Series)......................................................................................................69
Start Bootloader ..............................................................................................................................................69
Start-up with factory configuration .................................................................................................................70
Load a new application image (SmartWare) via TFTP...........................................................................................70
Load a new application image (SmartWare) via serial link .....................................................................................72
Factory configuration ............................................................................................................................................72
System image handling task list .............................................................................................................................73
Displaying system image information ..............................................................................................................73
Copying system images from a network server to Flash memory .....................................................................74
Copying driver software from a network server to Flash memory ....................................................................75
61
Page 64
6 • System image handling SmartWare Software Configuration Guide
Introduction
This chapter describes how to load and maintain system images and driver software. System images contain the
application image and driver software images. The application image represents the software running SmartWare, which has to be stored in the persistent region of the memory. Driver software images contain software
that also has to be stored in the persistent region of the memory and are used for optional PMC interface cards.
This chapter includes the following sections:
• Memory regions in SmartWare
• Boot procedure and bootloader (see page 64)
• Factory configuration (see page 72)
• System image handling task list (see page 73)
All Patton SmartNode devices are shipped with a default system image, which is stored in the persistent flash
memory of the SmartNode at the factory. The system image contains the application image and driver software
images that together build SmartWare. In addition a factory configuration is loaded to the SmartNode at the
factory, which sets initial SmartWare parameters. Therefore the user is neither has to load a system image not
the factory configuration to the SmartNode prior using it.
Your own operational configuration files are stored in the SmartNode flash memory, and copies may also be
stored on a remote server. Transferring configuration files between the flash memory and a remote server
requires the use of the Trivial File Transfer Protocol (TFTP). The TFTP server must be accessible through one
of the SmartNode IP interfaces. TFTP is not possible over the console interface.
In the following sections the focus is on SmartWare memory regions and the software components that can be
copied within the memory or moved between a TFTP server and the memory of the SmartNode. Since SmartWare uses a specific vocabulary in naming those software components, refer appendix A, “Terms and defini-
tions” on page 407 to ensure that you understand the concepts.
Memory regions in SmartWare
The SmartNode memory used by SmartWare is divided into several regions as shown in figure 13 on page 63.
A remote TFTP server is used for up- or downloading configurations, application and driver software images to
or from the SmartNode’s memory. In the SmartWare command syntax, the file path of a file on the TFTP
server that is used for image upload or download is prefixed with tftp: followed by the absolute file path starting
from the root directory of the TFTP server.
The flash memory stores data contained in it persistently and is made up of two logical regions called flash:
and nvram:, which are used as follows:
• The application image, a bootloader image and one or more driver software images have to be stored in the
logical region flash: of flash memory.
• Configuration files have to be stored in the logical region nvram: of the flash memory. The factory default config-
uration is always loaded, and may be restored by pressing the SmartNode reset button; see the getting started
guide that came with your SmartNode. The startup, or user-specific configuration, is also stored in nvram.
The factory configuration is read-only, and is contained in the persistent memory in the logical region nvram:
of the SmartNode. It can be used if no user-specific configuration is available to start-up SmartWare with a
minimal functionality. This configuration is named “factory-config” in the SmartWare terminology. A dedi-
62 Introduction
Page 65
SmartWare Software Configuration Guide 6 • System image handling
cated user-specific configuration has to be created and stored in the flash memory. This configuration defines
the user’s desired system functionality and is used to start-up the system under normal conditions. This configuration has to be stored as “default-config” in the logical region nvram: of flash memory. Any configuration
stored within the persistent memory in the logical region nvram: can be copied to a remote server using TFTP.
Since configurations are not executable from persistent memory, any configuration that is to be used has to be
copied into the volatile memory of the SmartNode prior to operation. This procedure takes place after the system bootstrap, where the application image (i.e. SmartWare) is started and a configuration must be available.
Shortly before SmartWare is fully started up the configuration “startup-config” is copied from the logical
region nvram: of flash memory as the “running-config” into the volatile memory system: of the SmartNode.
The volatile memory system: is a logical region within the random access memory (RAM) of the SmartNode.
Changing any settings during operation of a SmartNode alter the running configuration, i.e. that named “running-config” in the volatile memory system:. In order to have such modifications available after the next system
start, the running configuration must to be stored back as “startup-config” to the persistent memory nvram:.
Furthermore it is possible to backup the “running-config” in the volatile memory system: with a user-defined
name in persistent memory nvram: or on a remote TFTP server.
Figure 13. SmartNode memory regions logically defined in smartware
Memory regions in SmartWare 63
Page 66
6 • System image handling SmartWare Software Configuration Guide
Boot procedure
During a normal boot procedure of a SmartNode the bootstrap application checks the persistent memory in
the logical region nvram: for an application image. Following that the application image is executed, that is
SmartWare is started module by module. Shortly before SmartWare is fully started up the configuration “startup-config” is copied from the logical region nvram: of flash memory as “running-config” into the volatile
memory system: and is used to parameterize SmartWare. The boot procedure is illustrated in figure 14.
There are two situations during bootstrap during which the bootloader takes control. The bootstrap application checks the status of the Reset button (not available for SN4xxx) on the back plane of the SmartNode, and
if the system button has been pressed it launches the bootloader. The bootloader is also launched if a valid
application image is not available.
The bootloader ensures that basic operations, network access and downloads are possible in cases of interrupted or corrupted application image downloads. After downloading an application image the bootstrap only
64 Boot procedure
Figure 14. Boot Procedure
Page 67
SmartWare Software Configuration Guide 6 • System image handling
switches to the newly loaded application image if it is valid. Otherwise the bootstrap will still use the previous
application image.
If the application image is valid it is started, and SmartWare is brought into operation module by module.
During this system initialization phase (when the message Press reset button to restore factory defaults... appears
on the console screen), the status of the reset button on the back plane of the SmartNode is checked. If the button has been pressed the factory configuration is loaded into the volatile memory and is used to parameterize
SmartWare (not available for SN4xxx). If the button has not been pressed the startup configuration is loaded
into the volatile memory and is used to parameterize SmartWare.
Bootloader (for SmartNode 1000 and 2000 Series)
Start Bootloader and login
To start the Bootloader explicitly, power the SmartNode while pressing the reset button. All front LEDs will
light up. Keep the reset button pressed until the BRI/Ethernet-LEDs on SmartNode 1x00 and the ACT-LED
on SmartNode 2x00 extinguish. When the bootloader is started, the BRI -LEDs on SmartNode 1x00 and the
ACT-LED on SmartNode 2x00 are blinking. Open a telnet connection to the SmartNode via either one of
Ethernet interfaces and the Login display shown in figure 15 will appear. Use the credentials ‘admin’ / ‘patton’
to login.
Note The Bootloader does not support the console interface. The Ethernet inter-
faces preserve the IP addresses, IP masks and the default gateway, which they
had before starting the bootloader.
Figure 15. Login display
Main shell and domains
After login, you enter the Main Shell (see Figure 0-4). It offers you to select from three available Domains:
• Route Table Manager (RTM)
• Download Agent
• Diagnostic
Bootloader (for SmartNode 1000 and 2000 Series) 65
Page 68
6 • System image handling SmartWare Software Configuration Guide
The available command set is shown in table 6.
Table 6. Main Shell Command Set
Command Function
? Displays the main menu with available commands, domains and active sessions.
help Displays a list of the commands available in the current domain.
boot Restarts the system.
div d s The output of domain d is diverted to another session s, i.e. to Telnet interfaces.
sd d Switches to another domain. The available domains are displayed in the main
menu by entering ?. d = 0 invokes the Route Table Manager, d = 1 invokes the
Download Agent. d = 2 invokes the Diagnostics.
quit/quit s Terminates the current session/the session at Telnet interfaces.
Figure 16. Main Shell
Route Table Manager (RTM)
To access the Route Table Manager, type ‘sd 0’.
66 Bootloader (for SmartNode 1000 and 2000 Series)
Page 69
SmartWare Software Configuration Guide 6 • System image handling
Type ‘help’ to display a list of commands that are available in the RTM domain (see figure 17).
Figure 17. Route Table Manager Display
To add a new static route, use the command ‘add’.
For example:
add 1.2.3.4 mask 255.255.0.0 gw 1.2.3.10 metric 0
A route may be deleted by using the command ‘delete’.
For example:
delete 1.2.3.4 mask 255.255.0.0 gw 1.2.3.10
To deactivate/activate all static routes, use the commands ‘clear’ followed by ‘update’.
A list of all routes currently active is displayed by typing ‘print’.
Download Agent
To access the Download Agent, type ‘sd 1’.
Bootloader (for SmartNode 1000 and 2000 Series) 67
Page 70
6 • System image handling SmartWare Software Configuration Guide
Type ‘help’ to display a list of commands that are available in the Download Agent domain (see figure 18).
Figure 18. Download Agent Display
The Download Agent allows you to set and read different TFTP server settings:
• IP address (‘ssip’, ‘gsip’),
• Retry count (‘strc’, ‘gtrc’),
• Continue flag (‘stcf’, ‘gtcf’)
• Download file lifetime (‘sdfl’, ’gdfl’)
The command ‘download’ is used to download an application image or a configuration file from the TFTP
server, for example:
download /SmartWare/Sn1xxx/Vx/R2.10/BUILD21215 b
where ‘/SmartWare/...’ is the path to directory where the application image (Build) is stored, relative to the
configured TFTP root and ‘b’ is the batch file that tells the Download Agent which files to download.
Diagnostic
To access the Diagnostic domain, type ‘sd 2’.
68 Bootloader (for SmartNode 1000 and 2000 Series)
Page 71
SmartWare Software Configuration Guide 6 • System image handling
Type ‘help’ to display a list of the available commands in the Diagnostic domain (see figure 19).
Figure 19. Diagnostic Display
The command ’ping’ allows you to verify the IP connectivity within a network.
The various sectors of the SmartNode flash memory can be tested with the command ’flashtest’.
To delete the contents of the EFS the command ’eraseefs’ is used.
Bootloader (for SmartNode 4110/4520 Series)
The SmartNode 4110/4520 Series comes with a new Bootloader, the ‘RedBoot Bootloader’. It offers new features such as console access to the Bootloader and downloading application images (e.g. SmartWare) via the
serial link of the console.
Start Bootloader
To start the Bootloader, reload the system and press Ctrl-C (when the message Press ^C to abort boot script, ...
appears on the console screen). The follow prompt will be displayed:
RedBoot>
Enter ‘help’ to get an overview of the available commands. The cursor keys (up, down, left, right) are not working, use CTRL-N (for up) and CTRL-P (for down) instead. Overwriting and inserting does not work either.
Commands can be abbreviated as long as they do not become ambiguous.
Bootloader (for SmartNode 4110/4520 Series) 69
Page 72
6 • System image handling SmartWare Software Configuration Guide
Start-up with factory configuration
Step Command Purpose
1 RedBoot> fis load Copies the SmartWare application image from the
persistent memory (flash:) to the volatile memory
(RAM) from where it will be executed.
2 RedBoot> go -s factory-config Starts the SmartWare application telling it to use
‘factory-config’ as startup configuration.
You can also start-up with any other configuration
available in the persistent memory (nvram:) by providing its name instead of ‘factory-config’.
Load a new application image (SmartWare) via TFTP
The following procedure downloads the application image (SmartWare) for the mainboard. See the note below
on how to download the respective CLI description file.
Step Command Purpose
1
optional
2
optional
3
optional
4 RedBoot> load -r -v -h
5 RedBoot> fis delete -n 1 Delete the first application image.
6 RedBoot> fis create Store the downloaded application image to
7 RedBoot> fis list -l Check whether the image has been success-
RedBoot> ip_address - l
local_ip_address
RedBoot> ip_address -g
RedBoot> ping -h
[/
mask_len
tftp-server_ip_address
base_address file_name
]
gateway
host
-b
Sets the IP address and subnet mask of the
Ethernet interface 0/0 which shall be used to
receive the new application image.
mask_len
(or the number of 1’s within the subnet mask).
See Note below.
Sets the IP address of the default gateway.
Test connectivity to the TFTP server.
Downloads an application image into the volatile memory (RAM) from where the SmartNode
could directly execute it.
host
base_address
the application image. Use default address
0x1800100
file_name
TFTP server. Note: use the image file that contains the whole application, not the image
parts.
Reply with ‘y’ to the confirmation request.
the permanent memory (flash:).
Reply with ‘y’ to the confirmation request.
fully stored, whether it is the desired Release
and Build, and whether it is valid.
is the length of the network address
: IP address of the TFTP server
: memory location where to store
: path and name of the file on the
70 Load a new application image (SmartWare) via TFTP
Page 73
SmartWare Software Configuration Guide 6 • System image handling
Step Command Purpose
8 RedBoot> go Start the application image that was down-
loaded to the volatile memory (RAM).
Note With the Bootloader, only the Ethernet interface 0/0 is available. The Boot-
loader applies the IP address, subnet mask, and default gateway that was last
configured by the Bootloader itself or by an other application (e.g. SmartWare). If an application configured the Ethernet interface 0/0 to use DHCP,
the Bootloader will also use DHCP to learn the interface configuration. It
can receive and apply the IP address, subnet mask, default gateway and the
default (TFTP) server (transmitted as basic DHCP information ‘Next server
IP address’).
Note This procedure does not download the respective CLI description file.
Download it after starting up SmartWare with the following command:
copy tftp://<tftp_server_address>/<server path>/b1 flash:
Example: Downloading and storing a new application image (SmartWare)
RedBoot> ip -l 172.16.40.98/19
RedBoot> ip -g 172.16.32.1
RedBoot> ping -h 172.16.32.100
Network PING - from 172.16.40.98 to 172.16.32.100
..........PING - received 10 of 10 expected
RedBoot> load -r -v -h 172.16.32.100 -b 0x1800100 /Sn4xxx/image.bin
Using default protocol (TFTP)
Raw file loaded 0x01800100-0x0199ca6b, 1689964 bytes, assumed entry at 0x01800100
RedBoot> fis delete -n 1
Delete image 1 - continue (y/n)? y
... Erase from 0x60030000-0x601cc974: ..........................
RedBoot> fis create
Use address 0x01800100, size 1684402 ? - continue (y/n)? y
... Erase from 0x60030000-0x601cb3ba: ..........................
... Program from 0x00011eec-0x00011ef4 at 0x60030000: .
... Program from 0x01800100-0x0199b4b2 at 0x60030008: ..........................
... Program from 0x00011eec-0x00011ef4 at 0x60030000: .
Image successfully written to flash
RedBoot> fis list -l
Id Address Length State Description
Entry Load Addr Version
-------------------------------------------------------------------1 0x60030000 1693438 valid SmartWare R2.10 BUILD28015
0x01800100 0x01800100 V2.10
RedBoot> go
Starting ’SmartWare R2.10 BUILD28015’ at 0x01800100 via 0x01800100
Load a new application image (SmartWare) via TFTP 71
Page 74
6 • System image handling SmartWare Software Configuration Guide
Load a new application image (SmartWare) via serial link
The Bootloader supports protocols ‘X-Modem’ and ‘Y-Modem’ to download application images via the serial
link of the console. Do the following to initiate the download:
Step Command Purpose
1 RedBoot> load -r -v -m {
xmodem | ymodem } -b
base_address
5 RedBoot> fis delete -n 1 Delete the first application image.
6 RedBoot> fis create Store the downloaded application image to the permanent
7 RedBoot> fis list -l Check whether the image has been successfully stored,
8 RedBoot> go Start the application image that was downloaded to the vola-
Downloads an application image into the volatile memory
(RAM) from where the SmartNode could directly execute it.
‘xmodem’ or ‘ymoden’: Specify the protocol to be used, XModem or Y-Modem
base_address
image. Use default address 0x1800100
Execute the above RedBoot command first, then start the transfer from terminal program with the command ‘Send file via XModem’ (or similar).
Reply with ‘y’ to the confirmation request.
memory (flash:).
Reply with ‘y’ to the confirmation request.
whether it is the desired Release and Build, and whether it is
valid.
tile memory (RAM).
: memory location where to store the application
Note This type of download takes about 25 minutes (for the SmartNode 1000
series) since a serial link at only 9600 Baud is used.
Factory configuration
SmartNodes are delivered with a factory configuration stored in the logical region nvram: of the memory. It is
used to initially parameterize the network and component settings of SmartWare, which make sense at the very
beginning. Moreover if a SmartWare is malfunctioning resetting to the initial state is done by reloading the factory configuration. The factory configuration consists of default settings for the IP networking subsystem.
As soon as a user-specific configuration is created and stored as startup configuration, the factory configuration
will no longer used but it remains in the persistent memory. At any time during operation of a SmartNode it is
possible to switch back to the factory configuration. See section “Boot procedure” on page 64 and section
“Start-up with factory configuration” on page 70 for information on how to restore the factory-configuration.
Avoid downloading any system image if you do not completely
understand what you have to do!
72 Load a new application image (SmartWare) via serial link
Page 75
SmartWare Software Configuration Guide 6 • System image handling
System image handling task list
To load and maintain system images perform the tasks described in the following sections:
• Displaying system image information
• Copying system images from a network server to Flash memory (see page 74)
• Copying driver software from a network server to Flash memory (see page 75)
Displaying system image information
This procedure displays information about system images and driver software
Mode: Administrator execution
Step Command Purpose
1 show version Lists the system software release version, information about optional interface
cards mounted in slots, and other information.
Example: Display system image information
The following example shows the information that is available for a SmartNode 2000 series device with an
optional IC-4BRV interface card mounted in slot 2.
SN#show version
Product name : SN2300
Software Version : SmartWare R2.00 BUILD22031
Supplier :
Provider :
Subscriber :
Information for Slot 0:
SN2300 (Admin State: Application Started, Real State: Application Started)
Hardware Version : 1, 1
Serial number : 100000021579
PLD Version : 23010204h
Software Version : SmartWare R2.00 BUILD22031
Information for Slot 1:
this Slot is empty
Information for Slot 2:
IC-4BRV (Admin State: Application Started, Real State: Kernel Started)
Hardware Version : 1
PLD Version : 170001h
Software Version : Build 24026, min required : Build 24027
Loader Version : Build 39, min required: Build 39
Information for Slot 3:
this Slot is empty
System image handling task list 73
Page 76
6 • System image handling SmartWare Software Configuration Guide
Copying system images from a network server to Flash memory
As mentioned above the system image file contains the application software that runs SmartWare; it is loaded
in the flash memory at the Patton Electronics Co. factory. Since most of the voice and data features of the
SmartNode are defined and implemented within the application software, upgrading to a new release might be
necessary if you want to have additional voice and data features available. A new system image file has to be
stored permanently into the flash memory of your SmartNode to be present when booting the device.
Since the system image file is preloaded at the Patton Electronics Co. factory, you will only have to download
new SmartWare application software if a major software upgrade is necessary or if recommended by Patton
Electronics Co. Under normal circumstances downloading a system image file should not be needed.
Downloading a new system image file means storing it permanently at a defined location within the SmartNode flash memory. To store the system image file a special download script file has to be used. This script file
defines how the system image file is to be handled and where it is to be stored. You cannot download any system image file without an appropriate script file.
Each line in script file is a command for the CLI of your SmartNode. To download a system image file, which
will replace the currently running SmartWare application software, a script file with only one command is necessary.
Comment lines must have a hash character # in column one and can appear anywhere in the script file. Comment lines contain information for administrators or operators who maintain or use the script file.
The following example shows a script file used to download a system image and command line syntax definition file from a TFTP server.
# script file for system image download
# Patton Electronics Co. 2001-10-24
image.bin 1369474 21; ver 2300.1,2300.2;
cli.xml
+/flash/cli/spec.xml
#the next line deletes the whole embedded file system
*U D
Note The script file includes a 32-bit CRC on the last line, displayed as four char-
acters when seen in an ordinary text editor. Do not delete the line containing
the CRC entry or the download will fail!
The script file is downloaded with the copy commands. The copy command source defines the TFTP path to
the script file and the target is set use the script parser. After downloading the script file the system image file
and command line syntax definition file download is started automatically.
74 System image handling task list
Page 77
SmartWare Software Configuration Guide 6 • System image handling
Mode: Administrator execution
Step Command Purpose
1
node
(cfg)# copy tftp://
node-ip-address/b
flash: Downloads the script file b from the TFTP
server at address
the system image download process. This
progress is visualized with a counter, counting up from 0 to 100% according to the
downloaded amount of the file size for each
file that needs to be downloaded.
node-ip-address
and starts
Example: Copy system images from a network server to Flash memory
The following example shows how to download the system image file and command line syntax definition file
from the TFTP server at IP address 172.16.36.80. The download is defined by a script file, which has to be
downloaded first. After downloading the script file the system image file and command line syntax definition
file are downloaded automatically.
SN>enable
SN#configure
SN(cfg)#copy tftp://172.16.36.80/sn2300/build22032/b flash:
Completed image download
Completed file download /flash/cli/spec.xml
SN(cfg)#
Note When encountering problems due to memory exhaustion (message Parsing
batch file...% APP - OUT OF MEMORY.) shutdown the H.323 gateway
prior to initiating the download command as follows (which will temporarily free the required memory):
node(gw-h323)[h323]#shutdown
After the successful download either issue the ‘reload’ command (in order to start the IPNode with the new
software) or restart the H.323 gateway thus enabling calls again (with the current software):
node(gw-h323)[h323]#no shutdown
Copying driver software from a network server to Flash memory
Driver software images contain driver software that is to be downloaded to hardware devices such as optional
interface cards.
Downloading a driver software image file means storing it permanently at a defined location within the flash
memory on the motherboard or in the non-volatile memory of an optional interface card. To download driver
software image file a special download script file must be used.
System image handling task list 75
Page 78
6 • System image handling SmartWare Software Configuration Guide
The following example shows a script file used to download a driver software image file from a TFTP server for
an IC-4BRV interface card.
# script file for driver software image download
# Patton Electronics Co. 2001-10-24
;
/IC-4BRVoIP_Vx_R2.00_BUILD24028
+/flash/bin/pmc000216a6
4_ -
This script file defines how the driver software image file is to be handled and where it is to be stored.
Note You cannot download any driver software image file without an appropriate
script file.
Mode: Administrator execution
Step Command Purpose
1
node
(cfg)# copy tftp://
node-ip-address/b
flash: Downloads the script file b from the TFTP
server at address
node-ip-address
and
starts the driver software image download
process. This progress is visualized with a
counter, counting up from 0 to 100%
according to the downloaded amount of
the file size for each file that needs to be
downloaded.
Example: Copy driver software from a network server to Flash memory
The following example shows how to download the driver software image file from the TFTP server at IP
address 172.16.36.80. The download is defined by a script file, which has to be downloaded first. After downloading the script file the driver software image file is downloaded automatically.
SN>enable
SN#configure
SN(cfg)#copy tftp://172.16.36.80/ic-4brvoip/build24028/b flash:
Completed file download /flash/bin/pmc000216a6
SN(cfg)#
76 System image handling task list
Page 79
Chapter 7 Configuration file handling
Chapter contents
Introduction..........................................................................................................................................................78
Understanding configuration files ...................................................................................................................78
Factory configuration ............................................................................................................................................80
Configuration file handling task list.......................................................................................................................81
Copying configurations within the local memory ............................................................................................82
Replacing the startup configuration with a configuration from Flash memory ................................................83
Copying configurations to and from a remote storage location ........................................................................85
Replacing the startup configuration with a configuration downloaded from TFTP server ...............................86
Displaying configuration file information .......................................................................................................87
Modifying the running configuration at the CLI .............................................................................................87
Modifying the running configuration offline ...................................................................................................88
Deleting a specified configuration ...................................................................................................................89
77
Page 80
7 • Configuration file handling SmartWare Software Configuration Guide
Introduction
This chapter describes how to upload and download configuration files from and to a SmartNode 1000, 2000,
or 4000 Series devices. A configuration file is a batch file of SmartWare commands used within the software
modules that are performing specific functions of the SmartNode. Some aspects of configuration file management are also described in this chapter. Refer to chapter 6, “System image handling” on page 61 for more
information.
This chapter includes the following sections:
• Factory configuration (see page 80)
• Configuration file handling task list (see page 81)
All Patton SmartNode devices are shipped with a factory configuration file, which is stored in the flash memory
of the SmartNode.
A configuration file is like a script file containing SmartWare commands that can be loaded into the system.
Configuration files may also contain only partial configurations. This allows you to keep a library of command
sequences that you may want to use as required. By default the system automatically loads the factory configuration from the flash memory if no user-specific configuration is defined as the startup configuration.
Changing the current running configuration is possible as follows:
• You may change the running configuration interactively. Interactive configuring requires that you access the
CLI using the enable command to enter administrator execution mode. Then you must switch to the configuration mode by typing the command configure. Once in configuration mode you can enter the configuration commands that are necessary to configure your SmartNode.
• You can also create a new configuration file or modify an existing one offline. Configuration files can be
copied from the SmartNode flash memory to a remote server. Transferring configuration files between the
flash memory and a remote system requires the trivial file transfer protocol (TFTP). The TFTP server must
be reachable through one of the SmartNode network interfaces.
See chapter 4, “Accessing the CLI” on page 43 for information concerning access to the CLI.
In the following sections the emphasis is on SmartWare memory regions and on software components that can
be copied within the memory or be up/downloaded between a TFTP server and the memory of the SmartNode. Since SmartWare uses a specific vocabulary in naming those software components, refer to appendix A,
“Terms and definitions” on page 407 to ensure that you understand the concepts. Refer to chapter 6, “System
image handling” on page 61 for a brief description of how SmartWare uses system memory.
Understanding configuration files
Configuration files contain SmartWare commands that are used to customize the functionality of your SmartNode device. During system startup the SmartWare command parser reads the factory or startup configuration
file command-by-command, organizes the arguments and dispatches each command to the command shell for
execution. If, during operation of a SmartNode, you enter a command using the CLI of SmartWare, you alter the
running configuration accordingly. In other words you are modifying a live, in-service system configuration.
78 Introduction
Page 81
SmartWare Software Configuration Guide 7 • Configuration file handling
Figure 20, shows the characteristics of a configuration file. This configuration is stored on a TFTP server in the
file SN2300_001.cfg for later download to the SmartNode SN. The command syntax is identical for commands entered by the use of the CLI and commands contained in configuration files. For better comprehension SmartWare allows comments within configuration files. To add a line with a comment to your
configuration file simply begin the line with the hash (#) character. The command parser skips everything after
the hash character to the end of the line.
#----------------------------------------------------------------#
# SmartNode IP and Voice configuration #
#----------------------------------------------------------------#
# #
# Node: SN #
# Config: SN2300_001.cfg #
# Model: SN2300 0001-0001 #
# Serial No.: 100000021579 #
# Administrator: LB #
# Date: 12/10/2001 #
# #
#----------------------------------------------------------------#
# SNTP configuration used for time synchronization
cli version 2.00
sntp-client
sntp-client server primary 172.16.1.10 port 123 version 4
sntp-client poll-interval 600
sntp-client gmt-offset + 01:00:00
# system definitions
system
clock-source 1 2
hostname SN
# IP context configuration
context ip router
route 0.0.0.0 0.0.0.0 172.19.32.2 1
route 172.19.41.0 255.255.255.0 172.19.33.250
route 172.19.49.0 255.255.255.0 172.19.33.250
# CS context configuration
context cs switch
no number-prefix national
no number-prefix international
use tone-set-profile default
called-party rtab 201 dest-interface telecom-operator
called-party rtab 202 dest-interface telecom-operator
no shutdown
# interface LAN used for connection to internal network
interface lan
ipaddress 172.19.33.30 255.255.255.0
mtu 1500
# interface WAN used for connection to access network
interface wan
Introduction 79
Page 82
7 • Configuration file handling SmartWare Software Configuration Guide
ipaddress 172.19.32.30 255.255.255.0
mtu 1500
# interface used to access the PSTN telecom operator
interface pstn pstn-operator
routing dest-interface h323
bind port 1 0
# interface used to access the VoIP telecom provider
interface h323 voip-provider
routing dest-table rtab
remoteip 172.19.33.60
# H.323 gateway primarily used
gateway h323
codec g711alaw64k 10 20
codec g711ulaw64k 10 20
faststart
no ras
gatekeeper-discovery auto
bind interface lan router
use voip-profile default
no shutdown
port ethernet 0 0
medium auto
encapsulation ip
bind interface lan router
no shutdown
port ethernet 0 1
medium 10 half
encapsulation ip
bind interface wan router
no shutdown
Figure 20. Sample configuration file
Each configuration file that is stored in the flash memory needs a unique name. The user has to assign a file
name to any user-specific configuration. SmartWare predefines some names for configuration files. These are
the file names used to represent the factory configuration, startup configuration and running configuration,
which are factory-config, startup-config, and running-config. Refer to appendix A, “Terms and definitions” on
page 407 to learn more about configuration file types.
Factory configuration
Patton SmartNodes are delivered with a factory configuration in the logical region nvram: of the SmartNode that
is used to initially parameterize the network and component settings of SmartWare that are most useful when
starting initially. Moreover, if a SmartWare is malfunctioning, resetting to the initial state is possibly reloading
the factory configuration. The factory configuration consists of:
• Default settings for the IP networking subsystem
• Default settings for H.323 and ISoIP gateway subsystem
80 Factory configuration
Page 83
SmartWare Software Configuration Guide 7 • Configuration file handling
• Default settings for the quality of service subsystem
As soon as a user-specific configuration is created and stored as the startup configuration, the factory configuration is no longer used, but still remains in the persistent memory. At any time during the operation of a SmartNode it is possible to switch back to the factory configuration. The restoration procedure for restoring the
default settings is described in the getting started guide included with your SmartNode device.
Avoid downloading any configuration file if you do not completely understand what you have to do! If a configuration file
download fails or succeeds only partially your SmartNode device
cannot start up without a support intervention at the factory.
Configuration file handling task list
This section describes how to create, load, and maintain configuration files. Configuration files contain a set of
user-configured commands that customize the functionality of your SmartNode device so as to suit your own
operating requirements.
The tasks in this chapter assume that you have at least a minimal configuration running on your system. You
can create a basic configuration file using the configure command; see section “Modifying the running config-
uration at the CLI” on page 87 for details.
To display, copy, delete, and download or upload configuration files perform the tasks described in the following sections:
• Copying configurations within the local memory (see page 82)
• Replacing the startup configuration with a configuration from Flash memory (see page 83)
• Copying configurations to and from a remote storing location (see page 85)
• Replacing the startup configuration with a configuration downloaded from TFTP server (see page 86)
• Displaying configuration file information (see page 87)
• Modifying the running configuration at the CLI (see page 87)
• Modifying the running configuration offline (see page 88)
• Deleting a specified configuration (see page 89)
Configuration file handling task list 81
Page 84
7 • Configuration file handling SmartWare Software Configuration Guide
Copying configurations within the local memory
Configuration files may be copied within the local memory in order to switch between different configurations. Remember the different local memory regions in SmartWare as shown in figure 21.
Figure 21. Local memory regions in SmartWare
In the majority of cases, the interactively modified running configuration known as the running-config, which
is to be found in the volatile memory region system:, is copied to the persistent memory region nvram:. This
running config is stored under the name startup-config and replaces the existing startup configuration.
The current running configuration can be copied to the persistent memory region nvram: under a user-specified name, if that configuration is to be preserved.
In addition, an already existing configuration is usually copied to the persistent memory region nvram: using a
user-specified name, for conservation or later activation.
As shown in figure 21 the local memory regions are identified by their unique names, like nvram: which is
located in flash memory and system:, which is the system RAM, i.e. the volatile memory. As already mentioned,
within the same memory region any configuration file needs a unique name so for example it is not possible to
have two configurations files with the name running-config in the memory region nvram:.
As you might expect, the copy command does not move but replicates a selected source to a target configuration file in the specified memory region. Therefore the source configuration file is not lost after the copy process. There are three predefined configuration files names for which the specification of the memory region is
optional, namely the files factory-config, startup-config and running-config.
82 Configuration file handling task list
Page 85
SmartWare Software Configuration Guide 7 • Configuration file handling
Mode: Administrator execution
Step Command Purpose
1
node
#copy {factory-config | startup-
config | running-config | nvram:
name
} nvram:
target-name
source-
Copies the selected source configuration file
source-name
name
in local memory.
as target configuration file
target-
Example: Backing up the startup configuration
The following example shows how to make a backup copy of the startup configuration. In a first the startupconfig is copied under the name backup within the flash memory region nvram:.
SN#copy startup-config nvram:backup
Replacing the startup configuration with a configuration from Flash memory
The startup configuration is replaced by a configuration that is already present in the flash memory, by copying
it to that area of the flash memory where the startup configuration is to be stored.
Mode: Administrator execution
Step Command Purpose
1
node
# copy nvram:
new-startup
startup-config Replaces the existing persistent startup con-
figuration with the startup configuration
startup
already present in flash memory.
new-
Note It is assumed that the configuration new-startup that is present in flash mem-
ory was previously copied to the flash memory, e.g. from a TFTP server
using the copy command.
Configuration file handling task list 83
Page 86
7 • Configuration file handling SmartWare Software Configuration Guide
Example: Replacing the startup configuration with a configuration from Flash memory
The following example shows how to overwrite and therefore replace the persistent startup configuration in the
flash memory of a SmartNode with the configuration contained in the file new-startup already present in the
flash memory.
1. Replace the current startup configuration, using the copy command, into the flash memory area where the
startup configuration has to be stored.
SN#copy nvram:new-startup startup-config
2. Check the content of the persistent startup configuration by listing its command settings with the show
command.
SN#show startup-config
Startup configuration:
#----------------------------------------#
# SmartWare R2.00 BUILD220 #
# 2001-10-25T09:20:42 #
# Generated configuration file #
#----------------------------------------#
cli version 2.00
snmp community public rw
framerelay
exit
SN#
84 Configuration file handling task list
Page 87
SmartWare Software Configuration Guide 7 • Configuration file handling
Copying configurations to and from a remote storage location
Configuration files can be copied from local memory (persistent or volatile region) to a remote data store.
Remember the different store locations; they are the local memory in your SmartNode and the remote data store
on a server system. See figure 22 on page 85. A remote storage location is mostly used to store ready configurations for later download to a certain SmartNode. A TFTP server has to be used as a remote data store. From
within SmartWare this remote TFTP server is represented by the memory region tftp: in combination with the IP
address of the TFTP server and the name and path of the configuration file. We will explain the usage of the
remote memory region tftp: in the following section more detailed. Another typical task is uploading the current
running configuration to the remote data store for backup purpose, or if an extensive configuration file is to be
edited on the remote host. In this case the running configuration, named running-config, which is to be found in
the volatile memory region system: is transferred to the TFTP server. On the TFTP server the running configuration is stored to a file whose name is defined as one of the arguments of the copy command.
Figure 22. Remote memory regions for SmartWare
Finally configuration files, i.e. the startup configuration or a user-specific configuration that is stored in the
persistent memory region nvram: are often uploaded to the remote data store for backup, edit or cloning purposes. The latter procedure is very helpful when you have several SmartNode devices each using a configuration which does not greatly differ from the others, or which is the same for all devices. During the
configuration of the first SmartNode according to your requirements, the running configuration of this device,
named running-config and which is to be found in the volatile memory region system: is edited. Next the configuration is tested and if everything is as required, the running configuration is copied as startup configuration,
named startup-config, to the persistent memory region nvram: of the target device. After this the startup config-
Configuration file handling task list 85
Page 88
7 • Configuration file handling SmartWare Software Configuration Guide
uration is transferred to the TFTP server from where it can be distributed to other SmartNode devices, which
therefore get clones of the starting system if the configuration does not need any modifications.
Replacing the startup configuration with a configuration downloaded from
TFTP server
From within the administration execution mode, the startup-configuration is replaced by downloading a configuration from the TFTP server into the flash memory area where the startup configuration has to be stored.
Mode: Administrator execution
Step Command Purpose
1 node(cfg)# copy tftp://
startup
nvram:startup-config
ip-address/new-
Downloads the configuration file
the TFTP server at address
existing persistent startup configuration. This
progress is visualized with a counter, counting up
from 0 to 100% according to the downloaded
amount of the file size. If the download should fail
an error message
played.
% File Transfer - Get failed
new-startup
ip-address
from
replacing the
is dis-
Example: Sample configuration download from TFTP server
The following example shows how to overwrite and therefore replace the persistent startup configuration in the
flash memory of a SmartNode with the configuration contained in the file new-startup located on the TFTP
server at IP address 172.16.36.80.
1. Download the startup configuration with the copy command into the flash memory area where the startup
configuration is to be stored.
SN>enable
SN#configure
SN(cfg)#copy tftp://172.16.36.80/user/new-startup nvram:startup-config
Download...100%
SN(cfg)#
2. Check the content of the persistent startup configuration by listing its command settings with the show
command.
86 Configuration file handling task list
Page 89
SmartWare Software Configuration Guide 7 • Configuration file handling
SN#show nvram:startup-config
Startup configuration:
#----------------------------------------------------------------#
# SmartWare R2.00 BUILD22031 #
# 2001-10-25T09:20:42 #
# Generated configuration file #
#----------------------------------------------------------------#
cli version 2.00
snmp community public rw
framerelay
exit
SN#
Displaying configuration file information
This procedures describes how to display information about configuration files
Mode: Administrator execution
Command Purpose
show nvram: List of all persistent configurations
show running-config Displays the contents of the running configuration file
show startup-config Displays the contents of the startup configuration file
Modifying the running configuration at the CLI
The SmartWare accepts interactive modifications on the currently running configuration via the CLI. Interactive configuring needs access to the CLI. Use the enable command to enter administrator execution mode, and
then switch into the configuration mode by typing the command configure. Once in configuration mode you
can enter the configuration commands that are necessary to your SmartNode’s operation. When you configure
SmartWare using the CLI, the shell executes the commands as you enter them.
When you log-in to a SmartNode using the CLI all commands entered directly modify the running configuration, which is located in the volatile memory region system: (or RAM) of your SmartNode. Remember that this
memory is—as its name suggests—volatile, therefore if your modifications shall be permanent you have to
copy the configuration to the persistent memory. In most cases you will store it as the upcoming startup configuration and therefore store it in the persistent memory region nvram: under the name startup-config. On the
next start-up the system will initialize itself using the modified configuration. As a final the SmartNode has to
be restarted using the reload command.
Mode: Administrator execution
Step Command Purpose
1
node
#configure Enters administrator configuration mode
2 Enter all necessary configuration commands.
Configuration file handling task list 87
Page 90
7 • Configuration file handling SmartWare Software Configuration Guide
Step Command Purpose
3
node
(cfg)#copy running-config startup-config Saves the running configuration file as upcom-
ing startup configuration
4
node
(cfg)#reload Restarts the system
Example: Modifying the running configuration at the CLI
The following example shows how to modify the currently running configuration via the CLI and save it as the
startup configuration.
SN#configure
SN(cfg)#
SN(cfg)#copy running-config startup-config
SN(cfg)#reload
Press ’yes’ to restart, ’no’ to cancel : yes
The system is going down
Modifying the running configuration offline
In cases of complex configuration changes, which are easier to do offline, a SmartNode’s running configuration
may be stored on a TFTP server and there edited and saved. Since the SmartNode is acting as a TFTP client,
all file transfer operations are initiated from the SmartNode.
First the running configuration, named running-config, has to be uploaded from the SmartNode to the TFTP
server. After that the configuration file located on the TFTP server gets edited using any regular text editor.
Followed by downloading the configuration back to the SmartNode as upcoming startup configuration and
therefore store it in the persistent memory region nvram: under the name startup-config. Finally the SmartNode
has to be restarted using the reload command to activate the changes.
Note Consider that a user-specific configuration file does not manipulate any func-
tion of SmartWare until it is copied to—and therefore replaces—the configuration file startup-config. Downloading configuration files to flash memory
using a name other then startup-config is typically useful to activate any configuration changes or to store configuration for backup purposes in the flash
memory of the SmartNode.
Mode: Administrator execution
Step Command Purpose
1
node
#copy running-config tftp://
address/current-config
2 Offline editing of the configuration file current-
node-ip-
Uploads the current running configuration as file
current-config to the TFTP server at address nodeip-address. This progress is visualized with a
counter, counting up from 0 to 100% according
to the downloaded amount of the file size. If the
upload should fail an error message “% File
Transfer - Put failed” is displayed.
config on the TFTP server using any regular text
editor.
88 Configuration file handling task list
Page 91
SmartWare Software Configuration Guide 7 • Configuration file handling
Step Command Purpose
3
node
4
#copy tftp://
nvram:
node
startup-config
#reload Restarts the system
node-ip-address/current-config
Downloads the modified configuration file current-config from the TFTP server at address nodeip-address into the persistent memory region
nvram: using the name startup-config. This
progress is visualized with a counter, counting up
from 0 to 100% according to the downloaded
amount of the file size. If the download should
fail an error message “% File Transfer - Get
failed” is displayed.
Example: Modifying the running configuration offline
The following example shows the commands used to upload the running configuration from the SmartNode
to the file current-config on a TFTP server at IP address 172.16.36.80. The uploaded configuration file will be
written into the root directory specified by the TFTP server settings, and overwrites any existing file with the
same name. Read your TFTP server manual to get a thorough understanding of its behavior. After this the configuration file is available for offline editing on the TFTP server. Following the modified configuration file cur-
rent-config is downloaded from the TFTP server, at IP address 172.16.36.80, to the SmartNode’s persistent
memory region nvram: using the name startup-config. Finally the SmartNode has to be restarted.
SN#copy running-config tftp://172.16.36.80/user/current-config
Upload...100%
At this point in time the offline editing of the configuration file current-config on the TFTP server takes place.
SN#copy tftp://172.16.36.80/user/ current-config nvram:startup-config
Download...100%
SN#reload
Press ’yes’ to restart, ’no’ to cancel : yes
The system is going down
Deleting a specified configuration
This procedures describes how to delete configuration files from the SmartNode flash memory region nvram:.
Mode: Administrator execution
Step Command Purpose
1
node
#show nvram: Lists the loaded configurations
2
node
#erase name Deletes the configuration
name
from flash memory.
Example: Deleting a specified configuration
The following example shows how to delete a specific configuration from among a set of three available configurations in Flash memory. The configuration named “isoip-config” is to be deleted, since it is no longer used.
1. First the command show nvram: is used with to list all available configurations.
Configuration file handling task list 89
Page 92
7 • Configuration file handling SmartWare Software Configuration Guide
SN#show nvram:
Persistent configurations:
backup
minimal
startup-config
factory-config
2. The configuration named minimal has to be deleted explicitly.
SN#erase nvram:minimal
3. The command show nvram: is entered again to check if the selected configuration was deleted successfully
from the set of available configurations.
SN#show nvram:
Persistent configurations:
backup
startup-config
factory-config
90 Configuration file handling task list
Page 93
Chapter 8 Basic system management
Chapter contents
Introduction..........................................................................................................................................................92
Basic system management configuration task list ...................................................................................................92
Setting system information .............................................................................................................................92
Setting the system banner ................................................................................................................................94
Setting time and date ......................................................................................................................................94
Display clock information ...............................................................................................................................95
Display time since last restart ..........................................................................................................................95
Configuring and starting the Web server .........................................................................................................96
Determining and defining the active CLI version ............................................................................................96
Restarting the system ......................................................................................................................................97
Displaying the system logs ..............................................................................................................................97
Controlling command execution .....................................................................................................................98
Displaying the checksum of a configuration ....................................................................................................99
Configuration of Telnet sessions ...................................................................................................................100
91
Page 94
8 • Basic system management SmartWare Software Configuration Guide
Introduction
This chapter describes parameters that report basic system information to the operator or administrator, and
their configuration.
There are basic SmartWare parameters that need to be established when first setting up a new system. The
administrator needs to define the system’s hostname, set the location of the system, provide reference contact
information, and set the clock.
In addition basic management tasks such as checking the CRC of configuration files, displaying the currently
running SmartWare commands, moving SmartWare commands back into foreground, setting the system banner, enabling the embedded web server, and other task of system character are described in this chapter.
Basic system management configuration task list
All tasks in the following sections are optional, though some such as setting time and calendar services and system information are highly recommended.
To configure basic system parameters, perform the tasks described in the following sections.
• Setting system information (see page 92)
• Setting the system banner (see page 94)
• Setting time and date (see page 94)
• Display clock information (see page 95)
• Display time since last restart (see page 95)
• Configuring and starting the web server (see page 96)
• Determining and defining the active CLI version (see page 96)
• Restarting the system (see page 97)
• Displaying the system event log (see page 97)
• Controlling command execution (see page 98)
• Displaying the checksum of a configuration (see page 99)
Setting system information
The system information includes the following parameters:
• Contact
• Hostname
• Location
• Provider
• Subscriber
• Supplier
By default there is no information specified for any of the above parameters.
92 Introduction
Page 95
SmartWare Software Configuration Guide 8 • Basic system management
System contact information tells the user how to contact the information service, e.g. the help line of the service provider. The contact information may be any alphanumeric string, including spaces, that is no longer
than one line. This entry corresponds to the MIB II system sysContact object.
The system name, also called the hostname, is used to uniquely identify the SmartNode in your network. The
selected name should follow the rules for ARPANET hostnames. Names must start with a letter, end with a letter or digit, and have as interior characters only letters, digits, and hyphens. Names must be 63 characters or
fewer. For more information, refer to RFC 1035. This entry corresponds to the MIB II system sysName object.
After setting the hostname of the SmartNode the CLI prompt will be replaced with the chosen name.
Assigning explanatory location information to describe the system physical location of your SmartNode (e.g.
server room, wiring closet, 3rd floor, etc.) is very supportive. This entry corresponds to the MIB II system
sysLocation object.
The system provider information is used to identify the provider contact for this SmartNode device, together
with information on how to contact this provider. The provider is a company making services available to subscribers. The provider information may be any alphanumeric string, including spaces, that is no longer than
one line. This entry corresponds to the Patton Electronics Co. enterprise-specific MIB provider object.
The system subscriber information is used to get in touch with subscriber for this SmartNode device, together
with information on how to contact this subscriber. The subscriber is a company or person using one or more
services from a provider. The subscriber information may be any alphanumeric string, including spaces, that is
no longer than one line. This entry corresponds to the Patton Electronics Co. enterprise-specific MIB subscriber object.
The system supplier information is used to get in touch with the supplier for this SmartNode device, together
with information on how to contact this supplier. The supplier is a company delivering SmartNode devices to
a provider. The supplier information may be any alphanumeric string, including spaces, that is no longer than
one line. This entry corresponds to the Patton Electronics Co. enterprise-specific MIB supplier object.
Mode: Configure
Step Command Purpose
1
node
(cfg)#system contact
2
node
(cfg)#system hostname
3
node
(cfg)#system location
4
node
(cfg)#system provider
5
node
(cfg)#system subscriber
6
node
(cfg)#system supplier
Note If system information has to be formed out of more than one word the infor-
information
information
information
information
information
information
Sets the contact information to
Sets the hostname to
Sets the location information to
Sets the provider information to
Sets the subscriber information to
Sets the supplier information to
information
information
information
information
information
information
mation is enclosed by double quotes.
Basic system management configuration task list 93
Page 96
8 • Basic system management SmartWare Software Configuration Guide
Example: Setting system information
The following example shows the commands used to configure the contact information for your device, if you
start from the operator execution mode.
SN(cfg)#system contact "Bill Anybody, Phone 818 700 1504"
SN(cfg)#system hostname SN
SN(cfg)#system location Wiring Closet, 3rd Floor
SN(cfg)#system provider Best Internet Services, contact@bis.com, Phone 818 700
2340
SN(cfg)# system subscriber Mechanical Tools Inc., jsmith@mechtool.com, Phone 818
700 1402
SN(cfg)# system supplier WhiteBox Networks Inc., contact@whitebox.com, Phone 818
700 1212
Setting the system banner
The system banner is displayed on all systems that connect to your SmartNode via Telnet or a serial connection
(see figure 23). It appears at login and is useful for sending messages that affect administrators and operators,
such as scheduled maintenance or system shutdowns. By default no banner is present on login.
To create a system banner use the banner command followed by the message you want displayed. If the banner
message has to be formed out of more than one word the information is enclosed by double quotes. Adding the
escape sequence “\n” to the string forming the banner creates a new line on the connected terminal screen. Use
the no banner command to delete the message.
Mechanical Tools Inc.
jsmith@mechtool.com
Phone 818 700 1402
login:
Figure 23. System banner with message to operators
Mode: Configure
Step Command Purpose
1
node
(cfg)#banner
message
Sets the message for the system banner to
message
Example: Setting the system banner
The following example shows how to set a message for the system banner for your device, if you start from the
configuration mode.
SN(cfg)#banner "#\n# Patton Electronics Co.\n#\n# The password of all operators has
changed\n# please contact the administrator\n#"
Setting time and date
All SmartNode devices provide time-of-day and date services. These services allow the products to accurately
keep track of the current time and date. The system clock specifies year, month, day, hour, minutes, and
optionally seconds. The time is in 24-hour format yyyy-mm-ddThh:mm:ss and is retained after a reload.
94 Basic system management configuration task list
Page 97
SmartWare Software Configuration Guide 8 • Basic system management
Mode: Configure
Step Command Purpose
1
node
(cfg)#clock set
Note SmartWare includes an integrated SNTP client, which allows synchroniza-
yyyy-mm-ddThh:mm:ss
Sets the system clock to
yyyy-mm-ddThh:mm:ss
tion of time-of-day and date to a reference time server. Refer to chapter 19,
“SNTP client configuration” on page 223 for more details.
Example: Setting time and date
The following example shows the commands used to set the system clock of your device to August 6, 2001 at
16:55:57, if you start from the operator execution mode.
SN(cfg)#clock set 2001-08-06T16:55:57
Display clock information
This procedure describes how to display the current date and time
Mode: Both in operator and administrator execution
Step Command Purpose
1
node
>show clock Display the local time.
Example: Display clock information
The following example shows the commands used to display the time and date settings of your device in local
time, if you start from the operator execution mode.
SN>show clock
2001-08-06T16:55:57
Display time since last restart
This procedure describes how to display the time since last restart
Mode: Operator execution
Step Command Purpose
1
node
>show uptime Display the time since last restart.
Example:
The following example shows how to display the uptime of your device, if you start from the configuration mode.
SN>show uptime
The system is up for 1 days, 23 hours, 44 minutes, 18 seconds
Basic system management configuration task list 95
Page 98
8 • Basic system management SmartWare Software Configuration Guide
Configuring and starting the Web server
SmartNode includes an embedded web server, which can be used together with a customer-specific Java applet
that must be downloaded into the persistent memory region of your SmartNode. Applets are similar to applications but they do not run as standalones. Instead, applets adhere to a set of conventions that lets them run
within a Java-compatible browser. With a Java applet, custom-specific configuration tasks of SmartWare are
possible using a browser instead of accessing the SmartWare CLI via Telnet or the serial console.
Without a Java applet the value of the embedded web server is limited. Contact Patton Electronics Co. for any
questions about custom designed Java configuration tools for SmartWare.
Mode: Configure
Step Command Purpose
1
node
(cfg)#webserver lang {de | en} Sets the language to either German (de) or English (en)
2
node
(cfg)#webserver port number Sets the listening port number in the 1 to 65535, default
port number for web server is 80
Example: Configuring and starting the Web server
The following example shows how to set the web server language and the listening port of your device, if you
start from the configuration mode.
SN(cfg)#webserver lang en
SN(cfg)#webserver port 80
Determining and defining the active CLI version
SmartWare allows having a number of CLI version installed together, whereas only one CLI version is activated. There are commands available to determine the currently running CLI version and if necessary switch to
another CLI version. The idea of having several CLI version available on a system is mostly to offer reduced or
enhanced command sets to users.
Mode: Configure
Step Command Purpose
1
node
(cfg)#show version cli Displays the currently running CLI version
2
node
(cfg)#cli version
version.revision
Selects the active CLI version in the form version.revision
Example: Defining the desired CLI version
The following example shows how to determine the running CLI version and define CLI version 2.10 for your
device, if you start from the configuration mode.
SN(cfg)#show version cli
CLI version : 2.00
SN(cfg)#cli version 2.10
96 Basic system management configuration task list
Page 99
SmartWare Software Configuration Guide 8 • Basic system management
Restarting the system
In case the SmartNode has to be restarted, the reload command must be used. The reload command includes a
two-dialog, where the user is allowed to store any unsaved configuration data and finally confirms the system
restart.
Restarting the system interrupts running data transfers and all
voice calls established via the SmartNode that is to be restarted.
Mode: Administrator execution
Step Command Purpose
1
node
#reload Restarts the system
Example: Restarting the system
The following example shows how to restart the currently running system, if you start from the administrator
execution mode.
SN#reload
System configuration has been changed.
Press ’yes’ to store, ’no’ to drop changes : yes
Press ’yes’ to restart, ’no’ to cancel : yes
The system is going down
Displaying the system logs
The system logs contain warnings and information from the system components of SmartWare. In case of
problems it is often useful to check the event or the supervisor logs for information about malfunctioning system components. The event log stores general events such as flash full, DSP failed etc., comparable with the
event log on Windows NT. The supervisor log stores information from the system supervisor such as memory
full, task failed etc.
System resets may have a number of reasons, the most prominent being a manual reset issued on the telnet/
console (‘reload’). Other reset reasons include power off failures and system failures. In order to pinpoint the
problem, the reset log contains the reset cause.
Mode: Administrator execution
Step Command Purpose
1
node
#show log [event] Show event log.
2
node
#show log supervisor Show log of the system supervisor. Used for example after an unex-
pectedly reboot.
3
node
#show log reset Output a list of reset reasons (with date and time).
4
node
#show log boot Displays the console and log messages captured during startup of the
SmartNode.
Basic system management configuration task list 97
Page 100
8 • Basic system management SmartWare Software Configuration Guide
Example: Displaying system logs
The following example shows how to display event log warnings and information of your device, if you start
from the operator execution mode.
SN#show log event
2001-12-10T14:57:18 : LOGINFO : Link down on interface internal.
2001-12-10T14:57:39 : LOGINFO : Warm start.
2001-12-12T13:46:20 : LOGWARNING : Authentication failure.
2001-12-12T13:46:31 : LOGWARNING : Authentication failure.
2001-12-14T08:51:09 : LOGINFO : Slot 2: Event Logging Service for ic-4brvoip started.
2001-12-14T08:51:09 : LOGINFO : Slot 2: DrvPckt_Dsp_Ac48xx: DSP driver for
AC481xx created!
Controlling command execution
The SmartWare command shell includes a basic set of commands that allow you to control the execution of
other running commands. In SmartWare the commands jobs and fg are used for such purposes. The command
jobs lists all running commands, and fg allows switching back a suspended command to the foreground. More-
over using Ctrl-Z suspends an active command and lets the system prompt reappear. With Ctrl-C the currently active command can be terminated.
Mode: Administrator execution
Step Command Purpose
1 Execute the first command
2
node
#<Ctrl-Z> Suspend the active command and get system prompt back
3 Execute the second command
4
node
#jobs Shows the currently running commands
5
node
#fg
jobid
6
node
#<Ctrl-C> Terminates the currently running command
Brings job with
jobid
back to foreground
Example: Controlling Command Execution
The following example shows how to suspend an active command, list the running commands, switch back a
suspended command and terminate a currently active command on your device, if you start from the configuration mode.
SN>ping 172.16.36.80 1000 timeout 3
Sending 1000 ICMP echo requests to 172.16.36.80, timeout is 3 seconds:
Reply from 172.16.36.80: Time <10ms
Reply from 172.16.36.80: Time <10ms
Reply from 172.16.36.80: Time <10ms
Reply from 172.16.36.80: Time <10ms
Ctrl-Z suspend active command
% Suspended
98 Basic system management configuration task list
Loading...