CommWorks 5210 IP Telephony Manager User Guide Release 2.
CommWorks 5210 IP Telephony Manager User Guide Release 2.
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. 3Com Corporation reserves the right to revise this documentation and to make changes in content from time to time without obligation on the part of 3Com Corporation to provide notification of such revision or change.
CONTENTS CONTENTS ABOUT THIS GUIDE Finding Information............................................................................................................xiii Conventions.......................................................................................................................xiv Related Documentation......................................................................................................xiv Contacting CommWorks ..............................................................
vi Auto Response .................................................................................................................. 31 AutoResponse Configuration ........................................................................................ 31 Setting Authorized Stations................................................................................................ 32 Defining a Range of IP Addresses for Authorized Access ....................................................
vii 4 MAINTENANCE Upgrading Software ...........................................................................................................69 Software Upgrade Methods ..........................................................................................70 Upgrading the Software ................................................................................................71 Command Tool...............................................................................................................
viii B COMMAND LINE INTERFACE General Syntax................................................................................................................. 101 IP Telephony Manager Console ........................................................................................ 104 Configuration .................................................................................................................. 105 Actions/Commands.............................................................................
ix LIST OF TABLES Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 Content Description............................................................................................ xiii Notice Icon Description ....................................................................................... xiv Text Convention Descriptions.............................................................................. xiv Management Software ...........
x LIST OF FIGURES Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25 Figure 26 Figure 27 Figure 28 Figure 29 Figure 30 Figure 31 Figure 32 Figure 33 Figure 34 Figure 35 Figure 36 Figure 37 Figure 38 Figure 39 Figure 40 Figure 41 Figure 42 Figure 43 Figure 44 Figure 45 Figure 46 Figure 47 Figure 48 Figure 49 Figure 50 Fi
xi Figure 54 Community String Warning Message .................................................................79 Figure 55 Device Details Dialog Box ...................................................................................79 Figure 56 Inventory Window ..............................................................................................
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. Its primary audience is operations personnel.
xiv ABOUT THIS GUIDE Conventions The following tables list conventions in this guide. Table 2 Notice Icon Description Icon Notice Type Description Information Note Information that contains important features or instructions. Caution Information to alert you to potential damage to a program, system, or device. Warning Information to alert you to potential personal injury or fatality. May also alert you to potential electrical hazard.
Contacting CommWorks xv ■ CommWorks IP Telephony Parameter (MIB) Reference Guide ■ CommWorks IP Telephony Trap (Alarm) Reference Guide ■ Contacting CommWorks CommWorks 4007 SS7 Signaling Gateway Operation and Maintenance Guide For information about Customer Service, including support, training, code 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.
1 INSTALLATION This chapter contains an overview of IP Telephony Manager and installation procedures for UNIX.
CHAPTER 1: INSTALLATION 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. The NMC communicates with each installed card using a proprietary Management Bus Protocol (MBP).
Before You Begin 19 Table 5 Hardware Prerequisites (continued) Operating System HP Platform Hardware HP 712/100 or higher Model 712 Workstation 64 MB RAM (minimum) 1 GB Hard Disk Space (Space must be available on one partition. Swap space is recommended to be at or above 200 MB.) CD-ROM Drive Color Monitor Ethernet Interface Table 6 lists the software requirements needed to achieve the best performance from IP Telephony Manager.
CHAPTER 1: INSTALLATION 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. Remember to disable HP OpenView autodiscovery before you do a first time install/integration of IP Telephony Manager with HP OpenView.
Installing IP Telephony Manager 21 8 From the command line prompt, type the following commands and press Return after each: TCMHOME= (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. If TCM is later removed, these adjustments will be undone to restore the original state.
CHAPTER 1: INSTALLATION Starting IP Telephony Manager After you complete the installation and modify the path statement, you can start IP Telephony Manager. To start the IP Telephony Manager, from the command line prompt, type one of these commands: # xtcmvfpd or # xtcmvfpd The first command causes a list of the chassis components to display. You can then select the component that you want to start.
Connecting to Entities 23 To view the entity after the it is connected using IP Telephony Manager: 1 Start IP Telephony Manager. 2 Click File and then click Open from the IP Telephony Manger Console window. 3 Select the entity from the list. 4 Click OK. The entity appears in graphical form. When selected, the entity is blue; when deselected, the entity is black. Determining Gatekeeper and Media Gateway Connectivity To test Gatekeeper to Media Gateway connectivity, use the following procedure.
CHAPTER 1: INSTALLATION Integrating with HP OpenView The IP Telephony Manager installation script installs OpenView integration files 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. 1 Set the OpenView environmental variables. # cd /opt/OV/bin # . ./ov.envvars.
Integrating with HP OpenView 25 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. For best results, delete and rediscover the CommWorks devices. Removing HP OpenView Integration To remove OpenView integration: 1 Login as root.
CHAPTER 1: INSTALLATION Linking CommWorks Objects If you choose to install HP OpenView, you must install it before IP Telephony 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. 1 Type: #cd $OV_BIN #./ovstart #./ovw 2 Go to the chassis to be linked, and then click on it. 3 Right click and select Symbol Properties from the pop-up menu. 4 Under Behavior, click Execute.
2 CONFIGURATION This chapter describes how to configure CommWorks IP Telephony Manager. This chapter contains the following topics: ■ Management Station Configuration ■ Component Configuration ■ Synchronizing Network Time ■ Auto Response ■ Setting Authorized Stations ■ Defining a Range of IP Addresses for Authorized Access ■ Threshold Monitoring Configuration ■ Saving and Restoring Configurations Refer to Chapter 3 for a complete description of the IP Telephony Manager menus.
CHAPTER 2: CONFIGURATION Component Configuration Launching the Configuration Tool The IP Telephony Manager Console window is used to select target components whenever you are performing configuration, sending commands, or upgrading components through software download.
Synchronizing Network Time 29 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. We recommend choosing NTP server locations that are as close to the Media Gateway chassis as possible.
CHAPTER 2: CONFIGURATION 5 Enter the Primary and Secondary NTP IP Addresses (refer to Recording the NTP IP Addresses). 6 Set the Operational Mode to Unicast. 7 Click Set. Setting the NTP Parameters for the Other Entities For each Gatekeeper, SIP Proxy Server, and Back-end Server: 1 Using IP Telephony Manager, open the targeted server. 2 Select the server icon. 3 Select Configuration, then Programmed Settings from the IP Telephony Manager Console window.
Auto Response Auto Response 31 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). IP Telephony Manager provides a convenient graphical user interface (GUI) for the Network Manager to configure automatic responses to a specified event.
CHAPTER 2: CONFIGURATION 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. The response scripts are loaded. Responses can only be added one at a time. Some responses may require additional information (for example, Delay N. Seconds).
Setting Authorized Stations 33 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 Defining a Range of IP Addresses for Authorized Access later in this chapter.
CHAPTER 2: CONFIGURATION Defining a Range of IP Addresses for Authorized Access You can define a range of IP addresses for authorized access by using the Network Mask field in the authorized access list. The network mask that you type in this field masks the IP address for that entry to define a range of authorized IP addresses. For example, a network mask of 255.255.255.255 prevents access from all IP addresses except the destination IP address. An entry with a destination IP address of 139.78.202.
Threshold Monitoring Configuration Figure 9 Parameter Group Selection Window The Threshold Monitor Configuration window appears.
CHAPTER 2: CONFIGURATION The following table contains the fields and the values of the Configuring Threshold window. Table 8 Threshold Monitor Configuration Fields Field Name Description Threshold Object Object ID which is to be monitored. Example: This has 4294967294 at the end if an object with multiple instances is 1.3.6.1.4.1.429.4.75.5.1.8.0 to be monitored. Possible Selections Threshold Alias Alias for the object ID.
Adding a Threshold Parameter 37 Table 8 Threshold Monitor Configuration Fields (continued) Field Name Description Possible Selections Threshold Event Severity The severity configured will be sent in the trap. None Critical Warning Informational Threshold Alarm State State of the threshold object. If an object is not active, then it has a state of none. If an object is above threshold, then this object will show that state. If an Object has cleared the threshold, then it will show that state.
CHAPTER 2: CONFIGURATION 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.
Adding a Threshold Parameter 39 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.
CHAPTER 2: CONFIGURATION Figure 14 Adding Threshold Parameters Window 7 Click Set. 8 If you changed the threshold parameters on the Gatekeeper, SIP Proxy Server, or any of the Back-end Servers, you must restart the SNMP agent. Refer to Restarting Other Entities in Chapter 4 for more information. Editing a Threshold Parameter To edit a parameter that is being monitored: 1 Open a console window for the device where the threshold is going to be edited.
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.
CHAPTER 2: CONFIGURATION 5 Set Threshold Row Status to notinsservice. 6 Change the configuration as you need, refer to Table 8, and click Set. 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. 9 If you changed the threshold parameters on the Gatekeeper, SIP Proxy Server, or any of the Back-end Servers, you must restart the SNMP agent.
Saving and Restoring Configurations Saving and Restoring Configurations 43 The Save configuration utility performs a discovery of the configuration of a 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.
CHAPTER 2: CONFIGURATION 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. For more information, refer to Appendix B, Command Line Interface. The Chassis Save Progress window appears. 3 When the save is completed, click OK.
Saving and Restoring Configurations 45 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. For more information refer to Appendix B, Command Line Interface. The Chassis Restore Progress window appears.
CHAPTER 2: CONFIGURATION 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. For T1 cards, you must select the whole card and choose the software command group.
Saving and Restoring Configurations 47 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. For more information refer, to Appendix B, Command Line Interface. The Chassis Save Progress window appears. 4 When the save is completed, click OK.
CHAPTER 2: CONFIGURATION 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. For more information, refer to Appendix B, Command Line Interface. The Chassis Restore Progress window appears. 3 When the save is completed, click OK.
3 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.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM 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.
Accessing IP Telephony Manager Window 51 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. As you can see, the Chassis Console window and the Server windows contain the same menu items. For ease of reference, the IP Telephony Manager Console windows are used as examples.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM 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. It lets you to access other devices on your VoIP system.
File Menu Save Chassis NVRAM Submenu 53 The Save Chassis NVRAM submenu saves the Media Gateway chassis 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 Submenu The Restore Chassis NVRAM submenu restores the Media Gateway chassis configuration from a specified file. You can also use this submenu to configure another chassis by using the configuration saved on this file.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM 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 LED Poll Info Submenu The Other Side submenu displays the reverse side of the chassis. This guide shows the front panel of the chassis. Figure 28 shows the back of the Media Gateway chassis (IP Telephony Manager Chassis Console only). The LED Poll Info submenu displays the status of the LED lights.
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.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM Configuration Menu The Configuration menu is used to set the VoIP chassis to your environment requirements. Figure 31 Configuration Menu Programmed Settings Submenu The Programmed Settings submenu displays the Configuration Tool window for the selected entity. Parameters for a given component may be divided into several groups. When you select the Configuration Tool, the Parameter Group drop-down box appears, prompting you to select a parameter group.
Configuration Menu 57 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. This field is read only.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM 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. When you click on the field, a drop-down box appears, listing the possible values for the configuration. You can also use the Tab key to navigate through the fields.
Configuration Menu ■ ■ Action/Commands Submenu 59 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. The Action/Commands submenu displays the Command Tool window for the selected entity. Figure 34 shows an example of the CommWorks EdgeServer Pro entity.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM ■ Execute—Executes the selected command for the selected targets. ■ Close—Closes the Command Tool window. Software Download Submenu The Software Download submenu displays the files to be downloaded for the specified entity. You then select the files you need to be downloaded. Refer to Chapter 4 for more information.
Configuration Menu 61 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. ■ Print—Prints displayed data to a printer or file either in postscript or ASCII format. Figure 36 shows the Inventory Print menu.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM 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. Response Script Usage %—This indicator shows the percentage of available script space you have programmed.
Fault Menu Fault Menu 63 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.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM Trap Destination Submenu The Trap Destination submenu defines and modifies where the traps are sent. 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.
Security Menu 65 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.
CHAPTER 3: NAVIGATING AND USING THE SYSTEM Community Names Submenu The Community Names submenu lets you set the SNMP community strings. 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. For security reasons, you cannot view the community strings through IP Telephony Manager.
Security Menu ■ ■ 67 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.
4 MAINTENANCE This chapter describes how to use IP Telephony Manager to upgrade software and perform general maintenance tasks on CommWorks IP Telephony Platform cards.
CHAPTER 4: MAINTENANCE 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.
Upgrading Software ■ Extracts the CAB file from the DMF file. ■ Extracts the installation files from the CAB file. ■ Runs the setup. 71 Table 9 lists a comparison of the installation methods.
CHAPTER 4: MAINTENANCE 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. 4 If you selected a server to download to, you are prompted to select an entity. 5 From the Configuration menu, click Software Download.
Command Tool 73 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.
CHAPTER 4: MAINTENANCE 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. 2 Click Execute at the bottom of the window. 3 After executing the command, compare the results with the color-coded key below the status box.
Restarting Other Entities 75 Figure 50 Example Media Gateway Command Status Color Codes Restarting Other Entities You can restart the Gatekeepers, Back-end Servers, and SIP Proxy Servers 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.
CHAPTER 4: MAINTENANCE The entity has been successfully restarted. Restarting after Parameter Changes There are various parameters located under the Configuration menu that can be set to meet your requirements. The parameters that are prefixed with an asterisks (*) require that the entity be restarted when changes are made to the parameter. The following figure displays some of the parameters with the asterisks (*).
Setting Manual Switchovers 77 For the Back-end Servers: ■ ■ ■ Setting Manual Switchovers Accounting Server—restart 3Com Accounting service on IP Telephony Manager, or stop and start 3Com VoIP Accounting Data service applet on the Windows NT machine. Directory Mapping Server—restart 3Com Directory service on IP Telephony Manager, or stop and start 3Com VoIP Directory Data service applet on the Windows NT machine.
CHAPTER 4: MAINTENANCE Changing the SNMP Community Strings 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. For security reasons, you cannot view the community strings through IP Telephony Manager.
Changing the SNMP Community Strings 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.
CHAPTER 4: MAINTENANCE 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 Restarting Other Entities for more information.
Displaying Inventory Information Displaying Inventory Information 81 The IP Telephony Manager can display the installed components on your VoIP 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. The Inventory window appears with the information.
A Overview ERROR MESSAGES Error messages are divided into two types: ■ ■ Invocation Errors—result from missing or invalid use of command syntax, and are reported immediately to stderr.
APPENDIX : ERROR MESSAGES Invocation Errors This topic describes the error messages that can occur from a command syntax error.
Invocation Errors 85 Channel range contains zero: A channel range includes 0 (e.g., S1C0-2). Time slot range contains zero: A time slot range contains zero. Expected slot-level target: The target specification began with a slot-level target but also has targets at some other level. Expected time slot-level target: The target specification began with a time slot-level target but also has targets at some other level.
APPENDIX : ERROR MESSAGES 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. (Non-GUI only) Missing -G option The user did not choose a command group using the -G option.
Invocation Errors 87 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. Error: No target specified The user did not supply at least an IP address or host name on the command line.
APPENDIX : ERROR MESSAGES 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. For xtcmsdl, click OK to bring up the Select Files dialog box and select a NAC file. No default NAC file Fatal Error (tcmsdl). Nonfatal error (xtcmsdl).
Invocation Errors 89 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.
APPENDIX : ERROR MESSAGES 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. Warning: at most 256 trap commands accepted. The user specified more than 256 "-a", "-m", or "-d" directives. The remaining directives will be ignored.
Execution Errors 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. (The host database has probably been changed or is no longer accessible.
APPENDIX : ERROR MESSAGES 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: 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).
Execution Errors 93 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. Chassis Save The following are the Chassis Save error messages and what they indicate.
APPENDIX : ERROR MESSAGES 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: The device configuration files do not list as a valid group. Invalid command: The device configuration files do not list as a valid command within the current group.
Execution Errors 95 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. Modification(s) in current group will be overwritten.
APPENDIX : ERROR MESSAGES 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. (Non-GUI, warning only) IP Telephony Manager Console The following are the IP Telephony Manager Console error messages and what they indicate.
Execution Errors 97 Selected device is not a modem The target slot is not a modem. Channel number out of range: 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. Extra targets, only the first will be used The user selected more than one modem when invoking a tone test. The first specified modem will be used, and the others ignored.
APPENDIX : ERROR MESSAGES 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; only -q will be used. (Non-GUI, warning only) Nothing to do No trap destination-modifying arguments were given on the command line.
Execution Errors 99 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. No Default SDL File for Card Type Fatal Error (tcmsdl). Nonfatal error (xtcmsdl).
APPENDIX : ERROR MESSAGES 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. For xtcmsdl, clicking the OK button of the dialog box terminates the utility. SNMP Get Failed Fatal error.
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.
APPENDIX : COMMAND LINE INTERFACE 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. When using the "x" prefix, for any IP Telephony Manager command, only the target IP address or hostname is required.
General Syntax 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.
APPENDIX : COMMAND LINE INTERFACE S Sets target slots in the specified range C Sets target channels in the specified range. If omitted, execution at the card level is assumed. T Sets target timeslots in the specified range. If omitted, execution at the channel (span line) level is assumed. When used with the Command Tool, this part of the target can be given as T (without a range) and you will be prompted for a timeslot (for xtcmcmd only). Only one type of component can be selected at a time.
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 described below.
APPENDIX : COMMAND LINE INTERFACE -f (filename) ■ ■ tcmget: Place the result output of the get operation in a file given by (stdout can be designated using a filename of ’-’). tcmset: Read the output of the get operation from the file given by and use it to set the values. For example: tcmset -f 192.77.203.74:s17 -a This flag is available in the tcmget command only. Store output in ’argument’ format.
Configuration 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. Parameter names are matched using substring comparison against the list of known parameter names within the currently selected group.
APPENDIX : COMMAND LINE INTERFACE Specifies slots or channels to be issued commands. Target has the following format: :S[,C][,S [,C]...] where IP-host can be IP-dot notation, or a host name that is defined in the host database or /etc/hosts file. ■ ■ :S—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.
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 Command Status (-q) Where: [-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 internal matches.
APPENDIX : COMMAND LINE INTERFACE [-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. Set Trap Destination The following commands are used to define where the traps are to send there output.
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 Community Strings This section describes how to set the SNMP community strings. [x]tcmcs [-h] [-c] readCommunity [-C] writeCommunity [-z] target Where: -c readcomm SNMP read community string. -C writecomm SNMP write community string. -h Displays this help message.
APPENDIX : COMMAND LINE INTERFACE 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. -h Displays this help message. -c (readcomm) SNMP read community string. -C (writecomm) SNMP write community string. -z Disable set logging for this application. -L List all groups, or if -G is provided, list parameters for each group specified as part of a -G argument.
SNMP Commands 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. Substrings that match at the beginning of a group name have precedence over substrings that match internally.
APPENDIX : COMMAND LINE INTERFACE Tone Test Send Tone Test (-S) This section describes how to send and receive a tone test. 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: -S Initiates send tone test. -t Leave in test mode after exiting program. -s Specifies duration number in seconds. Default = 10. -p Specifies time between polls num in seconds. Default = 1.
Modem Tests 115 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 Status To query a modem to determine whether a test is already in progress, send the following command: tcmtest [-q] target Test Type (-T) -T test Where: test = modem test type substring.
APPENDIX : COMMAND LINE INTERFACE Device Save and Restore The following commands are used to save and restore the configuration on the 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. For example: tcmsave -f chassis1.whb 192.77.203.66 In this example, the utility saves the configuration data from the chassis with the IP address of 193.72.205.
Software Download 117 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). -F Force download to an NMC that is already in a download state. Default directory for .nac and .sdl files is $TCMHOME/data/sdl. For example: tcmsdl -s qf020202.sdl -n qf030000.nac 192.77.203.
APPENDIX : COMMAND LINE INTERFACE Filename Prefixes Filename prefixes indicate which component type uses a given SDL or NAC file. In most cases, the NAC and SDL files for a given component have the same prefix.
Feature Enable 119 Table 13 Software Download Progress Message Descriptions (continued) Feature Enable Message Description Additional Information SIG Software Download utility received a UNIX signal Signal received. IP Telephony Manager/Solaris catches the following signals (to avoid termination): PIPE, TERM, USR1, and USR2.
APPENDIX : COMMAND LINE INTERFACE 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 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] [-f filename] target Where: -l logfile The log file for system diagnostic messages. The GUI log file default is the UNIX syslog file.
Authorized Station Tool 121 -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: Can be in IP-dot notation, or a host name that is defined in the host database or /etc/hosts file.
APPENDIX : COMMAND LINE INTERFACE 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.
AutoResponse 123 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. When there are embedded spaces in the substring, the event should be properly quoted according to shell rules.
APPENDIX : COMMAND LINE INTERFACE Slot Level Events and Responses The following are the events and the responses to the events from the 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 ■ Terminate Script Execution ■ Continue if Test Passes
AutoResponse 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 ■ Modem Watchdog Reset ■ Management Bus Failure ■ DTR True ■ DTR False ■ Modem Ring No Answer ■
APPENDIX : COMMAND LINE INTERFACE ■ 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 -h Displays the command line parameters and the descriptions of the parameters and their flags. -c readcomm The SNMP read community string. -C writecomm The SNMP write community string.
AutoResponse 127 :S 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 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. Only the IP address of the of the chassis needs to be specified.
APPENDIX : COMMAND LINE INTERFACE
GLOSSARY C 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). ACF Admission Confirm—This is a call flow message. AMI Alternate Mark Inversion—A line encoding scheme for transmitting data bits over T1 and E1transmission systems. ANI Automatic Number Identification—The billing number of the person making the phone call.
APPENDIX : GLOSSARY CD CDR CE CEPT CHS CISPR CLI CMOS CNG CO CommWorks IP Telephony System Collision Detection—A process where a simultaneous transmission has taken place. Workstations can determine if this has happened if they do not receive an acknowledgement from the receiving station within a certain amount of time. When this occurs, the workstation will try again. Call Detail Record—Information gather during the call used later for billing purposes.
Appendix : Glossary 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. This collision subsequently delays retransmissions from those devices for some random length of time.
APPENDIX : GLOSSARY DRAM DRJ DRQ Dynamic Random Access Memory—The readable/writable memory used to store data in PCs. DRAM stores each bit of information in a "cell" composed of a capacitor and a transistor. Disengage Reject—This is a call flow message. Disengage Request—This is a call flow message. DS Digital Signal—Standard specifying the electrical characteristics for data transmission over four-wire telco circuits. DS1 is 1.544 Mbps, and DS3 is 44.736 Mbps. Also referred to as T1 and T3.
Appendix : Glossary 133 ESD Electrostatic Discharge—Discharge of stored static electricity that can damage electronic equipment and impair electrical circuitry, resulting in complete or intermittent failures. ESF Extended Super Frame—Framing type used on T1 circuits that consists of 24 frames of 192 bits each, with the 193rd bit providing timing and other functions. ESF is an enhanced version of super frame (SF).
APPENDIX : GLOSSARY IDE Integrated Drive Electronics—Standard interface to the hard disk drive on the PC. IEC International Electrotechnical Commission—The international standards body for electrotechnology. IIS Internet Information Server—Microsoft Windows NT web based server. It allows you to create control and manage a web site remotely. IMT Inter-Machine Trunks—In the SS7 network, the IMT is the channel that carries the data to the SSP.
Appendix : Glossary 135 LRJ Location Reject—This is a call flow message. LRQ Location Request—This is a call flow message. MBP 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. MFC Multifrequency Compelled—An E1 call setup protocol that requires the signals to be acknowledged. MIB Management Information Base—A key element of SNMP management systems.
APPENDIX : GLOSSARY OOBMAN Out-of-band Manager—OOBMan is an application that runs on 3Com 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. OS Operating System—A software program that controls and manages the operations of a computer system.
Appendix : Glossary 137 RCF RISC RFI RRAS RRJ Registration Confirm—This is a call flow message. Reduced Instruction Set Computer— Central processing unit architecture that greatly reduces processing time by having fewer, simpler instructions programmed into ROM, but allowing for complex processing by combining these simple instructions; primarily used in workstations.
APPENDIX : GLOSSARY SS7 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. SMS System Management Services—Allows provisioning and updating of information on subscribers and services in near-real time for billing and administrative purposes.
Appendix : Glossary 139 TDMA TFTP Total Control Manager Time Division Multiplexing Adapter—A device that allows analog voice and data devices to work through an ISDN connection. The terminal adapter is a protocol converter that adapts equipment not designed for ISDN, such as phones, faxes, and modems. Trivial File Transfer Protocol—simplified version of the File Transfer Protocol (FTP) that transfers files but does not provide password protection or user directory capability.
APPENDIX : GLOSSARY ZCS 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.
INDEX Symbols .cfm files 48 .dmf 69 .nvr files 44, 47 A accessing IP Telephony Manager 49 acronyms 129 Action/Commands menu 59 adjusting column width 59 authorized access 66 authorized access list clearing 80 Authorized Station Tool command 121 Authorized Stations configuring 32 Authorized Stations Add window elements 67 Authorized Stations menu 66 AutoResponse 31 command 123 configuration 31 menu 61 window elements 62 C Card-Level vs. Channel-Level Commands 73 Card-Level vs.
L R LED Poll Info menu 54 LED status 54 linking objects in HP OpenView 26 reboot 75 restarting 75, 76 Restore CFM menu 53 Restore Chassis NVRAM menu 53 restoring 47 chassis 46 chassis configuration 47 command line 47 configuration 43 configuration NVRAM 44 restoring chassis CFM 53 restoring chassis NVRAM 53 restoring configurations 116 M making changes 73 management functions 66 management station clearing 80 configuration 27 manual Gatekeeper switchover 77 menu Action/Commands 59 Authorized Statio
CommWorks Corporation 3800 Golf Road Rolling Meadows, IL 60008 ©2001 3Com Corporation All rights reserved Printed in the U.S.A.
