SmartNode Series
SmartWare Release 3.10
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: 13211U4-002 Rev. C
Part Number: 07MDSNR310SW
Revised: September 24, 2004
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 & 2004, 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.
Contents
Contents ......................................................................................................................................................... 1
Compliance Information .............................................................................................................................. 19
Radio and TV Interference .............................................................................................................................19
CE Notice .......................................................................................................................................................19
EU Declaration of Conformity .......................................................................................................................19
The basis on which conformity is being declared .......................................................................................19
Service ............................................................................................................................................................20
About this guide ........................................................................................................................................... 21
Audience............................................................................................................................................................... 21
How to read this guide ......................................................................................................................................... 21
Structure............................................................................................................................................................... 21
Typographical conventions used in this document................................................................................................ 25
General conventions .......................................................................................................................................25
Mouse conventions .........................................................................................................................................26
Service ............................................................................................................................................................26
1 System overview ............................................................................................................................................ 27
Introduction..........................................................................................................................................................28
SmartNode hardware platforms.............................................................................................................................29
SmartWare embedded software .............................................................................................................................30
SmartView management center tools.....................................................................................................................31
Applications...........................................................................................................................................................31
Carrier networks .............................................................................................................................................32
Enterprise networks ........................................................................................................................................32
LAN telephony ...............................................................................................................................................34
2 Configuration concepts ................................................................................................................................. 35
Introduction..........................................................................................................................................................36
Contexts and Gateways..........................................................................................................................................37
Context ...........................................................................................................................................................37
Gateway ..........................................................................................................................................................37
Interfaces, Ports, and Bindings...............................................................................................................................38
Interfaces ........................................................................................................................................................38
Ports and circuits ............................................................................................................................................38
Bindings ..........................................................................................................................................................38
Profiles and Use commands...................................................................................................................................39
Profiles ............................................................................................................................................................39
Use Commands ..............................................................................................................................................39
3 Command line interface (CLI) ...................................................................................................................... 41
Introduction..........................................................................................................................................................42
Command modes ..................................................................................................................................................42
1
Contents
Model 4520 & 4110 Series Getting Started Guide
CLI prompt ....................................................................................................................................................42
Navigating the CLI .........................................................................................................................................43
Initial mode ..............................................................................................................................................43
System changes ..........................................................................................................................................43
Configuration ...........................................................................................................................................43
Changing Modes .......................................................................................................................................43
Command editing .................................................................................................................................................43
Command help ...............................................................................................................................................43
The No form ..................................................................................................................................................43
Command completion ....................................................................................................................................43
Command history ...........................................................................................................................................44
Command Editing Shortcuts ..........................................................................................................................44
4 Accessing the CLI.......................................................................................................................................... 47
Introduction..........................................................................................................................................................48
Accessing the SmartWare CLI task list...................................................................................................................48
Accessing via the console port .........................................................................................................................49
Console port procedure .............................................................................................................................49
Accessing via a Telnet session ..........................................................................................................................50
Telnet Procedure .......................................................................................................................................51
Log onto the SmartWare .................................................................................................................................51
Selecting a secure password .............................................................................................................................52
Configure operators and administrators ..........................................................................................................52
Factory preset administrator account .........................................................................................................52
Creating an operator account ....................................................................................................................52
Creating an administrator account ............................................................................................................53
Displaying the CLI version .............................................................................................................................54
Displaying account information ......................................................................................................................54
Switching to another account ..........................................................................................................................54
Checking identity and connected users ...........................................................................................................55
Ending a Telnet or console port session ..........................................................................................................56
5 Establishing basic IP connectivity ................................................................................................................. 57
Introduction..........................................................................................................................................................58
IP context selection and basic interface configuration tasks....................................................................................58
Entering the IP context, creating IP interfaces and assigning an IP address .....................................................58
Defining IP Ethernet encapsulation and binding an IP interface to a physical port .........................................59
Activating a physical port ................................................................................................................................59
Displaying IP interface information ................................................................................................................60
Deleting IP interfaces ......................................................................................................................................61
Examples ...............................................................................................................................................................62
Setting up an IP interface on an Ethernet port ................................................................................................62
6 System image handling.................................................................................................................................. 65
Introduction..........................................................................................................................................................66
Memory regions in SmartWare..............................................................................................................................66
2
3
Model 4520 & 4110 Series Getting Started Guide
Boot procedure......................................................................................................................................................68
Bootloader (for SmartNode 1000 and 2000 Series) ...............................................................................................69
Start Bootloader and login ..............................................................................................................................69
Main shell and domains ..................................................................................................................................69
Route Table Manager (RTM) .........................................................................................................................70
Download Agent .............................................................................................................................................71
Diagnostic .......................................................................................................................................................72
Bootloader (for SmartNode 4110/4520 Series)......................................................................................................73
Start Bootloader ..............................................................................................................................................73
Start-up with factory configuration .................................................................................................................74
Load a new application image (SmartWare) via TFTP ....................................................................................74
Load a new application image (SmartWare) via the serial link .........................................................................76
Factory configuration ............................................................................................................................................76
System image handling task list .............................................................................................................................77
Displaying system image information ..............................................................................................................77
Copying system images from a network server to Flash memory .....................................................................78
Copying driver software from a network server to Flash memory ....................................................................79
Contents
7 Configuration file handling........................................................................................................................... 81
Introduction..........................................................................................................................................................82
Understanding configuration files ...................................................................................................................82
Factory configuration ............................................................................................................................................84
Configuration file handling task list.......................................................................................................................85
Copying configurations within the local memory ............................................................................................86
Replacing the startup configuration with a configuration from Flash memory ................................................87
Copying configurations to and from a remote storage location ........................................................................89
Replacing the startup configuration with a configuration downloaded from TFTP server ...............................90
Displaying configuration file information .......................................................................................................91
Modifying the running configuration at the CLI .............................................................................................91
Modifying the running configuration offline ...................................................................................................92
Deleting a specified configuration ...................................................................................................................93
8 Basic system management ............................................................................................................................. 95
Introduction..........................................................................................................................................................96
Basic system management configuration task list ...................................................................................................96
Managing feature license keys .........................................................................................................................97
Setting system information .............................................................................................................................98
Setting the system banner ................................................................................................................................99
Setting time and date ....................................................................................................................................100
Display clock information .............................................................................................................................100
Display time since last restart ........................................................................................................................100
Configuring and starting the Web server .......................................................................................................101
Determining and defining the active CLI version ..........................................................................................101
Restarting the system ....................................................................................................................................102
Displaying the system logs ............................................................................................................................102
Contents
Model 4520 & 4110 Series Getting Started Guide
Controlling command execution ...................................................................................................................103
Displaying the checksum of a configuration ..................................................................................................104
Configuration of terminal sessions ................................................................................................................105
9 Radius Client Configuration ....................................................................................................................... 107
Introduction........................................................................................................................................................108
The AAA component ..........................................................................................................................................108
General AAA Configuration ..........................................................................................................................109
Radius configuration ...........................................................................................................................................111
Configuring Radius clients ............................................................................................................................112
Configuring the Radius server .......................................................................................................................113
Attributes in the Radius request message .................................................................................................113
Attributes in the Radius accept message ...................................................................................................113
Configuring the local database accounts ..............................................................................................................114
10 IP context overview ..................................................................................................................................... 117
Introduction........................................................................................................................................................118
IP context overview configuration task list...........................................................................................................119
Planning your IP configuration ...........................................................................................................................120
IP interface related information .....................................................................................................................120
Serial interface related information ................................................................................................................121
QoS related information ...............................................................................................................................121
Configuring Ethernet and serial ports..................................................................................................................121
Creating and configuring IP interfaces.................................................................................................................121
Configuring NAPT .............................................................................................................................................122
Configuring static IP routing...............................................................................................................................122
Configuring RIP..................................................................................................................................................122
Configuring access control lists............................................................................................................................123
Configuring quality of service (QoS) ...................................................................................................................123
11 IP interface configuration ........................................................................................................................... 125
Introduction........................................................................................................................................................126
Software IP interface configuration task list .........................................................................................................126
Creating an IP interface ................................................................................................................................126
Deleting an IP interface ................................................................................................................................127
Setting the IP address and netmask ...............................................................................................................127
ICMP message processing .............................................................................................................................128
ICMP redirect messages ................................................................................................................................128
Router advertisement broadcast message .......................................................................................................129
Defining the MTU and MSS of the interface ................................................................................................129
Configuring an interface as a point-to-point link ..........................................................................................130
Displaying IP interface information ..............................................................................................................131
Testing connections with the ping command ................................................................................................131
Traceroute ....................................................................................................................................................132
Examples .............................................................................................................................................................132
Deleting an IP interface ................................................................................................................................132
4
5
Model 4520 & 4110 Series Getting Started Guide
Contents
12 NAT/NAPT configuration........................................................................................................................... 133
Introduction........................................................................................................................................................134
Dynamic NAPT ...........................................................................................................................................134
Static NAPT .................................................................................................................................................135
Dynamic NAT ..............................................................................................................................................136
Static NAT ...................................................................................................................................................136
NAPT traversal .............................................................................................................................................137
NAT/NAPT configuration task list .....................................................................................................................137
Creating a NAPT profile ...............................................................................................................................137
Activate NAT/NAPT ....................................................................................................................................138
Displaying NAT/NAPT configuration information ......................................................................................139
13 Ethernet port configuration ........................................................................................................................ 141
Introduction........................................................................................................................................................142
Ethernet port configuration task list ....................................................................................................................142
Entering the Ethernet port configuration mode ............................................................................................143
Configuring medium for an Ethernet port ....................................................................................................143
Configuring Ethernet encapsulation type for an Ethernet port ......................................................................144
Binding an Ethernet port to an IP interface ..................................................................................................144
Selecting the frame format for an Ethernet port ............................................................................................145
Configuring layer 2 CoS to service-class mapping for an Ethernet port .........................................................146
Adding a receive mapping table entry ......................................................................................................147
Adding a transmit mapping table entry ...................................................................................................147
Closing an Ethernet port ...............................................................................................................................148
14 Link scheduler configuration ...................................................................................................................... 151
Introduction........................................................................................................................................................152
Applying scheduling at the bottleneck ...........................................................................................................152
Using traffic classes .......................................................................................................................................152
Introduction to Scheduling ...........................................................................................................................153
Priority ....................................................................................................................................................153
Weighted fair queuing (WFQ) ................................................................................................................153
Shaping ...................................................................................................................................................153
Burst tolerant shaping or wfq ..................................................................................................................154
Hierarchy ................................................................................................................................................154
Quick references..................................................................................................................................................155
Setting the modem rate .................................................................................................................................155
Command cross reference .............................................................................................................................156
Link scheduler configuration task list...................................................................................................................156
Defining the access control list profile ...........................................................................................................157
Packet classification .................................................................................................................................157
Creating an access control list ..................................................................................................................158
Creating a service policy profile .....................................................................................................................159
Specifying the handling of traffic-classes ........................................................................................................161
Defining fair queuing weight ...................................................................................................................161
Contents
Model 4520 & 4110 Series Getting Started Guide
Defining the bit-rate ...............................................................................................................................162
Defining absolute priority .......................................................................................................................162
Defining the maximum queue length ......................................................................................................162
Specifying the type-of-service (TOS) field ...............................................................................................162
Specifying the precedence field ................................................................................................................163
Specifying differentiated services codepoint (DSCP) marking .................................................................163
Specifying layer 2 marking ......................................................................................................................164
Defining random early detection .............................................................................................................165
Discarding Excess Load ...........................................................................................................................165
Devoting the service policy profile to an interface .........................................................................................166
Displaying link arbitration status ..................................................................................................................167
Displaying link scheduling profile information .............................................................................................167
Enable statistics gathering .............................................................................................................................167
15 Serial port configuration ............................................................................................................................. 169
Introduction........................................................................................................................................................170
Serial port configuration task list .........................................................................................................................170
Disabling an interface ...................................................................................................................................171
Enabling an interface ....................................................................................................................................171
Configuring the serial encapsulation type ......................................................................................................172
Configuring the hardware port protocol ........................................................................................................173
Configuring the active clock edge ..................................................................................................................174
Enter Frame Relay mode ...............................................................................................................................175
Configuring the LMI type .............................................................................................................................175
Configuring the keep-alive interval ...............................................................................................................176
Enabling fragmentation ................................................................................................................................176
Entering Frame Relay PVC configuration mode ...........................................................................................178
Configuring the PVC encapsulation type ......................................................................................................178
Binding the Frame Relay PVC to IP interface ...............................................................................................179
Enabling a Frame Relay PVC ........................................................................................................................180
Disabling a Frame Relay PVC .......................................................................................................................181
Debugging Frame Relay ................................................................................................................................181
Displaying serial port information .................................................................................................................182
Displaying Frame Relay information .............................................................................................................183
Integrated service access ................................................................................................................................184
16 Basic IP routing configuration.................................................................................................................... 187
Introduction........................................................................................................................................................188
Routing tables ...............................................................................................................................................188
Static routing ................................................................................................................................................188
Basic IP routing configuration task list ................................................................................................................188
Configuring static IP routes ..........................................................................................................................188
Deleting static IP routes ................................................................................................................................189
Displaying IP route information ...................................................................................................................190
Examples .............................................................................................................................................................191
6
7
Model 4520 & 4110 Series Getting Started Guide
Contents
Basic static IP routing example ......................................................................................................................191
17 RIP configuration........................................................................................................................................ 193
Introduction........................................................................................................................................................194
Routing protocol .................................................................................................................................................194
RIP configuration task list ...................................................................................................................................195
Enabling send RIP ........................................................................................................................................195
Enabling an interface to receive RIP ..............................................................................................................196
Specifying the send RIP version ....................................................................................................................196
Specifying the receive RIP version .................................................................................................................197
Enabling RIP learning ...................................................................................................................................197
Enabling an interface to receive RIP ..............................................................................................................198
Enabling RIP announcing .............................................................................................................................198
Enabling RIP auto summarization ................................................................................................................199
Specifying the default route metric ................................................................................................................199
Enabling RIP split-horizon processing ...........................................................................................................200
Enabling the poison reverse algorithm ...........................................................................................................200
Enabling holding down aged routes ..............................................................................................................201
Displaying RIP configuration of an IP interface ............................................................................................201
Displaying global RIP information ................................................................................................................202
18 Access control list configuration.................................................................................................................. 203
Introduction........................................................................................................................................................204
About access control lists .....................................................................................................................................204
What access lists do .......................................................................................................................................204
Why you should configure access lists ...........................................................................................................204
When to configure access lists .......................................................................................................................205
Features of access control lists .......................................................................................................................205
Access control list configuration task list..............................................................................................................206
Mapping out the goals of the access control list .............................................................................................206
Creating an access control list profile and enter configuration mode .............................................................207
Adding a filter rule to the current access control list profile ...........................................................................207
Adding an ICMP filter rule to the current access control list profile ..............................................................209
Adding a TCP, UDP or SCTP filter rule to the current access control list profile .........................................211
Binding and unbinding an access control list profile to an IP interface ..........................................................213
Displaying an access control list profile .........................................................................................................214
Debugging an access control list profile .........................................................................................................214
Examples .............................................................................................................................................................216
Denying a specific subnet ..............................................................................................................................216
19 SNMP configuration ................................................................................................................................... 217
Introduction........................................................................................................................................................218
Simple Network Management Protocol (SNMP) ................................................................................................218
SNMP basic components ..............................................................................................................................218
SNMP basic commands ................................................................................................................................218
SNMP management information base (MIB) ...............................................................................................219
Contents
Model 4520 & 4110 Series Getting Started Guide
Network management framework .................................................................................................................219
Identification of the SmartNode 1000, 2000 and 4000 Series via SNMP ............................................................220
SNMP tools.........................................................................................................................................................221
SNMP configuration task list ..............................................................................................................................221
Setting basic system information..........................................................................................................................222
Setting access community information ................................................................................................................224
Setting allowed host information.........................................................................................................................225
specifying the default SNMP trap target ..............................................................................................................225
Displaying SNMP related information ................................................................................................................226
Using the AdventNet SNMP utilities ..................................................................................................................227
Using the MibBrowser ..................................................................................................................................227
Using the TrapViewer ...................................................................................................................................228
Standard SNMP version 1 traps...........................................................................................................................230
SNMP interface traps ..........................................................................................................................................232
20 SNTP client configuration .......................................................................................................................... 233
Introduction........................................................................................................................................................234
SNTP client configuration task list......................................................................................................................234
Selecting SNTP time servers .........................................................................................................................235
Defining SNTP client operating mode ..........................................................................................................235
Defining SNTP local UDP port ....................................................................................................................236
Enabling and disabling the SNTP client .......................................................................................................237
Defining SNTP client poll interval ...............................................................................................................237
Defining SNTP client constant offset to GMT .............................................................................................237
Defining the SNTP client anycast address .....................................................................................................238
Enabling and disabling local clock offset compensation .................................................................................239
Showing SNTP client related information ....................................................................................................240
Debugging SNTP client operation ................................................................................................................240
Recommended public SNTP time servers............................................................................................................241
NIST Internet time service ............................................................................................................................241
Other public NTP primary (stratum 1) time servers .....................................................................................242
Additional information on NTP and a list of other NTP servers ...................................................................243
Recommended RFC .....................................................................................................................................243
21 DHCP configuration................................................................................................................................... 245
Introduction........................................................................................................................................................246
DHCP-client configuration tasks.........................................................................................................................247
Enable DHCP-client on an IP interface ........................................................................................................247
Release or renew a DHCP lease manually (advanced) ...................................................................................248
Get debug output from DHCP-client ...........................................................................................................249
DHCP-server configuration tasks ........................................................................................................................250
Configure DHCP-server profiles ...................................................................................................................250
Use DHCP-server profiles and enable the DHCP-server ...............................................................................252
Check DHCP-server configuration and status ...............................................................................................253
Get debug output from the DHCP-server .....................................................................................................253
8
9
Model 4520 & 4110 Series Getting Started Guide
Contents
22 DNS configuration...................................................................................................................................... 255
Introduction........................................................................................................................................................256
DNS configuration task list .................................................................................................................................256
Enabling the DNS resolver ............................................................................................................................256
Enabling the DNS relay ................................................................................................................................257
23 DynDNS configuration............................................................................................................................... 259
Introduction........................................................................................................................................................260
DynDNS configuration task list ..........................................................................................................................260
Creating a DynDNS account ........................................................................................................................260
Configuring the DNS resolver ......................................................................................................................260
Configuring basic DynDNS settings .............................................................................................................261
Configuring advanced DynDNS settings (optional) ......................................................................................261
Defining a mail exchanger for your hostname .........................................................................................261
Troubleshooting ...........................................................................................................................................262
24 PPP configuration....................................................................................................................................... 265
Introduction........................................................................................................................................................266
PPP configuration task list...................................................................................................................................267
Creating an IP interface for PPP ...................................................................................................................267
Creating a PPP subscriber .............................................................................................................................269
Configuring a PPPoE session ........................................................................................................................270
Configuring a serial port for PPP ..................................................................................................................272
Creating a PPP profile ...................................................................................................................................273
Displaying PPP configuration information ...................................................................................................274
Debugging PPP ............................................................................................................................................275
Sample configurations .........................................................................................................................................279
PPP over Ethernet (PPPoE) ..........................................................................................................................279
Without authentication, encapsulation multi, with NAPT ......................................................................279
With authentication, encapsulation PPPoE .............................................................................................279
PPP over serial link .......................................................................................................................................280
Without authentication, numbered interface ...........................................................................................280
With authentication, unnumbered interface ............................................................................................280
25 VPN configuration ...................................................................................................................................... 281
Introduction........................................................................................................................................................282
Authentication ..............................................................................................................................................282
Encryption ....................................................................................................................................................282
Transport and tunnel modes .........................................................................................................................283
Key management ..........................................................................................................................................283
VPN configuration task list .................................................................................................................................283
Creating an IPsec transformation profile .......................................................................................................283
Creating an IPsec policy profile .....................................................................................................................284
Creating/modifying an outgoing ACL profile for IPsec .................................................................................286
Configuration of an IP interface and the IP router for IPsec ..........................................................................287
Displaying IPsec configuration information ..................................................................................................287
Contents
Model 4520 & 4110 Series Getting Started Guide
Debugging IPsec ...........................................................................................................................................288
Sample configurations .........................................................................................................................................289
IPsec tunnel, DES encryption .......................................................................................................................289
SmartNode configuration ........................................................................................................................289
Cisco router configuration .......................................................................................................................290
IPsec tunnel, AES encryption at 256 bit key length, AH authentication with HMAC-SHA1-96 ..................290
SmartNode configuration ........................................................................................................................290
Cisco router configuration .......................................................................................................................291
IPsec tunnel, 3DES encryption at 192 bit key length, ESP authentication with HMAC-MD5-96 ................291
SmartNode configuration ........................................................................................................................291
Cisco router configuration .......................................................................................................................291
26 CS context overview .................................................................................................................................... 293
Introduction........................................................................................................................................................294
CS context configuration task list ........................................................................................................................295
Planning the CS configuration ............................................................................................................................295
Configuring general CS settings...........................................................................................................................297
Configuring call routing ......................................................................................................................................298
Creating and configuring CS interfaces................................................................................................................299
Specify call routing ........................................................................................................................................299
Configuring dial tones.........................................................................................................................................300
Configuring voice over IP parameters..................................................................................................................300
Configuring ISDN ports .....................................................................................................................................301
Configuring FXS ports ........................................................................................................................................301
Configuring an H.323 VoIP connection .............................................................................................................301
Configuring a SIP VoIP connection ....................................................................................................................301
Activating CS context configuration....................................................................................................................302
Planning the CS context ...............................................................................................................................305
Configuring general CS settings ....................................................................................................................306
Configuring call routing ................................................................................................................................306
Configuring VoIP settings ............................................................................................................................308
Configuring BRI ports ..................................................................................................................................308
Configuring an H.323 VoIP connection .......................................................................................................309
Activating the CS context configuration ........................................................................................................309
Showing the running configuration ...............................................................................................................311
27 CS interface configuration........................................................................................................................... 315
Introduction........................................................................................................................................................316
CS interface configuration task list ......................................................................................................................317
Creating and configuring CS interfaces................................................................................................................317
Configuring call routing ......................................................................................................................................318
Configuring the interface mapping tables ............................................................................................................319
Configuring the precall service tables...................................................................................................................322
28 ISDN interface configuration...................................................................................................................... 325
Introduction........................................................................................................................................................326
10
11
Model 4520 & 4110 Series Getting Started Guide
Contents
ISDN interface configuration task list..................................................................................................................326
Configuring DTMF dialing (optional) ..........................................................................................................326
Configuring an alternate PSTN profile (optional) .........................................................................................327
29 FXS interface configuration......................................................................................................................... 329
Introduction........................................................................................................................................................330
FXS supplementary services description...............................................................................................................330
Call holding ..................................................................................................................................................330
Call waiting ...................................................................................................................................................330
Additional call offering ..................................................................................................................................331
FXS interface configuration task list ....................................................................................................................331
Configuring a subscriber number (recommended) ........................................................................................331
Configuring an alternate PSTN profile (optional) .........................................................................................332
Configuring caller-ID presentation (optional) ...............................................................................................332
Configuring call holding supplementary service (optional) ............................................................................333
Configuring call waiting supplementary service (optional) ............................................................................333
Configuring additional call offering supplementary service (optional) ...........................................................334
30 FXO interface configuration ....................................................................................................................... 335
Introduction........................................................................................................................................................336
FXO services description .....................................................................................................................................337
Creating an FXO interface...................................................................................................................................337
Deleting an FXO interface...................................................................................................................................338
FXO interface configuration task list ...................................................................................................................339
Configuring an alternate PSTN profile (optional) .........................................................................................339
Configuring when the digits are dialed (optional) .........................................................................................340
Configuring the number of rings to wait before answering the call (optional) ...............................................341
Configuring how to detect a call has disconnected (optional) ........................................................................342
Configuring how to detect an outgoing call is connected (optional) ..............................................................343
Configuring the destination of the call ..........................................................................................................344
FXO interface examples ................................................................................................................................345
31 H.323 interface configuration ..................................................................................................................... 347
Introduction........................................................................................................................................................348
H.323 interface configuration task list.................................................................................................................348
Binding the interface to an H.323 gateway ...................................................................................................349
Configuring an alternate VoIP profile (optional) ...........................................................................................350
Configuring CLIP/CLIR support (optional) .................................................................................................351
Enabling the early call disconnect (optional) .................................................................................................352
Enabling the via address support (optional) ...................................................................................................353
Override the default destination call signaling port (Optional) ......................................................................353
Configuring status inquiry settings (optional) ...............................................................................................354
32 SIP interface configuration ......................................................................................................................... 355
Introduction........................................................................................................................................................356
SIP interface configuration task list......................................................................................................................356
Contents
Model 4520 & 4110 Series Getting Started Guide
Binding the interface to a SIP gateway ..........................................................................................................357
Configure a remote host ................................................................................................................................357
Configuring an alternate VoIP profile (Optional) .........................................................................................358
Configuring early call connect / disconnect (optional) ..................................................................................358
Configuring a phone context (optional) ........................................................................................................359
33 Call router configuration............................................................................................................................. 361
Introduction........................................................................................................................................................363
Call router configuration task list.........................................................................................................................365
Map out the goals for the call router .............................................................................................................365
Enable advanced call routing on circuit interfaces .........................................................................................366
Configure general call router behavior ...........................................................................................................366
Configure address completion timeout ....................................................................................................366
Configure default digit collection timeout and terminating character ......................................................367
Configure number prefix for ISDN number types ........................................................................................368
Configure call routing tables .........................................................................................................................369
Create a routing table ..............................................................................................................................370
Called party number routing table ................................................................................................................372
Regular Expressions .................................................................................................................................372
Digit Collection ......................................................................................................................................374
Digit Collection Variants ........................................................................................................................375
Calling party number routing table .........................................................................................................378
Number type routing table ............................................................................................................................379
Numbering plan routing table .......................................................................................................................380
Name routing table .......................................................................................................................................380
IP address routing table .................................................................................................................................381
URI routing table ..........................................................................................................................................381
Presentation Indicator Routing Table ...........................................................................................................381
Screening Indicator Routing Table ...............................................................................................................382
Information transfer capability routing table .................................................................................................383
Time of day routing table ..............................................................................................................................384
Day of Week Routing Table .........................................................................................................................384
Date routing table .........................................................................................................................................385
Deleting routing tables ..................................................................................................................................385
Configure mapping tables .............................................................................................................................386
E.164 to E.164 Mapping Tables ...................................................................................................................391
Other mapping tables ...................................................................................................................................393
Deleting mapping tables ...............................................................................................................................394
Creating complex functions ..........................................................................................................................395
Deleting complex functions ..........................................................................................................................395
Creating call services .....................................................................................................................................396
Creating a hunt group service ........................................................................................................................397
Creating a distribution group service .............................................................................................................406
Deleting call services .....................................................................................................................................408
12
13
Model 4520 & 4110 Series Getting Started Guide
Contents
Activate the call router configuration ............................................................................................................408
Test the call router configuration ..................................................................................................................409
34 Tone configuration...................................................................................................................................... 417
Introduction........................................................................................................................................................418
Tone-set profiles..................................................................................................................................................418
MGCP-Events ..............................................................................................................................................419
Tone configuration task list .................................................................................................................................419
Configuring call-progress-tone profiles ..........................................................................................................420
Configure tone-set profiles ............................................................................................................................421
Enable tone-set profile ..................................................................................................................................421
Show call-progress-tone and tone-set profiles ................................................................................................422
35 ISDN port configuration............................................................................................................................. 425
Introduction........................................................................................................................................................426
ISDN reference points ..................................................................................................................................426
Possible SmartNode port configurations .......................................................................................................427
ISDN UNI Signaling ....................................................................................................................................427
SmartNode 1000 Series .......................................................................................................................................429
IC-4BRV Interface Card ...............................................................................................................................429
ISDN Configuration Concept.............................................................................................................................429
ISDN Layering .............................................................................................................................................429
Configuration example ..................................................................................................................................430
Description .............................................................................................................................................430
ISDN port configuration task list ........................................................................................................................431
Shutdown and enable ISDN ports ................................................................................................................431
Configure BRI port parameters (Layer 1) ......................................................................................................432
Configure PRI Port Parameters (Layer 1) ......................................................................................................433
Configure ISDN layer 2 parameters (Q921) .................................................................................................434
Configure ISDN layer 3 parameters (Q931) .................................................................................................435
Show ISDN port status .................................................................................................................................437
Examples .......................................................................................................................................................439
36 FXS port configuration ............................................................................................................................... 441
Introduction........................................................................................................................................................442
Shutdown and enable FXS ports..........................................................................................................................442
Bind FXS ports to higher layer applications.........................................................................................................443
Configure country-specific FXS port parameters..................................................................................................443
Other FXS port parameters..................................................................................................................................444
Choose a low-bit-rate codec for FXS ports...........................................................................................................445
Example ..............................................................................................................................................................446
37 FXO port configuration .............................................................................................................................. 447
Introduction........................................................................................................................................................448
Shutdown and enable FXO ports.........................................................................................................................448
Bind FXO ports to higher layer applications........................................................................................................449
Contents
Model 4520 & 4110 Series Getting Started Guide
Configure country specific FXO port parameters.................................................................................................449
Other FXO port parameters ................................................................................................................................450
38 H.323 gateway configuration ...................................................................................................................... 451
Introduction........................................................................................................................................................452
Gateway configuration task list............................................................................................................................452
Configure datapath related settings ...............................................................................................................453
Binding the gateway to an IP interface ..........................................................................................................454
Enable the gateway ........................................................................................................................................454
Configure registration authentication service (RAS) (Optional) ....................................................................455
Configure H.235 Security (optional) ............................................................................................................456
Advanced configuration options (optional) ...................................................................................................460
Enabling H.245 Tunneling .....................................................................................................................460
Enabling the fastconnect procedure .........................................................................................................460
Enabling the early H.245 procedure ........................................................................................................461
Changing the TCP port for inbound call-signaling connections ..............................................................461
Setting the response timeout ...................................................................................................................461
Setting the connect timeout ....................................................................................................................462
Configuring the terminal type for registration with the gatekeeper ..........................................................462
Troubleshooting ...........................................................................................................................................463
39 SIP gateway configuration........................................................................................................................... 465
Introduction........................................................................................................................................................466
Gateway configuration task list............................................................................................................................466
Configure DNS resolver ................................................................................................................................467
Configure datapath related settings ...............................................................................................................467
Binding the gateway to an IP interface ..........................................................................................................468
Enable the Gateway ......................................................................................................................................468
Registering with a registrar (optional) ...........................................................................................................468
Configure a domain name (optional) ............................................................................................................469
Configure a default server (optional) .............................................................................................................470
Configure authentication parameters (optional) ............................................................................................471
Enable the session timer (optional) ................................................................................................................471
Advanced configuration options (optional) ...................................................................................................472
Changing the listening port for inbound call-signaling ............................................................................472
Define session timer version ....................................................................................................................472
Define call transfer version ......................................................................................................................473
Troubleshooting ...........................................................................................................................................473
40 VoIP profile configuration .......................................................................................................................... 475
Introduction........................................................................................................................................................476
VoIP profile configuration task list ......................................................................................................................476
Creating a VoIP profile .................................................................................................................................477
Configure codecs ..........................................................................................................................................478
Configuring DTMF relay .............................................................................................................................480
Configuring RTP payload types ....................................................................................................................480
14
15
Model 4520 & 4110 Series Getting Started Guide
Contents
Configuring the dejitter buffer (advanced) ....................................................................................................480
Enabling/disabling filters (advanced) .............................................................................................................483
Configuring Fax transmission .......................................................................................................................484
Configuring modem transmission .................................................................................................................486
Examples .............................................................................................................................................................487
Home office in an enterprise network ...........................................................................................................487
Home office with fax ....................................................................................................................................489
Soft phone client gateway ..............................................................................................................................490
41 PSTN profile configuration......................................................................................................................... 493
Introduction........................................................................................................................................................494
PSTN profile configuration task list ....................................................................................................................494
Creating a PSTN profile ...............................................................................................................................494
Configuring the echo canceller ......................................................................................................................495
Configuring output gain ...............................................................................................................................495
42 VoIP debugging........................................................................................................................................... 497
Introduction........................................................................................................................................................498
Debugging strategy..............................................................................................................................................498
Verifying IP connectivity.....................................................................................................................................498
Debugging call signaling......................................................................................................................................499
Debugging ISDN signaling ...........................................................................................................................500
Verify an incoming call ...........................................................................................................................500
Verify an outgoing call ............................................................................................................................502
Verify ISDN layer 1,2,3 status ................................................................................................................503
Debugging FXS Signaling .............................................................................................................................504
Verify an incoming call ...........................................................................................................................504
Verify an outgoing call ............................................................................................................................505
Debugging H.323 Signaling .........................................................................................................................506
Verify an incoming call ...........................................................................................................................507
Verify an outgoing call ............................................................................................................................508
Debugging SIP signaling ...............................................................................................................................510
Verify an incoming call ...........................................................................................................................511
Verify an outgoing call ............................................................................................................................511
Using SmartWare’s internal call generator .....................................................................................................512
Debugging voice data ..........................................................................................................................................513
Check system logs .........................................................................................................................................515
How to submit trouble reports to Patton ......................................................................................................515
A Terms and definitions ................................................................................................................................ 517
Introduction........................................................................................................................................................518
SmartWare architecture terms and definitions .....................................................................................................518
B Mode summary ........................................................................................................................................... 525
Introduction........................................................................................................................................................526
C Command summary ................................................................................................................................... 529
Contents
Model 4520 & 4110 Series Getting Started Guide
Introduction........................................................................................................................................................531
operator_exec ......................................................................................................................................................531
administrator_exec ..............................................................................................................................................533
configure .......................................................................................................................................................535
Contexts and interfaces........................................................................................................................................536
context_ip .....................................................................................................................................................536
interface ..................................................................................................................................................536
dyndns ....................................................................................................................................................537
context_cs .....................................................................................................................................................537
cr_table_routing ......................................................................................................................................537
cr_table_mapping ...................................................................................................................................537
cr_table_precall-service ............................................................................................................................537
cr_table_complex_function .....................................................................................................................538
interface_h323 ........................................................................................................................................538
interface_sip ............................................................................................................................................538
interface_isdn ..........................................................................................................................................539
interface_fxs ............................................................................................................................................539
interface_fxo ...........................................................................................................................................539
service_hunt ............................................................................................................................................539
service_distribute .....................................................................................................................................540
service_second-dialtone ...........................................................................................................................540
Gateways .............................................................................................................................................................540
gateway_h323 ...............................................................................................................................................540
gateway_sip ...................................................................................................................................................540
Ports....................................................................................................................................................................541
port_ethernet ................................................................................................................................................541
pppoe ......................................................................................................................................................541
port_serial .....................................................................................................................................................541
framerelay ...............................................................................................................................................542
pvc ..........................................................................................................................................................542
port_virtual ...................................................................................................................................................542
port_fxs .........................................................................................................................................................542
port_fxo ........................................................................................................................................................542
port_isdn ......................................................................................................................................................543
port_isdn_q921 .......................................................................................................................................543
port_isdn_q931 .......................................................................................................................................543
Profiles ................................................................................................................................................................543
profile_acl .....................................................................................................................................................543
profile_service-policy ....................................................................................................................................544
source ......................................................................................................................................................544
profile_napt ..................................................................................................................................................544
profile_ppp ...................................................................................................................................................545
profile-ipsec-transform ..................................................................................................................................545
ipsec-manual-policy ......................................................................................................................................545
16
17
Model 4520 & 4110 Series Getting Started Guide
profile_call-progress-tone ..............................................................................................................................545
profile_tone-set .............................................................................................................................................545
profile_voip ...................................................................................................................................................546
profile_pstn ...................................................................................................................................................548
profile_dhcp-server .......................................................................................................................................548
profile_authentication ...................................................................................................................................548
Other...................................................................................................................................................................548
radius-client ..................................................................................................................................................548
system ...........................................................................................................................................................548
ic_voice ...................................................................................................................................................548
subscriber_ppp ..............................................................................................................................................548
Show help .....................................................................................................................................................549
Show command history ................................................................................................................................549
Show RedBoot version ..................................................................................................................................550
Restart system ...............................................................................................................................................550
Display memory content ...............................................................................................................................550
Set IP addresses .............................................................................................................................................550
Check network connection to remote system ................................................................................................551
Load a program to memory, so that it can be executed or stored in the Flash memory ..................................551
Execute a program loaded into memory ........................................................................................................552
Manage program images in Flash memory ....................................................................................................552
Display images stored in Flash memory ...................................................................................................552
Load an image into RAM so that it can be started ...................................................................................553
Re-initialize Flash image store .................................................................................................................553
Create a new image in the Flash image store ............................................................................................554
Delete an image from the Flash image store ............................................................................................554
RedBoot Configuration ................................................................................................................................554
Displaying current configuration .............................................................................................................554
Modify configuration ..............................................................................................................................555
Re-initialize configuration to default values .............................................................................................555
Read data from EEPROM ......................................................................................................................555
Enable/Disable cache ...............................................................................................................................555
Contents
D Internetworking terms & acronyms ........................................................................................................... 557
Abbreviations.......................................................................................................................................................558
E Used IP ports & available voice codecs in the SmartWare ......................................................................... 563
Used IP ports in the SmartWare..........................................................................................................................564
Available voice codecs in the SmartWare .............................................................................................................565
18
Contents
Model 4520 & 4110 Series Getting Started Guide
Compliance Information
Radio
and TV
The SmartNode series of products generate and use radio frequency energy, and if not installed and used properly—i.e. in strict accordance with the manufacturer’s instructions—may cause interference to radio and television reception. The SmartNode devices have been tested and found to comply with the limits for a Class A
computing device in accordance with specifications in Subpart B of Part 15 of FCC rules, which are designed
to provide reasonable protection from such interference in a commercial installation. However, there is no
guarantee that interference will not occur in a particular installation. If a SmartNode series device does cause
interference to radio or television reception, which can be determined by disconnecting the unit, the user is
encouraged to try to correct the interference by one or more of the following measures: moving the computing
equipment away from the receiver, re-orienting the receiving antenna and/or plugging the receiving equipment
into a different AC outlet (such that the computing equipment and receiver are on different branches).
CE Notice
The CE symbol on your Patton Electronics equipment indicates that it is in compliance with the Electromagnetic Compatibility (EMC) directive and the Low Voltage Directive (LVD) of the European Union (EU). A
Certificate of Compliance is available by contacting Technical Support.
Interference
EU Declaration of Conformity
EU Directives covered by this declaration
89/336/EEC Electromagnetic Compatibility Directive amended by 92/31/EEC & 93/68/EEC
72/23/EEC Low Voltage Equipment Directive amended by 93/68/EEC
Note During the transition period, products may not comply with the Low
Voltage Directive.
The basis on which conformity is being declared
The products identified above comply with the requirements of the above EU directives by meeting the following standards:
• Safety compliance: EN 60950
• EMC compliance: EN 55022, EN 55024
• ETSI TBR3 (BRI)
• TBR4 (PRI)
The CE mark was first applied in 2000.
19
Compliance Information SmartWare Software Configuration Guide
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.
20
About this guide
The objective of this SmartWare Command Configuration Guide is to provide information concerning the syn-
tax and usage of the command set. 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 25)
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 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 517 contains the terms and their definitions that are used
throughout this SmartWare Software Configuration Guide
• Chapter 1, "System overview" on page 27 provides an overview of the main elements of a SmartNode sys-
tem.
• Chapter 10, "IP context overview" on page 117
• Chapter 26, "CS context overview" on page 293
Structure
This guide contains the following chapters and appendices:
• Chapter 1, "System overview" on page 27 provides an overview of the main elements of a SmartNode system.
• Chapter 2, "Configuration concepts" on page 35 introduces basic SmartWare configuration concepts.
21
About this guide SmartWare Software Configuration Guide
• Chapter 3, "Command line interface (CLI)" on page 41 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 47 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 57 explains how to establish network-based con-
nections to and from your SmartNode by using IP interfaces and Ethernet ports.
• Chapter 6, "System image handling" on page 65 describes how to load and maintain system images and
driver software.
• Chapter 7, "Configuration file handling" on page 81 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 95 describes parameters that report basic system informa-
tion to the operator or administrator, and their configuration.
• Chapter 9, "Radius Client Configuration" on page 107 provides an overview of the authentication, autho-
rization, and accounting (AAA) component in SmartWare and describes how to configure the Radius client,
a subpart of the AAA component.
• Chapter 10, "IP context overview" on page 117 outlines SmartWare Internet protocol (IP) context, together
with its related components.
• Chapter 11, "IP interface configuration" on page 125 provides a general overview of SmartNode interfaces
and describes the tasks involved in their configuration.
• Chapter 12, "NAT/NAPT configuration" on page 133 provides a general overview of the network address
port translation and describes the tasks involved in its configuration.
• Chapter 13, "Ethernet port configuration" on page 141 provides an overview of Ethernet ports and
describes the tasks involved in their configuration through SmartWare.
• Chapter 14, "Link scheduler configuration" on page 151 describes how to use and configure SmartWare
quality of service (QoS) features.
• Chapter 15, "Serial port configuration" on page 169 provides an overview of the serial port and describes
the tasks involved in its configuration through SmartWare.
• Chapter 16, "Basic IP routing configuration" on page 187 provides an overview of IP routing and describes
the tasks involved in configuring static IP routing in SmartWare.
• Chapter 17, "RIP configuration" on page 193 provides an overview of the routing information protocol
(RIP) and describes the tasks involved in configuring RIP features within SmartWare.
• Chapter 18, "Access control list configuration" on page 203 provides an overview of IP access control lists
and describes the tasks involved in their configuration through SmartWare.
• Chapter 19, "SNMP configuration" on page 217 provides overview information about the simple network
management protocol (SNMP) and describes the tasks used to configure those of its features supported by
SmartWare.
• Chapter 20, "SNTP client configuration" on page 233 describes how to configure a simple network time pro-
tocol (SNTP) client.
22
SmartWare Software Configuration Guide About this guide
• Chapter 21, "DHCP configuration" on page 245 provides an overview of the dynamic host configuration
control protocol (DHCP) and describes the tasks involved in its configuration.
• Chapter 22, "DNS configuration" on page 255 describes how to configure the domain name system (DNS)
component.
• Chapter 23, "DynDNS configuration" on page 259 describes configuring the dynamic DNS (DynDNS)
service.
• Chapter 24, "PPP configuration" on page 265 describes how to configure the point-to-point protocol over
different link layers.
• Chapter 25, "VPN configuration" on page 281 describes how to configure the VPN connections between
two SmartNodes or between a SmartNode and a third-party device.
• Chapter 26, "CS context overview" on page 293 gives an overview of SmartWare circuit-switching (CS) con-
text and its associated components and describes the tasks involved involved in its configuration.
• Chapter 27, "CS interface configuration" on page 315 gives an overview of interfaces in the CS context and
describes the tasks involved its configuration.
• Chapter 28, "ISDN interface configuration" on page 325 provides an overview of ISDN interfaces, and the
tasks involved involved in their configuration.
• Chapter 29, "FXS interface configuration" on page 329 provides an overview of FXS interfaces, and the
tasks involved involved their configuration.
• Chapter 31, "H.323 interface configuration" on page 347 provides an overview of H.323 interfaces used by
H.323 gateways and describes the specific tasks involved involved in their configuration.
• Chapter 32, "SIP interface configuration" on page 355 provides an overview of SIP interfaces used by SIP
gateways and describes the specific tasks involved involved in their configuration.
• Chapter 33, "Call router configuration" on page 361 provides an overview of call router tables, mapping
tables and call services and describes the tasks involved in configuring the call router in SmartWare.
• Chapter 34, "Tone configuration" on page 417 gives an overview of SmartWare call-progress-tone profiles
and tone-set profiles and describes the tasks involved in their configuration.
• Chapter 35, "ISDN port configuration" on page 425 provides an overview of SmartNode ISDN ports and
describes the tasks involved in configuring ISDN ports in SmartWare.
• Chapter 36, "FXS port configuration" on page 441 provides an overview of POTS signaling and Smart-
Node FXS ports and describes the tasks involved in configuring FXS ports in SmartWare.
• Chapter 38, "H.323 gateway configuration" on page 451 provides an overview of the H.323 gateway and
describes the tasks involved involved in its configuration.
• Chapter 39, "SIP gateway configuration" on page 465 provides an overview of the SIP gateway and
describes the tasks involved in its configuration.
• Chapter 40, "VoIP profile configuration" on page 475 gives an overview of SmartWare VoIP profiles, how
they are used and describes the tasks involved in VoIP profile configuration.
• Chapter 41, "PSTN profile configuration" on page 493 gives an overview of SmartWare PSTN profiles, and
describes how they are used and the tasks involved in PSTN profile configuration.
23
About this guide SmartWare Software Configuration Guide
• Chapter 42, "VoIP debugging" on page 497 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 517 contains the terms and their definitions that are used
throughout this SmartWare Software Configuration Guide.
• Appendix B, "Mode summary" on page 525 illustrates the modes hierarchy.
• Appendix C, "Command summary" on page 529 is a command reference.
• Appendix D, "Internetworking terms & acronyms" on page 557 contains terms and definitions relating to
internetworking.
• Appendix E, "Used IP ports & available voice codecs in the SmartWare" on page 563 describes the used IP
ports and available voice codecs in SmartWare.
24
SmartWare Software Configuration Guide About this 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
25
About this guide SmartWare Software Configuration 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.
26
Chapter 1 System overview
Chapter contents
Introduction..........................................................................................................................................................28
SmartNode hardware platforms.............................................................................................................................29
SmartWare embedded software .............................................................................................................................30
SmartView management center tools.....................................................................................................................31
Applications...........................................................................................................................................................31
Carrier networks .............................................................................................................................................32
Enterprise networks ........................................................................................................................................32
LAN telephony ...............................................................................................................................................34
27
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 29)
• SmartWare embedded software (see page 30)
• SmartView Management Center tools (see page 31)
A complete SmartNode system or network, as installed in any of the application scenarios introduced in section
“Applications” on page 31, is typically composed of the following main elements plus a third-party network infra-
structure:
• 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.
28 Introduction
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
Figure 2 depicts the basic system model of a Patton SmartNode. 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 and SIP Voice over IP (VoIP) is supported.
• 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 29
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 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 SmartWare release notes for build numbers and
build-specific enhancements and limitations.
A SmartWare build is a binary image file. It is usually divided into several checksum-protected files to improve
download efficiency and security. The download to the SmartNode is handled in sequence by using a download batchfile. Refer to chapter 6, “System image handling” on page 65 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 SmartWare application.
It also provides minimal network services, allowing the SmartNode to be accessed and upgraded over the
network even if SmartWare application should not start. The boot loader is installed in the factory and
requires no upgrading.
• The PMC loader initializes the PMC interface cards when mounted in SmartNode 2000 series devices. It
checks the hardware versions and determines whether compatible PMC drivers are available. The PMC
loader may be upgraded together with a SmartWare release.
• The PMC driver software performs the runtime tasks on the PMC interface cards mounted in SmartNode
2000 series devices. The PMC drivers are interface card specific and also have build numbers. Refer to the
30 SmartWare embedded software
SmartWare Software Configuration Guide 1 • System overview
SmartWare 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’s 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 31
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 of an external modem, the SmartNode can connect to leased lines or any bridged-Ethernet broadband access.
Enterprise networks
In company-owned and operated wide area 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.
32 Applications
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 33
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 or SIP
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.
Figure 6 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.
34 Applications
Chapter 2 Configuration concepts
Chapter contents
Introduction..........................................................................................................................................................36
Contexts and Gateways..........................................................................................................................................37
Context ...........................................................................................................................................................37
Gateway ..........................................................................................................................................................37
Interfaces, Ports, and Bindings...............................................................................................................................38
Interfaces ........................................................................................................................................................38
Ports and circuits ............................................................................................................................................38
Bindings ..........................................................................................................................................................38
Profiles and Use commands...................................................................................................................................39
Profiles ............................................................................................................................................................39
Use Commands ..............................................................................................................................................39
35
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.
Patton strongly recommends 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.
This chapter includes the following sections:
• Contexts and gateways (see page 37)
• Interfaces, ports, and bindings (see page 38)
• Profiles and Use commands (see page 39)
Patton SmartNodes are multi-service network devices that offer high flexibility for the inter-working of circuitswitched 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.
Figure 7. Configuration concept overview
Figure 7 shows the various elements of a complete SmartNode configuration. Each of these elements imple-
ments 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-
36 Introduction
SmartWare Software Configuration Guide 2 • Configuration concepts
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 sections that follow refer to figure 7 on page 36 and describe the concepts and elements in more
detail.
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. A separate configuration can be built by means of the context concept for newly supported network layer technologies without complicating the configuration methods of existing features. For example, as
bridging, ATM, or FR switching becomes available so a bridging, ATM, or FR context can be introduced.
Each context contains a number of interfaces, which build the connections to other SmartWare elements and
the outside world. Figure 7 on page 36 shows two contexts:
• one of type IP named router
• 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 default
circuit-switching context named switch can contain number translations, local breakout conditions, and leastcost routing parameters.
Gateway
The concept of a gateway is introduced for the communication between contexts of different types. 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 36
shows two gateways, one of type h323 named h323 and one of type SIP named sip.
Contexts and Gateways 37
2 • Configuration concepts SmartWare Software Configuration Guide
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
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 36, 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 more information.
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.
Figure 7 on page 36 shows five ports. Three ports are bound directly to an IP interface. One port has a single
circuit configured, which is bound to the IP context. Two 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.
38 Interfaces, Ports, and Bindings
SmartWare Software Configuration Guide 2 • Configuration concepts
In the case of PSTN CS interfaces (BRI, PRI, FXS, FXO 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 VoIP CS interfaces (H.323, SIP), bindings are configured statically in the CS interface configuration. The binding is created from the interface to the gateway.
Bindings from ports to IP interfaces and from CS interfaces to ISDN ports are shown in figure 7 on page 36.
Profiles and Use commands
Profiles
Profiles provide configuration shortcuts. They contain specific settings that 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 36.
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.
Profiles and Use commands 39
2 • Configuration concepts SmartWare Software Configuration Guide
40 Profiles and Use commands
Chapter 3 Command line interface (CLI)
Chapter contents
Introduction..........................................................................................................................................................42
Command modes ..................................................................................................................................................42
CLI prompt ....................................................................................................................................................42
Navigating the CLI .........................................................................................................................................43
Initial mode ..............................................................................................................................................43
System changes ..........................................................................................................................................43
Configuration ...........................................................................................................................................43
Changing Modes .......................................................................................................................................43
Command editing .................................................................................................................................................43
Command help ...............................................................................................................................................43
The No form ..................................................................................................................................................43
Command completion ....................................................................................................................................43
Command history ...........................................................................................................................................44
Command Editing Shortcuts ..........................................................................................................................44
41
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 via the
SmartNode console port or through a Telnet session. The CLI lets you configure the complete SmartWare
functionality, as opposed to the SNMP and HTTP management interfaces that offer a more limited subset of
the functions. You can enter CLI commands online 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 43)
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 current working mode is indicated by the CLI prompt.
Appendix B, “Mode summary” on page 525 contains a detailed overview of all command modes, and
appendix C, “Command summary” on page 529 describes the commands that are valid in each mode.
CLI prompt
For interactive (online) sessions, the system prompt is displayed as:
nodename>
In the operator exec mode, the system prompt is displayed as:
nodename#
In the administrator exec mode and in the different configuration modes, the system prompt is displayed as:
nodename(mode)[name]#
Where:
• nodename is the currently configured name of the 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.
• name is the name of the instance of the current configuration mode
Example: the prompt in radius-client mode, assuming the nodename SN and the instance deepblue is:
SN(radius)[deepblue]#
The CLI commands used to enter each mode and the system prompt that is displayed when you are working
in each mode is summarized in appendix B, “Mode summary” on page 525.
42 Introduction
SmartWare Software Configuration Guide 3 • Command line interface (CLI)
Navigating the CLI
Initial mode
When you initiate a session, you can log in with operator or administrator privileges. Whichever login you use,
the CLI is always set to operator exec (non-privileged exec) mode by default upon startup. 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 changes to the system, the administrator exec (privileged exec) mode must be entered. The
enable user interface command is used for this purpose (the enable command is only accessible if you are
logged in as an administrator). Once in administrator exec mode, all of the system commands are available to
you.
Configuration
To make configuration changes, the configuration mode must be entered by using the configure command in
the administrator exec mode. After doing that, other configuration modes are accessible, as diagrammed in the
overview in figure 7 on page 36.
Changing Modes
The exit command moves the user up one level in the mode hierarchy (the same command works in any of
configuration modes). 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 by using the logout command within any mode.
Command editing
Command help
To see a list of all CLI commands available within a mode, type a question mark “?” or the <tab> key 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 or the <tab> key 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
Command editing 43
3 • Command line interface (CLI) SmartWare Software Configuration Guide
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 enter 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 go through by pressing the <uparrow> and <down-arrow> keys, and then pressing <enter> to enter the command.
The show history command displays a list of the commands you can go through by using the arrow keys.
Command Editing Shortcuts
SmartWare CLI provides a number of Emacs-style command shortcuts that facilitate editing of the command
line. Command editing shortcuts are summarized in table 3 on page 44. 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).
Esc f is handled differently; press and release the “Escape” key (often labeled Esc on many keyboards) and then
press the f key.
Table 3. Command edit shortcuts
Keyboard Description
Ctrl-p or <up-arrow> Recall previous command in the command history.
Ctrl-n or <down-arrow> Recall next command in the command history.
Ctrl-f or <right-arrow> Move cursor forward one character.
Ctrl-b or <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.
44 Command editing
SmartWare Software Configuration Guide 3 • Command line interface (CLI)
Table 3. Command edit shortcuts (Continued)
Keyboard Description
Ctrl-v Insert a code to indicate to the system that the keystroke
immediately following should be treated as normal text,
not a CLI command.
E.g. Pression the question mark (?) character in the CLI
prints a list of possible tokens. If you want to use the '?' in
a configuration command, e.g. to enter a regular expression, press Ctrl-v immediately followed by the question
mark (?).
Command editing 45
3 • Command line interface (CLI) SmartWare Software Configuration Guide
46 Command editing
Chapter 4 Accessing the CLI
Chapter contents
Introduction..........................................................................................................................................................48
Accessing the SmartWare CLI task list...................................................................................................................48
Accessing via the console port .........................................................................................................................49
Console port procedure .............................................................................................................................49
Accessing via a Telnet session ..........................................................................................................................50
Telnet Procedure .......................................................................................................................................51
Log onto the SmartWare .................................................................................................................................51
Selecting a secure password .............................................................................................................................52
Configure operators and administrators ..........................................................................................................52
Factory preset administrator account .........................................................................................................52
Creating an operator account ....................................................................................................................52
Creating an administrator account ............................................................................................................53
Displaying the CLI version .............................................................................................................................54
Displaying account information ......................................................................................................................54
Switching to another account ..........................................................................................................................54
Checking identity and connected users ...........................................................................................................55
Ending a Telnet or console port session ..........................................................................................................56
47
4 • Accessing the CLI SmartWare Software Configuration Guide
Introduction
SmartNode products are designed for remote management and volume deployment. The management and
configuration of SmartNodes is therefore based on IP network connectivity. Once a SmartNode is connected
to, and addressable in, an IP network, you can remotely perform all configuration, management, and maintenance tasks.
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 (by using a terminal directly connected to a SmartNode)
• Remotely, via the IP network (by using a Telnet application)
The ports available for connection and their labels for each SmartNode model are shown 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 41.
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 following sections describe the basic tasks involved in accessing the SmartWare command line interface.
Depending on your application scenario, some tasks are mandatory while others could be optional.
• Accessing via the console port (see page 49)
• Accessing via a Telnet session (see page 50)
• Logging on to the SmartWare (see page 51)
• Selecting a secure password (see page 52)
• Configuring operators and administrators (see page 52)
• Displaying the CLI version (see page 54)
• Displaying account information (see page 54)
• Switching to another log-in account (see page 54)
• Checking identity and connected users (see page 55)
• Ending a Telnet or console port session (see page 56)
48 Introduction
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 8). The host must use a terminal emulation application that
supports serial interface communication.
Figure 8. Setup for initial configuration via the console port
Note You do not need to configure IP settings 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 49
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 9, part A) or through an Ethernet hub with two straight cables (see figure 9, part B).
Figure 9. 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. Table 4 lists the default
IP address and network mask of the Ethernet ports of the SmartNode.
Table 4. 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 4 apply to an operating scenario com-
255.255.0.0/16
255.255.255.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 SmartWare release notes for more details.
50 Accessing the SmartWare CLI task list
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 the SmartWare
Accessing your SmartNode via the local console port or via a Telnet session opens 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 resembles that shown in figure 10. 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 10. 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 10, 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 51
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 applies 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
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, SmartWare contains a factory preset administrator account with the name administrator and an empty password. After adding a new administrator account, the factory preset administrator
account is automatically deleted and only the newly created administrator account is available. You can create
more than one administrator account, but there has to be at least one administrator account defined. If, for
some reason, the last administrator account is deleted, SmartWare automatically recreates the factory preset
administrator account with the name administrator and an empty password.
Creating an operator account
Operators do not have the privileges to run the enable command and therefore cannot modify the system configuration. Operators can view partial system information.
52 Accessing the SmartWare CLI task list
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 Saves the change made to the running config-
enable Enters administration execution mode
configure Enters configuration mode
operator
name
password
password
Creates a new operator account
password
uration of the SmartNode, so that it will be
used following a reload
password
name
and
Example: Create an operator account
The following example shows how 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 described 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 a new administrator account
name
and password
account parameters.
password
Example: Create an administrator account
The following example shows how to add a new administrator account with a login name super and a matching
password 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 53
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 the 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 : 3.00
Displaying account information
You can use the show command in the SmartWare to display information about existing administrator and
operator accounts. This command is not available for an operator account.
The following procedure describes how to display account information:
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
A user can use the su command to switch from one user account to working in another. 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, he must enter the password of the particular
account to get privileged access.
Mode: Administrator or operator execution
Step Command Purpose
1
node>
su account-name Changes to the user account
account-name
.
54 Accessing the SmartWare CLI task list
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 the 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
The who command displays who is logged in or gives more detailed information about users and process states.
Depending on the 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 in which you are working.
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 user executing the who command. ID repre-
sents 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 55
4 • Accessing the CLI SmartWare Software Configuration Guide
Ending a Telnet or console port session
Use the logout command in the operator or administration execution mode to end a Telnet or console port session. To confirm the logout command, you must enter yes on the dialog line as shown in the example below.
Mode: Operator execution
Step Command Purpose
1
node>
logout Terminates the session after a confirmation by the 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.
56 Accessing the SmartWare CLI task list
Chapter 5 Establishing basic IP connectivity
Chapter contents
Introduction..........................................................................................................................................................58
IP context selection and basic interface configuration tasks....................................................................................58
Entering the IP context, creating IP interfaces and assigning an IP address .....................................................58
Defining IP Ethernet encapsulation and binding an IP interface to a physical port .........................................59
Activating a physical port ................................................................................................................................59
Displaying IP interface information ................................................................................................................60
Deleting IP interfaces ......................................................................................................................................61
Examples ...............................................................................................................................................................62
Setting up an IP interface on an Ethernet port ................................................................................................62
57
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. You can configure basic IP connectivity in 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 10, “IP context overview” on page 117, and chapter 11, “IP interface
configuration” on page 125.
The chapter includes the following sections:
• IP context selection and basic interface configuration tasks
• Examples (see page 62)
The predefined IP context in SmartWare contains the functionality of a classic IP router. Within the IP context, packets are routed between IP interfaces according to 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 following are the basic tasks involved in configuring an IP context, the related interfaces, and ports:
• 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 59)
• Activating the physical port (see page 59)
• Displaying IP interface information (see page 60)
• Deleting IP interfaces (see page 61)
After you have entered the IP context and performed the basic configuration tasks, it is possible to configure
additional protocols and services such as RIP, ICMP, and NAPT for your IP context.
Entering the IP context, creating IP interfaces and assigning an IP address
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 the interface
name
name
, which repre-
you have just created.
ip-address
name
and
netmask
58 Introduction
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, you must define the IP Ethernet encapsulation for the related port. It is
assumed that you would like to define the 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. It is assumed that 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 the interface name to port
Enters port configuration mode and
selects the Ethernet port
slot
, on which use the IP Ethernet
encapsulation and to which bind an IP
interface.
port on slot
on slot
router, which is the IP router context
slot
slot
to the IP context named
port
on slot
port
Example: Define IP Ethernet encapsulation and bind IP interface to physical port
It is assumed that you would like to set the IP encapsulation for the 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 completing all the settings for the IP interface, you must activate the physical port. The SmartWare
default status for any port is disabled. In SmartWare terminology, any port is in the shutdown state unless it is
activated by command.
IP context selection and basic interface configuration tasks 59
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 the current state CLOSED.
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, you must remove the shutdown status of the port. That means you must
change the state of the port 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
It is assumed that 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
You can display information for all the configured IP interfaces by using 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
60 IP context selection and basic interface configuration tasks
SmartWare Software Configuration Guide 5 • Establishing basic IP connectivity
Example: List existing IP interfaces
You can display IP interface information by using the show ip interface command in configuration mode. In
the following 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
It is often necessary to delete an existing interface in the IP context. The procedure described 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 procedure described below assumes that you would like to delete the IP interface named external. Use the
following commands in IP context mode.
1. List the existing interfaces:
SN(ctx-ip)[router]#interface <?>
<interface> New interface
external Existing interface
internal Existing interface
lan Existing interface
wan Existing interface
IP context selection and basic interface configuration tasks 61
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
2. Delete the interfaces named external with the no interface command, with the interface name as argu-
ment:
SN(ctx-ip)[router]#no interface external
3. 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. Figure 11 shows the relation between the IP interface lan and the Ethernet port 0 on
slot 0. The configuration procedure below starts in the operator execution mode:
Figure 11. Relation between IP Interface
lan
and Ethernet port 0 on slot 0
1. Select the context IP mode for the required IP interface configuration.
SN>enable
SN#configure
SN(cfg)#context ip router
2. Create a new interface lan, 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
3. Select the Ethernet port 0 on slot 0; set the medium to 10 Mbps in half-duplex mode, and choose the IP
encapsulation for this port.
SN(if-ip)[lan]#port ethernet 0 0
SN(prt-eth)[0/0]#medium 10 half
62 Examples
SmartWare Software Configuration Guide 5 • Establishing basic IP connectivity
SN(prt-eth)[0/0]#encapsulation ip
4. Bind the interface lan you just defined to the Ethernet port, and then activate the port.
SN(prt-eth)[0/0]#bind interface lan router
SN(prt-eth)[0/0]#no shutdown
5. Store the configuration settings 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 63
5 • Establishing basic IP connectivity SmartWare Software Configuration Guide
64 Examples
Chapter 6 System image handling
Chapter contents
Introduction..........................................................................................................................................................66
Memory regions in SmartWare..............................................................................................................................66
Boot procedure......................................................................................................................................................68
Bootloader (for SmartNode 1000 and 2000 Series) ...............................................................................................69
Start Bootloader and login ..............................................................................................................................69
Main shell and domains ..................................................................................................................................69
Route Table Manager (RTM) .........................................................................................................................70
Download Agent .............................................................................................................................................71
Diagnostic .......................................................................................................................................................72
Bootloader (for SmartNode 4110/4520 Series)......................................................................................................73
Start Bootloader ..............................................................................................................................................73
Start-up with factory configuration .................................................................................................................74
Load a new application image (SmartWare) via TFTP ....................................................................................74
Load a new application image (SmartWare) via the serial link .........................................................................76
Factory configuration ............................................................................................................................................76
System image handling task list .............................................................................................................................77
Displaying system image information ..............................................................................................................77
Copying system images from a network server to Flash memory .....................................................................78
Copying driver software from a network server to Flash memory ....................................................................79
65
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 must be stored in the persistent region of the memory. Driver software images contain software
that must also be stored in the persistent region of the memory. Driver software images are used for optional
PMC interface cards.
This chapter includes the following sections:
• Memory regions in SmartWare
• Boot procedure and bootloader (see page 68)
• Factory configuration (see page 76)
• System image handling task list (see page 77)
Patton SmartNode devices are shipped with a default system image that is stored in persistent flash memory.
The system image contains the application image and driver software images that comprise the SmartWare. In
addition, a factory configuration is loaded into the SmartNode at the factory that sets initial SmartWare
parameters.
Operational configuration files that you create are stored in SmartNode flash memory. Backup copies can also
be stored on a remote server. Transferring configuration files between the flash memory and a remote server
requires using the trivial file transfer protocol (TFTP). The TFTP server must be accessible through one of the
SmartNode IP interfaces. TFTP cannot be used from the console interface.
The following sections focus on SmartWare memory regions, as well as the software components you can copy
into the memory or move 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 517 to ensure that you understand the concepts.
Memory regions in SmartWare
The SmartNode memory SmartWare uses is divided into several regions as shown in figure 12 on page 67. A
remote TFTP server is used for uploading or downloading the configurations, application, and driver software
images to or from the SmartNode’s memory. In SmartWare command syntax, you must prefix the file path of a
file on the TFTP server that is used for image upload or download with tftp:, followed by the absolute file path
starting from the root directory of the TFTP server.
The flash memory persistently stores data it contains and has 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 must be stored in the
logical region flash: of the flash memory.
• Configuration files must be stored in the logical region nvram: of the flash memory. The factory default configu-
ration 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. It is contained 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 SmartWare terminology.
66 Introduction
SmartWare Software Configuration Guide 6 • System image handling
A dedicated user-specific configuration must 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 must be stored as default-config in the logical region nvram: of the flash memory. Any configuration stored in the logical region nvram: can be copied to a remote server by using TFTP.
Since configurations cannot be executed from the persistent memory, any configuration to be used must 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
the flash memory as the running-config into the volatile memory system: of the SmartNode. The volatile memory
system: is a logical region in the random access memory (RAM) of the SmartNode.
Changing any settings during operation of a SmartNode alters the running configuration, i.e. the one named
running-config in the volatile memory system:. In order to have such modifications available after the next system start, the running configuration must be stored back as startup-config into the persistent memory nvram:.
Furthermore, it is possible to backup the running-config located in the volatile memory system: into the persistent memory nvram: or on a remote TFTP server, by using a user-defined name.
Figure 12. SmartNode memory regions logically defined in SmartWare
Memory regions in SmartWare 67
6 • System image handling SmartWare Software Configuration Guide
Boot procedure
During a normal boot procedure of a SmartNode, the bootstrap application checks for an application image in
the persistent memory of the logical region nvram:. The application image is then executed, i.e. the 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 the flash memory as running-config into the volatile memory system:
and it is used to parameterize SmartWare. Figure 13 illustrates the boot procedure.
Figure 13. Boot procedure
There are two situations during bootstrap when the bootloader takes control:
• The bootstrap application checks the status of the Reset button (not available for SN4xxx) on the back
panel of the SmartNode; if the user has pressed the system button, it launches the bootloader
• If a valid application image is not available
The bootloader ensures that basic operations, network access, and downloads are possible in case of interrupted
or corrupted application image downloads. After downloading an application image, the bootstrap only
68 Boot procedure
SmartWare Software Configuration Guide 6 • System image handling
switches to the newly loaded application image if it is valid. Otherwise, the bootstrap still uses 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 panel 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
the 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 the SmartWare.
Bootloader (for SmartNode 1000 and 2000 Series)
Start Bootloader and login
To start the Bootloader explicitly, power on the SmartNode while pressing the reset button. All front LEDs will
light up. Keep pressing the reset button until the BRI/Ethernet LEDs on SmartNode 1x00 and the ACT LED on
SmartNode 2x00 are off. When the bootloader starts, 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 14 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 default gateway that they had
before starting the bootloader.
Figure 14. Login display
Main shell and domains
After login, you access the Main Shell (see figure 14). You can select from three available domains:
• Route Table Manager (RTM)
• Download Agent
• Diagnostic
Bootloader (for SmartNode 1000 and 2000 Series) 69
6 • System image handling SmartWare Software Configuration Guide
The available command set is shown in table 5.
Table 5. 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 Diverts the output of domain d to another session s, i.e. to Telnet interfaces.
sd d Switches to another domain. You can display the available domains in the main
menu by entering “?”. The “d = 0” command 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 15. Main shell
Route Table Manager (RTM)
To access the Route Table Manager, type sd 0.
70 Bootloader (for SmartNode 1000 and 2000 Series)
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 16).
Figure 16. 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
You can delete a route 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.
You can display a list of all routes currently active by typing print.
Download Agent
To access the Download Agent, type sd 1.
Bootloader (for SmartNode 1000 and 2000 Series) 71
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 17).
Figure 17. 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)
You can use the command download 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 the 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.
72 Bootloader (for SmartNode 1000 and 2000 Series)
SmartWare Software Configuration Guide 6 • System image handling
Type help to display a list of the available commands in the Diagnostic domain (see figure 18).
Figure 18. Diagnostic Display
The command ping allows you to verify the IP connectivity within a network.
You can test the various sectors of the SmartNode flash memory with the command flashtest.
Use the command eraseefs to delete the contents of the EFS.
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 the capability for 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>
Type help to display an overview of the available commands.
Note If the cursor keys (up, down, left, right) are not working, use Ctrl-N (for up)
and Ctrl-P (for down) instead. Commands can be abbreviated as long as
they do not become ambiguous.
Bootloader (for SmartNode 4110/4520 Series) 73
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 Deletes the first application image.
6 RedBoot> fis create Stores the downloaded application image to
7 RedBoot> fis list -l Checks 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.
Tests the 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 the 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
74 Bootloader (for SmartNode 4110/4520 Series)
SmartWare Software Configuration Guide 6 • System image handling
Step Command Purpose
8 RedBoot> go Starts the application image that was down-
loaded into 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 were last
configured by the Bootloader itself or by another 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
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
Bootloader (for SmartNode 4110/4520 Series) 75
6 • System image handling SmartWare Software Configuration Guide
Load a new application image (SmartWare) via the serial link
The Bootloader supports the ‘X-Modem’ and ‘Y-Modem’ protocols 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 Deletes the first application image.
6 RedBoot> fis create Stores the downloaded application image to the permanent
7 RedBoot> fis list -l Checks whether the image has been successfully stored,
8 RedBoot> go Starts 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 ‘ymodem’: Specify the protocol to be used, XModem or Y-Modem
base_address
image. Use the default address 0x1800100
Execute the above RedBoot command first, then start the transfer from the terminal program with the command ‘Send file via
X-Modem’ (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 it uses a serial link at only 9600 baud.
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 makes sense at the very beginning. Moreover, in case of SmartWare malfunction, you can reset to the initial state by reloading the factory configuration. The factory configuration consists of the default settings for the IP networking subsystem.
Once the user-specific configuration is created and stored as startup configuration, the factory configuration is
no longer used but it remains in the persistent memory. It is possible to switch back to the factory configuration at any time during the operation of a SmartNode. See section “Boot procedure” on page 68 and section
“Start-up with factory configuration” on page 74 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!
76 Factory configuration
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 the Flash memory (see page 78)
• Copying the driver software from a network server to the Flash memory (see page 79)
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 R3.10 R2.00 BUILD22031
Supplier :
Provider :
Subscriber :
Information for Slot 0:
2500 (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 77
6 • System image handling SmartWare Software Configuration Guide
Copying system images from a network server to Flash memory
As mentioned previously, the system image file contains the application software that runs SmartWare; it is
loaded into the flash memory at the Patton Electronics Co. factory. Since most of the voice and data features of
the SmartNode are defined and implemented in 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 must 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 have to download a new
SmartWare application software only 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, you must use a special download script file. This script file
defines how to handle the system image file and where to store it. You cannot download any system image file
without an appropriate script file.
Each line in the 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
*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!
You can download the script file with the copy command. The copy command source defines the TFTP path
to the script file and the target is set to use the script parser. After downloading the script file, the system image
file and command line syntax definition file download starts automatically.
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
78 System image handling task list
SmartWare Software Configuration Guide 6 • System image handling
Example: Copy system images from a network server to the 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/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 the driver software to be downloaded into 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 the
driver software image file, you must use a special download script file.
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 to handle the driver software image file and where to store it.
Note You cannot download any driver software image file without an appropriate
script file.
System image handling task list 79
6 • System image handling SmartWare Software Configuration Guide
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 the 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)#
80 System image handling task list
Chapter 7 Configuration file handling
Chapter contents
Introduction..........................................................................................................................................................82
Understanding configuration files ...................................................................................................................82
Factory configuration ............................................................................................................................................84
Configuration file handling task list.......................................................................................................................85
Copying configurations within the local memory ............................................................................................86
Replacing the startup configuration with a configuration from Flash memory ................................................87
Copying configurations to and from a remote storage location ........................................................................89
Replacing the startup configuration with a configuration downloaded from TFTP server ...............................90
Displaying configuration file information .......................................................................................................91
Modifying the running configuration at the CLI .............................................................................................91
Modifying the running configuration offline ...................................................................................................92
Deleting a specified configuration ...................................................................................................................93
81
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 in the software modules that perform specific functions of the SmartNode. This chapter also describes some aspects of configuration file management. Refer to chapter 6, “System image handling” on page 65 for more information.
This chapter includes the following sections:
• Factory configuration (see page 84)
• Configuration file handling task list (see page 85)
All Patton SmartNode devices are shipped with a factory configuration file, which is stored in their flash memory.
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 by using the enable command to enter administrator execution mode. You must then switch to the
configuration mode with the command configure. Once in configuration mode, 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. You can copy configuration
files 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 47 for information concerning access to the CLI.
The following sections focus on SmartWare memory regions and software components that can be copied
within the memory or uploaded/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 517 to ensure that you understand the concepts. Refer to chapter 6, “System image
handling” on page 65 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 you use the SmartWare CLI to enter a command during operation of a SmartNode, you alter the
running configuration accordingly. In other words, you are modifying a live, in-service system configuration.
82 Introduction
SmartWare Software Configuration Guide 7 • Configuration file handling
Figure 19, shows the characteristics of a configuration file. It is stored on a TFTP server in the file
SN2300_001.cfg for later download to the SmartNode SN. The command syntax used to enter commands
with the CLI and add commands in configuration files is identical. For better comprehension, you can add
comments in 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 3.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
# 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
ipaddress 172.19.32.30 255.255.255.0
mtu 1500
# CS context configuration
context cs switch
no shutdown
# routing table configuration
routing-table called-e164 rtab
route 2.. dest-interface telecom-operator
Introduction 83
7 • Configuration file handling SmartWare Software Configuration Guide
# interface used to access the PSTN telecom operator
interface isdn telecom-operator
route call dest-interface h323
# interface used to access the VoIP telecom provider
interface h323 voip-provider
route call dest-table rtab
remoteip 172.19.33.60
bind gateway h323
# H.323 gateway primarily used
gateway h323
faststart
no ras
gatekeeper-discovery auto
bind interface lan router
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 19. Sample configuration file
Each configuration file 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 factory
configuration (factory-config), startup configuration (startup-config), and running configuration (running-
config) file names. Refer to appendix A, “Terms and definitions” on page 517 to learn more about configura-
tion file types.
Factory configuration
Patton SmartNodes are delivered with a factory configuration in the logical region nvram:. This factory configu-
ration initially parameterizes the most useful network and component settings of SmartWare. Moreover, in case
of SmartWare malfunction, resetting to the initial state means possibly reloading the factory configuration. The
factory configuration consists of:
• Default settings for the IP networking subsystem
• Default settings for H.323 and SIP gateway subsystem
• Default settings for the quality of service subsystem
Once 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. It is possible to switch back to the factory config-
84 Factory configuration
SmartWare Software Configuration Guide 7 • Configuration file handling
uration at any time during the operation of a SmartNode configuration. The getting started guide included
with your SmartNode device describes the restoration procedure for restoring the default settings.
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 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 by using the configure command; see section “Modifying the running con-
figuration at the CLI” on page 91 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 86)
• Replacing the startup configuration with a configuration from the Flash memory (see page 87)
• Copying configurations to and from a remote storing location (see page 89)
• Replacing the startup configuration with a configuration downloaded from the TFTP server (see page 90)
• Displaying configuration file information (see page 91)
• Modifying the running configuration at the CLI (see page 91)
• Modifying the running configuration offline (see page 92)
• Deleting a specified configuration (see page 93)
Configuration file handling task list 85
7 • Configuration file handling SmartWare Software Configuration Guide
Copying configurations within the local memory
Configuration files may be copied into the local memory in order to switch between different configurations.
Remember the different local memory regions in SmartWare as shown in figure 20.
Figure 20. Local memory regions in SmartWare
In most cases, the interactively modified running configuration known as the running-config, which is located
in the volatile memory region system:, is copied into the persistent memory region nvram:. This running config
is stored under the name startup-config and replaces the existing startup configuration.
You can copy the current running configuration into the persistent memory region nvram: under a user-specified name, if you want to preserve that configuration.
In addition, an already existing configuration is usually copied into the persistent memory region nvram: by
using a user-specified name, for conservation or later activation.
As shown in figure 20 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, configuration files in the same memory region need a unique name. For example, it is not possible to
have two configuration 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 file names for which it is optional to specify the memory region,
namely factory-config, startup-config and running-config.
86 Configuration file handling task list
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
into the 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. It is copied under the
name backup into the flash memory region nvram:.
SN#copy startup-config nvram:backup
Replacing the startup configuration with a configuration from Flash memory
It is possible to replace the startup configuration by a configuration that is already present in the flash memory.
You can do so by copying it to the area of the flash memory where the startup configuration is 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 by
using the copy command.
Configuration file handling task list 87
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 replace the persistent startup configuration in the flash memory of a
SmartNode by overwriting it with the configuration in the file new-startup stored in flash memory.
1. Replace the current startup configuration, by using the copy command, into the flash memory area where
the startup configuration is 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 R3.10 BUILD24128 #
# 2001-10-25T09:20:42 #
# Generated configuration file #
#----------------------------------------#
cli version 3.00
snmp community public rw
framerelay
exit
SN#
88 Configuration file handling task list
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 21). 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 21. 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 located 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 star-
tup-config, into the persistent memory region nvram: of the target device. After this, the startup configuration is
Configuration file handling task list 89
7 • Configuration file handling SmartWare Software Configuration Guide
transferred to the TFTP server, where it can be distributed to other SmartNode devices. These devices 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, you can replace the startup-configuration by downloading a
configuration from the TFTP server into the flash memory area where to store the startup configuration.
Mode: Administrator execution
Step Command Purpose
1 node(cfg)# copy tftp://
new-startup
nvram:startup-config
ip-address[:port]/
Downloads the configuration file
the TFTP server at address
existing persistent startup configuration. Optionally
you can enter the UDP
tens. If the port is not specified, the default port 69 is
used. This progress is visualized with a counter,
counting up from 0 to 100% according to the downloaded amount of the file size. Should the download
fail, an error message
displayed.
port
% File Transfer - Get failed
new-startup
ip-address
where the TFTP server lis-
replacing the
from
is
Example: Sample configuration download from the TFTP server
The following example shows how to replace the persistent startup configuration in the flash memory of a
SmartNode by overwriting it 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 to store
the startup configuration.
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.
90 Configuration file handling task list
SmartWare Software Configuration Guide 7 • Configuration file handling
SN#show nvram:startup-config
Startup configuration:
#----------------------------------------------------------------#
# SmartWare R3.10 BUILD22128 #
# 2001-10-25T09:20:42 #
# Generated configuration file #
#----------------------------------------------------------------#
cli version 3.00
snmp community public rw
framerelay
exit
SN#
Displaying configuration file information
This procedure describes how to display information about configuration files
Mode: Administrator execution
Command Purpose
show nvram: Lists 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
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 to 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 by using the CLI, the shell executes the commands as you enter them.
When you log in to a SmartNode by using the CLI, all commands you enter directly modify the running configuration located in the volatile memory region system: (or RAM) of your SmartNode. Because it is located in
volatile memory, to be made permanent, your modifications must be copied to the persistent (non-volatile)
memory. In most cases you will store it as the upcoming startup configuration 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. After the startup configuration has been saved to persistent memory, you have to restart the
SmartNode by using the reload command to cause the system to intialize with the new configuration.
Mode: Administrator execution
Step Command Purpose
1
node
#configure Enters administrator configuration mode
2 Enter all necessary configuration commands.
3
node
(cfg)#copy running-config startup-config Saves the running configuration file as the
upcoming startup configuration
Configuration file handling task list 91
7 • Configuration file handling SmartWare Software Configuration Guide
Step Command Purpose
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, you may store a SmartNode’s running
configuration on a TFTP server, where you can edit and save it. Since the SmartNode is acting as a TFTP client, it initiates all file transfer operations.
First, upload the running configuration, named running-config, from the SmartNode to the TFTP server. You
can then edit the configuration file located on the TFTP server by using any regular text editor. Once the configuration has been edited, download it back into the SmartNode as upcoming startup configuration and store
it in the persistent memory region nvram: under the name startup-config. Finally, restart the SmartNode by
using the reload command to activate the changes.
Note Consider that a customized configuration file will not modify any function of
SmartWare until it has been copied to persistent memory as the new configuration file startup-config.
Mode: Administrator execution
Step Command Purpose
1
node
#copy running-config tftp://
address[:port]/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
ip-address
port
not specified, the default port 69 is used. 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.
. Optionally you can enter the UDP
where the TFTP server listens. If the port is
node-
92 Configuration file handling task list
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: by 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. Should the download fail,
an error message “% File Transfer - Get failed” is
displayed.
Example: Modifying the running configuration offline
The following example shows how to upload the running configuration from the SmartNode to the file cur-
rent-config on a TFTP server at IP address 172.16.36.80. The uploaded configuration file is 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. Once the configuration file current-config has been modified, it
is downloaded from the TFTP server, at IP address 172.16.36.80, into the SmartNode’s persistent memory
region nvram: using the name startup-config. Finally, you must restart the SmartNode.
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 procedure 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 the 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 minimal is to be deleted, since it is no longer used.
1. Use the command show nvram: to list all available configurations.
SN#show nvram:
Persistent configurations:
Configuration file handling task list 93
7 • Configuration file handling SmartWare Software Configuration Guide
backup
minimal
startup-config
factory-config
2. Delete the configuration named minimal explicitly.
SN#erase nvram:minimal
3. Enter again the command show nvram: 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
94 Configuration file handling task list
Chapter 8 Basic system management
Chapter contents
Introduction..........................................................................................................................................................96
Basic system management configuration task list ...................................................................................................96
Managing feature license keys .........................................................................................................................97
Setting system information .............................................................................................................................98
Setting the system banner ................................................................................................................................99
Setting time and date ....................................................................................................................................100
Display clock information .............................................................................................................................100
Display time since last restart ........................................................................................................................100
Configuring and starting the Web server .......................................................................................................101
Determining and defining the active CLI version ..........................................................................................101
Restarting the system ....................................................................................................................................102
Displaying the system logs ............................................................................................................................102
Controlling command execution ...................................................................................................................103
Displaying the checksum of a configuration ..................................................................................................104
Configuration of terminal sessions ................................................................................................................105
95
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. The following are basic SmartWare parameters that must be established when setting up a
new system:
• Defining the system's hostname
• Setting the location of the system
• Providing reference contact information
• Setting the clock
Additionally, the following tasks are described in this chapter:
• Checking the CRC of configuration files
• Displaying the currently running SmartWare commands
• Moving SmartWare commands into the foreground
• Setting the system banner
• Enabling the embedded web server
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.
• Managing feature license keys (see page 97)
• Setting system information (see page 98)
• Setting the system banner (see page 99)
• Setting time and date (see page 100)
• Displaying clock information (see page 100)
• Displaying time since last restart (see page 100)
• Configuring and starting the web server (see page 101)
• Determining and defining the active CLI version (see page 101)
• Restarting the system (see page 102)
• Displaying the system event log (see page 102)
• Controlling command execution (see page 103)
• Displaying the checksum of a configuration (see page 104)
• Configuration of terminal sessions (see page 105)
96 Introduction
SmartWare Software Configuration Guide 8 • Basic system management
Managing feature license keys
Several features of the firmware require a system specific license key to be installed to enable the feature. You
will receive a file containing license keys for all of your purchased features from your equipment vendor.
This section describes how to install the feature license keys on your equipment. Because license keys comprise
very long strings of characters, the standard way of installing them is to download the file containing the
license keys from a TFTP server to the equipment. Therefore, a TFTP server must be present in the IP network
where you can store the license keys file obtained from the distributor. If no TFTP server is available, the
license key can also be manually typed (or copied and pasted) in a console or Telnet window. Both procedures
are described below.
Mode: Configure
Step Command Purpose
1
SN
(cfg)#copy tftp:
licenses:
//tftp-server/path/filename
Downloads the license key file and install the
licenses.
Example: Installing license keys from a TFTP server
The following example shows the command used to install license keys, which are stored in a license file on a
TFTP server.
SN(cfg)#copy tftp://172.16.4.3/keystore/sn1x00_120393.lic licenses:
Mode: Configure
Step Command Purpose
1
node
(cfg)#install license
2 Repeat step 1 for any additional license keys
license-key
Install the license key
Example: Installing license keys from the console
The following example shows the command used to install license keys manually on the console.
SN(cfg)#install license 10011002R1Ws63yKV5v28eVmhDsVGj/JwKqIdpC4Wr1BHaNtenXUYF/
2gNLoihifacaTPLKcV+uQDG8LJis6EdW6uNk/
GxVObDEwPFJ5bTV3bIIfUZ1eUe+8c5OpCCd7PSAe83Ty2c/
CnZPSlEjIrVlJrr8VhOr1DYxkEV9evBp+tSY+y9sCeXhDWt5Xq15SAPlznTLQmym7fDakvm+zltzswX/
KX13sdkR0ub9IX4Sjn6YrvkyrJ2dCGivTTB3iOBmRjV1u
After installing license keys, you can check if the license keys have been added successfully to your system using
the following command.
Mode: Configure
Step Command Purpose
1
node
(cfg)#show licenses Display all installed licenses
Example: Displaying installed licenses
Basic system management configuration task list 97
8 • Basic system management SmartWare Software Configuration Guide
The following example shows the command used to display all installed licenses on a system and a sample of its
output.
SN(cfg)#show licenses
VPN [vpn]
License serial number: 14343534
Status: Active
SN(cfg)#
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.
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 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 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 enterprise-specific MIB supplier object.
98 Basic system management configuration task list
Loading...