Page 1 CommWorks 5210 IP Telephony Manager User Guide Release 2.3 Part Number 10044879...
Page 3 CommWorks 5210 IP Telephony Manager User Guide Release 2.3 Part Number 10044879...
Page 4 Copyright © 2001, 3Com Corporation. All rights reserved. No part of this documentation may be reproduced in any form or by any means or used to make any derivative work (such as translation, transformation, or adaptation) without written permission from 3Com Corporation.
Page 5: Table Of Contents
ONTENTS ONTENTS BOUT UIDE Finding Information...xiii Conventions...xiv Related Documentation...xiv Contacting CommWorks ... xv NSTALLATION Overview ...17 Management Workstation...18 Prerequisites ...18 Before You Begin...19 Removing Previous Versions...20 Option 1 ...20 Option 2 ...20 Installing IP Telephony Manager...20 Setting PATH and LD_LIBRARY_PATH ...21 Starting IP Telephony Manager ...22 Connecting to Entities ...22 Determining Gatekeeper and Media Gateway Connectivity ...23...
Page 6 Auto Response ... 31 AutoResponse Configuration ... 31 Setting Authorized Stations... 32 Defining a Range of IP Addresses for Authorized Access ... 34 Threshold Monitoring Configuration ... 34 Adding a Threshold Parameter ... 37 Editing a Threshold Parameter... 40 Threshold Traps... 42 Saving and Restoring Configurations...
Page 7 AINTENANCE Upgrading Software ...69 Software Upgrade Methods ...70 Upgrading the Software ...71 Command Tool...73 Launching the Command Tool...73 Card-Level vs. Channel-Level Commands...73 Command Window...73 Restarting Other Entities ...75 Restarting after Parameter Changes ...76 Setting Manual Switchovers ...77 Changing the SNMP Community Strings ...78 Clearing Authorized Access Lists...80 Displaying Inventory Information ...81 RROR...
Page 8 viii OMMAND General Syntax... 101 IP Telephony Manager Console ... 104 Configuration ... 105 Actions/Commands... 109 Query Current Command Status (-q)... 109 Set Trap Destination ... 110 To Add a Trap Destination Entry (-a) ... 110 To Modify a Trap Destination Entry (-m) ... 110 To Delete a Trap Destination Entry (-d) ...
Page 9 IST OF ABLES Table 1 Content Description... xiii Table 2 Notice Icon Description ... xiv Table 3 Text Convention Descriptions... xiv Table 4 Management Software ... 18 Table 5 Hardware Prerequisites ... 18 Table 6 Software Prerequisites ... 19 Table 7 Files added to HP OpenView Windows Directories ... 27 Table 8 Threshold Monitor Configuration Fields ...
Page 10 IST OF Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Configuring Thresholds Window ...35 Figure 11 Selecting an Entity Window ...38 Figure 12 Parameter Group Selection Window ...38 Figure 13 Configuring Thresholds Window ...39 Figure 14 Adding Threshold Parameters Window ...40 Figure 15 Selecting an Entity Window ...40...
Page 11 Figure 54 Community String Warning Message ...79 Figure 55 Device Details Dialog Box ...79 Figure 56 Inventory Window ...81...
Page 13: About This Guide
About This Guide contains an overview of the IP Telephony Manager User Guide, describes where to find specific information, lists conventions and related documentation, and explains how to contact CommWorks Corporation. This guide describes how to install, configure, and operate IP Telephony Manager, as well as how to use it to troubleshoot and maintain components of the CommWorks IP Telephony Platform.
Page 14: Conventions
BOUT UIDE Conventions The following tables list conventions in this guide. Table 2 Notice Icon Description Icon Table 3 Text Convention Descriptions Convention Text represented as a screen display Text represented as menu or sub-menu names. Text represented by <filename> Related The following documents contain information about the components of the Documentation...
Page 15: Contacting Commworks
Contacting For information about Customer Service, including support, training, code CommWorks releases and updates, contracts, and documentation, visit our website at http://totalservice.commworks.com. Refer to the Documentation CD-ROM for information about product warranty. Before contacting CommWorks Technical Support, have this information available: CommWorks IP Telephony Parameter (MIB) Reference Guide CommWorks IP Telephony Trap (Alarm) Reference Guide...
Page 17: Installation
CommWorks Network Application Cards (NACs) and Network Interface Cards (NICs) through a Network Management Card (NMC) installed on the CommWorks 5210 IP Telephony Platform. Two protocols govern these management functions: Simple Network Management Protocol (SNMP) between the NMC and the management station, and a proprietary CommWorks protocol between the NMC and the managed cards.
Page 18: Management Workstation
1: I HAPTER NSTALLATION The management station uses Management Information Bases (MIBs), defined for each card in the hub, to issue commands to the NMC. The NMC executes the commands and obtains the results using a proprietary CommWorks protocol. The NMC uses SNMP to send these results to the management station.
Page 19: Before You Begin
Table 5 Hardware Prerequisites (continued) Operating System HP Platform Table 6 lists the software requirements needed to achieve the best performance from IP Telephony Manager. Table 6 Software Prerequisites Operating System SUN Platform HP Platform If you are installing HP OpenView for the first time, temporarily disable autodiscovery.
Page 20: Removing Previous Versions
1: I HAPTER NSTALLATION If you are using HP OpenView, you must install it before you install IP Telephony Manager. If not, HP OpenView does not integrate correctly. Make sure IP Telephony Manager and HP OpenView are installed on the same system.
Page 21: Setting Path And Ld_Library_Path
8 From the command line prompt, type the following commands and press Return after each: TCMHOME=<installation directory> (for example, /opt/tcm) export TCMHOME mkdir -p $TCMHOME cd cdrom/cdrom0/tcm_sol (for HP, tcm_ux) ./install A message appears: The script will make adjustments, only as needed, to system files in /etc/imit.d, the crontab, /etc/services, and /usr/lib/x11.
Page 22: Starting Ip Telephony Manager
1: I HAPTER NSTALLATION Starting IP Telephony After you complete the installation and modify the path statement, you can Manager start IP Telephony Manager. To start the IP Telephony Manager, from the command line prompt, type one of these commands: # xtcmvfpd # xtcmvfpd <target chassis IP address>...
Page 23: Determining Gatekeeper And Media Gateway Connectivity
1 Using IP Telephony Manager Console window, select the edge server card. 2 On the menu bar, select Performance and then Performance Monitor. The Select Entity window appears. 3 Select the entity 3Com Gateway and then click OK. The Performance window appears. Figure 1 Performance Window 4 Select Gatekeepers from the Functional Group.
Page 24: Integrating With Hp Openview
1: I HAPTER NSTALLATION Integrating with HP The IP Telephony Manager installation script installs OpenView integration files OpenView to the appropriate OpenView Network Node Manager subdirectories. OpenView integration occurs as part of the IP Telephony Manager installation, when the OpenView environmental variables are set beforehand. To integrate IP Telephony Manager with OpenView manually, follow the procedure below.
Page 25: Removing Hp Openview Integration
If CommWorks devices were populated in OpenView before IP Telephony Manager was installed, the network map will not display the CommWorks bitmaps correctly after IP Telephony Manager integration. This occurs even if the CommWorks menu options are not enabled and the isUSREntNetHub capability is not set to True.
Page 26: Linking Commworks Objects
1: I HAPTER NSTALLATION Linking CommWorks If you choose to install HP OpenView, you must install it before IP Telephony Objects Manager. This lets you start IP Telephony Manager directly from HP OpenView. To link CommWorks objects in HP OpenView to IP Telephony Manager, use the following procedure.
Page 27: Configuration
This chapter describes how to configure CommWorks IP Telephony Manager. This chapter contains the following topics: Refer to Chapter 3 for a complete description of the IP Telephony Manager menus. Unless otherwise specified, this document uses the generic term edge server to refer to either the edge server card or the EdgeServer Pro card.
Page 28: Component Configuration
2: C HAPTER ONFIGURATION Component The IP Telephony Manager Console window is used to select target Configuration components whenever you are performing configuration, sending commands, or upgrading components through software download. Launching the There are two ways to launch the Configuration Tool: Configuration Tool Synchronizing You must synchronize the system time of each component in the network...
Page 29: Selecting Public Ntp Servers
Selecting Public NTP Servers 1 From any computer with internet access, access the following website: http://www.eecis.udel.edu/~mills/ntp/clock1.htm 2 From the website, record the IP addresses for two separate active servers. One is used as the primary NTP server, and the other is used as the secondary NTP server.
Page 30: Setting The Ntp Parameters For The Other Entities
2 Select the server icon. 3 Select Configuration, then Programmed Settings from the IP Telephony Manager Console window. 4 Select 3Com SNMP Agent from the Select Entity drop-down list. 5 Click OK. 6 Select Network Time Protocol. A window similar to the following appears:...
Page 31: Autoresponse
Auto Response AutoResponse lets network managers define a set of actions (auto response script) to be taken automatically when a specified event occurs in the chassis. The event may be specific to a particular module (NAC or NMC) in a given slot of the chassis, or specific to a particular entity (such as a single modem channel).
Page 32: Setting Authorized Stations
2: C HAPTER ONFIGURATION 3 Select the event from the Event drop-down list. 4 Select what you want the system to do when the selected event occurs from the Available Responses list and click Add. The response is added to the Responses Configured list box. 5 Click OK.
Page 33: Figure 6 Authorized Stations Add Window
Figure 6 Authorized Stations Add Window 4 In the Add dialog box, enter the IP address for the workstation you are currently working from and click OK. The Authorized Stations Completion window appears with the newly added IP addresses listed. Figure 7 Authorized Station Completion Window For information about setting the network mask, refer to IP Addresses for Authorized Access...
Page 34: Defining A Range Of Ip Addresses For Authorized Access
(For the Media Gateway, you need to select the edge server card.) 2 From the Configuration menu, click Programmed Settings. 3 Select the 3COM SNMP SubAgent from the Select Entity window (For Back-end Servers and the Gatekeeper, select 3Com SNMP Agent.) and click...
Page 35: Figure 9 Parameter Group Selection Window
Threshold Monitoring Configuration Figure 9 Parameter Group Selection Window The Threshold Monitor Configuration window appears. Figure 10 Configuring Thresholds Window...
Page 36: Table 8 Threshold Monitor Configuration Fields
2: C HAPTER ONFIGURATION The following table contains the fields and the values of the Configuring Threshold window. Table 8 Threshold Monitor Configuration Fields Field Name Threshold Object Threshold Alias Threshold Period Threshold Type Threshold Alarm Value Threshold Alarm Clear Value Description Possible Selections...
Page 37: Adding A Threshold Parameter
(For the Media Gateway, you need to select the edge server card.) 2 From the Configuration menu, click Programmed Settings. 3 Select the 3COM SNMP SubAgent from the Select Entity window (For Back-end Servers and the Gatekeeper, select 3Com SNMP Agent.) and click...
Page 38: Figure 11 Selecting An Entity Window
2: C HAPTER ONFIGURATION Figure 11 Selecting an Entity Window 4 From the Parameter Group Selection window, select Threshold Monitor Configuration. Figure 12 Parameter Group Selection Window The Threshold Monitor Configuration window appears.
Page 39: Figure 13 Configuring Thresholds Window
Figure 13 Configuring Thresholds Window 5 Configure the fields in the Configuring Threshold window as needed. Refer to Table 8. Click Set. 6 Set Threshold Row Status to createAndGo. As shown in the following figure. Adding a Threshold Parameter...
Page 40: Editing A Threshold Parameter
(For the Media Gateway, you need to select the edge server card.) 2 From the Configuration menu, click Programmed Settings. 3 Select the 3COM SNMP SubAgent from the Select Entity window (For Back-end Servers and the Gatekeeper, select 3Com SNMP Agent.) and click Figure 15 Selecting an Entity Window in Chapter 4 for more information.
Page 41: Figure 16 Parameter Group Selection Window
Editing a Threshold Parameter 4 From the Parameter Group Selection window, select Threshold Monitor Configuration. Figure 16 Parameter Group Selection Window The Threshold Monitor Configuration window appears. Figure 17 Configuring Thresholds Window...
Page 42: Threshold Traps
2: C HAPTER ONFIGURATION 5 Set Threshold Row Status to notinsservice. 6 Change the configuration as you need, refer to 7 Set the Threshold Row Status to active. The following figure shows the Threshold Parameter drop-down list. Figure 18 Editing Threshold Parameters Window 8 Click Set.
Page 43: Saving And Restoring Configurations
Saving and Restoring The Save configuration utility performs a discovery of the configuration of a Configurations device and saves it to a file. After it is saved to a file, the Restore configuration utility is used to restore the configuration to that device, or it can be used to apply the file to other devices with similar components.
Page 44: Restoring A Chassis Configuration From Nvram
2: C HAPTER ONFIGURATION Figure 19 Save Chassis NVRAM Dialog Box 2 Enter or select the .nvr file you are saving to and click OK. The default directory for .nvr files is: $TCMHOME/data/nvram/. If you are saving or restoring from the command line and you are not using the x prefix option, progress is reported as status messages on screen.
Page 45: Component Save To Nvram
Figure 20 Restore Chassis NVRAM Dialog Box 2 Enter or select the .whb file you are restoring from and click OK. The default directory for .nvr files is: $TCMHOME/data/nvram/. If you are saving or restoring from the command line and you are not using the x prefix option, progress is reported as status messages on screen.
Page 46: Nmc Save Chassis To Nvram
2: C HAPTER ONFIGURATION Not all components support the Save to NVRAM feature. For those that support this feature, the HIPer DSP and NMC cards, you must select the right command type and group. For example, the modem software command group is available only when you select modems at the channel level, as opposed to selecting the whole card.
Page 47: Restoring A Configuration From Cfm
Figure 21 Save Chassis CFM Dialog Box 3 Enter or select the .cfm file you are saving to and click OK. The default directory for .nvr files is: $TCMHOME/data/nvram/. If you are saving or restoring from the command line and you are not using the x prefix option, progress is reported as status messages on screen.
Page 48: Figure 22 Restore Chassis Cfm Dialog Box
2: C HAPTER ONFIGURATION Figure 22 Restore Chassis CFM Dialog Box 2 Enter or select the .cfm file you are restoring from and click OK. The default directory for .cfm files is: opt/tcm/data/cfm/tch. If you are saving or restoring from the command line and you are not using the x prefix option, progress is reported as status messages on screen.
Page 49: Navigating And Using The System
This chapter describes the menus in the IP Telephony Manager. The function of the menus can vary depending on the component, if that is the case, then you are referred to that individual component’s user manual. This chapter contains the following topics: As an example, the descriptions in this section pertain to the CommWorks IP Telephony Media Gateway.
Page 50: Figure 23 Ip Telephony Manager Console Window
3: N HAPTER AVIGATING AND SING THE Figure 23 IP Telephony Manager Console Window The IP Telephony Manager Console window contains a graphical representation of the Total Control chassis. The view can be changed by the View menu to see the front or back of the chassis. Select the area of the chassis on the IP Telephony Manager Console window on which you want the function to be performed, then select the function from the main menu bar.
Page 51: Figure 24 Ip Telephony Manager Server Window
Accessing IP Telephony Manager Window Figure 24 IP Telephony Manager Server Window To perform a function on the Gatekeeper, SIP Proxy Server, or Back-end Server, click on the server icon and simply choose the command from the main menu. The remainder of this section describes the functions located on the main menu.
Page 52: File Menu
3: N HAPTER AVIGATING AND SING THE YSTEM File Menu The file menu is used to open devices on the system, save and restore configurations, and to import Software download files. Figure 25 shows an example of the File menu from the Media Gateway. Figure 25 File Menu Open Submenu The Open submenu displays the Device List window.
Page 53: Save Chassis Nvram Submenu
Save Chassis NVRAM The Save Chassis NVRAM submenu saves the Media Gateway chassis Submenu configuration to a specific file on NVRAM. Refer to Chapter 2 for more information on saving the chassis to NVRAM (IP Telephony Manager Chassis Console only). Restore Chassis NVRAM The Restore Chassis NVRAM submenu restores the Media Gateway chassis Submenu...
Page 54: View Menu
3: N HAPTER AVIGATING AND SING THE View Menu The View menu lets you adjust the way IP Telephony Manager displays the console or server window. Figure 28 View Menu Other Side Submenu The Other Side submenu displays the reverse side of the chassis. This guide shows the front panel of the chassis.
Page 55: Figure 30 Icon View Window
View Menu Figure 30 Icon View Window The first icon displays the Command Tool dialog box for the chosen entity. The second icon displays the Configuration menus. The third icon displays the software download dialog box for the selected entity. The forth icon displays diagnostics information for the selected entity.
Page 56: Configuration Menu
3: N HAPTER AVIGATING AND SING THE YSTEM Configuration Menu The Configuration menu is used to set the VoIP chassis to your environment requirements. Figure 31 Configuration Menu Programmed Settings The Programmed Settings submenu displays the Configuration Tool window Submenu for the selected entity.
Page 57: Figure 32 Edgeserver Pro Card Parameter Group Window
Figure 32 EdgeServer Pro Card Parameter Group Window The Configuration Tool menu contains the following fields: Selected targets—The name of the target to be configured from this menu that was selected from the IP Telephony Manager chassis or server. Displays the slot and channel numbers of the selected components. For example, S4C1-30 means that channels 1-30 of the component in slot 4 of a device has been selected.
Page 58: Figure 33 Example Of Hiper Dsp Modem Identification Configuration Table
3: N HAPTER AVIGATING AND SING THE Figure 33 Example of HiPer DSP Modem Identification Configuration Table Click on the cell with the setting you want to edit. If a value is read-only, the cursor changes to the “No” sign when placed over the cell. If the value can be modified, an arrow appears in the value field.
Page 59: Action/Commands Submenu
Exit—Closes the window and displays the previous window. Adjusting Column Width—You can adjust the column width using the mouse. Place the cursor over the column divisor line until it changes to a bar and arrow, then click and drag the line left or right. Action/Commands The Action/Commands submenu displays the Command Tool window for the Submenu...
Page 60: Software Download Submenu
3: N HAPTER AVIGATING AND SING THE Execute—Executes the selected command for the selected targets. Close—Closes the Command Tool window. Software Download The Software Download submenu displays the files to be downloaded for the Submenu specified entity. You then select the files you need to be downloaded. Refer to Chapter 4 for more information.
Page 61: Autoresponse Submenu
For example, 0000000010010000 means that DIP switches 8 and 5 are ON and all others are off. Software Version—Version of software currently installed in the component's flash RAM. You can perform the following tasks from this window: Save—Saves the inventory data table to an ASCII text file. Exit—Closes the inventory utility.
Page 62: Figure 37 Auto Response Window
3: N HAPTER AVIGATING AND SING THE Figure 37 Auto Response Window The AutoResponse dialog box contains the following fields and buttons: Selected Targets—This box shows the slot(s) or channel(s) selected in the chassis display. Event—Click this box to select an event. If you select an event that requires a descriptor, make sure that you have programmed the descriptor.
Page 63: Fault Menu
Fault Menu Fault Menu The Fault menu lets you enable/disable traps and define the trap’s destination. Figure 38 Fault Menu Trap Settings Submenu The Trap Setting submenu defines the traps for the specified entity. Refer to the individual component user guide for information about setting this for your VoIP component.
Page 64: Trap Destination Submenu
3: N HAPTER AVIGATING AND SING THE Trap Destination The Trap Destination submenu defines and modifies where the traps are sent. Submenu Refer to the individual component user guide for information about setting this for your VoIP component. Figure 40 Trap Destination Window Performance Menu The Performance menu lets you define the events on your system that IP Telephony Manager is to monitor.
Page 65: Security Menu
Security Menu Figure 42 Performance Monitor Menu After you click OK, a table, or graph appears showing the events you selected in real time mode. Security Menu The Security menus lets you set the SNMP community strings and maintain the management capabilities at the selected station.
Page 66: Community Names Submenu
3: N HAPTER AVIGATING AND SING THE Community Names The Community Names submenu lets you set the SNMP community strings. Submenu The IP Telephony Manager default value for SNMP community string is public for read only and private for read-write. To change the default values, you must first change the community string on the devices and then on IP Telephony Manager.
Page 67: Figure 45 Authorized Stations Add Window
Modify— Brings up a dialog box for changing the network mask or comment for the selected device. (You must select an entry from the list before using this button.) Delete—Deletes the selected entry. When you click Add, the Authorized Stations Add dialog box appears. Figure 45 Authorized Stations Add Window The Authorized Stations Add window contains the following fields: Destination IP—Displays the IP address of the authorized station.
Page 69: Maintenance
This chapter describes how to use IP Telephony Manager to upgrade software and perform general maintenance tasks on CommWorks IP Telephony Platform cards. This chapter contains the following topics: Unless otherwise specified, this document uses the generic term edge server to refer to either the edge server card or the EdgeServer Pro card.
Page 70: Software Upgrade Methods
4: M HAPTER AINTENANCE Back-end Servers: CommWorks SNMP SubAgent OOBMan Provisioning Server Directory Mapping Server Accounting Server Billing Support Server Remote upgrades of the above listed firmware cards are also accomplished through the use of SDL-2. SMS is no longer used for this purpose. Software Upgrade You can transfer and install upgrade files by any of the following methods: Methods...
Page 71: Upgrading The Software
Extracts the CAB file from the DMF file. Extracts the installation files from the CAB file. Runs the setup. Table 9 lists a comparison of the installation methods. Table 9 Upgrade Option Comparison Option IP Telephony Manager Serial Connection MIB Browser / TFTP Server Upgrading the After you have decided what method you want to install the upgrades, you are Software...
Page 72: Figure 46 Software Download Dialog Box
4: M HAPTER AINTENANCE If you do not have unzip capabilities on your UNIX system, you can download the freeware from the internet and install it on your system. 3 Select the component to which you want to download software. The Media Gateway, Gatekeeper, SIP Proxy Server or select the Back-end Server.
Page 73: Command Tool
When the software download is complete, a green box appears under the command status. 9 Click OK when finished. Command Tool The Command Tool is used to perform hardware and software commands on a selected component, such as busy-out, disconnect, reset, or save to NVRAM. As an example, the procedures in this section refer to the CommWorks IP Telephony Media Gateway.
Page 74: Figure 48 Example Hiper Dsp Hardware Commands
4: M HAPTER AINTENANCE Figure 48 Example HiPer DSP Hardware Commands Figure 49 shows the software commands that can be executed for the HiPer DSP card. Figure 49 Example HiPer DSP Software Commands 1 Select the type of command you want to perform from the Command to Execute or Category drop-down boxes.
Page 75: Restarting Other Entities
Figure 50 Example Media Gateway Command Status Color Codes Restarting Other You can restart the Gatekeepers, Back-end Servers, and SIP Proxy Servers Entities gracefully or by a hard restart. A graceful restart closes all open applications on the server, closes the operating system, and then restarts the computer, just as if you restarted the computer from the Windows Start menu.
Page 76: Restarting After Parameter Changes
If you need to restart the Gateway, you need to restart the edge server Plugin Manager Service (EPMS). To restart the EPMS, you can either restart the 3Com Gateway on IP Telephony Manager or stop and start the EPMS service from the service applet on the Windows NT machine.
Page 77: Setting Manual Switchovers
4 Click OK. 5 Select the server graphic. 6 Click Actions/Commands from the Configuration menu. 7 When prompted to select an entity, click 3Com Gatekeeper in the list box, and then click OK. The Command Tool dialog box appears. 8 Click Switchover Commands in the Category drop-down list.
Page 78: Changing The Snmp Community Strings
4: M HAPTER AINTENANCE Changing the SNMP The IP Telephony Manager default value for SNMP community string is public Community Strings for read only and private for read-write. To change the default values you must first change the community string on the devices and then on IP Telephony Manager.
Page 79 A warning message appears verifying that you are about to change the community string and that this change will impact any user who tries to connect to the IP Telephony Manager chassis. Figure 54 Community String Warning Message After you make this change, the current active IP Telephony Manager session, will not be able to modify, or read (depending on how you have reset the community strings) the current opened chassis until you specify the same community strings for IP Telephony Manager.
Page 80: Clearing Authorized Access Lists
HAPTER AINTENANCE 6 Click OK. 7 If you changed the 3Com SNMP Community Strings on the Gatekeeper, SIP Proxy Server, or any of the Back-end Servers, you must restart the SNMP agent. Refer to To change the IP Telephony Manager community string through the command line enter: xtcmvfpd <target chassis IP address>...
Page 81: Displaying Inventory Information
Displaying Inventory The IP Telephony Manager can display the installed components on your VoIP Information system; such as the serial numbers, hardware and software version, DIP switch settings, and memory for each card. To display inventory information from the IP Telephony Manager Console window, click Configuration menu, and then select Inventory.
Page 83: A Error Messages
Overview Error messages are divided into two types: RROR ESSAGES Invocation Errors—result from missing or invalid use of command syntax, and are reported immediately to stderr. They include: Command Line Target Selection Chassis Restore Chassis Save Command Tool Configuration Tool Software Download Test Tool IP Telephony Manager Console...
Page 84: Invocation Errors
PPENDIX RROR ESSAGES Invocation Errors This topic describes the error messages that can occur from a command syntax error. The invocation errors categories listed here are: Command Line Target The following are the Command Line Target Selection error messages and a Selection description of what they indicate.
Page 85: Chassis Restore
Channel range contains zero: <target specification> A channel range includes 0 (e.g., S1C0-2). Time slot range contains zero: <target specification> A time slot range contains zero. Expected slot-level target: <target specification> The target specification began with a slot-level target but also has targets at some other level.
Page 86: Command Tool
PPENDIX RROR ESSAGES Error, unexpected command line format The user did not supply an IP address, or (Non-GUI only) did not provide a filename. Command Tool The following are the Command Tool error messages and what they indicate. Missing -E option The user did not choose a command to execute using the -E option.
Page 87: Software Download
Error: Too many targets specified The user specified more than one IP address/slot-channel combination. (There is more than one white space-separated word in the target list.) Invalid target name The target does not specify a valid IP address or host name. Software Download The following are the Software Download error messages and what they indicate.
Page 88: Test Tool
PPENDIX RROR ESSAGES Extension is not ’sdl ’Fatal Error (tcmsdl). Nonfatal error (xtcmsdl). This error occurs if the specified SDL file does not have the correct extension (*.sdl). For tcmsdl, an error message is displayed on the screen or output to the log file, and then the utility terminates.
Page 89: Ip Telephony Manager Console
Error: Too many targets specified The user specified more than one IP address/slot-channel combination. (There is more than one white space-separated word in the target list.) Invalid target format The target does not specify a valid IP address or host name. Missing -T option The user did not choose a test to execute using the -T option.
Page 90: Execution Errors
PPENDIX RROR ESSAGES Error: insufficient arguments A "-a", "-m", or "-d" directive ended unexpectedly. Error: no target supplied The user did not supply an IP address or host name on the command line. Error: invalid target format The target is not a valid IP address or host name, or contains slot/channel specifications.
Page 91 Error constructing target specification...hostname no longer valid? The user was prompted for target slot/channels using the chassis selection dialog. After targets were selected, the construction of a target failed, probably because an IP host name could not be found in the hosts database even though the host name was valid at program initialization.
Page 92: Chassis Restore
PPENDIX RROR ESSAGES Missing or invalid device.dat file! IP Telephony Manager has a corrupt device configuration schema, or other internal error. Missing or invalid software.dat file! IP Telephony Manager has a corrupt device configuration schema, or other internal error. IP Telephony Manager Discovery error: <specific error> An error occurred in attempting to launch IP Telephony Manager against a chassis (e.g., the discovery process timed out or had some other error).
Page 93: Chassis Save
The selected configuration file was saved from a chassis of a different size. Continue? Select either Yes or No. .whb file does not match chassis size Fatal error unless -F (force mismatch) is specified. The selected configuration file is from a chassis with a different card configuration. Continue? Select either Yes or No.
Page 94: Configuration Tool
PPENDIX RROR ESSAGES There are no commands for this type of device. The device configuration files do not list any commands for the target device. Invalid group name: <name> The device configuration files do not list <name> as a valid group. Invalid command: <name>...
Page 95: Test Tool
Cannot load between channel and card levels The "load from" source is at channel level while the target devices are at card level, or vice versa. Missing device configuration file There is no configuration schema file for the target devices. There are no configurable parameters for this type of card The target slot or channel has no configurable parameters.
Page 96: Ip Telephony Manager Console
PPENDIX RROR ESSAGES Cancel Execution and exit program? Issued in a "Yes/No" dialog when user quits from window frame while command/test is in progress. (GUI, warning only) Program exit during execution The command or test program was terminated (e.g., by a signal) while a command or test was in progress.
Page 97: Trap Destination
Selected device is not a modem The target slot is not a modem. Channel number out of range: <number> The target channel number is invalid for the particular type of card. No DS0 assigned to modem. Test aborted. The modem does not have a time slot assignment and tone test is therefore impossible.
Page 98: Software Download
PPENDIX RROR ESSAGES Community string and Comment too long. Truncate? Issued in an "OK/Cancel" dialog when a community string and/or comment is entered that is too long. (GUI, warning only) Trap query overrides -a/-m/-d The user specified both -q (query) and -a/-m/-d (table manipulation) arguments;...
Page 99 <filename> does not exist Fatal Error (tcmsdl). Nonfatal error (xtcmsdl). This error occurs if you selected a filename that does not exist. For tcmsdl, an error message is displayed on the screen or output to the log file, and then the utility terminates. For xtcmsdl, click OK to bring up the Select Files dialog box and select the correct file.
Page 100 100 A PPENDIX RROR ESSAGES SNMP Set Failed Fatal error. This error occurs if the target card is communicating with the Software Download utility, but does not respond correctly to a SNMP Set command. The exact SNMP error is displayed. For tcmsdl, an error message is displayed on the screen or output to the log file, and then the utility automatically terminates.
Page 101: B Command Line Interface
The command line interface consists of a number of non-interactive commands or utilities. These utilities are run at the command line from a shell prompt or a shell script. This appendix contains the following catatorgies of commands: General Syntax The following command parameters are available for all utilities: [x]command [-l logfile] [-h] [-c readcomm] [-C writecomm] target Brackets indicate that the parameter is optional.
Page 102 102 A PPENDIX OMMAND NTERFACE An "x" placed at the beginning of any IP Telephony Manager command omits command parameters and the target slot and channel designation-only the target IP address or hostname is required. Graphic user interfaces (GUIs), such as the IP Telephony Manager device display, appear and assist you in selecting component parameters and targets.
Page 103 For instance, to display Help for the Software Download utility, type the following command: tcmsdl -h [-c readcomm][-C writecomm] readcomm—read only community string writecomm—read/write community string Used to specify the SNMP community strings that have been assigned to the device. Note that these switches are optional, but can be used to override IP Telephony Manager’s initialization file settings.
Page 104: Ip Telephony Manager Console
104 A PPENDIX OMMAND NTERFACE Sets target slots in the specified range Sets target channels in the specified range. If omitted, execution at the card level is assumed. Sets target timeslots in the specified range. If omitted, execution at the channel (span line) level is assumed.
Page 105: Configuration
Configuration 105 Configuration The configuration command line interface (CLI) uses the following syntax: tcmget command: tcmget [-h] [-l logfile] [-c readcomm] [-C writecomm] [-z] [-L] [-a] [-f file] [-F] [-G group [parameter]...]... target tcmset command: tcmset [-c readcomm] [-C writecomm] [-h] [-l logfile] [-z] [-L] [-f filename] -G group parameter value [parameter value]...target The options and parameters for the tcmget and tcmset commands are...
Page 106 106 A PPENDIX OMMAND NTERFACE -f (filename) tcmget: Place the result output of the get operation in a file given by <filename> (stdout can be designated using a filename of ’-’). tcmset: Read the output of the get operation from the file given by <filename>...
Page 107 (parameter) Parameter whose value is to be printed (for tcmget) or set (for tcmset). (For example, ’Serial Number’.) Each parameter should be separated by a space and requires proper shell quoting. At least one parameter should be supplied per group, unless -L (list parameters by group) is specified.
Page 108 108 A PPENDIX OMMAND NTERFACE Specifies slots or channels to be issued commands. Target has the following format: <IP-host>:S<s-range>[,C<c-range>][,S<s-range> [,C<c-range>]...] where IP-host can be IP-dot notation, or a host name that is defined in the host database or /etc/hosts file. :S<s-range>—decimal number or a range s1-s2 (where s1 and s2 are decimal numbers and - is a literal hyphen) representing the location of card(s) within the chassis.
Page 109: Actions/Commands
Actions/Commands 109 Actions/Commands The command utility uses the following syntax: tcmcmd [-q] -E command -G group [-P parameter][-F][-p seconds]target Query Current Where: Command Status (-q) [-q] Displays the result of the last issued command the selected targets Example: tcmcmd [-q]target -E command command—a substring of valid commands A substring match to the beginning of a command string has precedence over...
Page 110: Set Trap Destination
110 A PPENDIX OMMAND NTERFACE [-p seconds] Sets amount of time, in seconds, between polls. Target Follows general syntax. Note that if you omit a channel range, the command is assumed to be targeted at the slot level. This applies as well to timeslot designations for commands sent to T1 cards-if the timeslot is omitted, the command will issued at the channel (span) level.
Page 111: Snmp Commands
SNMP Commands 111 SNMP Commands This describes how to set SNMP community strings and how to monitor the SNMP parameters. For security reasons, you can not view the community strings through IP Telephony Manager. Setting SNMP This section describes how to set the SNMP community strings. Community Strings [x]tcmcs [-h] [-c] readCommunity [-C] writeCommunity [-z] target...
Page 112 112 A PPENDIX OMMAND NTERFACE Where: -l (logfile) Log file for system diagnostic messages. GUI default: log to UNIX syslog; CLI default: stderr. Specify ’-’ (hyphen) to reverse these two behaviors. Displays this help message. -c (readcomm) SNMP read community string. -C (writecomm) SNMP write community string.
Page 113 -G (BI) Selects a group, followed by a list of parameters within that group which are to be retrieved. (For example, ’NMC Identification’.) Group specifications must appear after all other command arguments, and before the target. Group names are matched using substring comparison against the list of known group names for the target.
Page 114: Tone Test
114 A PPENDIX OMMAND NTERFACE Tone Test This section describes how to send and receive a tone test. Send Tone Test (-S) The following command causes the modem to send a tone of the specified frequency, duration, and amplitude. tcmtone -S[-t][-s num][-p num] [freq[hz][level[db]]]target Where: Initiates send tone test.
Page 115: Receive Tone Test (-R)
Receive Tone Test (-R) Use the following command to receive a tone test: tcmtone -R [-t] [-s num] [-p num] target Modem Tests tcmtest -T test [-s num] target Query Current Test To query a modem to determine whether a test is already in progress, send the Status following command: tcmtest [-q] target...
Page 116: Device Save And Restore
116 A PPENDIX OMMAND NTERFACE Device Save and The following commands are used to save and restore the configuration on the Restore specified device. Save Configuration tcmsave -f filename target Where: filename The .whb output file to which the configuration is stored. target The IP address or hostname of the device.
Page 117: Software Download
Software Download To run tcmsdl, issue the following command: tcmsdl [-s sdlfile] [-n nacfile] [-F] [-v] target Where: sdlfile The SDL file name (if omitted, uses latest version available for card type). nacfile The NAC file name (if omitted, uses latest version available for card type). Force download to an NMC that is already in a download state.
Page 118: Filename Prefixes
BNAC ENAC Card/Entity T1 HiPer DSP E1 HiPer DSP E1/R2 HiPer DSP HiPer NMC 3Com SNMP SubAgent (Gateway only) 3Com SNMP Agent (VoIP Server only) Gateway Gatekeeper Provisioning Server Accounting Server Directory Server Accounting Server Authentication Server SIP Proxy Server...
Page 119: Feature Enable
Table 13 Software Download Progress Message Descriptions (continued) Message Feature Enable The following command line launches the Feature Enable option: tcminv [-l logfile] [-h] [-c readcomm] [-C writecomm] [target] Where: -l logfile The log file for system diagnostic messages. The GUI log file default is the UNIX syslog file. The CLI default is stderr. You can reverse these defaults by specifying a "-"...
Page 120: Inventory
120 A PPENDIX OMMAND NTERFACE Where: IP-host Can be in IP-dot notation, or a host name that is defined in the host database or \etc\hosts file. :S<Slot> The decimal number representing the location of the card in the chassis. Inventory Use the following syntax to launch the Inventory utility: tcminv [-l logfile] [-h] [-c readcomm] [-C writecomm] [-d delimiter]...
Page 121: Authorized Station Tool
-f filename The file to save inventory to (for CLI only). target Specifies chassis host(s) to be displayed. The format for target is as follows: <IP-host> Can be in IP-dot notation, or a host name that is defined in the host database or /etc/hosts file.
Page 122: Cli Parameters (-Q, -A, -M, -D)
122 A PPENDIX OMMAND NTERFACE target An optional parameter that specifies the IP address or hostname of the NMC in which stations are being configured If no target is specified, the GUI behaves as if -h was the only parameter passed.
Page 123: Autoresponse
AutoResponse The AutoResponse can be invoked by the following syntax: tcmarsp [-E event] [-h] [target] Where: -E event Specifies which event to use as the default. The specified parameter must be a substring of one of the event descriptive strings described below. Substrings that match at the beginning of the descriptive string have precedence over those that match in the middle.
Page 124: Slot Level Events And Responses
124 A PPENDIX OMMAND NTERFACE Slot Level Events and The following are the events and the responses to the events from the Responses AutoResponse command Events: Module Inserted Module Re-initialized Module Removed Module Non-operational Module Watchdog Time-out Responses (the "(N)" notation indicates that the response requires a parameter): Generate AutoResponse SNMP TRAP ID (N) Delay Script Execution (N) Seconds...
Page 125 Reset By DTE DTE Transmit Idle Block Error Count at Threshold Fallback Count at Threshold Dial Out Login Failure Dial Out Restricted Number Dial In Login Failure Dial Back Restricted Number Dial Back Using Restricted Modem Login Attempt Limit Exceeded User Blacklisted Attempted Login by Blacklisted User Response Attempt Limit Exceeded...
Page 126 126 A PPENDIX OMMAND NTERFACE Test Modem Test Analog NIC Test Analog Phone Line Restore Analog Phone Line Busy out DS0 - T1 Slot (N) Span (N) Channel (N) Restore DS0 - T1 Slot (N) Span (N) Channel (N) Modem Software Reset Terminate Connection Busy Out Analog Phone Line Displays the command line parameters and the descriptions of the parameters...
Page 127 AutoResponse 127 :S<s-range> A decimal number of a range s1-s2 (where s1 and s2 are decimal numbers separated by a literal hyphen) representing the location of the card(s) in the chassis. :C<c-range> A decimal number or a range c1-c2 (where c1 and c2 are decimal numbers separated by a literal hyphen) representing the channel number(s) on the specified cards.
Page 128 128 A PPENDIX OMMAND NTERFACE...
Page 129: Lossary
LOSSARY This appendix lists acronyms and terminology used in the CommWorks VoIP application. A-Link Access link. SS7 Signaling link used to connect the Signaling Transfer Point (STP) and Signaling Switch Point (SSP). Admission Confirm—This is a call flow message. Alternate Mark Inversion—A line encoding scheme for transmitting data bits over T1 and E1transmission systems.
Page 130 Central Office—The telephone company facility where the request for service comes through the switching equipment and the requests for service gets routed. CommWorks IP A total system of hardware and software components that route telephone calls Telephony System and data over an IP based network (VoIP).
Page 131 CSMA Carrier Sense Multiple Access—Media-access mechanism wherein devices ready to transmit data first check the channel for a carrier. If no carrier is sensed for a specific period of time, a device can transmit. If two devices transmit at once, a collision occurs and is detected by all colliding devices.
Page 132 DTMF Dual Tone Multi-frequency—The sounds a touch-tone telephone makes when its keys are pressed. Data Terminal Ready—A control signal that is activated to let the DCE know when the DTE is ready to send and receive data.
Page 133 United States. It’s purpose is to provide standards for the telecommunications industry. Federal Communications Commission—A United States federal regulatory agency which oversees all aspects of the communications industry, TV, radio, telephone etc. in the United States. File Transfer Protocol—Application protocol, part of the TCP/IP protocol stack, for transferring files between network nodes.
Page 134 IP Telephony Manager IP Telephony Manager is a software application developed by CommWorks, a division of 3Com, that runs on a UNIX management station. This application remotely manages 3Com Network Application Cards (NACs) and Network Interface Cards (NICs) through a Network Management Card (NMC) installed on the CommWorks 5210 IP Telephony Platform.
Page 135 Location Reject—This is a call flow message. Location Request—This is a call flow message. Management Bus Protocol—This protocol was developed by 3Com and is used in the NMC to communicate to the other cards in the Total Control chassis. Multifrequency Compelled—An E1 call setup protocol that requires the signals to be acknowledged.
Page 136 136 A PPENDIX LOSSARY Out-of-band Manager—OOBMan is an application that runs on 3Com OOBMAN Windows NT components of the CommWorks IP Telephony platform. It is designed to allow a user to dial into an NT device, using a terminal emulation program such as Hyperterminal, and view or modify various configuration information on that machine.
Page 137 Signaling LAN Application Protocol—SLAP is the interface between the Total Control Chassis and the external SS7 Gateway system. It replaces the D-channel signaling that normally exists in an ISDN PRI interface. SLAP is 3Com’s proprietary software. Signaling Switch Point—Simply put, this is the telephone switch.
Page 138 138 A PPENDIX LOSSARY Signaling System 7—A global standard for telecommunications as defined by the International Telecommunication Union (ITU). The SS7 standard defines the procedure protocol by which network elements in the PSTN exchange information over a digital signaling network. System Management Services—Allows provisioning and updating of information on subscribers and services in near-real time for billing and administrative purposes.
Page 139 Internet instead of in analog form over the public switched telephone network (PSTN). A major advantage of VoIP is that it avoids the tolls charged by ordinary telephone service. VRAM VIrtual Random Access Memory Wide Area Network—Public or private computer network serving a wide...
Page 140 140 A PPENDIX LOSSARY Zero Code Suppression—Used primarily with T1. The insertion of a one bit to prevent the transmission of eight consecutive zeros on an active line. When eight or more consecutive zeros are detected on the line, the system considers the line inactive, and releases the line.
Page 141 NDEX Symbols .cfm files .dmf .nvr files accessing IP Telephony Manager acronyms Action/Commands menu adjusting column width authorized access authorized access list clearing Authorized Station Tool command Authorized Stations configuring Authorized Stations Add window elements Authorized Stations menu AutoResponse command configuration menu window elements...
Page 142 LED Poll Info menu LED status linking objects in HP OpenView making changes management functions management station clearing configuration manual Gatekeeper switchover menu Action/Commands Authorized Stations AutoResponse Chassis Save All Community Names Configuration Exit Fault File Import SDL Files Inventory Inventory Print LED Poll Info Open...

3Com CommWorks 5210 User Manual

About this Guide

1 Installation

2 Configuration

3 Navigating and Using the System

4 Maintenance

A Error Messages

B Command Line Interface

Lossary

Quick Links

Related Manuals for 3Com CommWorks 5210

Summary of Contents for 3Com CommWorks 5210

Table of Contents