VCX Maintenance Guide ™ VCX™ V7000 IP Telephony Solution Convergence Application Suite System Release 7.1 Part Number 900-0382-01 Rev AA Published August 2006 http://www.3com.
3Com Corporation 350 Campus Drive Marlborough, MA 01752-3064 Copyright © 2002–2006, 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.
CONTENTS ABOUT THIS GUIDE Conventions 12 Related Documentation Comments 14 1 13 VCX SYSTEM MAINTENANCE OVERVIEW Network-based Telephony 16 VCX Software Components 16 VCX Hardware Configurations 18 Single-Site Configurations 19 Multi-Site Configurations 19 VCX Maintenance Tasks 21 About VCX Passwords 23 VCX File and Directory Name Guidelines 2 24 CONFIGURING THE CALL RECORDS SERVICE Call Records Service Overview 28 Configuring an Accounting Service Group 29 Adding an Accounting Group 30 Viewing Config
Listing All Configured Accounting Services Viewing Accounting Service Details 36 Managing CDRs and Super CDRs 37 Understanding CDR Fields 37 Viewing CDRs 40 Viewing Super CDRs 41 QoS Monitoring Statistics 41 3 36 MANAGING VCX SERVERS Managing the Tomcat Web Server 46 Verifying Tomcat Server Status 46 Stopping the Tomcat Server 46 Starting the Tomcat Server 46 Clearing the Tomcat Cache 47 Changing a Daylight Saving and Time Zone Configuration 47 Managing Log and CDR Files 48 Tomcat and IP Messaging Log
SNMP Support 59 Managing the SIP Phone Downloader 61 Starting the SIP Phone Downloader 61 Stopping the SIP Phone Downloader 61 Restarting the SIP Phone Downloader 61 Managing the IP Messaging Service 62 Verifying IP Messaging Service Status 62 Starting the IP Messaging Service 62 Stopping the IP Messaging Service 62 Restarting the IP Messaging Service 62 Managing Authorized SNMP Station Access 63 Changing Codecs 64 How to Change Your Codec 65 Converting Prompts and Messages to a Different Codec 4 BACKI
6 MANUALLY CONFIGURING MULTI-MASTER REPLICATION Multi-Master Replication Overview 90 Replicated Table Location 90 Manually Configuring Replication for an IP Telephony Server or IP Telephony and Messaging Server 91 Manually Configuring Region to Region Replication 93 Verifying Replication at a Branch Office 96 Verifying the Number of VCX Data Schemas in a Region 97 Deleting Replication Errors 99 7 RECONFIGURING A VCX SERVER Reconfiguration Overview 102 Sample VCX Server Reconfiguration 8 103 MANAGIN
Adding Primary and Secondary Authentication and Directory Servers 147 10 MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE Command Overview 150 Using Single User Mode 152 Command Modes 154 Single User Mode Command Syntax 155 Single User Mode Examples 155 Using Batch Mode 156 Managing User Accounts with an XML File 157 Adding User Accounts with a CSV File 161 Files and Directories 162 A UPGRADING VCX SERVER SOFTWARE FROM V7.0 TO V7.1 Verifying Software Versions 166 Overview of a 7.0 to 7.
Upgrading the Regional IP Messaging Servers 200 Upgrading the Regional Call Servers 203 Upgrading the Regional Call Records Server 205 Upgrading Branch Offices 207 Configuring UPS Monitoring 211 B UPGRADING VCX SERVER SOFTWARE FROM V7.1.X TO V7.1.Y Verifying Software Versions 216 Overview of a 7.1.x to 7.1.
Upgrading the Secondary VCX Server 261 Set Up Database Replication 262 Upgrading a Single-Site System With Four Servers 264 Upgrading the Primary IP Telephony Server 266 Upgrading the Primary IP Messaging Server 267 Upgrading the Secondary IP Telephony Server 269 Upgrading the Secondary IP Messaging Server 270 Set Up Database Replication 271 Upgrading a Multi-Site System With No Branch Offices 273 Upgrading the Call Records Server 273 Upgrading a Multi-Site VCX System with Branch Offices 274 Multi-Site V
F CALL PROCESSOR COMMAND LINE INTERFACE COMMANDS Call Processor CLI Overview CLI Command Descriptions INDEX 336 337
ABOUT THIS GUIDE This guide describes how to maintain 3Com® VCX IP Telephony Solution software. VCX software runs on either the 3Com V6000 or 3Com V7000 server platforms. This guide describes how to maintain VCX™ IP Telephony Solution components, which include the VCX software services running in standard VCX software configurations.
ABOUT THIS GUIDE Conventions Table 1 and Table 2 list conventions that are used throughout this guide.
Related Documentation Related Documentation 13 These 3Com documents contain additional information about the products in this release that are a part of or support the 3Com Convergence Applications Suite.
ABOUT THIS GUIDE The following documents provide information on products that support this release: Enterprise Management Suite ■ Enterprise Management Suite Getting Started Guide, Version 2.3 ■ Enterprise Management Suite User Guide, Version 2.3 ■ Enterprise Management Suite 2.3 for VCX 7.1 User Guide Digital Gateways ■ V7122 and V6100 Digital User Guide, Version 4.8 ■ V6100 Digital Fast Track Installation Guide, Version 4.8 ■ V7122 Digital Fast Track Installation Guide, Version 4.
1 VCX SYSTEM MAINTENANCE OVERVIEW The 3Com® VCX IP Telephony Solution delivers reliable, highly-scalable, comprehensive standards-based IP telephony for large enterprises. This chapter provides an overview of the VCX™ system and the steps required to maintain the servers and services in a VCX environment.
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW Network-based Telephony The VCX IP Telephony Solution (referred to in this guide as the VCX system) merges telephony with networking by delivering business telephone service over a data network. The VCX architecture provides a distributed call processing system using the SIP signalling protocol to establish voice, video, and text sessions between SIP phones and other SIP-compatible devices.
VCX Software Components 17 Authentication (for example, validating a username and password) Authorization (for example, verifying a user is allowed to make an international call) User-specific routing or translation (for example, processes a personal speed dial number) ■ Directory (routing and translation functions): The routing function identifies, selects, and prioritizes all the possible routes for a given call.
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW Table 3 VCX Software Configuration Options Standard Software Configurations Software Service IP Telephony and IP Messaging Call Server Server Authentication IP IP Call and Telephony Messaging Directory Records Server Server Server Server Call Processor Yes Yes Yes SIP Downloader Yes Yes Yes Authentication and Directory Services Yes Accounting Services Yes Yes Yes Provisioning Services Yes Yes Yes Common Agent Yes Yes Yes IP Messaging
VCX Hardware Configurations 19 There are two basic configuration options, single-site and multi-site systems. The hardware servers in each option type run the VCX operating system. Currently supported hardware platforms include: ■ V7000-series systems with IBM X306m or IBM X346 servers ■ V6000 Integrated Branch Communications servers ■ V6100 Integrated Branch Communications servers The next two sections describe typical examples of single-site and multi-site configurations.
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW ■ ■ ■ One or two servers running the IP Messaging services configuration. The number of servers depends on whether the branch offices are configured with IP Messaging services or obtain that service from the regional office.
VCX Maintenance Tasks 21 The version 7.1 upgrade procedure allows you to enable Global Voicemail Integration on servers running IP Messaging software. However, you must install IP Messaging software on a GVCS, and then set up the GVCS through the IP Messaging administrator configuration interface before enabling Global Voicemail Integration on regional and branch office IP Messaging servers.
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW Table 4 VCX Maintenance Tasks Task Purpose Reference Configure accounting groups on Identifies the Accounting services from the Call Records service. which the Call Records service should collect Call Detail Records (CDRs). Chapter 2 Maintain VCX system servers. Chapter 3 Tasks include: ■ Clearing the Tomcat cache. ■ Modifying a time zone configuration. ■ Stopping and starting various VCX services.
About VCX Passwords 23 Table 4 VCX Maintenance Tasks (continued) Task Purpose Reference Upgrade VCX system software. Upgrade VCX system software to a later release. Appendix A, for version 7.0 to version 7.1 upgrades Appendix B for version 7.1.x to version 7.1.y upgrades Appendix C for version 6.0 to version 7.0 upgrades Downgrade VCX system software. Downgrade VCX system software to the last previously installed release.
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW default passwords. Consult with your VCX installer for the current passwords. Note that these passwords can be changed after the initial installation by running the vcx-reconfigure script. See Chapter 7. CAUTION: Do not use operating system commands or utilities to change these passwords. The vcx-reconfigure script changes the password where necessary in VCX scripts and configurations. Operating system commands and utilities do not.
VCX File and Directory Name Guidelines Table 6 Characters to Avoid in File and Directory Names (continued) Character Description $ Dollar sign ! Exclamation mark < and > Left and right carets | Bar & Ampersand ; Semicolon ( and ) Left and right parentheses # Pound or hash character @ At sign € Euro sign Space and tab characters 25
CHAPTER 1: VCX SYSTEM MAINTENANCE OVERVIEW
2 CONFIGURING THE CALL RECORDS SERVICE This chapter describes how to configure accounting groups on the Call Records service. An accounting group identifies the Accounting services from which the Call Records service should collect Call Detail Records (CDRs).
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE Call Records Service Overview A Call Detail Record (CDR) contains information about a processed call. This information can include the identity of the calling and called parties, the duration of the call, and the type of call. CDRs can be imported by third-party billing platforms to generate billing statements. In a VCX system, CDRs can be generated by a call processor or by an IP Messaging server.
Configuring an Accounting Service Group 29 For example, your VCX system could include the following components: ■ The East region includes two sites (call processors) each running an Accounting service: SalesE and EngE. ■ The West region includes two sites (call processors) each running an Accounting service: SalesW and EngW. In this example, you could create two Account service groups on the Call Records service. The EastGroup includes the Accounting services SalesE and EngE.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE Adding an Accounting Group To add an accounting group: 1 Log on to the VCX server hosting the Call Records service as cworks and enter these commands: cd /opt/3com/VCX/bssxml/bin ./config.sh A menu of configuration options appears followed by the SELECT OPERATION prompt. 2 At the prompt, enter 101. The Enter Unique Group Name prompt appears. 3 Enter a descriptive name for your group. The new group is created and enabled automatically.
Configuring an Accounting Service Group Enabling and Disabling Groups 31 You can enable or disable configured groups. A disabled group stops collecting CDRs from member Accounting services. The CDRs are stored on each server hosting an Accounting service and accumulate as long as there is enough disk space. When you create a group, it is enabled by default, However, the VCX-supplied Accounting service group named defaultGroup, is in a disabled state by default.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE A menu of configuration options appears followed by the SELECT OPERATION prompt. 2 At the prompt, enter 103. The Enter the Group Name to Delete prompt appears. The configured groups are listed above the prompt. 3 Enter the name of the group you want to delete. The group is deleted. To verify the group is deleted use the list option (104).
Adding Accounting Services to the Call Records Service 33 4 Enter a unique identifier that you want to assign to the Accounting service. For instance, if it is a branch office in Joliet, IL, you could use branchJolietIL as the identifier. There is no name length limit for an Accounting service identifier. The Enter Source Address prompt appears. 5 Enter the IP address or hostname of the Accounting service you are associating with this group.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE a At the Enter Password for Username prompt, enter cworks. An asterisk (*) appears at the Password prompts. Enter and re-enter the password for the user (default username is cworks). The ‘cworks’ in the bracket after the prompt is not the default password. You must enter the correct password for the user.
Adding Accounting Services to the Call Records Service 35 empty password is accepted, which is probably not the correct password for that user (cworks) on the Accounting service. The Do you want to Update Password prompt appears. 6 Re-enter the password already assigned for the cworks user. Do not try to change a password here. The Update Source Address prompt appears. 7 Enter the IP Address of the server you need to edit. The Update Source Path prompt appears.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE empty password is accepted, which is probably not the correct password for that user (cworks) on the Accounting service. The Are you sure you want to Delete this Source prompt appears. 6 Enter y to delete the Accounting service. The Accounting service is deleted from the group and you are returned to the main menu.
Managing CDRs and Super CDRs 37 3 The screen displays the number of configured Accounting services. Press Enter to view the Accounting services (clustered in their group) until you reach the Enter Source Name to View Details prompt. 4 Enter the name of the appropriate Accounting service. The Accounting service details are displayed and you are returned to the main menu.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE Table 7 CDR Field Descriptions and Values (continued) Tag Variable Description and Values Example b0 SESSIONSEQUENCEEND Indicates when a session sequence ends. N/A For internal use only. b1 ACCTAUTHENTICATIONFAILURECNT Account Auth Failure Count 1 b3 CALLINGPARTYE164ADDRESS An E.164 number from which the 304001 call is placed to the access gateway. Only the phone extension is displayed.
Managing CDRs and Super CDRs 39 Table 7 CDR Field Descriptions and Values (continued) Tag Variable Description and Values Example f4 CALLTERMINATIONCAUSE Reason for call disconnect or not completed. Note that a value of zero indicates that the call has not been disconnected, or that no disconnect reason was given. Only one value can be provided as the disconnect reason. 404 The codes listed come directly from the all processor and correspond to SIP error codes.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE Table 7 CDR Field Descriptions and Values (continued) Tag Variable Description and Values Example o5 OUTBOUNDENDPOINTTYPE Indicates the type of outbound end 2 point. 2 – Gateway 6 – Terminal 9 – Call processor 10 – Others 11 – Unknown 12 – Redirect call processor 13 – IP Messaging server o6 TRANSFEREDTOURI URI that a call was transferred to.
QoS Monitoring Statistics 41 cdr_c.xml A CDR looks similar to this: 12161113040109843791130400298437f49120050411 20:32:2220050411 20:32:2220050411 20:32:43210102< /j5>008fbe79-36a9-d911-89b3-b82da66107be4< o1>114000001sip:8475555000@10.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE in XML format and stored on the Accounting server in the /opt/3com/VCX/acctxml/qos directory. You can use a third-party application to download the QDRs and create reports. QoS monitoring, as implemented on a VCX system, covers 3Com IP telephones (models 310x) as endpoints. The EMS administrator can: ■ Configure one or more monitored endpoints or subnets. ■ Configure thresholds for QoS statistics generation by the phones on those monitored subnets.
QoS Monitoring Statistics ■ Packet Loss Average ■ Round Trip Delay Average 43 Note the following QoS monitoring considerations: ■ QoS configuration information (for example, monitored endpoints and thresholds) is persistent across system reboots and upgrades. ■ The endpoint statistics and call history tables available for viewing through EMS do not persist across reboots of the system, upgrades, or restarts of the Accounting server.
CHAPTER 2: CONFIGURING THE CALL RECORDS SERVICE
3 MANAGING VCX SERVERS This chapter describes various maintenance tasks you may need to perform on the VCX services running on servers in your VCX system. Most maintenance tasks require logging in to a VCX server using one of the VCX system accounts. Each account has an associated password. See About VCX Passwords for more information.
CHAPTER 3: MANAGING VCX SERVERS Managing the Tomcat Web Server Verifying Tomcat Server Status The Tomcat web server allows administrators and users to access web-based VCX management and provisioning interfaces. The Tomcat server can run on an IP Telephony and IP Messaging Server, an IP Telephony Server, an IP Messaging Server, or a Call Server. To verify that the Tomcat server is running: 1 Log in into the server hosting the Tomcat server using the root account.
Changing a Daylight Saving and Time Zone Configuration 47 cd /opt/3com/VCX/scripts/rc3.d ./S70tomcat start exit Clearing the Tomcat Cache If your browser generates page errors while accessing the VCX Central Manager or any of the web-based management interfaces (VCX Administrator, VCX User, or IP Messaging) such as “page not found”, “page doesn't render”, “page doesn't render correctly”, or “exception faults”, you may need to clear the Tomcat cache.
CHAPTER 3: MANAGING VCX SERVERS 3 Enter the following command: setup timezone 4 Follow the prompts to change the time zone setting. 5 Enter the following commands: save exit The configuration tool applies the changes. Managing Log and CDR Files VCX software writes data to various log files and call information to Call Detail Records (CDRs) and, optionally, Quality of Service Detail Records (QDRs). IP Messaging software also writes call information to CDRs.
Managing Log and CDR Files ■ 49 Additional IP Messaging files you should periodically examine include: ■ /usr/app/gen/app.out ■ /usr/app/gen/eml_client.out ■ /usr/app/gen/cpy4.out Each of these files resets after a restart of IP Messaging. Consequently, these files will not grow too large unless the system is extremely busy or the system runs without a restart for a long period of time (months).
CHAPTER 3: MANAGING VCX SERVERS Accounting server, do not change this setting. The Call Records service will purge CDRs from the Accounting server after collecting them. If you do not have Call Records service, change this setting to AUTO_CLEAN_IF_NO_LATEST_UPDATE="Y" to enable self-cleaning on the Accounting service. The variable AUTO_CLEAN_IF_NO_LATEST_UPDATE_INTERVAL is set to 96 hours (four days) by default. A smaller value initiates the self-cleaning more often.
Verifying Service Operation 51 If you enable generation of QoS statistics and QDRs, change this setting to AUTO_CLEAN_IF_NO_LATEST_UPDATE="Y" to enable self-cleaning on the Accounting service. The variable AUTO_CLEAN_IF_NO_LATEST_UPDATE_INTERVAL is set to 96 hours (four days) by default. A smaller value initiates the self-cleaning more often. A larger value allows the QDRs to remain on the Accounting server longer. 5 Save your changes.
CHAPTER 3: MANAGING VCX SERVERS Starting the Common Agent To start the Common Agent: 1 Log in using the root account. 2 Enter the following commands: cd /opt/3com/VCX/commagent/vcx-scripts/init.d ./commagent start Stopping the Common Agent you can stop the Common Agent using operating system commands or using EMS.
Managing the Common Agent Restarting the Common Agent 53 If the Common Agent is currently running, use EMS to restart the Common Agent immediately or gracefully. If the Common Agent is stopped, EMS will not be able to communicate with the VCX system to issue the restart command. The Common Agent can also be restarted from the VCX console.
CHAPTER 3: MANAGING VCX SERVERS Managing the Call Processor Service This section describes how to start and stop the Call Processor service, and how to view Call Processor service status. The script that starts the Call Processor service runs the Call Processor service in the background with the Call Processor process monitor. The process monitor monitors the Call Processor server application and restarts it if the application stops.
Managing the Call Processor Service Stopping the Call Processor 55 You can stop the Call Processor service using operating system commands or by using EMS. Using Operating System Commands To stop the Call Processor service using operating system commands: 1 Log in into the server hosting the Call Processor service using the vcx account. 2 Enter these commands: cd /opt/3com/VCX/scripts/rc3.d .
CHAPTER 3: MANAGING VCX SERVERS Using EMS To restart the Call Processor service from EMS: 1 From the Explorer tab, right-click the 3Com Call Processor service. 2 From the pop-up menu, select Maintenance, then select Hard Restart to shutdown and restart the Call Processor service.
Managing the Accounting Service and the Authentication and Directory Service Viewing Service Status 57 To view the status of the Accounting service or the Authentication and Directory service: 1 Log in to the server hosting the service whose status you want to view using the root account. 2 Enter the following commands: cd /opt/3com/VCX/scripts/rc3.d .
CHAPTER 3: MANAGING VCX SERVERS Restarting a Service To restart the Accounting service or the Authentication and Directory service: 1 Log in to the server hosting the service you want to restart using the root account. 2 Enter the following commands: cd /opt/3com/VCX/scripts/rc3.d .
Managing the Accounting Service and the Authentication and Directory Service Enabling Server Logging 59 The files acctxmlconfig.xml (Accounting service) and vcxdataconfig.xml (Authentication and Directory service) each have a setting to enable server logging. This is used to control the common logging function, which is shared with all Tier 2 and Tier 3 devices. This controls the logging of various status, warning, and error messages in the server.
CHAPTER 3: MANAGING VCX SERVERS Verifying SNMP Support To verify that either the acctxmlconfig.xml (Accounting service) or vcxdataconfig.xml (Authentication and Directory service) files are set up for the back-end server: 1 Log in to the server hosting the service using the root account. 2 Enter the following command: cd /opt/3com/VCX//conf For , enter acctxml for the Accounting service or enter vcxdata for the Authentication and Directory service. 3 Open the acctxmlconfig.
Managing the SIP Phone Downloader 61 6 Start the Common Agent service by entering the following commands: cd /opt/3com/VCX/commagent/vcx-scripts/init.d ./commagent start 7 Start the service (see Starting a Service). Managing the SIP Phone Downloader Starting the SIP Phone Downloader The SIP Phone Downloader loads an application image on to a 3Com phone, which enables SIP support on the phone.
CHAPTER 3: MANAGING VCX SERVERS Managing the IP Messaging Service Verifying IP Messaging Service Status The IP Messaging service provides voicemail and unified messaging services to users. To verify the status of the IP Messaging service: 1 Log in to the server hosting the IP Messaging service using the app account. 2 Enter the following commands: cd /opt/3com/VCX/scripts/rc3.d .
Managing Authorized SNMP Station Access Managing Authorized SNMP Station Access 63 You can use an SNMP management station, such as 3Com Corporation’s Enterprise Management Suite, to manage a VCX server. You must, however, grant the management station explicit access to the VCX server to enable the exchange of SNMP management and monitoring messages. You can add and delete SNMP stations using the cagManageAuthorizedStations script.
CHAPTER 3: MANAGING VCX SERVERS delete :- Remove an authorized station entry quit:- exit this utility help:- show commands that are supported ***************************************************** supported commands are "show", "add", "delete", "quit", "help":: ■ ■ ■ Changing Codecs To add an SNMP management station, enter add. The script prompts you to enter the IP address and network mask of the management station you want to add. To delete an existing SNMP management station, enter delete.
Changing Codecs 65 If you want to enable a set of language prompts that are compatible with the currently operating codec, simply run the add_language utility as described in “Adding a Set of Language Prompts” in the IP Messaging Module Operations and System Administration Guide. IP Messaging supports only one codec at a time. How to Change Your Codec ■ If you want your IP Messaging system to operate with a different codec (for example, switch from the default G.
CHAPTER 3: MANAGING VCX SERVERS 4 Enter the following command to switch to the directory containing the add_language and change_codec: utilities: cd /usr/app/app.dir 5 Enter the following command to run the add_language utility: ./add_language 6 Enter the appropriate response to the prompt to add UK English language prompts. 7 Enter the following command to run the change_codec utility: .
Changing Codecs 67 (US English). The steps in the example install the G.729a codec and convert any existing custom prompts and voice mail messages to the G.729a codec format. IP Messaging must not be actively processing calls while the codec_data_convert utility is running. 1 Log in to the primary IP Messaging server using the root account. 2 Enter the following command to switch to the IP Messaging installation directory: cd /opt/installtemp 3 Enter the following command to install the G.
CHAPTER 3: MANAGING VCX SERVERS
4 BACKING UP AND RESTORING A VCX CONFIGURATION This chapter describes how to back up and restore a VCX system configuration using the vcx-config-backup and vcx-config-restore commands.
CHAPTER 4: BACKING UP AND RESTORING A VCX CONFIGURATION VCX Configuration Backup and Restore Overview The VCX configuration backup and restore feature allows you to completely back up all relevant VCX configuration data on a machine running one or more VCX services into a single file, and subsequently restore that configuration using the backup file. You can perform the backup and restore operations either locally (using the vcx-config-backup and vcx-config-restore commands) or remotely (using EMS).
VCX Configuration Backup and Restore Overview 71 Note that the vcx-config-restore command includes a parameter, exclude-os, that excludes the operating system information from a restore operation. If you select this option, the restore operation generates a warning if the system's current IP configuration does not match the configuration contained in the backup file.
CHAPTER 4: BACKING UP AND RESTORING A VCX CONFIGURATION apply the old configuration by restoring the backup file to the upgraded system. Backing Up a VCX Configuration ■ You can backup and restore the currently active version of VCX software and the currently active version of the VCX operating system only. Configuration files from any other versions of VCX (or its constituent components) or the operating system which may be on the system are not backed up.
Backing Up a VCX Configuration ■ 73 --test — Lists the files that would be backed up but does not create the backup file. The backup file is created in the /opt/3com/VCX/backup directory. The directory will be created if it does not already exist. Note that a VCX component may designate some configuration files and directories as optional. Optional files and directories are backed up if present but no error results if they are absent.
CHAPTER 4: BACKING UP AND RESTORING A VCX CONFIGURATION Table 8 VCX Configuration Backup File Naming Format (continued) Filename Element Description Specifies the configuration type of the system on which the vcx-config-backup command was executed. Possible values for type include: ■ all — Indicates the host system is running as an IP Telephony and IP Messaging Server. ■ softswitch — Indicates the host system is running as an IP Telephony Server.
Restoring a VCX Configuration 75 The optional arguments include: ■ ■ ■ ■ --help — Displays information on command usage. --fullauto — Displays complete information about the backup file (version, operating system version, components, and so on). --version — Displays the version of VCX software for the components contained in the backup file. --osversion — Displays the version of the VCX operating system contained in the backup file.
CHAPTER 4: BACKING UP AND RESTORING A VCX CONFIGURATION VCX Configuration, some configuration files and directories may be designated as optional. Optional files and directories are backed up if present when the vcx-config-backup command is executed. Optional files configured after the backup operation are removed during the restore operation. Similarly, the content of a directory backup replaces in full the content of the directory at the time of the restore.
Backup and Restore Operation Logs 77 Note that, for security reasons the VCX firewall is not stopped. Furthermore, the Common Agent stops only briefly while its own restore is done. For EMS-based operations, this minimizes the time during which remote manageability is unavailable. Backup and Restore Operation Logs Each execution of the vcx-config-backup and vcx-config-restore command is tracked using syslog. Information about each backup and restore operation is written to /var/log/messages.
CHAPTER 4: BACKING UP AND RESTORING A VCX CONFIGURATION
5 MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES This chapter describes how to manage the database associated with each Authentication and Directory service.
CHAPTER 5: MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES Backing Up and Restoring the Authentication and Directory Server Database Your VCX system includes backup and restore utilities for the VCX Authentication and Directory server database. This database includes provisioning data configured through the VCX Administrator web interface (refer to the VCX Administration Guide). 3Com recommends regular database backups. You should also back up this database before performing any upgrades.
Backing Up and Restoring the Authentication and Directory Server Database 81 4 Enter the following commands to change the directory and stop the VCX Authentication and Directory service. cd /opt/3com/VCX/scripts/rc3.d ./S20vcxdata stop 5 Enter the following commands to start the VCX Authentication and Directory server database backup utility: cd /opt/3com/VCX/vcxdata/bin ./backupVcxdata The utility prompts you to verify that Tomcat and the VCX Authentication and Directory server services are stopped.
CHAPTER 5: MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES To run the VCX Authentication and Directory server database restore utility: 1 Log in to the server hosting the Authentication and Directory database backup file. The steps in this procedure assume the backup file is located on another Authentication and Directory server. Log in using the cworks account.
Backing Up and Restoring the Authentication and Directory Server Database 83 scp or ssh, you will be prompted to confirm that you want to trust the target server. 1 Log in to both the primary and secondary servers hosting Tomcat using the tomcat account. Depending on your VCX configuration, Tomcat runs on either the IP Telephony server, the IP Telephony and IP Messaging server, or the Call server.
CHAPTER 5: MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES 8 Enter the site ID of the Master Definition site. The vcxdatabackup..tgz back up file located at /opt/3com/VCX/auth/db/import/ is restored to the VCX Authentication and Directory server database. 9 Enter the following command on the primary VCX Authentication and Directory server to start replication: ./setupReplication The Enter the VCX Site Identification i.e. Site Id prompt appears.
Exporting Table Data 85 cd /opt/3com/VCX/scripts/rc3.d ./S20vcxdata start Exporting Table Data Use the CWDATA package to export tables into flat files. Export data as follows: ■ For one table in a schema (except the runtime tables). See Exporting Table Data for a Single Table. ■ For all the tables under one schema (except the runtime tables). See Exporting Table Data for all Tables. Exporting data saves the current configuration.
CHAPTER 5: MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES To export all the tables in a schema: 1 From a SQL Plus command line, login as . 2 Execute the following: For this procedure, change the following to match the system: ■ Change the value of p_dir to the export directory. ■ Make sure to enter the procedure name EXACTLY as shown. SET SERVEROUTPUT ON declare p_dir varchar2(255); begin p_dir:='/tmp/export'; CWDATA.
Exporting Table Data Clearing the Configurable Tables Use this procedure to clear all the data tables in either the Accounting service, or the Authentication and Directory server. Once data is deleted it must be reloaded from the text files. To clear the configurable tables from the back-end server database: 1 Log on to the directory server as cworks. 2 Change to the /opt/3com/VCX//bin directory: cd /opt/3com/VCX//bin 3 Clear the data by entering the following command: ./besbulkload.
CHAPTER 5: MANAGING AUTHENTICATION AND DIRECTORY SERVICE DATABASES
6 MANUALLY CONFIGURING MULTI-MASTER REPLICATION This chapter describes Multi-Master Replication (MMR) and how to manually configure it in your VCX system.
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION Multi-Master Replication Overview Multi-Master Replication (MMR) is the process of copying and maintaining database tables in multiple databases that make up a distributed database system. Changes applied at one site are captured and stored locally before being forwarded and applied at each of the remote locations. Oracle replication is a fully integrated feature of the Oracle server; it is not a separate server.
Manually Configuring Replication for an IP Telephony Server or IP Telephony and Messaging Server Manually Configuring Replication for an IP Telephony Server or IP Telephony and Messaging Server 91 This section provides instructions on how to manually perform database replication for these two configurations: ■ Regional IP Telephony Server — An IP Telephony Server configuration includes the Accounting Services, the Call Records Services, the Call Processor, and the Authentication and Directory Services.
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION The Enter the VCX Site Identification i.e. Site Id: appears. 4 Enter the site ID of the office you are logged into. The Enter the Number of MASTER SITEs other than the MASTER DEFINITION SITE [1] prompt appears. Since there are only 2 servers in this configuration, enter 1. Typically, the primary server is the Master Definition Site and the secondary server is the Master Site. 5 Enter 1 for the total number of Master Sites in configuration.
Manually Configuring Region to Region Replication Manually Configuring Region to Region Replication 93 For multi-site configurations with 2 Regions, each region contains a replicated copy of the other region's database. For example, consider a multi-site configuration with two regions, Region 1 and Region 2. Each region has two Authentication and Directory server databases. ■ R1DB is the primary database located on Region 1.
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION d Enter y. 3 If you are setting up replication after provisioning data has been added to the regional database, the following procedure for backing up and restoring data must be performed; otherwise, continue with step 4. Backing up and restoring databases is not necessary if replication is set up after a fresh install on the Authentication and Directory servers (in other words, there is no data in the databases).
Manually Configuring Region to Region Replication 95 g Log in as cworks, and enter these commands: cd /opt/3com/VCX/vcxdata/bin ./restoreVcxdata h Enter the Site ID for Region 1. i Enter these commands: ./backupVcxdata cd /opt/3com/VCX/vcxdata/db/export There should be a single file with this format: vcxdatabackup.tgz j To place the file on the VCX Authentication and Directory server in Region 1, enter these commands: scp vcxdatabackup.
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION h Enter Site ID of Region 2. i For the Master Definition Site enter the IP address of Region 2. j For the Master Site enter the IP address of Region 1. k On each VCX Authentication and Directory server run checkReplication to verify replication is normal. l Log in as cworks and enter these commands: cd /opt/3com/VCX/vcxdata/bin ./checkReplication m Restart Tomcat on each region’s Call serve.
Verifying the Number of VCX Data Schemas in a Region 97 The Enter the Number of MASTER SITEs other than the MASTER DEFINITION SITE [1]: prompt appears. To determine the number of Master Sites associated with this branch, use the listVcxdata command. See Manually Configuring Replication for an IP Telephony Server or IP Telephony and Messaging Server on page 91 for more information.
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION Branch offices 1 through 3 replicate to Region 1 (primary), but since Region 1 (primary) is the Master Definition Site, there are only 3 Master sites in this cluster. Branch offices 4 through 6 replicate to Region 1 (secondary), which is considered a Master Site since it is not the primary regional office. This cluster has 4 Master Sites in it.
Deleting Replication Errors BRANCH1StLOUIS BRANCH2MADISON VCXDATA Schema Count: 3 Deleting Replication Errors This section provides details on how to use the VCX replication error deletion script. Replication errors occasionally need to be deleted (for instance, before you perform an upgrade). To delete replication errors, log onto the server hosting the VCX Authentication and Directory server as cworks and enter these commands: cd /opt/3com/VCX/vcxdata/bin .
CHAPTER 6: MANUALLY CONFIGURING MULTI-MASTER REPLICATION
7 RECONFIGURING A VCX SERVER This chapter describes how to reconfigure a VCX server using the vcx-reconfigure command.
CHAPTER 7: RECONFIGURING A VCX SERVER Reconfiguration Overview Reconfiguring a VCX server enables you to modify its networking parameters and the configuration of the services that run on the server. You may decide to reconfigure a VCX server if, for example, you are moving it to a new subnetwork or if you are expanding your VCX system to include additional servers and need all servers to work together in the new configuration.
Sample VCX Server Reconfiguration Sample VCX Server Reconfiguration 103 The sample reconfiguration script in this section is based on a two-server configuration. The changes made are described in Table 9. Any configuration parameters not listed in Table 9 remain unchanged. Table 9 Changes in Server Configuration Parameter Original Value New Value IP Address (eth0) 10.230.64.30 10.230.64.40 IP Address (eth1) 10.230.64.31 10.230.64.41 Partner IP Address (eth0) 10.230.66.30 10.230.67.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script ----------------------------------------------------------------------------------------- Welcome to the VCX Reconfiguration Utility -----------------------------------------------------------------------------------------This utility allows a previously configured VCX system to be reconfigured for example, to change its IP address or the IP addresses of other VCX servers with which it communicates.
Sample VCX Server Reconfiguration 105 Sample VCX Reconfiguration Script (continued) Do you want to change any networking configuration? [no] :yes Dropping replication - please wait. Copyright (C) 2005 3COM Corporation. All rights reserved. Multi-Master Replication DROP Start Configuring .... Enter the VCX Site Identification i.e. Site Id: ?? []:testone Enter the site ID for this server.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) VCXDATATESTONEX Database Multi-Master Replication DROP Process starting ... For Log Details Refer to ../log/replication_VCXDATATESTONEX_DROP200503300731.log Dec 14, 2005 9:05:25 AM com.coms.replication.run.Start dropReplication INFO: ----------------------------------------------3Com VCXDATATESTONEX Database ...
Sample VCX Server Reconfiguration 107 Sample VCX Reconfiguration Script (continued) -------------------------- Configuring Hostname --------------------------Enter system hostname : test-three In this sample script, the host name is being changed from test-one to test-three. --------------------- Configuring IP Interface 'eth0' --------------------IP Address : 10.230.64.40 Network Subnet Mask : 255.255.255.0 Default Gateway Address : 10.230.64.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) -------------------- Configuring Network Time Protocol -------------------Enter NTP servers one at a time. When done, enter 0.0.0.0 to stop. Primary NTP Server Secondary NTP Server : 10.35.10.51 : 10.36.10.51 In this sample script, NTP server IP addresses remain unchanged. CAUTION: If VCX systems are not synchronized via NTP, timing-related problems can occur.
Sample VCX Server Reconfiguration 109 Sample VCX Reconfiguration Script (continued) In this sample script, the country code remains unchanged. Please select a time zone from the following list: 1. Alaska Time 2. Alaska Time - Alaska panhandle 3. Alaska Time - Alaska panhandle neck 4. Alaska Time - west Alaska 5. Aleutian Islands 6. Central Time 7. Central Time - Michigan - Wisconsin border 8. Central Time - North Dakota - Oliver County 9. Eastern Standard Time - Indiana - Crawford County 10.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) DNS Servers: 10.25.10.31 10.26.10.31 10.27.10.31 Search Domains: ne.3com.com NTP Servers: 10.35.10.51 10.36.10.51 Time Zone: America/New_York --------------------------------------------------------------------------Is all of the above information correct? [yes] : Press the Enter or Return key to accept the information. To change any of the parameters, enter no.
Sample VCX Server Reconfiguration 111 Sample VCX Reconfiguration Script (continued) --------------------------------------------------------------------------------------- Welcome to the VCX Service Reconfiguration Wizard --------------------------------------------------------------------------------------------------------------- Configuring VCX Services ------------------------Services running on this server need to communicate with other systems and devices in order to operate.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) The SIP default dialing domain is used to construct the SIP URI for outbound SIP requests. Enter the SIP default dialing domain : 1.1.1.1 In this sample script, the dialing domain remains unchanged. The secondary Call Processor acts as a backup if the primary is down or unreachable. IP address of the secondary Call Processor : 10.230.67.41 Call Processor tasks are associated with the eth1 network interface.
Sample VCX Server Reconfiguration 113 Sample VCX Reconfiguration Script (continued) The secondary Media Gateway is an additional interface between the VCX IP Telephony system and the external telephone network. If there is no secondary Media Gateway, leave this entry blank. IP address of the secondary Media Gateway : 10.230.67.15 In this sample script the IP address of the secondary media gateway remains unchanged. Press the Enter or Return key to accept the current IP address.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) --------------- Configuring additional parameters for System --------------- This section allows you to change the password for each VCX system account. Press Enter to accept the current password. Root account password. A blank entry means 'no change'. Password Password (confirm) : : Oracle account password. A blank entry means 'no change'. Password Password (confirm) : : Tomcat account password.
Sample VCX Server Reconfiguration 115 Sample VCX Reconfiguration Script (continued) ---------- Configuring additional parameters for UPS Monitoring ----------An Uninterruptible Power Supply (UPS) can be used with VCX systems to avoid disruption due to a power outage. VCX provides a UPS monitoring service which tracks the UPS's status and performs a safe shutdown when the its battery is depleted during a long power outage.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) The SNMP 'write' community string configured in the UPS is required. (For security reasons, it is recommended that the default value provided by the UPS be changed.) UPS 'write' community string : private The string you enter here must match the SNMP write community string configured on the UPS. Enter the IP address assigned to the second UPS's management card or Ethernet interface.
Sample VCX Server Reconfiguration 117 Sample VCX Reconfiguration Script (continued) -------- Configuring additional parameters for IP Messaging Service -------The hostname of the other IP Messaging system is needed in order to set up Intelligent Mirroring redundancy with this system. Hostname of peer IP Messaging system : test-four Enter the host name of the Secondary VCX Server, as it will be defined after the reconfiguration.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) IP Messaging includes an optional ability to back up messages to an external server. Enable data backup server for IPMS? [N] : Press the Enter or Return key to accept the default answer. In this sample script, the default answer (N) indicates that data backup was not originally enabled on this server. IP Messaging includes an optional ability to import subscriber profiles from VCX.
Sample VCX Server Reconfiguration 119 Sample VCX Reconfiguration Script (continued) Do you wish to change any of the IP Messaging System parameters? [N] : Press the Enter or Return key to accept the data that you have accepted or changed. To review the data and make additional changes, enter Y. --------- Configuring additional parameters for Auth & Dir Service --------At a branch office, the password for access to the regional office system's 'cworks' account is required.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) In some cases it may be desirable for SNMP Traps to be sent to multiple destinations. Additional Trap Destinations can be entered here. Enter a blank input to indicate that all destinations have been entered. IP Address of the first additional trap destination for this system. Trap Destination : 10.230.62.
Sample VCX Server Reconfiguration 121 Sample VCX Reconfiguration Script (continued) Common Agent supports a management station authentication feature. Answering 'Y' here will allow only a set of pre-identified SNMP management stations to manage the system. (You will be able to enter IP addresses of authorized management stations next. Authorized management stations can also be configured using EMS or another management station at a later point.
CHAPTER 7: RECONFIGURING A VCX SERVER Sample VCX Reconfiguration Script (continued) ---------------------------- Applying Changes ----------------------------- The script displays several status messages. The last message reminds you to reboot all servers after they have all been reconfigured and to reboot them all at the same time.
8 MANAGING UNINTERRUPTIBLE POWER SUPPLIES This chapter describes how to manage one or more Uninterruptible Power Supplies (UPS) in your VCX system. It describes how to add UPS support to an existing VCX system, and how to monitor UPS status.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES UPS Overview Critical network equipment is often connected to an Uninterruptible Power Supply (UPS) to ensure continued operation in the event of mains power loss. A server in a VCX system can be connected to, and can monitor, one or two (if the server has dual power supplies) UPS devices. Each UPS includes a battery. The battery maintains a charge while power is supplied to the VCX system.
Adding UPS Support to an Existing VCX System UPS Configuration Options 125 For the current VCX software release, 3Com Corporation supports UPS hardware from American Power Conversion (APC) Corporation. For a list of supported APC UPS devices and VCX hardware platforms, consult with your 3Com Service Representative or your 3Com Voice Authorized Reseller. To install and configure a UPS, follow the instructions provided by APC.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES ■ Set up two UPS devices to service a single VCX server with redundant power supplies. ■ Set up one UPS to service multiple VCX servers. ■ Set up two UPS devices to service multiple VCX servers through one server with redundant power supplies. As a general rule, the power requirements of devices serviced by a UPS should not exceed 80% of UPS load capacity.
Adding UPS Support to an Existing VCX System Requirements 127 Setting up a VCX system to use UPS power and to monitor UPS status using the vcx-ups-setup command requires the following configuration information for each UPS in the VCX system: ■ IP address of the UPS — You must know the pre-configured IP address assigned to the UPS. ■ SNMP community string — You must know the pre-configured SNMP write community string assigned to the UPS.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES Enter N (you must uppercase) to indicate there is a single UPS servicing the entire VCX system. -- upsipaddr Enter the IP address of the UPS. Use dotted decimal notation but do not enter leading zeros. For example, enter 10.230.63.3, not 010.230.063.003. -- community Enter the SNMP community string configured on the UPS to enable communication between the master VCX server and the UPS.
Adding UPS Support to an Existing VCX System 129 Note that you must include all the vcx-ups-setup command parameters even if you are only changing a single value. Single UPS System – Configuring a Slave VCX Server To enable and configure a VCX server as a slave in a single UPS system: 1 Log in, using the root account, to the VCX server you want to designate as a slave.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES After the initial slave VCX server configuration, you can change a parameter value by reentering the vcx-ups-setup command. In the following example, the IP address of the master VCX server is changed: vcx-ups-setup --master N --monitormultipleups N --upsserver 10.230.63.7 Note that you must include all the vcx-ups-setup command parameters even if you are only changing a single value.
Adding UPS Support to an Existing VCX System 131 devices are used to provide power. For servers with redundant power supplies, ensure that each power supply is connected to a different UPS (and if possible, you should connect each UPS to different mains circuits). In this case, the servers should all remain operational unless both UPS devices are on battery and at or below the low battery threshold. At this point, a coordinated shutdown of all systems must be performed.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES Figure 4 Two UPS Devices Powering Redundant VCX Servers Primary IPM Server VCX Server UPS UPS VCX Server Secondary IPM Server When you have multiple UPS devices, you should connect each UPS to different mains circuits if possible. Dual UPS System – Configuring the Master VCX Server To enable and configure a VCX server as the master in a multiple UPS system: 1 Log in, using the root account, to the VCX server you want to designate as the master.
Adding UPS Support to an Existing VCX System 133 Enter Y (you must uppercase) to indicate there are multiple UPS devices servicing the VCX system. -- upsipaddr Enter the IP address of the first UPS. Use dotted decimal notation but do not enter leading zeros. For example, enter 10.230.63.3, not 010.230.063.003. -- community Enter the SNMP community string configured on the first UPS to enable communication between the master VCX server and the UPS.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES ■ The IP address of the second UPS is 10.230.63.4. ■ The community string the second UPS will use to communicate with the master VCX server is private. ■ The low battery threshold charge is 33%. After the initial master VCX server configuration, you can change a parameter value by reentering the vcx-ups-setup command.
Adding UPS Support to an Existing VCX System 135 The following example shows the syntax required to initially configure a slave VCX server in a system supported by multiple UPS devices: vcx-ups-setup --master N --monitormultipleups Y --upsserver 10.230.63.5 When this command is executed: ■ UPS monitoring is enabled on the current VCX server. ■ The server is designated a slave. ■ The VCX system will be serviced by multiple UPS devices. ■ The IP address of the master VCX server is 10.230.63.5.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES The optional argument --fullauto specifies that the command should run in automatic mode. In this mode, command execution does not provide any interactive prompts or queries. Note that you can enter the vcx-ups-setup command with the optional --help argument to display information on command usage.
Monitoring UPS Status 137 Table 10 vcx-ups-status Command Parameters (continued) Parameter Description --ismaster Indicates whether or not (Y or N) this VCX server is configured as the master. --listslaves Lists the IP addresses of all VCX servers configured as slaves. --all Displays values for the following parameters: --help ■ upsstatus ■ upsload ■ upsmfr ■ batterycharge ■ upsserial ■ upsmodel Displays information on command usage.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES VCX Server Response to Power Events This section describes how UPS-supported VCX systems respond to various power events. Power events and VCX server responses are shown in Table 11. Table 11 VCX Server Behavior for Power Events Event Response Power Loss When one or more VCX servers are connected to a UPS and a power loss occurs, the servers continue to operate without interruption.
VCX Server Response to Power Events 139 Table 11 VCX Server Behavior for Power Events (continued) Event Response Final Shutdown The UPS receives a signal to turn off after a time delay (the default is 270 seconds) to allow for the last shutdown steps to complete. The VCX system generates a trap indicating that shutdown in imminent. If multiple VCX servers are powered from the same UPS, all servers are provided sufficient time to complete their individual shutdown operations.
CHAPTER 8: MANAGING UNINTERRUPTIBLE POWER SUPPLIES
9 CONFIGURING THE CALL PROCESSOR The VCX Call Processor provides call routing as well as other call services for the VCX IP Telephony Solution.
CHAPTER 9: CONFIGURING THE CALL PROCESSOR Call Processor Overview Call Processor Advantages Configuration Methods The Call Processor handles both call processing and call routing and acts as a SIP back-to-back user agent. This means that the Call Processor actually serves as one active end point for each signaling leg of a call. The Call Processor advantages are: ■ Uses stateful routing — maintains information about a user’s session.
Configuring Trusted Endpoints ■ 143 Through the remoteCli Command Line Interpreter The remoteCli interface is run from a console attached to the VCX server. This command allows you to configure trusted end points (described in this chapter) and other VCX components (see Call Processor Command Line Interface Commands). The Call Processor XML file (nmdb.
CHAPTER 9: CONFIGURING THE CALL PROCESSOR 3 Start the remoteCLI interface: .
Configuring Accounting and Directory Services Editing Trusted Endpoints 145 To edit a trusted endpoint of a Call Processor using the CLI: 1 Log onto the server hosting the Call Processor. 2 Navigate to the /opt/3com/VCX/callprocessor/remoteCli/bin. 3 Start the remoteCLI interface: .
CHAPTER 9: CONFIGURING THE CALL PROCESSOR CAUTION: If you add one or both of these services using the method described in this section and later you run the vcx-reconfigure command, the list of services provided in vcx-reconfigure will override those defined using remoteCli. Furthermore, if you reconfigure your VCX system using remoteCli and subsequently upgrade the system to a newer release, the upgrade process will not recognize the remoteCli reconfiguration.
Configuring Accounting and Directory Services 147 config accts pri=2 IpAddress= config accts pri=2 LocalIpAddress= config acctc use=true 5 The interface lists the IP address of the new Accounting server.
CHAPTER 9: CONFIGURING THE CALL PROCESSOR config authc use=false config auths pri=2 IpAddress= config auths pri=2 LocalIpAddress= config authc use=true 5 The interface lists the IP address of the new Authentication and Directory Server.
10 MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE This chapter describes how to add, modify, and delete user accounts using the user-MAC command.
CHAPTER 10: MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE Command Overview The user-MAC command enables the automated creation of VCX user accounts and phone extension assignments. You can run the command in two modes: ■ Single user mode — In this mode, the command adds one user account at a time based on the user attributes specified as command parameters. You can also use this mode to modify or delete a single user account.
Command Overview 151 Table 13 User Account Attributes (continued) Attribute Description Phone Address (extension) Mandatory. Specifies the phone extension to be assigned to the user account. The specified number must be unique on the Call Processor. Site Id Optional. Specifies the site identifier assigned to the location hosting the account. This ID is specified during VCX software installation procedure. Host Name Optional.
CHAPTER 10: MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE mode, the required syntax, and examples. For online help with command syntax, enter the following command: ./user-MAC --verbose-help When you execute the user-MAC command, console output indicates the progress of the requested action and provides a summary when finished. Using Single User Mode You can use the user-MAC command in single user mode to add modify, or delete one user account at a time.
Using Single User Mode 153 Table 14 user-MAC Command Parameters (continued) Parameter (full name/abbreviation) Takes Value? Mode Parameter Type --password or --pa Yes Single String Description The value specifies the password the user enters to access the VCX User Provisioning interface. To create the account with the default password (changeme), omit this field. --title or --t Yes Single String The value specifies an honorific (for example, Mr or Ms).
CHAPTER 10: MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE Note the following syntax considerations: ■ Full parameter and abbreviated parameter names must be prefaced with two hyphens (for example, --password). ■ String parameter values that include spaces, punctuation, or special characters must be enclosed in double quotation marks. For example, the address 26 Granite Street must be entered as --street1 “26 Granite Street”.
Using Single User Mode 155 If you want to change the account’s username, you enter the user-MAC command with --modify plus the --uname parameter and the --new-uname parameter. You cannot use the user-MAC command with the --modify to change the value of the --site-id parameter. However, the --site-id parameter is required in modify mode if you want to change account parameters for a user who is not located in the default site (the site on which you are logged in).
CHAPTER 10: MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE The following example adds a user account for jjohnson and assigns the user the phone extension 2314323. The account will be created on the branch office with the site ID Br3. user-MAC --uname jjhonson --password 3dkaRiEI02 --title Mr --first Jack --middle Oliver --last Jhonson --email jackj@dcah.
Using Batch Mode 157 Batch mode processing can run in either stop mode (the default) or non-stop mode (the user-MAC command line includes the --non-stop qualifier). For both modes, during the initial parse, the input file is validated for format but not for content validity. If the parse encounters a formatting error (for example, an angle bracket (>) is missing in an XML file), processing stops. ■ In stop mode, if an error is found after the initial parse is complete, processing stops.
CHAPTER 10: MANAGING USER ACCOUNTS USING THE COMMAND LINE INTERFACE newPhone?, newUname?, password?, title?, first?, middle?, last?, email?, street1?, street2?, city?, state?, country?, zip?, site?, remote?, pprofile? )> uname (#PCDATA) > phone (#PCDATA) > newPh
Using Batch Mode 159 value value value value value value value value value value value value value value value value value value