vpacket 6100 Series, Hotwire 5100, 5100 Series Reference Manual

Series 5100/6100
Voice/Data Router
Reference Manual
Data Features
Trademarks and copyrights
Vpacket, Vpacket Communications, and the Vpacket 5100/6100 Series Voice/Data Router are registered trademarks of Vpacket Communications, Inc., Milpitas, California.
Vpacket Communications, Inc. does not warrant that the hardware will work properly in all environments and applications, and makes no warranty and representation, either implied or expressed, with respect to the quality, performance, merchantability, or fitness for a particular purpose.
The products and programs described in this document are licensed products of Vpacket Communications, Inc. This document contains proprietary information protected by copyright, and this document and all accompanying hardware, software, and documentation are copyrighted. Vpacket Communications, Inc. has made every effort to ensure that this manual is accurate. However, information in this guide is subject to change without notice and does not represent a commitment on the part of Vpacket Communications, Inc. Vpacket Communications, Inc. makes no commitment to update or keep current the information in this document, and reserves the right to make changes to this manual and/or product without notice. Vpacket Communications, Inc. assumes no responsibility for any inaccuracies and omissions that may be contained in this document. If you find information in this document that is incorrect, misleading, or incomplete, we would appreciate your comments and suggestions.
No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal use, without the express written permission of Vpacket Communications, Inc.
Copyright © 2000-2002 by Vpacket Communications, Inc.™ U.S. Patents Pending. All Rights Reserved. Reproduction or media conversion by any means is protected by copyright and may only occur with prior written permission of Vpacket Communi
cations, Inc.
The PSQM technology included in this product is protected by copyright and by European, US, and other patents, and is provided under license from OPTICOM Dipl. Ing. M. Keyhl GmbH, Erlangen, Germany, 2001
1390 McCarthy Boulevard Milpitas, CA 95035
Tel: 1(866)VPACKET (872-2538) Fax: 1(408)433-5870 E-mail: mail@vpacket.com Web: http://www.vpacket.com
Document title Date issued Product number Release
Vpacket Series 5100/6100 Voice/Data Router Reference Manual (Data Features)
June 2002 750-0025-001, Rev A 2.1.1
Vpacket 5100/6100 Series Voice/Data Router MGCP Telephony Configuration
750-0031-001, Rev A
Vpacket 5100/6100 Series Voice/Data Router SIP Telephony Configuration
750-0032-001, Rev A
Vpacket 5100/6100 Series Voice/Data Router H.323 Telephony Configuration
750-0033-001, Rev A
Vpacket 5100/6100 Series Voice/Data Router Web Interface Manual
750-0035-001, Rev A
About this manual
About this manual
ii Vpacket 5100/6100 Series Reference Manual
Content summary
Vpacket 5100/6100 Series Reference Manual
iii
Audience
This manual is written for the technical staff of a service provider, who are responsible for the installation and configuration of a Vpacket 5100/6100 Voice/Data Router (VDR). These users include, but are not limited to, network technicians, systems administrators, and network operation staff.
Content summary
This manual contains all of the information you need to configure the data features of a 5100/ 6100 VDR. Table 1 lists the chapters and appendixes and a summary of each.
Table 1. Chapter summaries
Chapter title Contents
Chapter 1 System commands Describes how to utilize the command line interface
Chapter 2 User administration Describes how to create and manage user accounts
Chapter 3 Interfaces Describes how to configure the WAN, LAN, and loopback
interfaces
Chapter 4 IP services Describes commands for DNS, DHCP, NTP, SNMP, and RIP
features
Appendix A FTP loader commands
About this manual
iv Vpacket 5100/6100 Series Reference Manual
Conventions
This manual uses typeface, syntax, and messages to alert you to information of special interest.
Typefaces
Table 2 lists the typefaces that are used in this manual.
Command syntax
The syntax of commands is described using the following conventions:
Angle brackets (<fill_in_the_blank >) denote required parameters or arguments.
Square brackets ([ ]) denote optional elements.
A pipe (|) separates choices.
Messages
Notes, cautions, and warnings are posted throughout the manuals to give supplementary information and encourage safety awareness and safe practices.
Notes
Notes are supplemental information requiring your attention.
For example:
Note. Please remember to go to the Vpacket Web site and complete the online Warranty Registration Card. Doing so registers your Vpacket 5100/6100 VDR and allows you to receive the latest information, technical support, and upgrades applicable to your unit.
Table 2. Typefaces and their meanings
Typeface Description
Bold Designates menus, commands, and parameters
Courier Designates output resulting from a command issued by a user and messages
issued via a telnet or terminal-emulation screen
Related documentation
Vpacket 5100/6100 Series Reference Manual
v
Cautions
Cautions are information requiring extra attention.
For example:
Caution. No system-level confirmation message appears during the deletion.
Warnings
Warnings are information that, if not followed, could result in injury or equipment damage.
For example:
Warning. Use of longer screws could result in damage to internal components.
Related documentation
The documentation set related to the Vpacket 5100/6100 VDR includes all documents on the CD-ROM that was shipped with the unit:
Vpacket 5100/6100 Series Voice/Data Router Installer’s Guide, Release 2.1 (P/N 750-00??-001)
•Quick Start Guides
T1 and dual T1 Quick Start Guide
SDSL Quick Start Guide
Ethernet WAN Quick Start Guide
T1-PRI Voice Quick Start Guide
•Vpacket 5100/6100 Series Voice/Data Router Datasheet
The reference manual is broken down into five sections allowing you to print only the sections that apply to your network environment:
Vpacket 5100/6100 Series Voice/Data Router Reference Manual (Data Features)
Vpacket 5100/6100 Series Voice/Data Router MGCP Telephony Configuration
Vpacket 5100/6100 Series Voice/Data Router SIP Telephony Configuration
Vpacket 5100/6100 Series Voice/Data Router H.323 Telephony Configuration
Vpacket 5100/6100 Series Voice/Data Router Web Interface Manual
!
WARNING
About this manual
vi Vpacket 5100/6100 Series Reference Manual
Contact information
For more information about the Vpacket 5100/6100 Series VDRs, please contact us using any of the following methods.
Voice calls
We welcome your calls at 1(866) 872-2538 (VPACKET) Monday through Friday, from 9:00 am to 6:00 pm Pacific Time. Voice mail is available during non-business hours.
E-mail
If you prefer, you can send information requests to our e-mail address: info@vpacket.com
Fax number
You can also send your requests for information to our 24-hour fax number:
1(408) 433-5870
Website
Our website contains valuable information about our products. We encourage you to visit us at http://www.vpacket.com
Contents
Vpacket 5100/6100 Series Reference Manual vii
Chapter 1 System commands 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
System level general commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Setting an alias. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Broadcasting a message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Enabling system enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Exiting a submenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Obtaining help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Viewing command history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Logging out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Sending a message to a specific user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Setting sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Viewing who is logged in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
!x and !! to execute past commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Navigation, memory, and file management commands . . . . . . . . . . . . . . . . . . . . . . . .14
Changing directories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Clearing a configuration, screen, or statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Forcing a configuration change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Deleting a file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Displaying directory contents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Downloading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Executing a script or file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Using FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Creating a directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Using ping to check connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Creating a script for future execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Renaming a file or directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Removing a directory. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Resetting the 5100/6100 VDR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Saving a configuration, image, or file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Tracing a route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Uploading files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Setting system variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Viewing information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
viii Vpacket 5100/6100 Series Reference Manual
CONTENTS
Chapter 2 User administration 41
Defining access privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
User administration commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Setting users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Deleting a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Modifying user password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Modifying the access level of a user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Viewing the User Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Viewing a user’s access level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 3 Interfaces 51
Interface commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Commands common to all interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Setting the IP gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Setting the voice interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Viewing IP addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Viewing an Ethernet macaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Viewing LAN (Ethernet), IP, or WAN statistics . . . . . . . . . . . . . . . . . . . . . . . . . . 60
LAN (10/100BaseT) commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Deleting a LAN IP address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
General WAN commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Setting the IP WAN interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Viewing the WAN T1 configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Viewing WAN statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Viewing the WAN state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
T1 WAN commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Setting the WAN cable length . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Setting WAN circuitname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Setting the WAN clocksource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Setting the T1 WAN data protocol. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting the encapsulation type (T1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Setting the WAN facilities data link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Setting the WAN framing mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Setting the WAN interface type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Setting the WAN linecoding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Setting the WAN loopback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Vpacket 5100/6100 Series Reference Manual ix
CONTENTS
SDSL WAN commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Viewing the SDSL WAN statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Configuring the DSLAM type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuring SDSL WAN encapsulation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuring the WAN data protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Setting the SDSL baud rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Viewing ATM virtual circuits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Adding a virtual circuit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Deleting a virtual circuit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Ethernet WAN commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Loopback interface commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Setting a loopback interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Deleting a loopback interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Viewing the loopback configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Setting the loopback interface to be a NAT outside interface. . . . . . . . . . . . . . . . 91
Network Address Translation (NAT) commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Enabling or disabling NAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Setting a NAT port map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Deleting a NAT port map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Viewing NAT port maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Adding a static IP mapping for NAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Adding a NAT static mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Deleting a static mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Setting the WAN outside address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Viewing the static IP NAT mappings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Access control list commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Adding an access control list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Deleting an access control list entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Viewing an application access control list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Chapter 4 IP services 99
IP service commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
DNS commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Setting a primary DNS server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Setting a secondary DNS server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Setting the DNS client wait time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Viewing DNS information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
x Vpacket 5100/6100 Series Reference Manual
CONTENTS
DHCP commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Setting a DHCP pool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Setting the DHCP mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Setting a DHCP default lease time-out value . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Setting DNS servers for a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Setting a default router for a DHCP pool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Assigning a domain name for a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Setting the IP address range for a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . . 111
Setting the DHCP maximum lease . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Setting the NetBIOS name server for a DHCP pool . . . . . . . . . . . . . . . . . . . . . 112
Setting the Netbios node type for a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . 112
Setting the network address for a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . . 113
Deleting a DHCP pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Viewing DHCP pool information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Setting a DHCP static host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Setting a domain name for a DHCP static host. . . . . . . . . . . . . . . . . . . . . . . . . 115
Setting a DHCP configuration file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Setting the DNS server for a DHCP static host. . . . . . . . . . . . . . . . . . . . . . . . . 116
Setting a network address for a DHCP static host . . . . . . . . . . . . . . . . . . . . . . 116
Setting a hardware address for a DHCP static host . . . . . . . . . . . . . . . . . . . . . 117
Setting the DHCP static host server address . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Deleting a DHCP static host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Viewing DHCP lease information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Viewing DHCP mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
View DHCP server information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Viewing the DHCP static host information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Static routing commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Static routes from the 5100/6100 to the network behind Router ABC . . . . . . . 121
Static routes from the 5100/6100 VDR to a remote server . . . . . . . . . . . . . . . . 122
Adding a static route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Deleting a static route from the routing table . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Viewing the IP configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
RIP commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Enabling and disabling RIP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Viewing RIP status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Application port command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Changing the server application port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Network Timing Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Vpacket 5100/6100 Series Reference Manual xi
CONTENTS
Setting the NTP server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Setting the NTP time zone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Setting the NTP interval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Viewing NTP information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Setting an SNMP community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Deleting an SNMP community . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Setting SNMP trap destinations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Deleting an SNMP trap destination. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Viewing the SNMP trap destination table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Setting the telnet time-out value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
WAN link loss commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Setting the PSTN lifeline. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Viewing the PSTN lifeline status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Appendix FTP loader commands A-1 Index
xii Vpacket 5100/6100 Series Reference Manual
CONTENTS
Contents
1
System commands
Overview, page 2
System level general commands, page 3
Navigation, memory, and file management commands, page 14
CHAPTER 1
System commands
2 Vpacket 5100/6100 Series Reference Manual
Overview
The Command Line Interface (CLI), which contains the software commands to provision, manage, and monitor the physical interfaces and software data features of the 5100/6100 VDR, can be accessed through a serial link to the console port or from a remote telnet session. The CLI follows a specific syntax and recognizes shortcuts.
The CLI has a main level and configuration submenus.
The main level is the entry point where you can access a general set of commands for administrating the 5100/6100 VDR and perform general system-level operations (navigation, enable system features, logout, view directories, and so forth) within the directory file system.
The configuration submenus are a series of extended command sets that are accessed from the system prompt. These submenus can be grouped into the following clusters according to their functions:
System-Level general commands
Navigation, memory, and file management
Many CLI commands require text or numerical parameters as part of the command. These fields are either required or optional, depending on how the information is punctuated. Table 1-1 lists the different punctuation and meanings.
Table 1-1. CLI syntax markers
Marker Meaning
( ) For example: (set user)
You can enter a submenu by entering the first one or two words of a command and then pressing the Enter key. If you are defining many parameters without interruption, using a submenu can save you time from repeatedly entering the first few words of a command. You must enter the exit command to exit the submenu.
< > For example: <username>
You must enter the required information.
[ ] For example: [access_level]
You are not required to supply input; this input is optional. Optional parameters come with preset configurations. Changes are only required to meet the needs of your network.
| For example: 1483Bridged | 1490Bridged | 1490Routed
A pipe separates mutually exclusive choices.
System level general commands
Vpacket 5100/6100 Series Reference Manual 3
Commands can be issued from either the top-level prompt, a submenu, or in some cases from the FTP loader. Table 1-2 gives examples of command prompts and shortcuts.
You can request help at any time by entering help or ?. A partial command, space and then a question mark will also yield a help menu. The next sections list, define, and give examples of the CLI commands.
System level general commands
The system level general commands affect the operation of the CLI. They are not directly related to 5100/6100 VDR configuration. They do not display when a general help request is made; however, each has its own help text.
You can view the general commands by entering one of the commands and then issuing the help or ? commands. Table 1-3 lists the system level general commands, a brief description of each command, and a page where you can obtain more information.
Table 1-2. Command prompts
Access prompt Example
Default
Vpacket # set user add ?
Submenu
Vpacket (set user)# add
Shortcut at default Vpacket # show uni
(instead of entering)
show unitInformation
FtpLoader
FtpLoader(2)> show config info
Table 1-3. System-level general commands
Command Description See...
alias Permits text substitution page 4
broadcast Writes a message to all users logged in page 4
enable Configures system actions (engineering, log, more, support) page 4
exit Exits the current submenu level page 8
help Displays help for a general and specific commands page 8
history Displays a sequence of the last 30 commands page 10
logout Logs out of the current session page 10
CHAPTER 1
System commands
4 Vpacket 5100/6100 Series Reference Manual
Setting an alias
You can set an alias by issuing the alias command. This command allows you to customize the commands that you can enter to manage the 5100/6100 VDR.
Syntax: alias <string1> <string2>
Argument:
string1 the alias that you want to set
string2 the command that string1 represents; quotations are necessary around
commands that contain spaces
Example:
In this example, an alias is set so that when a user wants to list the contents of a directory, the user only has to enter “showme,” which might be more meaningful to the user than entering the dir command.
Broadcasting a message
You can send a message to all users who are logged-on by issuing the broadcast command. This command is available for user or admin access level.
Syntax: broadcast <string>
Argument:
string a message, enclosed in quotation marks, that you want sent to the users who are
currently logged on to a 5100/6100 VDR
sendtext Writes text to another user page 11
sleep Forces the console to not accept input for a set number of seconds page 12
who Displays users currently logged in page 12
!x or !! Executes the command given in the history list
(! <number> or !!)
page 13
VPacket# alias showme dir VPacket#
Table 1-3. (continued) System-level general commands
Command Description See...
System level general commands
Vpacket 5100/6100 Series Reference Manual 5
Example:
In this example, an administrator sends the message “testing to begin in 10 minutes” to other users who may also be logged on at the same time.
Enabling system enhancements
You can enable system enhancements by issuing one or more of the enable commands:
enable engineering
enable log
enable more
enable support
enable thishelp
enable engineering
This command provides access to additional commands but activation of the enable engineering command requires a password that can only be supplied by Vpacket Customer
Support.
Syntax: enable engineering <password>
Arguments:
password is a secret alphanumeric key provided by Customer Support personnel
Example:
You need to contact Vpacket Customer Support to enable this feature.
VPacket# broadcast "testing to begin in 10 minutes"
testing to begin in 10 minutes
VPacket#
VPacket# enable engineering let_me_in Incorrect password for this feature VPacket#
CHAPTER 1
System commands
6 Vpacket 5100/6100 Series Reference Manual
enable log
You can record a session in a text file for later review by issuing the enable log command. The no enable log command disables this feature.
Syntax:
enable log < input | output | both >
no enable log
Arguments:
input | output | both input records only the commands you enter; output records
only the output generated by the 5100/6100 VDR; both records input and output
Example:
In this example, the log is enabled to record only the administrator’s input and not messages generated by the 5100/6100 VDR unit.
enable more
You can enable or disable the pagination of command output in excess of 24 lines for a telnet client by issuing the enable more command. When active, the message “Press any key to continue (Q to quit)” is displayed on the screen. The no enable more command disables this feature.
Syntax:
enable more
no enable more
Example:
In this example, the unit displays all information in a telnet session and paginates the information in groups of 24 lines. The prompt “press any key to continue” will appear for information in excess of 24 lines.
VPacket# enable log input VPacket#
VPacket# enable more VPacket#
System level general commands
Vpacket 5100/6100 Series Reference Manual 7
enable support
This command provides access to additional support commands by issuing the enable support command. The password can only be supplied by Vpacket Customer Support.
Syntax: enable support <password>
Argument:
password is a secret alphanumeric string provided by Customer Support
Example:
You need to contact Vpacket Customer Support to enable this feature.
enable thishelp
You can enable or disable the inclusion of the command help above the list of arguments or parameters by issuing the enable thishelp or no enable thishelp commands. By default, the help definition for each command keyword appears above the list of parameters or arguments. Issuing the no enable thishelp command results in the immediate removal of the command help definition.
Syntax:
enable thishelp no enable thishelp
Example:
In this example, the help to set an access list is viewed first with enable thishelp (default) and includes the help definition of “acl”. Next, the help definition for all commands is disabled. The help for an access list is viewed again; and this time, the help only includes the next sequential words to complete the command syntax to add or delete an access list.
VPacket# enable support let_me_in Incorrect password for this feature VPacket#
VPacket# set acl ? acl - Set access control list add - Add entries to access control list delete - Delete entries from access control list VPacket# set acl VPacket# no enable thishelp VPacket# set acl ? add - Add entries to access control list delete - Delete entries from access control list VPacket# set acl
CHAPTER 1
System commands
8 Vpacket 5100/6100 Series Reference Manual
Exiting a submenu
You can move to the next higher level of the menu interface by issuing the exit command. If you issue exit, you will move the user command up one level in the menu structure; or you can issue exit all to move immediately to the top-level menu. The keyboard shortcut is Control+Z.
Syntax:
exit
exit all
Example:
In this example, after setting a WAN interface, the exit command is issued, which brings the administrator out of the IP set commands but still allows the administrator to issue any set command.
Obtaining help
You can obtain two types of help.
Help
You can read a description of each command and view appropriate arguments or parameter choices by entering help and then the name or part of a command.
Syntax: help <command>
Example:
In this example, the user wanted to access a DHCP command. By entering help set dhcp and then pressing Enter, a list of appropriate commands appeared and each command is paired with a brief description of what the whole command does.
VPacket(set->ip)# wan 172.57.35.6 255.255.255.240 VPacket(set->ip)# exit VPacket(set)#
VPacket# help set dhcp delete - Delete a Pool or Static Host entry mode - Select the DHCP Mode pool - Name of Pool server - server specific information static_host - Name of Static Host VPacket#
System level general commands
Vpacket 5100/6100 Series Reference Manual 9
Help edit
You can view the list of keystrokes by issuing the help edit command.
Syntax: help edit
Example:
In this example, the editing keystrokes are shown.
VPacket# help edit
Available editing keystrokes
Delete current character.....................Ctrl-d
Delete text up to cursor.....................Ctrl-u
Delete text after cursor.....................Ctrl-k
Move to beginning of line....................Ctrl-a
Move to end of line..........................Ctrl-e
Get prior command from history...............Ctrl-p
Get next command from history................Ctrl-n
Move cursor left.............................Ctrl-b
Move cursor right............................Ctrl-f
Move back one word...........................Esc-b
Move forward one word........................Esc-f
Convert rest of word to uppercase............Esc-c
Convert rest of word to lowercase............Esc-l
Delete remainder of word.....................Esc-d
Delete word up to cursor.....................Ctrl-w
Transpose current and previous character.....Ctrl-t
Enter command and return to root prompt......Ctrl-z
CHAPTER 1
System commands
10 Vpacket 5100/6100 Series Reference Manual
Viewing command history
You can view a list of the last 30 commands issued by issuing the history command. They are numbered in reverse-sequential order so the highest-numbered is the most recently issued. Use these numbers with the !x or !! command to employ command shortcuts.
Syntax: history
Example:
In this example, the only seven commands that were issued appear in order from first to last. Typographical errors also appear (see command number 6).
Logging out
You can exit the current session by issuing the logout command. This command can only be issued from the top-level menu.
Syntax: logout
Example:
In this example, the user is logged out of the system. A complete logout elicits a “Login” prompt.
VPacket# history 1 show ip 2 show dhcp 3 mode 4 exit 5 broadcast "Testing to begin in 10 minutes. Please log off." 6 history] 7 history VPacket#
VPacket# logout Login:
System level general commands
Vpacket 5100/6100 Series Reference Manual 11
Sending a message to a specific user
You can send a message to a specific user who is currently logged into the system by issuing the sendtext command. The message must be enclosed within quotations marks.
Syntax sendtext <username> <string>
Arguments:
username the name of the person you want to send a message to; 15 characters or less; no
spaces
string the message, enclosed in quotation marks
Example from administrator:
Message received on user terminal:
In this example, a request sent to the default “user” to logout is sent. The user had just logged in and then the administrator send the message to logout, which was immediately sent to the user’s terminal.
VPacket# sendtext user "please logout" VPacket#
Login: user Password:
VPacket# please logout
CHAPTER 1
System commands
12 Vpacket 5100/6100 Series Reference Manual
Setting sleep
You can force the 5100/6100 VDR to sleep for a defined number of seconds by issuing the sleep command.
Caution. If the time you enter is too long for your needs, you must power cycle the 5100/6100 VDR to escape.
Syntax: sleep <number of seconds>
Argument:
number of seconds the amount of time you want the 5100/6100 VDR CLI; to
escape you have to hard boot the 5100/6100 VDR
Example:
In this example, the 5100/6100 VDR is set to sleep for 60 seconds. When it comes back online a “wake up” message appears.
Viewing who is logged in
You can view who is logged in and by what means they are connected to the 5100/6100 VDR by issuing the who command.
Syntax: who
Example:
In this example, this table shows that one active console session is in progress and that the user is an admin. A second user is logged in from IP address 172.16.1.231.
VPacket# sleep 60 Going to sleep for 60 seconds. Wake up!
VPacket# who
internal Console
admin Console
user 172.16.1.231
VPacket#
!
System level general commands
Vpacket 5100/6100 Series Reference Manual 13
!x and !! to execute past commands
These two shortcut commands can be used in conjunction with the history command to force the execution of specific commands. !! forces execution of the last action in the history list and ! accompanied by a command number from the history list executes the specified command. Both commands are valid for the current active session.
Syntax: !<x>
Argument:
x is the number of the command as shown in the command history list
Example:
In this example, !7 forces execution of command number 7 in the history list, which in this case was show ip.
VPacket# !7 VPacket# show ip ACTIVE indicates this is the current operational setting CONFIG indicates this has been configured but not activated
-------------------------IP INTERFACE---------------------­ INTERFACE NAME IP ADDRESS NET MASK ACTIVE ethernet 10.10.10.254 255.255.255.0 CONFIG wan 205.176.94.11 255.255.255.0 CONFIG Default Gateway 10.10.10.254 ACTIVE Voice Ip Address 205.176.94.11
----------------------------------------------------------­VPacket#
CHAPTER 1
System commands
14 Vpacket 5100/6100 Series Reference Manual
Navigation, memory, and file management commands
Table 1-4 lists the navigation and file management commands available at the top-level of the CLI. After the table you can read a detailed description of these commands and their functions.
These commands affect the component configuration and permit access to sets of subcommands. For example, “set” accesses a submenu you use to configure IP and WAN interfaces, and so on. Such commands are marked with italics in the command listing.
Table 1-4. Navigation, memory, and file management commands
Command Description See...
cd Changes directory location page 15
clear Clears/empties the screen, configuration or statistical
buffers
page 16
commit Forces a configuration change page 16
delete Deletes a file from the file system page 18
dir Lists the files in Flash memory page 19
download Downloads a file, including the operating code or
configuration image files, from a host to the Flash memory
page 19
execute Reads and executes an ASCII script file of CLI commands page 20
ftp Performs FTP client mode operations page 21
mkdir Creates a directory within the current file system page 21
ping Issues ICMP packets to evaluate link stability page 22
record Records the command line entries to a file for running in
the future rather than execute as soon as entered
page 22
rename Renames a file page 24
reset Resets the system page 25
rmdir Deletes a directory page 24
route Add and delete static route information page 120
save Saves the current configuration to Flash memory page 26
set Sets the value of configuration parameters page 29
Navigation, memory, and file management
Vpacket 5100/6100 Series Reference Manual 15
Changing directories
You can change your location within the directory system by issuing the cd command. The 5100/ 6100 VDR contains three directories: \maincode, \config, and \tracelog. You may add other directories for storing files and logs using the mkdir command. See page 21 for more information.
Syntax: cd <directoryname>
Argument:
directoryname a backslash followed by an up to 8-character name of the directory you
want to enter; characters can include letters, numbers, or the _ character
Example:
In this example, the 5100/6100 VDR changed from the one directory to the maincode directory.
show Displays configuration parameters page 35
telephony A shell that does no interpretation of entry and passes the
data entered to the telephony interface
telephony section(s)
traceroute Traces a route to a host page 27
upload Uploads a file, including operating code or configuration
images to a network host
page 28
VPacket# cd maincode Changed to directory maincode VPacket#
Table 1-4. (continued) Navigation, memory, and file management commands
Command Description See...
CHAPTER 1
System commands
16 Vpacket 5100/6100 Series Reference Manual
Clearing a configuration, screen, or statistics
You can clear or empty various counters or displays by issuing a clear command.
clear screen
You can clear the current viewing surface without interrupting the current session by issuing the clear screen command.
Syntax: clear screen
clear stats
You can clear all of the statistical counters or selected statistics by issuing the clear stats command.
Syntax: clear stats <all | ethernet | ip | wan>
Arguments:
all deletes all statistics on the 5100/6100 VDR
ethernet deletes only the Ethernet statistics on the 5100/6100 VDR
ip deletes only the IP statistics on the 5100/6100 VDR
wan deletes only the WAN statistics on the 5100/6100 VDR
Example:
In this example, the WAN stats are cleared.
Forcing a configuration change
You can force a change to the currently running configuration file by issuing one or more of the commit commands:
•commit
•commit atm
•commit dhcp
•commit IP
commit t1
VPacket# clear stats wan VPacket#
Loading...
+ 156 hidden pages