Software Guide
MultiVOIP Gatekeeper Software Guide P/N S0000123, Revision Beta Copyright © 2001 by Multi-Tech Systems, Inc. All rights reserved. This publication may not be reproduced, in whole or in part, without prior expressed written permission from Multi-Tech Systems, Inc. Multi-Tech Systems, Inc. makes no representation or warranties with respect to the contents hereof and specifically disclaims any implied warranties of merchantability or fitness for any particular purpose. Furthermore, Multi-Tech Systems, Inc.
Software User License Agreement The MultiVOIP Gatekeeper software is licensed by Multi-Tech Systems, Inc., to the original end-user purchaser of the product, hereafter referred to as “Licensee.” The License includes the distribution disc, other accompanying programs, and the documentation. The MultiVOIP Gatekeeper software, hereafter referred to as “Software,” consists of the computer program files included on the original distribution disc.
Contents 1 Introduction Introduction............................................................................................................................. 2 Features.................................................................................................................................... 2 Typographic Conventions ..................................................................................................... 4 2 Overview Introduction.....................................................
Call Details Commands (manual mode only) ............................................................31 RIP Message Dialog Box................................................................................................31 H.450 Transfer Destination Dialog Box ..............................................................................32 Transfer by Facility Dialog Box ...........................................................................................32 Send Facility Message Dialog Box..........
1 Introduction
MultiVOIP Gatekeeper Software Guide 1 Introduction Introduction This manual describes how to configure and manage the MultiVOIP Gatekeeper software. The software comes pre-installed on the Multi-Tech MultiVOIP™ Gatekeeper, Model MVPGK1. The MultiVOIP™ Gatekeeper is a complementary product to Multi-Tech’s MVP200 two- channel, MVP400 four-channel, and MVP800 eight-channel voice-over-IP gateways. It provides network managers with the power to define and control how H.
MultiVOIP Gatekeeper Software Guide 1 Introduction • Bandwidth management With the MultiVOIP Gatekeeper, the network administrator can specify bandwidth limitations within a gatekeeper’s zone and can specify a bandwidth limit for gateway endpoints. For example, a gatekeeper may determine there is no bandwidth available for a call or no additional bandwidth available for an ongoing call requesting an increase. This provides an easy and effective means of controlling traffic volume.
MultiVOIP Gatekeeper Software Guide 1 Introduction Typographic Conventions Certain typographic conventions have been adopted throughout the text of this manual to illustrate keyboard input, screen display dialogs, and special vocabulary. • Text entered by you is shown in bold. Example: supervisor. • Code examples and screen messages are shown in a monospace font. • Italics are used for important new terms, for book and manual titles, and when terminology is explained, introduced, or emphasized.
2 Overview 5
MultiVOIP Gatekeeper Software Guide 2 Overview Introduction The Gatekeeper program interface consists of the following windows and dialog boxes, which are explained in detail in the following chapters: • Main window For monitoring registrations and call transactions. Selecting objects in this window lets you access windows and dialog boxes for setting policies dealing with endpoints, current calls, network parameters, services, topology islands, neighbor gatekeepers, and H.450 transfers.
MultiVOIP Gatekeeper Software Guide 2 Overview Data Files When the Gatekeeper program is run for the first time, it creates three files that contain important data. To run the Gatekeeper with default values only, make sure that the primary and backup files are not present in the directory before starting the program. • primary.dat This file contains the saved configuration and user data. The primary.dat file is written to when you press the Save button in the main window. • backup.
3 Main Window 8
MultiVOIP Gatekeeper Software Guide 3 Main Window Gatekeeper Main Window The Gatekeeper main window displays messages and faults produced by the Gatekeeper. In the main window you can monitor registrations and call transactions, and gain access to windows for setting policies dealing with endpoints, calls, parameters, services, topology islands, and neighbor gatekeepers.
MultiVOIP Gatekeeper Software Guide 3 Main Window • Neighbor gatekeepers Details of these windows are given in the following chapters. Log The Log has two tabs that display Gatekeeper messages and faults as they occur. All entries are time-stamped. The Messages tab also displays a resources report that lists Gatekeeper resource availability for the current Gatekeeper session. For more information, see “Resources Report.
MultiVOIP Gatekeeper Software Guide 3 Main Window Registration Causes the Gatekeeper to carry out registration transactions automatically, using the default event handler function. Calls Causes the Gatekeeper to carry out call transactions automatically, using the default event handler function. Supplementary Services Causes the Gatekeeper to carry out Supplementary Service transactions automatically, using the default event handler function.
MultiVOIP Gatekeeper Software Guide 3 Main Window Resources Button Click the Resources button to generate a Resources Report that lists Gatekeeper resource availability for the current Gatekeeper session. The report is displayed in the Messages tab of the Log window. The following items are listed for each resource type: • The number of items currently being used. • The maximum number of items available. • The maximum number of items used in the Gatekeeper session.
MultiVOIP Gatekeeper Software Guide 3 Main Window Memory Configuration Dialog Box To open the Memory Configuration dialog box, click the Memory Config button in the Gatekeeper main window. Use this dialog box to supply the number of maximum calls, the Gatekeeper configuration values, the network configuration values for the system, the RAS and Q931 values, and the H.245 Proxy network address. Figure 3-3 Memory Configuration dialog box Maximum Calls The maximum number of concurrent calls.
MultiVOIP Gatekeeper Software Guide 3 Main Window Memory Selecting the Memory option enables you to set the memory size for the non-volatile part of the Gatekeeper memory configuration. Storage Size The total size of the memory. Registration Table Size The size of the Registration Table memory. Cell Size The size of cells in bytes used to store the addresses. The number reflects the average size of the alias. If aliases are long, larger cell size prevents the extra 21 byte overhead per cell.
MultiVOIP Gatekeeper Software Guide 3 Main Window System Allows the setting of values that control the amount of memory allocated for managing H.323-opened transactions. You can let the Gatekeeper automatically adjust the system values, or you can specify each value separately. Auto Adjustment to Maximum Calls Select to allow the Gatekeeper to automatically adjust the values to the setting in the Maximum calls field. Pool Size The maximum size of the Protocol Value Tree (PVT) pool.
MultiVOIP Gatekeeper Software Guide 3 Main Window RAS Specifies the RAS transport parameters. Response TO The timeout in seconds before retransmission. Port The RAS port of the Gatekeeper. Multicast IP The multicast IP address of the Gatekeeper. Multicast Port The multicast IP port of the Gatekeeper. Q931 Specifies the Q931 transport parameters. Response TO The timeout in seconds waiting for the TCP reply. Connect TO The timeout in seconds waiting for the Connect message of a call.
4 Endpoints Window 17
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window Endpoints Window To open the Endpoints window, click Endpoints in the Windows Menu. The Endpoints window is used to monitor the status of the registration, either static or dynamic. From the Endpoints window you can access the Predefined Properties dialog box and the Online Properties dialog box.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window • Message The type of message sent by the endpoint when the mode for processing registration is manual. This can be an LRQ, RRQ, URQ, or AppURQ (which is a URQ sent by the Gatekeeper). • Time To Live The time remaining in seconds before the TimeToLive timer expires. If the endpoint fails to reregister within this time, the endpoint is unregistered.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window RRQ/URQ Dialog Boxes The RRQ and URQ dialog boxes open only when the mode for processing the registration is manual, which you set by clearing the Registration option in the Automatic Modes box. These dialog boxs display the contents of the current message related to the endpoint. The message may be sent by the endpoint or to the endpoint by the Gatekeeper. The RRQ and URQ dialog boxes contain response buttons that correspond to the message type.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window All endpoints—terminals, Gateways, and MCUs—together with their Gatekeeper, constitute a zone. You can configure a zone in advance by predefining endpoints that are entitled to register with the Gatekeeper. This is done by first adding new endpoints with their details in the Predefined Properties dialog box and then setting Registration Policy in the main window to Predefined endps.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window Registration IP/Port The RAS addresses for this terminal. If the endpoint has a fixed IP address, enter this address. Otherwise, you can use Dynamic IP (DHCP) policy, as explained in the “Endpoints Window” chapter. If you are registering only one terminal with this IP, you can leave the port field empty. A port number is required only when two terminals are using the same IP, such as when two terminals are running on the same host.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window Online Properties Dialog Box When an endpoint registers with the Gatekeeper, the endpoint is activated, becoming online. Following an orderly shutdown, the endpoint unregisters automatically, ending the online portion of the registration. Registration informs the Gatekeeper that the endpoint is active and ready to receive calls. Calls are routed only to online endpoints.
MultiVOIP Gatekeeper Software Guide 4 Endpoints Window The fields displayed in the Online Properties dialog box are similar to the fields in the Predefined Properties dialog box with the following changes: Time to Live Lets you set a new value for the Time to Live (TTL) timer that was set when the endpoint registered. By so doing, you can speed or postpone the expiration time of an endpoint that supports the TTL mechanism.
5 Calls Window 25
MultiVOIP Gatekeeper Software Guide 5 Calls Window Calls Window To open the Calls window, click Calls in the Windows Menu. The Calls window displays all calls currently taking place with detailed information about each call. From this window you can open the Call Details dialog box, the H.450 Transfer Destination dialog box, the Facility Transfer dialog box, and the Send Facility dialog box.
MultiVOIP Gatekeeper Software Guide 5 Calls Window • CID The conference ID number. • Call ID The call ID number. Calls Commands Disconnect Call Disconnects the selected call. Disconnect Destination Disconnects the destination of the call only and allows the application to route the call to a new destination. This option takes effect only before a call connects. Disconnect All Causes all current calls to disconnect.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Figure 5-2 Call Details dialog box for a new call Figure 5-3 Call Details dialog box for an existing call You can enter or view details of a call in the following fields of the dialog box: 28
MultiVOIP Gatekeeper Software Guide 5 Calls Window Call General Information Call Number The number of the call you selected. CID Sum The conference ID number. Call ID Sum The call ID number. Call Model Indicates whether the call is routed or direct. Total Bandwidth The total amount of bandwidth used by the call. Conference Goal The type of conference request: create, invite or join. State The last reported state of the call. Reasons The reason associated with the last state of the call.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Requested Bandwidith The bandwidth requested by the calling endpoint for this call. Approved Bandwidth The bandwidth the Gatekeeper made available to the calling endpoint. Destination Information Names A list of H.323 alias names used for making the call. Phone Numbers A list of e164 alias phone numbers used for making the call. E-mail An e-mail address used for making the call.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Editing Destination Parameters (manual mode only) When the call is in one of the states: Address Resolution, Setup Arrive, Wait Dest Connect, or Call Cannot Complete, you can edit the parameters of the destination. In this case, the Gatekeeper program does the following: • Checks whether an IP address is supplied. • Looks for names. • Looks for phone numbers. Thus if you want to enter a new name, you must first delete the existing IP address.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Figure 5-4 RIP Message dialog box The RIP message delay is set in the following fields: Delay in Seconds The time in seconds allowed for delaying a response to the Gatekeeper that sent the ARQ, DRQ or BRQ. ARQ/DRQ/BRQ Specifies to which message to send the RIP message. Origin/Destination Specifies whether you want to send the RIP to the origin or the destination endpoint. H.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Figure 5-5 Transfer by Facility dialog box You can specify the transport address and aliases for the new destination in the following fields: IP/Port The IP address and port of the new destination for transferring the call. Names The names of the transferring messages. Phones The e164 alias number of the endpoint. URL A URL alias. E-mail An e-mail address alias. Transport Address A transport name alias consisting of an IP address and port number.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Send Facility Message Dialog Box To open the Send Facility Message dialog box, click the Send Facility button in the Calls window. This dialog box lets you edit a Facility message and send the message to either the source or the destination of the call. Figure 5-6 Send Facility Message dialog box You can specify one or more of the following details in the Send Facility Message dialog box: CID The conference ID number. Reason The type of Facility message.
MultiVOIP Gatekeeper Software Guide 5 Calls Window that operates under a routed-mode Gatekeeper receives a Setup message directly from another endpoint that is not registered with the Gatekeeper, it receives a routeCallToGatekeeper ARJ from the Gatekeeper. It should then send a Facility message with this reason carrying the address of the Gatekeeper to the originating endpoint.
MultiVOIP Gatekeeper Software Guide 5 Calls Window Codes The codes of a country, extension and/or manufacturer. Call Number The number of the call you selected. Call Side The source or destination of the current call.
6 Parameters Window 37
MultiVOIP Gatekeeper Software Guide 6 Parameters Window Parameters Window To open the Parameters window, click Parameters in the Windows Menu. This window controls and monitors parameters that affect the general behavior of the Gatekeeper. Figure 6-1 Parameters window Status The following data are used to monitor the current status of the Gatekeeper. Ongoing Calls The number of current calls with the Gatekeeper. Currently Registered The number of endpoints registered with the Gatekeeper.
MultiVOIP Gatekeeper Software Guide 6 Parameters Window Configuration Options Use Multicast Select to have the Gatekeeper send an LRQ message over a multicast channel to resolve an unrecognized alias. Clear to have the Gatekeeper use the Neighbor Gatekeepers to resolve an unrecognized alias. Alias Giving When an endpoint sends an RRQ message, the Gatekeeper uses the additional aliases that were predefined for the endpoint as online aliases.
MultiVOIP Gatekeeper Software Guide 6 Parameters Window Call Mode Direct Call Mode Sets the call mode to direct. In this mode, terminals send ARQ messages to the Gatekeeper, but pass the call signaling and media control signaling directly between them. Routed Call Mode Sets the call mode to routed. In this mode, terminals pass admission requests and call signaling through the Gatekeeper. Media control information is sent directly between the terminals.
MultiVOIP Gatekeeper Software Guide 6 Parameters Window • IRQ messages add to the traffic already present over the network, and the shorter the delay, the more IRQ messages are sent. However, the longer the delay, the longer it takes for the Gatekeeper to detect dynamic registrations that have ceased to be online.
7 Services Window 42
MultiVOIP Gatekeeper Software Guide 7 Services Window Services Window To open the Services window, click Services in the Windows Menu. The Services window displays the following information about each service: • Prefix A prefix that identifies the service. • Description A description of the service that is accessible by dialing the prefix. • Registration status The status of the registration, which can be: • Default when the service is accessible to all endpoints that are not predefined in the zone.
MultiVOIP Gatekeeper Software Guide 7 Services Window Gatekeeper Defined Services You can either define your own Gatekeeper services, or use any of the built-in services, which are predefined internally and supported by the Gatekeeper. Example of a Gatekeeper Service You can define a service named TECHSUPP and register five different terminals that provide technical support. Any call directed to TECHSUPP can connect to one of the five terminals. To do so: 1. Add a service with a prefix TECHSUPP. 2.
MultiVOIP Gatekeeper Software Guide 7 Services Window Examples of Forward service procedures • Simple forwarding of all calls to another terminal To forward all calls to another terminal, the user dials the assigned prefix followed by the telephone number for routing incoming calls. • Forwarding a call via a Gateway To forward a call to another terminal via a Gateway, the user dials the forwarding prefix, the Gateway prefix, and the telephone number.
MultiVOIP Gatekeeper Software Guide 7 Services Window Exit Zone When you define a prefix for the Exit Zone service, you need to dial the prefix to reach an endpoint in another zone. This can be useful for restricting unauthorized users from making calls to other zones. When this service is defined, the Gatekeeper only completes calls to other zones if the Exit Zone prefix is present in the dialed string.
MultiVOIP Gatekeeper Software Guide 7 Services Window Services Commands Gatekeeper Defined Services Add Opens the Service Properties dialog box for adding a service. Edit Opens the Service Properties dialog box for editing a selected service. Delete Deletes the selected service. Note: You cannot delete built-in services. Gateway Supported Prefixes Add Prefix Opens the Service Properties dialog box for adding a prefix. Edit Prefix Opens the Service Properties dialog box for editing a prefix.
MultiVOIP Gatekeeper Software Guide 7 Services Window Prefix Identifies the service. The prefix can be a numeric code, alphanumeric string, name, or phone number that the user dials. For Version 2 Gateway Prefixes, the prefix can also be of URL and e-mail type. Also for Version 2, the type must precede the prefix. For example, TEL: 3 or NAME: John. Description A description of the service that is accessible by dialing the prefix.
8 Topology Window 49
MultiVOIP Gatekeeper Software Guide 8 Topology Window Topology Window To open the Topology window, click Topology in the Windows Menu. Use this window to define topology islands for the Gatekeeper. An island is a cluster of components. Dividing the network into islands enables the Gatekeeper to direct calls through the most optimal routes, avoiding slow connections or bottlenecks as much as possible.
MultiVOIP Gatekeeper Software Guide 8 Topology Window Topology Commands Add Opens the Topology Island Component View dialog box for adding an island to the Gatekeeper. Delete Deletes the selected island. Edit Opens the Topology Island Component View dialog box for editing the details of a selected island. Delete All Deletes all islands listed in the Topology window.
MultiVOIP Gatekeeper Software Guide 8 Topology Window • Subnet mask The mask of an island is that part of the host IP that will be matched against the IP of the island. • Description A description of the island component. Commands Add Opens the Edit Component dialog box for adding island components to the island. Delete Deletes the selected island components. Edit Opens the Edit Component dialog box for editing the selected island components. Delete All Deletes all the island components.
MultiVOIP Gatekeeper Software Guide 8 Topology Window Description A description of the island component. Example of an Island Scheme A Gateway can be connected to more than one island via different LAN ports. If the Network Topology Table in the Topology Island Component View dialog box is defined to reflect this scenario, when a call is placed, the Topology Table is used to detect the island of the caller. The call is then routed through the optimal port.
9 Neighbors Window 54
MultiVOIP Gatekeeper Software Guide 9 Neighbors Window Neighbors Window To open the Neighbors window, click Neighbors in the Windows Menu. The Neighbors window enables you to specify the IP addresses of gatekeepers in other zones. The Gatekeeper uses its neighbor gatekeepers to resolve the destination IP address when a call should be routed to another zone.
MultiVOIP Gatekeeper Software Guide 9 Neighbors Window IP/Port The RAS address of the neighbor gatekeeper. Distance Defines the distance associated with the neighbor gatekeeper. This value is compared with the allowed distance that was set for the calling endpoint in the Predefined Properties dialog box. If the allowed distance of the calling endpoint is less than the distance of the neighbor gatekeeper, the neighbor gatekeeper will not be accessed by a unicast location request.
Appendixes 57
MultiVOIP Gatekeeper Software Guide A Adding Concurrent Calls Appendix A Adding Concurrent Calls MultiVOIP Gatekeeper software comes with a license for the maximum number of concurrent calls ordered at the time of purchase. The maximum number of concurrent calls can be increased at any time by purchasing additional licenses. Contact your Multi-Tech representative to order additional concurrent call licenses. When you do so, you will be asked for the Gatekeeper software’s unique Product ID.
Index 59
MultiVOIP Gatekeeper Software Guide A Accept Calls option, 11 activity configurations, 11 adding concurrent calls, 58 address type alias, 22 alias giving, 39 aliases, 21, 29, 30, 33, 35, 39 All endpoints option, 10 allowed distance, 22 allowed services, 22 auto adjustment to maximum calls, 15 automatic modes, 10 B bandwidth, 30, 40 C Calculate button, 14 Call Details commands, 31 Call Details dialog box, 27–32 Call Forwarding service, 44 call IRQ interval, 41 call modes, 40 Call Proceeding messages, 39 c
MultiVOIP Gatekeeper Software Guide pregrantedARQ permissions, 39 Product ID, 58 Protocol Value Tree (PVT), 15 Q Q.