H3C XE 200/2000 IP PBX (hereinafter referred to as XE IP PBX) supports the number substitution function, allowing a calling/called number to be substituted before or after it is analyzed. To simplify substitute rule matching, regular expressions are supported in match-templates.

You can bind substitute tables to the XE IP PBX globally to provide substitution service for all calls. In addition, you can configure substitute rules for a device, subscriber line, or static route number to achieve flexibility.

If configured, the XE IP PBX can support multiple substitutions or inheritance-mode substitution, meaning the substitute of a number can be substituted again.

The XE IP PBX provides two types of number substitution: location-based and rule-based, delivering abundant voice services, such as caller-dependent call routing, emergency call, secretary station, calling number protection, and call transfer.

1.2 Number Analysis

1.2.1 Number Resources

For the XE IP PBX, number resources are classified by geographical location, and are represented in the format of country code + area code + subscriber number, such as 0086-(0)10-63564979. You can set country and area codes of devices on your XE IP PBX. Their subscriber numbers are dynamic numbers reported by managed gateways (the gateway in this manual refers to H.323 gateway and SIP user agent client, unless otherwise noted), static route numbers, or subscriber line number information configured on the XE IP PBX.

1.2.2 Purpose of Number Analysis

When processing a call, the XE IP PBX analyzes its number based on information about the calling party and called number, obtaining data such as number priority and device information about the called party to complete the call.

1.3 Location-Based Number Substitution

As the name implies, location-based number substitution is to substitute a calling/called number based on its geographical location information. You can configure on the XE IP PBX the country and area codes for its administered voice gateways rather than configure them separately on each voice gateway.

The following is how location-based number substitution works, taking call routing between voice gateways with different area codes for example:

l A voice gateway sends a call to the XE IP PBX.

l The XE IP PBX analyzes the received number, identifying the called gateway.

l Based on the analysis, the XE IP PBX adds the corresponding area code before the calling subscriber number, and removes the area code from the called number.

l After completing the number substitution operation, the XE IP PBX routes the call.

This example assumes that the two voice gateways use the same country code.

1.3.1 Dialing with Location-Based Number Substitution

In a VoIP network set up using the XE IP PBX, you can dial as you would in a PSTN network.

When location-based number substitution applies, which dial method is available depends on whether the calling and called parties are using the same country code and area code.

Table 1-1 Available dial methods when location-based number substitution applies

Same country code?	Same area code?	Dial…
Yes	Yes	Subscriber number Area code + subscriber number Country code + area code + subscriber number
Yes	No	Area code + subscriber number Country code + area code + subscriber number
No	No	Country code + area code + subscriber number

1.3.2 Location-Based Number Substitution Policy

In location-based approach, the system analyzes information about the calling and called parties before performing number substitution, to recognize device type and whether the device is in the location server (LS) domain (the range that is administered by the LS), and to identify whether the devices are administered and whether they are in the same LS domain.

& Note:

l Number substitution can be controlled globally or for a specific device. Refer to 1.3.3 “Configuring Location-Based Number Substitution” for details.

l LS domain means differently with domain. Refer to Chapter 2.2 “Basic NAT/FW Tunnel Traversal Configuration” of the “Location Server Configuration” module in this manual for information about domain.

I. Calling number substitution policy

Calling number substitution functions to have a calling number presented in an appropriate format at the called side depending on the geographical location of the calling party to the called party.

1) When the calling device is inside the LS domain

When receiving a call from an intra-domain device, the system performs calling number substitution depending on whether the country and area codes of the calling and terminating devices are the same, as shown in the following table:

Table 1-2 Calling number substitution policy for intra–LS domain calling devices

Same country code?	Same area code?	Substitute of the calling number is…
Yes	Yes	Subscriber number
Yes	No	Area code + subscriber number
No	No	Country code + area code + subscriber number

2) When the calling device is outside the LS domain

When receiving a call from a device outside the domain, the system does not perform location-based calling number substitution.

II. Called number substitution policy

When the XE IP PBX processes an intra-LS domain call, it performs number analysis before routing the call to the called gateway inside the LS domain.

In an inter-LS domain call, the terminating device can be a process server (PS), an office gatekeeper/SIP server for example, an intra-LS domain gateway or an office gateway. Depending on the type of the terminating device, the system adopts different called number substitution policies.

& Note:

The following describes the default called number substitution policies in different situations. You can customize them depending on the support of your devices to country and area codes. For example, if your gateways support country and area codes, you can configure the XE IP PBX to send numbers without substituting them to the gateways. Refer to Enabling/disabling number substitution for a device.

1) When the calling device is inside the LS domain

When receiving a call from an intra–LS domain device, the system takes one of the following actions depending on the type of the terminating device:

l If the terminating device is an intra–LS domain or office gateway, replace the called number with its subscriber number.

l If the terminating device is an office gatekeeper or an office SIP server, replace the called number as shown in the following table:

Table 1-3 Calling number substitution policy for intra–LS domain calling devices

Same country code?	Same area code?	Substitute of the calling number is…
Yes	Yes	Subscriber number
Yes	No	Area code + subscriber number
No	No	Country code + area code + subscriber number

2) When the calling device is outside the LS domain

When receiving a call from a device outside the LS domain, the system takes one of the following actions depending on the type of the terminating device:

l If the terminating device is an intra–LS domain or office gateway, replace the called number with its subscriber number.

l If the terminating device is an office gatekeeper or an office SIP server, replace the format of the called number with its country code + area code + subscriber number format.

1.3.3 Configuring Location-Based Number Substitution

I. Enabling/disabling location-based number substitution

When location-based number substitution is enabled, the system adds to or removes from a number the country and area codes based on the applied substitution policy. Disabling this function will invalidate the country and area codes configured for gateways and office devices.

Perform the following configuration in LS view.

Table 1-4 Enable/disable location-based number substitution

Operation	Command
Enable location-based number substitution on the LS	policy area-code-substitute enable
Disable location-based number substitution on the LS	policy area-code-substitute disable

By default, location-based number substitution is enabled.

II. Enabling/disabling number substitution for a device

With location-based number substitution enabled, the LS makes substitution decision after analyzing a call, depending on whether the terminating device can recognize the format of the number resources available with the XE 200/2000. If the terminating device can recognize the format, the LS can send the number to the terminating device without number substitution.

You are recommended to configure the area-code-substitute enable command for an H.323 gateway, SIP UA, or office gateway and the area-code-substitute disable command for an office H.323 gatekeeper or office SIP server.

Perform the following configuration in LS-GW or LS-OFFICEGROUP view.

Table 1-5 Enable/disable number substitution for the device

Operation	Command
Enable number substitution for the device	area-code-substitute enable
Disable number substitution for the device	area-code-substitute disable

By default, the LS performs location-based number substitution before sending a number to a gateway but not before sending a number to an office group.

Table 1-6 Recommended configuration list

Device type	Recommended configuration	Default configuration
Gateway	area-code-substitute enable	area-code-substitute enable
Office gateway	area-code-substitute enable	area-code-substitute disable
Office PS	area-code-substitute disable	area-code-substitute disable

III. Configuring country and area codes for devices

You can configure country and area codes on the LS for its administered devices based on their geographical locations.

& Note:

On the XE IP PBX, you can configure only area codes for devices. When a call involves devices with different area codes, the dialed number must include the area code. The same applies when a call involves different country codes.

Perform the following configuration in LS-GW or LS-OFFICEGROUP view.

Table 1-7 Configure the country/area code of the device

Operation	Command
Configure the country/area code	area-code { region-code [ nation-code ] }
Delete the country/area code	undo area-code

By default, neither country code nor area code is configured for the gateway or office group.

& Note:

XE supports a combination of country code + area code + subscriber number within 31 bits.

If country code and area code have already been configured on the device, the character string of subscriber number or route number cannot begin with country code, area code or the combination of country code and area code.

1.4 Rule-Based Number Substitution

As the name implies, rule-based number substitution is to substitute a calling/called number based on substitute rule.

You can apply rule-based number substitution to the LS globally, to an intra–LS domain device, or to a specific number. In addition, you can use it independently or in conjunction with location-based number substitution or voice VPN, depending on the desired dial policy.

1.4.1 Objects of Rule-Based Number Substitution

Rule-based number substitution can be performed on calling numbers, called numbers, or both.

1.4.2 Number Substitute Rules

You can configure substitute rules depending on the actual network requirements. In a rule, you can set input and output patterns of calling/called numbers, and determine when to perform substitution. In addition, you can configure a rule directly for a device or number.

1.4.3 Substitute Table

A substitute table comprises up to eight rules. You can bind it to the LS globally, to a device, or to a static route number.

1.4.4 Number Substitution Types

Rule-based number substitution can be one of the following types:

l Global, where all calling and/or called numbers matching the applied rules in the LS domain are substituted.

l Per device, where only the calling and/or called numbers associated with a specific device are substituted if they match the applied rules.

l Per number, where only the calling and/or called numbers associated with a specific number are substituted if they match the applied rules.

1.4.5 When to Perform Rule-Based Number Substitution

In rule-based approach, number substitution can occur before or after number analysis. If substitution occurs before number analysis, the system can select a particular terminating device depending on your setting, implementing the functions such as secretary station and emergency call. If substitution occurs after number analysis, the system can deliver functions such as caller protection by presenting a masked calling number at the called side.

1.4.6 Inheritance of Number Substitution

Two rule-based number substitution modes are available: inheritance and non-inheritance.

1) In inheritance mode

l When multiple substitute rules are available, the system performs substitution according to the first matched rule. If the substitute of this number matches another rule, substitution operation continues, so on and so forth. For precedence order of substitute rules and tables, see Table 1-17.

l When both substitute rules and substitute tables are available with a subscriber line, static route number, or gateway/office group, substitute rules take precedence over substitute tables.

2) In non-inheritance mode

l When multiple substitute rules are available, the system performs only one substitution according to the first matched rule. For precedence order of substitute rules and tables, see Table 1-17.

l When both substitute rules and substitute tables are available with a subscriber line, static route number, or gateway/office device, substitute rules take precedence over substitute tables.

1.4.7 Rule-Based Number Substitution Policy

When rule-based number substitution applies, the system selects polices considering the following:

l Whether substitution occurs before or after number analysis

l To which LS domain the called/calling device belongs

l Whether the involved devices are in the same LS domain

I. Before number analysis

1) When the calling device is inside the LS domain

For a call whose calling device is inside the LS domain, the system performs number substitution according to the global substitute tables bound to the LS, and substitute tables/rules bound to and configured for the calling gateway/calling number.

2) When the calling device is outside the LS domain

Number substitution is performed only according to the substitute tables bound to the LS globally.

II. After number analysis

1) When the calling device is inside the LS domain

For an intra–LS domain calling device, the system performs number substitution according to the global substitute tables bound to the LS, and substitute tables/rules bound to and configured for the calling/called gateway and calling/called number.

2) When the calling device is outside the LS domain

For an originating device outside the LS domain, the system performs number substitution according to the substitute tables bound to the LS globally, and the substitute tables/rules bound to and configured for the terminating device and called number.

1.4.8 Configuring Rule-Based Number Substitution

I. Enabling/disabling rule-based number substitution

When rule-based number substitution is enabled, the system substitutes numbers based on the applied policy and rules. Disabling the function will invalidate substitute rules.

Perform the following configuration in LS view.

Table 1-8 Enable/disable rule-based number substitution

Operation	Command
Enable rule-based number substitution	policy num-substitute enable
Disable rule-based number substitution	policy num-substitute disable

By default, rule-based number substitution is enabled.

II. Configuring/deleting substitute rules for static route numbers

For each static route number, you can configure up to two substitute rules.

Perform the following configuration in prefix view.

Table 1-9 Configure/delete a substitute rule for the static route number

Operation	Command
Configure a substitute rule for the static route number	prefix-rule rule-tag { caller input-format output-format [ callee input-format output-format ] \| callee input-format output-format } { before \| after }
Delete the specified or all substitute rules for the static route number	undo prefix-rule { rule-tag \| all }

By default, no substitute rule is configured for the static route number.

III. Configuring/deleting substitute rules for devices

For a gateway or office group, you can create number substitute rules as the number substitution policy for all calls related to the gateway or office group.

& Note:

You can create up to eight number substitution rules for each gateway or office group.

Perform the following configuration in LS-GW view or LS-OFFICEGROUP view.

Table 1-10 Configure/delete a substitute rule for the device

Operation	Command
Configure a substitute rule for the device	rule rule-tag { caller input-format output-format [ callee input-format output-format ] \| callee input-format output-format } { before \| after }
Delete the specified or all substitute rules for the device	undo rule { rule-tag \| all }

By default, no substitute rule is configured.

IV. Configuring/deleting substitute rules for subscriber lines

You can also configure number substitute rules for a subscriber line as the number substitution policy for all calls related to the subscriber line.

& Note:

You can create up to two number substitution rules for each subscriber line.

Perform the following configuration in subscriber view

Table 1-11 Configure/delete a substitute rule for the subscriber line

Operation	Command
Configure a substitute rule for the subscriber line	sscb-rule rule-tag { caller input-format output-format [ callee input-format output-format ] \| callee input-format output-format } { before \| after }
Delete the specified or all substitute rules for the subscriber line	undo sscb-rule { rule-tag \| all }

By default, no substitute rule is configured for subscriber lines.

V. Creating/deleting a substitute table

When required to use many substitute rules, you can configure them in a substitute table and then bind the table to the LS globally, to a device, to a subscriber line number, or to a static route number for management convenience.

In addition, using substitute tables allows you to create multiple sets of substitution policies, between which you can toggle quickly to accommodate to network changes.

Perform the following configuration in LS view.

Table 1-12 Create a substitute table

Operation	Command
Create a substitute table	number–substitute table- identifier
Delete the specified or all substitute tables	undo number–substitute { table- identifier \| all }

By default, no substitute table exists.

VI. Configuring/deleting substitute rules in substitute tables

The substitute rules, which are directly configured for devices, subscriber line numbers, and static route numbers, take precedence over those in substitute tables. These rules however can be the same.

Perform the following configuration in substitute table view.

Table 1-13 Configure/delete a substitute rule

Operation	Command
Configure a rule in the substitute table	rule rule-tag { caller input-format output-format [ callee input-format output-format ] \| callee input-format output-format } { before \| after }
Delete the specified or all rules from the substitute table	undo rule { rule-tag \| all }

By default, no substitute rule exists in the substitute table.

VII. Binding/unbinding substitute tables

You can bind a substitute table to the LS globally, to a gateway or office group, to a static route number, or to a voice subscriber line.

& Note:

You can bind a maximum of 16 substitute tables to the LS globally, eight to a device, and two to a static route number or subscriber line. You can bind the same substitute tables or different ones to both the LS and a device/static route number/subscriber line.

Perform the following configuration in LS, LS-GW, LS-OFFICEGROUP, prefix, or subscriber view.

Table 1-14 Bind/unbind a substitute table

Operation	Command
Bind a substitute table	substitute table-identifier
Unbind the specified or all substitute tables	undo substitute { table-identifier \| all }

By default, no substitute table is bound.

VIII. Configuring inheritance of number substitution

For the XE IP PBX, number substitution has two modes: inheritance and non-inheritance.

In non-inheritance mode, the system performs only one substitution operation in each number substitution.

In inheritance mode, the system may perform multiple substitution operations in each number substitution. In this case, after a number is substituted according to the matched rule, its substitute will be substituted again if another matched rule is found. This substitution operation continues until no match is found.

Perform the following configuration in LS view.

Table 1-15 Enable/disable inheritance-mode of number substitution

Operation	Command
Enable inheritance mode	policy substitute-inherit enable
Enable non-inheritance mode	policy substitute-inherit disable

By default, inheritance mode is enabled.

1.5 Displaying Information about Number Substitution

Perform the following configuration in any view.

Table 1-16 Display information about number substitution

Operation	Command
Display details about a specific or all substitute tables	display location-server number-substitute { table-identifier \| all }
Display all globally bound substitute tables	display location-server substitute
Display information about the device to which the specified number belongs	display subscriber long-number [ nation-num+region-num ]

1.6 Precedence Order of Substitute Rules and Tables

You can use location-based number substitution and rule-based number substitution independently or together, observing the following rules:

l If two methods are adopted, rule-based number substitution takes precedence over location-based number substitution.

l For rule-based number substitution, see the following table to learn the precedence of one substitute rule/table over another.

Table 1-17 Precedence order of substitute rules/tables

When number substitution occurs…	Precedence order
Before number analysis (Precedence is descending from top to bottom)	For an intra–LS domain calling device: l Substitute rules directly configured for the calling number l Substitute tables bound to the calling number l Substitute rules directly configured for the calling device l Substitute tables bound to the originating device l Substitute tables bound to the LS globally
For an originating device outside the LS domain: l Only substitute tables bound to the LS globally is used
After number analysis (Precedence is descending from top to bottom)	For an intra–LS domain originating device: l Substitute rules directly configured for the called number l Substitute tables bound to the called number l Substitute rules directly configured for the terminating device l Substitute tables bound to the terminating device l Substitute rules directly configured for the calling number l Substitute tables bound to the calling number l Substitute rules directly configured for the originating device l Substitute tables bound to the originating device l Substitute tables bound to the LS globally l Location-based number substitution
For a calling device outside the LS domain: l Substitute rules directly configured for the called number l Substitute tables bound to the called number l Substitute rules directly configured for the terminating device l Substitute tables bound to the terminating device l Substitute tables bound to the LS globally l Location-based number substitution

When number substitution occurs…

Precedence order

Before number analysis

(Precedence is descending from top to bottom)

For an intra–LS domain calling device:

l Substitute rules directly configured for the calling number

l Substitute tables bound to the calling number

l Substitute rules directly configured for the calling device

l Substitute tables bound to the originating device

l Substitute tables bound to the LS globally

For an originating device outside the LS domain:

l Only substitute tables bound to the LS globally is used

After number analysis

(Precedence is descending from top to bottom)

For an intra–LS domain originating device:

l Substitute rules directly configured for the called number

l Substitute tables bound to the called number

l Substitute rules directly configured for the terminating device

l Substitute tables bound to the terminating device

l Substitute rules directly configured for the calling number

l Substitute tables bound to the calling number

l Substitute rules directly configured for the originating device

l Substitute tables bound to the originating device

l Substitute tables bound to the LS globally

l Location-based number substitution

For a calling device outside the LS domain:

l Substitute rules directly configured for the called number

l Substitute tables bound to the called number

l Substitute rules directly configured for the terminating device

l Substitute tables bound to the terminating device

l Substitute tables bound to the LS globally

l Location-based number substitution

1.7 Number Substitution Configuration Example

1.7.1 Location-Based Number Substitution Configuration Example I

I. Network requirements

On a network, one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls. Four gateways are present: H.323 gateway 1 and H.323 gateway 2 with area code 010 and H.323 gateway 3 and H.323 gateway 4 with area code 020.

This scenario involves area codes but not country codes.

II. Network diagram

Figure 1-1 Network diagram for location-based number substitution I

III. Configuration procedure

& Note:

This scenario assumes that the H.323 gateway 1, H.323 gateway 2, H.323 gateway 3, H.323 gateway 4, and the XE IP PBX have reachable routes between them and routing configuration is beyond the scope of this example.

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[XE-ls-ps-gkserver] heartbeat password xe

# Enable location-based number substitution.

[XE-ls] policy area-code-substitute enable

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] area-code 010

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] area-code 010

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw02] area-code 020

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] port 1719

[XE-ls-gw-gw04] area-code 020

[XE-ls-gw-gw04] quit

# Start the LS.

[XE-ls] start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] match-template 0......

[VG1-voice-dial-entity1] quit

[VG1-voice-dial] entity 2 voip

[VG1-voice-dial-entity2] address ras

[VG1-voice-dial-entity2] match-template 88..

[VG1-voice-dial-entity2] quit

[VG1-voice-dial] entity 8801 pots

[VG1-voice-dial-entity8801] line 0

[VG1-voice-dial-entity8801] match-template 8801

[VG1-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] match-template 0......

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 2 voip

[VG2-voice-dial-entity2] address ras

[VG2-voice-dial-entity2] match-template 88..

[VG2-voice-dial-entity2] quit

[VG2-voice-dial] entity 8802 pots

[VG2-voice-dial-entity8802] line 0

[VG2-voice-dial-entity8802] match-template 8802

[VG2-voice-dial-entity8802] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG2-voice-gk] ras-on

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] match-template 0......

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 2 voip

[VG3-voice-dial-entity2] address ras

[VG3-voice-dial-entity2] match-template 99..

[VG3-voice-dial-entity2] quit

[VG3-voice-dial] entity 9901 pots

[VG3-voice-dial-entity9901] line 0

[VG3-voice-dial-entity9901] match-template 9901

[VG3-voice-dial-entity9901] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] match-template 0......

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 2 voip

[VG4-voice-dial-entity2] address ras

[VG4-voice-dial-entity2] match-template 99..

[VG4-voice-dial-entity2] quit

[VG4-voice-dial] entity 9902 pots

[VG4-voice-dial-entity9902] line 0

[VG4-voice-dial-entity9902] match-template 9902

[VG4-voice-dial-entity9902] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG3-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

1.7.2 Location-Based Number Substitution Configuration Example II

I. Network Requirements

On a network, one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls. Four gateways are present: GW01 and GW02 with the same country code (86) but different area codes (010 and 020 respectively), and GW03 and GW04 with the same country code (49) but different area codes (030 and 040 respectively).

This scenario involves both area codes and country codes.

II. Network diagram

Figure 1-2 Network diagram for location-based number substitution II

III. Configuration procedure

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[XE-ls-ps-gkserver] heartbeat password xe

# Enable location-based number substitution.

[XE-ls] policy area-code-substitute enable

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] area-code 010 86

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] area-code 020 86

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw03] area-code 030 49

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] area-code 040 49

[XE-ls-gw-gw04] quit

# Start the LS.

[XE-ls]start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] match-template 0......

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] quit

[VG1-voice-dial] entity 2 voip

[VG1-voice-dial-entity2] match-template 66..

[VG1-voice-dial-entity2] address ras

[VG1-voice-dial-entity2] quit

[VG1-voice-dial] entity 3 voip

[VG1-voice-dial-entity3] match-template 49......

[VG1-voice-dial-entity3] address ras

[VG1-voice-dial-entity3] quit

[VG1-voice-dial] entity 6601 pots

[VG1-voice-dial-entity6601] match-template 6601

[VG1-voice-dial-entity6601] line 0

[VG1-voice-dial-entity6601] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] match-template 0......

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 2 voip

[VG2-voice-dial-entity2] match-template 77..

[VG2-voice-dial-entity2] address ras

[VG2-voice-dial-entity2] quit

[VG2-voice-dial] entity 3 voip

[VG2-voice-dial-entity3] match-template 49......

[VG2-voice-dial-entity3] address ras

[VG2-voice-dial-entity3] quit

[VG2-voice-dial] entity 7701 pots

[VG2-voice-dial-entity7701] match-template 7701

[VG2-voice-dial-entity7701] line 0

[VG2-voice-dial-entity7701] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG2-voice-gk] ras-on

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] match-template 0......

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 2 voip

[VG3-voice-dial-entity2] match-template 88..

[VG3-voice-dial-entity2] address ras

[VG3-voice-dial-entity2] quit

[VG3-voice-dial] entity 3 voip

[VG3-voice-dial-entity3] match-template 86......

[VG3-voice-dial-entity3] address ras

[VG3-voice-dial-entity3] quit

[VG3-voice-dial] entity 8801 pots

[VG3-voice-dial-entity8801] match-template 8801

[VG3-voice-dial-entity8801] line 0

[VG3-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.40 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] match-template 0......

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 2 voip

[VG4-voice-dial-entity2] match-template 99..

[VG4-voice-dial-entity2] address ras

[VG4-voice-dial-entity2] quit

[VG4-voice-dial] entity 3 voip

[VG4-voice-dial-entity3] match-template 86......

[VG4-voice-dial-entity3] address ras

[VG4-voice-dial-entity3] quit

[VG4-voice-dial] entity 9901 pots

[VG4-voice-dial-entity9901] match-template 9901

[VG4-voice-dial-entity9901] line 0

[VG4-voice-dial-entity9901] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG4-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

1.7.3 Rule-Based Number Substitution Configuration Example

I. Network requirements

On a company’s network, VoIP service is provided and one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls.

To avoid missing important calls after changing seats in the office for example, staff members can apply for having all calls to original numbers forwarded to new numbers. This can be done through rule-based number substitution.

For example, A’s original telephone number is 6601 and the new number is 9901 after seat changing. Rule-based number substitution can be deployed, forwarding calls to 6601 to number 9901.

II. Network diagram

Figure 1-3 Network diagram for rule-based number substitution

III. Configuration procedure

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[xe-ls-ps-gkserver] heartbeat password xe

# Enable rule-based number substitution.

[XE-ls] policy num-substitute enable

# Create a substitute table.

[XE-ls] number-substitute 1

# Configure a substitute rule in the substitute table.

[XE-ls-sst-1] rule 0 callee 6601 9901 before

# Bind the substitute table to the LS globally.

[XE-ls] substitute 1

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] quit

# Start the LS.

[XE-ls] start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] match-template ....

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] quit

[VG1-voice-dial] entity 6601 pots

[VG1-voice-dial-entity6601] match-template 6601

[VG1-voice-dial-entity6601] line 0

[VG1-voice-dial-entity6601] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] match-template ....

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 7701 pots

[VG2-voice-dial-entity7701] match-template 7701

[VG2-voice-dial-entity7701] line 0

[VG2-voice-dial-entity7701] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] match-template ....

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 8801 pots

[VG3-voice-dial-entity8801] match-template 8801

[VG3-voice-dial-entity8801] line 0

[VG3-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.40 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] match-template ....

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 9901 pots

[VG4-voice-dial-entity9901] match-template 9901

[VG4-voice-dial-entity9901] line 0

[VG4-voice-dial-entity9901] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG4-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

1.7.4 Inheritance-Mode Number Substitution Configuration Example

I. Network requirements

On a network, one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls. To allow the XE IP PBX to substitute a number multiple times, for example, to have 1000 substituted for 6601 and then 9901 for 1000, you must perform the following configurations based on the Rule-Based Number Substitution Configuration Example.

II. Network diagram

Figure 1-4 Network diagram for inheritance-mode number substitution

III. Configuration procedure

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[xe-ls-ps-gkserver] heartbeat password xe

# Enable rule-based number substitution.

[XE-ls] policy num-substitute enable

# Enable inheritance-mode number substitution.

[XE-ls] policy substitute-inherit enable

# Create a substitute table.

[XE-ls] number-substitute 1

# Configure substitute rules in substitute table 1.

[XE-ls-sst-1] rule 0 callee 6601 1000 before

[XE-ls-sst-1] rule 1 callee 1000 9901 before

# Bind the table to the LS globally.

[XE-ls] substitute 1

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] quit

# Start the LS.

[XE-ls] start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] match-template ....

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] quit

[VG1-voice-dial] entity 2 voip

[VG1-voice-dial] entity 6601 pots

[VG1-voice-dial-entity6601] match-template 6601

[VG1-voice-dial-entity6601] line 0

[VG1-voice-dial-entity6601] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] match-template ....

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 7701 pots

[VG2-voice-dial-entity7701] match-template 7701

[VG2-voice-dial-entity7701] line 0

[VG2-voice-dial-entity7701] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] match-template ....

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 8801 pots

[VG3-voice-dial-entity8801] match-template 8801

[VG3-voice-dial-entity8801] line 0

[VG3-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.40 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] match-template ....

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 9901 pots

[VG4-voice-dial-entity9901] match-template 9901

[VG4-voice-dial-entity9901] line 0

[VG4-voice-dial-entity9901] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG4-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

1.7.5 Secretary Station Service Configuration Example

I. Network Requirements

On a company’s network, one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls and four gateways are present: GW01, GW02, GW03, and GW04.

The departments of this company have a secretary each. It requires that:

l When staff members call their own secretaries, they dial the same secretary station number 1111. The system could transfer the calls automatically and appropriately.

l When staff members call the secretary of another department, they dial the called department code before dialing the secretary station number.

Take departments A and B for example. On GW01 and GW02, department code (area code) 010 is configured for Department A. On GW03 and GW04, department code (area code) 020 is configured for Department B.

II. Network diagram

Figure 1-5 Network diagram for centralized networking of H.323 gatekeeper and LS

III. Configuration procedure

& Note:

This scenario assumes that the H.323 gateway 1, H.323 gateway 2, H.323 gateway 3, H.323 gateway 4, XE IP PBX have reachable routes between them and the routing configuration is beyond the scope of this example.

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[XE-ls-ps-gkserver] heartbeat password xe

# Enable location-based number substitution.

[XE-ls] policy area-code-substitute enable

# Enable rule-based number substitution.

[XE-ls] policy num-substitute enable

# Create and configure a substitute table.

[XE-ls] number-substitute table1

[XE-ls-sst-table1] rule 0 callee ^1111 8801 before

[XE-ls-sst-table1] rule 1 callee 0201111 0209901 before

[XE-ls-sst-table1] quit

[XE-ls] number-substitute table2

[XE-ls-sst-table2] rule 0 callee ^1111 9901 before

[XE-ls-sst-table2] rule 1 callee 0101111 0108801 before

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] area-code 010

[XE-ls-gw-gw01] substitute table1

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] area-code 010

[XE-ls-gw-gw02] substitute table1

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw02] area-code 020

[XE-ls-gw-gw02] substitute table2

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] area-code 020

[XE-ls-gw-gw02] substitute table2

[XE-ls-gw-gw04] quit

# Enable the LS.

[XE-ls] start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] match-template 0......

[VG1-voice-dial] entity 2 voip

[VG1-voice-dial-entity2] address ras

[VG1-voice-dial-entity2] match-template ....

[VG1-voice-dial-entity2] quit

[VG1-voice-dial] entity 8801 pots

[VG1-voice-dial-entity8801] line 0

[VG1-voice-dial-entity8801] match-template 8801

[VG1-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] match-template 0......

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 2 voip

[VG2-voice-dial-entity2] address ras

[VG2-voice-dial-entity2] match-template ....

[VG2-voice-dial] entity 8802 pots

[VG2-voice-dial-entity8802] line 0

[VG2-voice-dial-entity8802] match-template 8802

[VG2-voice-dial-entity8802] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG2-voice-gk] ras-on

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] match-template 0......

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 2 voip

[VG3-voice-dial-entity2] address ras

[VG3-voice-dial-entity2] match-template ....

[VG3-voice-dial-entity2] quit

[VG3-voice-dial] entity 8801 pots

[VG3-voice-dial-entity8801] line 0

[VG3-voice-dial-entity8801] match-template 9901

[VG3-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] match-template 0......

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 2 voip

[VG4-voice-dial-entity2] address ras

[VG4-voice-dial-entity2] match-template ....

[VG4-voice-dial-entity2] quit

[VG4-voice-dial] entity 9902 pots

[VG4-voice-dial-entity9902] line 0

[VG4-voice-dial-entity9902] match-template 9902

[VG4-voice-dial-entity9902] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG4-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

1.7.6 Hybrid Number Substitution Configuration Example

I. Network requirements

On a company’s network, one XE 200 IP PBX in centralized mode is functioning to forward H.323 calls. Four gateways are present: GW01 and GW02 with area code 010, and GW03 and GW04 with area code 0571.

The company’s headquarters is located in City A and using the service of gateways GW01 and GW02; its branch is located in City B and using the service of gateways GW03 and GW04.

A staff member travels from City B to City A and will stay in City A for about three months. To avoid missing important calls, the staff member applies for having all calls placed to his/her original office telephone number transferred, for example, from 0571-8801 to 010-6601.

II. Network diagram

Figure 1-6 Network diagram for hybrid number substitution

III. Configuration procedure

1) Configure the H.323 gatekeeper

# Configure Ethernet interface 0/0.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.50 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 local

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) Configure the LS

# Configure the LS.

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

[XE-ls] process-server gkserver

[xe-ls-ps-gkserver] heartbeat password xe

# Enable location-based number substitution.

[XE-ls] policy area-code-substitute enable

# Enable rule-based number substitution.

[XE-ls] policy num-substitute enable

# Create a substitute table.

[XE-ls] number-substitute 1

# Configure a rule in substitute table 1.

[XE-ls-sst-1] rule 0 callee 05718801 0106601 before

# Bind the table to the LS globally.

[XE-ls] substitute 1

# Configure the gateways.

[XE-ls] gateway gw01

[XE-ls-gw-gw01] device-type h323

[XE-ls-gw-gw01] dynamic-ip enable

[XE-ls-gw-gw01] area-code 010

[XE-ls-gw-gw01] quit

[XE-ls] gateway gw02

[XE-ls-gw-gw02] device-type h323

[XE-ls-gw-gw02] dynamic-ip enable

[XE-ls-gw-gw02] area-code 010

[XE-ls-gw-gw02] quit

[XE-ls] gateway gw03

[XE-ls-gw-gw03] device-type h323

[XE-ls-gw-gw03] dynamic-ip enable

[XE-ls-gw-gw03] area-code 0571

[XE-ls-gw-gw03] quit

[XE-ls] gateway gw04

[XE-ls-gw-gw04] device-type h323

[XE-ls-gw-gw04] dynamic-ip enable

[XE-ls-gw-gw04] area-code 0571

[XE-ls-gw-gw04] quit

# Start the LS.

[XE-ls] start

3) Configure H.323 gateway 1

# Configure Ethernet interface 0.

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.80.10 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities.

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 1 voip

[VG1-voice-dial-entity1] match-template 0571....

[VG1-voice-dial-entity1] address ras

[VG1-voice-dial-entity1] quit

[VG1-voice-dial] entity 2 voip

[VG1-voice-dial-entity2] match-template 66..

[VG1-voice-dial-entity2] address ras

[VG1-voice-dial-entity2] quit

[VG1-voice-dial] entity 3 voip

[VG1-voice-dial-entity3] match-template 77..

[VG1-voice-dial-entity3] address ras

[VG1-voice-dial-entity3] quit

[VG1-voice-dial] entity 6601 pots

[VG1-voice-dial-entity6601] match-template 6601

[VG1-voice-dial-entity6601] line 0

[VG1-voice-dial-entity6601] return

# Configure the gatekeeper client.

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.80.10

[VG1-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG1-voice-gk] ras-on

4) Configure H.323 gateway 2

# Configure Ethernet interface 0.

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.80.20 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities.

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 1 voip

[VG2-voice-dial-entity1] match-template 0571....

[VG2-voice-dial-entity1] address ras

[VG2-voice-dial-entity1] quit

[VG2-voice-dial] entity 2 voip

[VG2-voice-dial-entity2] match-template 77..

[VG2-voice-dial-entity2] address ras

[VG2-voice-dial-entity2] quit

[VG2-voice-dial] entity 3 voip

[VG2-voice-dial-entity3] match-template 66..

[VG2-voice-dial-entity3] address ras

[VG2-voice-dial-entity3] quit

[VG2-voice-dial] entity 7701 pots

[VG2-voice-dial-entity7701] match-template 7701

[VG2-voice-dial-entity7701] line 0

[VG2-voice-dial-entity7701] return

# Configure the gatekeeper client.

[VG2-voice] gk-client

[VG2-voice-gk] gw-id gw02

[VG2-voice-gk] gw-address ip 192.168.80.20

[VG2-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG2-voice-gk] ras-on

5) Configure H.323 gateway 3

# Configure Ethernet interface 0.

[VG3] interface ethernet 0

[VG3-Ethernet0] ip address 192.168.80.30 255.255.255.0

[VG3-Ethernet0] quit

# Configure voice entities.

[VG3] voice-setup

[VG3-voice] dial-program

[VG3-voice-dial] entity 1 voip

[VG3-voice-dial-entity1] match-template 010....

[VG3-voice-dial-entity1] address ras

[VG3-voice-dial-entity1] quit

[VG3-voice-dial] entity 2 voip

[VG3-voice-dial-entity2] match-template 88..

[VG3-voice-dial-entity2] address ras

[VG3-voice-dial-entity2] quit

[VG3-voice-dial] entity 3 voip

[VG3-voice-dial-entity3] match-template 99..

[VG3-voice-dial-entity3] address ras

[VG3-voice-dial-entity3] quit

[VG3-voice-dial] entity 3 voip

[VG3-voice-dial] entity 8801 pots

[VG3-voice-dial-entity8801] match-template 8801

[VG3-voice-dial-entity8801] line 0

[VG3-voice-dial-entity8801] return

# Configure the gatekeeper client.

[VG3-voice] gk-client

[VG3-voice-gk] gw-id gw03

[VG3-voice-gk] gw-address ip 192.168.80.30

[VG3-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG3-voice-gk] ras-on

6) Configure H.323 gateway 4

# Configure Ethernet interface 0.

[VG4] interface ethernet 0

[VG4-Ethernet0] ip address 192.168.80.40 255.255.255.0

[VG4-Ethernet0] quit

# Configure voice entities.

[VG4] voice-setup

[VG4-voice] dial-program

[VG4-voice-dial] entity 1 voip

[VG4-voice-dial-entity1] match-template 010....

[VG4-voice-dial-entity1] address ras

[VG4-voice-dial-entity1] quit

[VG4-voice-dial] entity 2 voip

[VG4-voice-dial-entity2] match-template 99..

[VG4-voice-dial-entity2] address ras

[VG4-voice-dial-entity2] quit

[VG4-voice-dial] entity 3 voip

[VG4-voice-dial-entity3] match-template 88..

[VG4-voice-dial-entity3] address ras

[VG4-voice-dial-entity3] quit

[VG4-voice-dial] entity 3 voip

[VG4-voice-dial] entity 9901 pots

[VG4-voice-dial-entity9901] match-template 9901

[VG4-voice-dial-entity9901] line 0

[VG4-voice-dial-entity9901] return

# Configure the gatekeeper client.

[VG4-voice] gk-client

[VG4-voice-gk] gw-id gw04

[VG4-voice-gk] gw-address ip 192.168.80.40

[VG4-voice-gk] gk-id gkserver gk-addr 192.168.80.50 1719

[VG4-voice-gk] ras-on

Chapter 2 Backup and Load Sharing

2.1 Backup

In a large VoIP network, multiple PSs and LSs can be deployed to prevent voice service failures caused by breakdown of an XE IP PBX. The backup feature provided by XE server ensures the proper and stable operation of the VoIP network. The backup functionality provided by an XE server includes two parts: PS backup and LS backup.

2.1.1 Introduction to LS Backup

To implement the LS backup function, at least two LSs are deployed on the VoIP network, the priority level of each LS is configured on the PS. When the LS being used by the PS becomes faulty, the PS will select another LS that it available based on the backup policy to ensure the proper operation of the VoIP network.

The following figure shows the LS backup model.

Figure 2-1 LS backup model

In the LS backup model, three LSs (Location Server 1, Location Server 2 and Location Server 3) and one PS (Process Server 1) are deployed on the VoIP network. Process Server 1 is configured to use Location Server 1, Location Server 2, and Location Server 3, of which the priority levels are 0, 1, and 2 respectively. The smaller the priority value is, the higher the priority is. Under normal conditions, Process Server 1 uses Location Server 1, which has the highest priority. If Location Server 1 fails, Process Server 1 will choose Location Server 2 a certain period (usually 3 minutes) after the failure, which has a priority next to Location Server 1, and establish a connection with Location Server 2. If Location Server 2 fails, the PS will choose an LS with a priority next to it, and so on. In this way, the failure of one LS will not cause the VoIP network to break down.

The XE IP PBX supports the LS-BACK backup policy. Namely, if the PS is not using the LS with the highest priority, the PS will check whether an LS with a higher priority is available by polling the LSs. If a high-priority LS is available, the PS will establish a connection with that LS and then end the connection with the low-priority LS. In the LS backup model, if Process Server 1, which is LS-BACK policy enabled, is currently using Location Server 3, of which the priority level is 3, Process Server 1 will check whether Location Server 1 (priority 0) and Location Server 2 (priority 1) are available by polling these LSs. If Location Server 2 is available, Process Server 1 will end the connection with Location Server 3 and establish a connection with Location Server 2, while continuing probing Location Server 1(priority 0) and attempting to establish a heartbeat connection with it.

Perform the following configuration in the PS view.

Table 2-1 Enable/disable LS backup

Operation	Command
Enable/disable LS backup	ls-back { disable \| enable }

By default, the LS backup is disabled.

2.1.2 Introduction to PS Backup

To implement PS backup, at least two PSs are deployed on the VoIP network. When one PS becomes faulty, another PS will takeover the work of the faulty one to ensure the proper operation of the VoIP network.

There two PS backup models:

l PS-GROUP backup model

l OFFICE-GROUP-PS backup model

I. Introduction to the PS-GROUP backup model

The following figure shows the PS-GROUP model.

Figure 2-2 PS-GROUP backup model

The idea is to assign the PSs administered by an LS to different groups. After a gateway registers with a PS successfully, the system sends a positive response to the gateway, containing information about other PSs in the same PS group for backup. (For SIP, the information includes IP address and port; for H.323, the information includes gatekeeper identifier, IP address, port, whether registration is required, and priority.) In case the current PS fails, the gateway can register with another PS in the same PS group according to the backup information to maintain operation of the network.

II. Introduction to the OFFICE-GROUP-PS backup model

The following figure shows the OFFICE-GROUP-PS model.

Figure 2-3 OFFICE-GROUP-PS backup model

The OFFICE-GROUP-PS backup model performs backup specific to office PSs. Namely, when the primary office PS in an office group, the secondary PS in the office group will take over the work of the faulty one.

The networking configuration scenario in Figure 2-3 is as follows:

l Location Server 1 dominates Process Server 1, and Location Server 2 dominates Process Server 2 and Process Server 3.

l On Process Server 2, assign Process Server 2, Process Server 3 and Gateway 2 to the same PS group, and specify Process Server 2 as the primary PS in the group.

l Gateway 1 registers to Location Server 1 through Process Server 1, and Gateway 2 registers to Location Server 2 through Process Server 2.

l Configure an office group that contains Office Process Server 2 and Office Process Server 3 on Location Server 1. The priority of Office Process Server 2 is higher than that of Office Process Server 3.

After office configuration, Location Server 1 notifies Process Server 1 to send periodically heartbeat messages to Process Server 2, the high-priority office PS in the office group. If a heartbeat response is received, this means that Office Process Server 2 is available. When Process Server 2 fails, Location Server 1 notifies Process Server 1 to sends heartbeat periodically messages to Process Server 3, which has a priority level next to Process Server 2. If a heartbeat response is received, this means that Office Process Server 3 is available. In this case, Process Server 1 continues attempting to establish a heartbeat connection with Process Server 2, while Gateway 2 registers to Location Server 2 through Process Server 3. When a user on Gateway 1 calls a user on Gateway 2, the call can proceed even if Process Server 2 has failed. This is what office PS backup is for. If a heartbeat connection is successfully established between Process Server 1 and Process Server 2, this means that the Process Server 2 has recovered from failure, and Gateway 2 will also continue to register to Location Server 2 through Process Server 2.

2.1.3 Configuring LS Backup

To implement LS backup, you need at least two LSs (at most five LSs), one of which serves as the primary server, and the others as the secondary servers. The configuration procedure is as follows:

1) Configure the PS information on the primary LS and all secondary LSs. For details, see the basic LS configuration part of “LS Configuration Operations”.

2) Configure the gateway information on the primary LS and all secondary LSs. For details, see the basic LS configuration part of “LS Configuration Operations”.

3) Configure the information of the primary and secondary LSs on the PS. For details, see 2.1.3 I. “Configuring LS list entries on the PS”.

I. Configuring LS list entries on the PS

Use the ls-mode command on the PS to define the LS modes, IP addresses, ports and priority levels of the available LSs.

The specified priority value for an LS should be the ID value of that LS. On the PS, this value uniquely identifies an LS. The priority value range is 0 to 4; the small the value is, the higher the priority is.

Among the configured LSs, the LS that has the highest priority serves as the primary LS, while all the rest are secondary LSs.

Perform the following configuration in PS view.

Table 2-2 Configure PS list entries

Operation	Command
Configuring an LS list entry on the PS	ls-mode id-priority { local \| { remote ip-address ip-address [ port port ] } }
Delete an LS list entry or all LS list entries from the PS	undo ls-mode { id-priority \| all }

2.1.4 Configuring PS-Group Backup

I. Assigning a PS to a PS group

To implement registration backup, a PS group must contain at least two PSs.

& Note:

A PS can have up to seven backup PSs.

Perform the following configuration in LS-PS view.

Table 2-3 Assign a PS to a PS group

Operation	Command
Assign a PS to a PS group	psgroup-id group-id
Remove the PS from the PS group	undo psgroup-id

By default, the PS does not belong to any PS group.

II. Configuring the backup gatekeeper port number in H.323 registration responses

To have a PS act as the gatekeeper for registration backup and load sharing, you need to configure the RAS port number of the backup gatekeeper with the following command. This port number is carried in the backup PS information or redirect PS information that the PS sends to the H.323 gateway device.

Perform the following configuration in LS-PS view.

Table 2-4 Configure the backup gatekeeper port number in H.323 registration responses

Operation	Command
Configure the backup gatekeeper port number in H.323 registration responses	ras-port port
Restore the default port number	undo ras-port

By default, the PS receives/transmits RAS signaling at port 1719 when functioning as a backup PS or as the PS to which an H.323 gateway is redirected.

III. Configuring the backup SIP Server port number in SIP registration responses

To have a PS act as the SIP server for registration backup and load sharing, you need to configure the port number of the backup SIP server with the following command. This port number is carried in the backup PS information or redirect PS information that the PS sends to the SIP gateway device.

Perform the following configuration in LS-PS view.

Table 2-5 Configure the backup SIP server port number in SIP registration responses

Operation	Command
Configure the backup SIP server port number in SIP registration responses	sip-port port
Restore the default port number	undo sip-port

By default, the PS receives/transmits SIP signaling at port 5060 when functioning as a backup PS or as the PS to which a SIP gateway is redirected.

IV. Enabling/disabling the registration backup capability of the gateway

You can enable or disable registration backup capability specific to a gateway, depending on the support of the gateway to the registration backup function of the XE 200/2000 and the actual needs.

& Note:

Before enabling the registration capability of a gateway, make sure that the gateway:

l Supporting registration backup

l Being assigned to a PS group that has at least two PSs

l Supporting registration redirect

In addition, configuring the load-share disable command or load-share enable command will disable or enable registration backup and load sharing capabilities together.

Perform the following configuration in LS-GW view.

Table 2-6 Enable/disable the gateway to participate in registration backup

Operation	Command
Enable/disable the registration backup capability of the gateway	load-share { disable \| enable }
Restore the default	undo load-share

By default, the registration backup capability of the gateway is disabled.

V. Assigning a gateway to a PS group

Use the psgroup-id command to assign a gateway to a PS group. If this PS group has an available PS, the gateway can only register with the LS through this PS. If no PS is available in this PS group, the gateway can register through a PS that does not belong to this PS group.

Perform the following configuration in LS-GW view.

Table 2-7 Assign the gateway to a PS group

Operation	Command
Assign a gateway to a PS group	psgroup-id group-id [master-ps ps-id ]
Remove the gateway from the PS group	undo psgroup-id

By default, the gateway does not belong to any PS group.

2.1.5 Configuring OFFICE-GROUP-PS Backup

The procedure for configuring office PS backup is as follows:

1) Configure an office group LSs. For details, see the office information configuration part of “LS Configuration Operations”.

2) Configure a static route number for routing calls to the office group. For details, see the office information configuration part of “LS Configuration Operations”.

3) Configure the basic information of the primary office PS in the office group. For details, see the office information configuration part of “LS Configuration Operations”.

4) Configure the basic information of the secondary office PSs in the office group. For details, see the office information configuration part of “LS Configuration Operations”.

5) Configure the registration port and device status for the office devices. For details, see descriptions below.

& Note:

l The primary office PS is distinguished from the secondary office PSs by the priority. The office PS with the highest priority is the primary office PS, while all the rest are secondary PSs.

l In OFFICE-GROUP-PS backup configuration, only one primary office PS can be configured in each office group.

l In OFFICE-GROUP-PS backup configuration, different priority levels must be assigned for different office PSs.

l The SIP server must be enabled on the office devices.

I. Configuring the registration port for office devices

Use the register-port command to designate a port through which the office devices in the current office group receive heartbeat messages from the PS. The heartbeat between the PS and the office PSs is implemented through the register message (register) and response message (200 OK) of the SIP protocol. Therefore, the SIP server must be enabled on the office devices to process the register message, and a port must be designated in LS-OFFICEGROUP-OFFUCE view for the office PSs to receive the register message.

Perform the following configuration in LS-OFFICEGROUP-OFFICE view.

Table 2-8 Configure the registration port for office devices

Operation	Command
Configure the registration port for office devices	register-port port
Restore the default registration port for office devices	undo register-port

By default, the registration port is port 5060.

II. Configure the status information of office devices

In OFFICE-GROUP-PS backup configuration, the status of the office devices must be set to “normal”.

Perform the following configuration in LS-OFFICEGROUP-OFFICE view.

Table 2-9 Configure the status information of office devices

Operation	Command
Configure the status information of office devices	device-status { forever \| normal }

III. Configure the type of office devices

Perform the following configuration in LS-OFFICEGROUP-OFFICE view.

Table 2-10 Configure the type of office devices

Operation	Command
Configure the type of office devices	device-type { h323-gw \| h323-gk \| sip }

& Note:

In OFFICE-GROUP-PS backup configuration, the type of the office devices must not be “h323-gw”.

2.2 Load Sharing

2.2.1 Introduction to Load Sharing

In a large VoIP network constructed using the XE IP PBX, PS overload and network load imbalance may occur due to the following reasons:

l Difference of PSs in physical performance and network environment

l Significant network structure changes, for example, addition of a large number of gateways

To ensure healthy operation of the voice network, the XE IP PBX provides the load sharing mechanism, allowing you to configure load distribution policies to dynamically tune load distribution.

2.2.2 Load Sharing Mechanism

You can have the LS dynamically adjust the load capability of each PS in the same PS group by using two parameters: relative capacity of each PS in the group, and number of the subscriber lines accommodated by each gateway.

For example, a PS group contains two PSs: PS1 and PS2. PS1 can accommodate up to 100 online gateways, supporting up to 200 subscriber lines as a whole. PS2 can accommodate up to 1000 online gateways, supporting up to 2000 subscriber lines as a whole.

Considering their actual capabilities, you can set the relative capability of PS1 to 5 and that of PS2 to 50. When a gateway belonging to the group initiates a register request, the LS determines which PS is to be used considering the number of subscriber lines registered with each PS and their relative capability.

I. First registration request

When a gateway first initiates a registration request, the LS gathers information about the load of the PS group to which the gateway belongs regardless of whether the intended PS belongs to the same PS group.

Depending on the number of subscriber lines registered with each PS in the PS group and their relative capabilities, the LS determines with which PS the gateway should register. If this PS is the intended one, registration continues; if not, the system sends a redirect message back to the gateway, indicating with which PS the gateway can register.

II. Periodical load sharing tuning

Logoff of many gateways may break the load sharing policy that you set, resulting in load imbalance among the PSs in a PS group. To prevent this from happening, the LS tunes the load of each PS in the group at intervals of half an hour. When receiving regular registration requests from gateways, the LS redirects some gateways to register with PSs with lighter load to achieve new balance.

2.2.3 Operation of Load Sharing

To help you set the relative capability and number of permitted subscriber lines appropriately for a PS, the following describes the actions that the system takes to achieve load sharing:

1) Identify the existing PS groups on the LS. For example, PS groups g1, g2, and g3 are found.

2) Identify the PSs in each PS group. For example, five PSs, P1 through P5, are found in PS group g1.

3) Identify the gateways in each PS group. For example, 20 gateways, W1 through W20, are found in PS group g1.

4) Sum up the user-defined relative capabilities of all PSs in the group with the following formula:

Where, i is the subscript for the PSs, CV_i is the relative capability that you have set for PS i, and CV is the sum.

5) Sum up the subscriber lines accommodated by all gateways in this group with the following formula:

Where, j is the subscript for gateways, SV_jis the number of subscriber lines of the gateway j, and SV is the sum.

6) Compute the number of subscriber lines that each PS can accommodate with the following formula:

Where, i is the subscript for the PSs.

7) If a PS is overloaded, one or more appropriate gateways are redirected to other PSs with lighter load in the same group for registration.

Thus, a new balance is achieved.

2.2.4 Configuring Load Sharing

I. Enabling/disabling the load sharing capability of a gateway

You can enable or disable load sharing capability specific to a gateway depending on the support of the gateway to the load sharing function of the XE 200/2000 and the actual needs.

& Note:

Before enabling the load sharing capability of a gateway, make sure that the gateway:

l Support load sharing

l Be assigned to a PS group that has at least two PSs

l Support registration redirect

In addition, configuring the load-share disable command or load-share enable command will disable or enable registration backup and load sharing capabilities together.

Perform the following configuration in LS-GW view.

Table 2-11 Enable/disable load sharing capability of the gateway

Operation	Command
Enable/disable the load sharing capability of the gateway	load-share { disable \| enable }
Restore the default load sharing setting for the gateway	undo load-share

By default, the load sharing capability of the gateway is disabled.

II. Configuring the relative capability of a PS in a PS group

The relative capability of a PS is the assigned capability of the PS relative to other PSs in the same group. The relative capacities of the PSs in different groups are not comparable.

Perform the following configuration in LS-PS view.

Table 2-12 Configure the relative capacity of a PS in a PS group

Operation	Command
Configure the relative capability of the PS in a PS group	relative-capability value
Restore the default relative capability of the PS	undo relative-capability

The default relative capability of the PS is 1.

III. Configuring the number of subscriber lines accommodated by a gateway

The number of subscriber lines accommodated by a gateway can be different from or the same as the actual hardware capacity of the gateway. Set it depending on your overall load sharing policy.

Perform the following configuration in LS-GW view.

Table 2-13 Configure the number of subscriber lines accommodated by the gateway

Operation	Command
Configure the number of subscriber lines accommodated by the gateway	subsline-sum number
Restore the default	undo subsline-sum

By default, each gateway can accommodate up to four subscriber lines.

IV. Configuring the backup gatekeeper port number in H.323 Registration_Confirm messages

Refer to Configuring the backup gatekeeper port number in H.323 registration responses.

V. Configuring the backup SIP Server port number in SIP registration response messages

Refer to Configuring the backup SIP Server port number in SIP registration responses.

2.3 Backup and Load Sharing Configuration Example

2.3.1 LS Backup Example

I. Network requirements

l XE IP PBX 1 serves as the PS (Process Server), XE IP PBX 2 serves as the primary LS (Location Server 1), and XE IP PBX 3 serves as the secondary LS (Location Server 2).

l Configure device information and gateway information of the PS on Location Server 1 and Location Server 2.

l On the PS, designate Location Server 1 (ID=0) as the primary LS, and Location Server 2 (ID=1) as secondary LS.

l On the gateway, designate Process Server as the gatekeeper.

II. Network diagram

Figure 2-4 Network diagram for LS backup configuration

III. Configuration procedure

& Note:

This example is based on the assumption that XE IP PBX 1, XE IP PBX 2, XE IPPBX 3, and H.323 Gateway are accessible to one another via available routes and does not cover the route configuration. Configure the routes according to your network environment.

1) Configure Location Server 1

# Configure the Ethernet interface

[XE2] interface ethernet 0/0

[XE2-Ethernet0/0] ip address 192.168.2.2 255.255.255.0

[XE2-Ethernet0/0] quit

# Configure the LS

[XE2] location-server

[XE2-ls] ls-config interface Ethernet 0/0

[XE2-ls] start

[XE2-ls] process-server ps0

[XE2-ls-ps-ps0] heartbeat password ps0key

[XE2-ls] gateway gw01

[XE2-ls-gw-gw01] device-type h323

[XE2-ls-gw-gw01] dynamic-ip enable

[XE2-ls-gw-gw01] quit

2) Configure Location Server 2

# Configure the Ethernet interface

[XE3] interface ethernet 0/0

[XE3-Ethernet0/0] ip address 192.168.3.2 255.255.255.0

[XE3-Ethernet0/0] quit

# Configure the LS

[XE3] location-server

[XE3-ls] ls-config interface Ethernet 0/0

[XE3-ls] start

[XE3-ls] process-server ps0

[XE3-ls-ps-ps0] heartbeat password ps0key

[XE3-ls] gateway gw01

[XE3-ls-gw-gw01] device-type h323

[XE3-ls-gw-gw01] dynamic-ip enable

[XE3-ls-gw-gw01] quit

3) Configure the PS

# Configure the Ethernet interface

[XE1] interface ethernet 0/0

[XE1-Ethernet0/0] ip address 192.168.1.2 255.255.255.0

[XE1-Ethernet0/0] quit

# Configure the gatekeeper

[XE1] process-server

[XE1-ps] ps-config ps0 interface Ethernet 0/0

[XE1-ps] heartbeat password ps0key

[XE1-ps] ls-mode 0 remote ip-address 192.168.2.2

[XE1-ps] ls-mode 1 remote ip-address 192.168.3.2

[XE1-ps] start

[XE1-ps] ls-back enable

[XE1-ps] gatekeeper

[XE1-ps-gk] start

4) Configure the H.323 gateway

# Configure the Ethernet interface

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.4.2 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 8888 voip

[VG1-voice-dial-entity8888] address ras

[VG1-voice-dial-entity8888] match-template ....

[VG1-voice-dial-entity8888] quit

[VG1-voice-dial] entity 9901 pots

[VG1-voice-dial-entity9901] line 0

[VG1-voice-dial-entity9901] match-template 9901

[VG1-voice-dial-entity9901] return

# Configure GK-Client

[VG1] voice-setup

[VG1-voice] gk-client

[VG1-voice-gk] gw-id gw01

[VG1-voice-gk] gw-address ip 192.168.4.2

[VG1-voice-gk] gk-id ps0 gk-addr 192.168.1.2 1719

[VG1-voice-gk] ras-on

2.3.2 Configuring PS-Group Backup and Load Sharing

I. Network requirements

Three XE IP PBXs are networked in distributed mode and run the H.323 protocol. One XE IP PBX functions as an LS, and the other two functions as PSs with the gatekeeper function enabled. Their gatekeeper IDs are gkserver01 and gkserver02 respectively. These two PSs belong to the same PS group, group01.

A total number of 150 gateways belong to group01. When registering with the LS, H.323 gateway 1 through H.323 gateway 100 use gkserver01, and H.323 gateway 101 through H.323 150 use gkserver02.

According to the load sharing policy made by the network administrator, the relative capability of gkserver01 is 2, and that of gkserver02 is 1. In addition, each gateway has four voice subscriber-lines.

II. Network diagram

Figure 2-5 Network diagram for registration backup and load sharing

III. Configuration procedure

& Note:

l This scenario assumes that the voice devices have reachable routes between them and routing configuration is beyond the scope of this example.

l As for configuring gateways, only procedures for configuring H.323 gateway 1 and H.323 gateway 150 are provided. You can follow almost the same procedures to configure other gateways.

1) On H.323 gatekeeper gkserver01

# Configure the Ethernet interface.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.231 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver01 interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 remote ip-address 192.168.80.230

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

2) On H.323 gatekeeper gkserver02

# Configure the Ethernet interface.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.232 255.255.255.0

[XE-Ethernet0/0] quit

# Configure the gatekeeper.

[XE] process-server

[XE-ps] ps-config gkserver02 interface Ethernet 0/0

[XE-ps] heartbeat password xe

[XE-ps] ls-mode 0 remote ip-address 192.168.80.230

[XE-ps] start

[XE-ps] gatekeeper

[XE-ps-gk] start

3) On the LS

# Configure the LS.

[XE] interface Ethernet 0/0

[XE-Ethernet0/0] ip address 192.168.80.230 255.255.255.0

[XE-Ethernet0/0] quit

[XE] location-server

[XE-ls] ls-config interface Ethernet 0/0

# Configure PS gkserver01.

[XE-ls] process-server gkserver01

[XE-ls-ps-gkserver01] heartbeat password xe

[XE-ls-ps-gkserver01] psgroup-id group01

[XE-ls-ps-gkserver01] relative-capability 2

[XE-ls-ps-gkserver01] quit

# Configure PS gkserver02

[XE-ls] process-server gkserver02

[XE-ls-ps-gkserver02] heartbeat password xe

[XE-ls-ps-gkserver02] psgroup-id group01

[XE-ls-ps-gkserver02] relative-capability 1

[XE-ls-ps-gkserver02] quit

# Configure gateways.

[XE-ls] gateway gw001

[XE-ls-gw-gw001] device-type h323

[XE-ls-gw-gw001] dynamic-ip enable

[XE-ls-gw-gw001] load-share enable

[XE-ls-gw-gw001] psgroup-id group01

[XE-ls-gw-gw001] subsline-sum 4

[XE-ls-gw-gw001] quit

…

[XE-ls] gateway gw150

[XE-ls-gw-gw150] device-type h323

[XE-ls-gw-gw150] dynamic-ip enable

[XE-ls-gw-gw150] load-share enable

[XE-ls-gw-gw150] psgroup-id group01

[XE-ls-gw-gw150] subsline-sum 4

[XE-ls-gw-gw150] quit

# Enable the LS.

[XE-ls] start

4) On H.323 gateway 1

# Configure the Ethernet interface.

[VG001] interface ethernet 0

[VG001-Ethernet0] ip address 192.168.80.1 255.255.255.0

[VG001-Ethernet0] quit

# Configure voice entities.

[VG001] voice-setup

[VG001-voice] dial-program

[VG001-voice-dial] entity 1 voip

[VG001-voice-dial-entity1] match-template ....

[VG001-voice-dial-entity1] address ras

[VG001-voice-dial-entity1] quit

[VG001-voice-dial] entity 1001 pots

[VG001-voice-dial-entity1001] match-template 1001

[VG001-voice-dial-entity1001] line 0

[VG001-voice-dial-entity1001] quit

[VG001-voice-dial] entity 1002 pots

[VG001-voice-dial-entity1002] match-template 1002

[VG001-voice-dial-entity1002] line 0

[VG001-voice-dial-entity1002] quit

[VG001-voice-dial] entity 1003 pots

[VG001-voice-dial-entity1003] match-template 1003

[VG001-voice-dial-entity1003] line 0

[VG001-voice-dial-entity1003] quit

[VG001-voice-dial] entity 1004 pots

[VG001-voice-dial-entity1004] match-template 1004

[VG001-voice-dial-entity1004] line 0

[VG001-voice-dial-entity1004] quit

# Configure the GK client.

[VG001-voice] gk-client

[VG001-voice-gk] gw-id gw001

[VG001-voice-gk] gw-address ethernet 0

[VG001-voice-gk] gk-id gkserver01 gk-addr 192.168.80.231 1719

[VG001-voice-gk] ras-on

…

5) On H.323 gateway 150

# Configure the Ethernet interface.

[VG150] interface ethernet 0

[VG150-Ethernet0] ip address 192.168.80.150 255.255.255.0

[VG150-Ethernet0] quit

# Configure voice entities.

[VG150] voice-setup

[VG150-voice] dial-program

[VG150-voice-dial] entity 1 voip

[VG150-voice-dial-entity1] match-template ....

[VG150-voice-dial-entity1] address ras

[VG150-voice-dial-entity1] quit

[VG150-voice-dial] entity 1557 pots

[VG150-voice-dial-entity1557] match-template 1557

[VG150-voice-dial-entity1557] line 0

[VG150-voice-dial-entity1557] quit

[VG150-voice-dial] entity 1558 pots

[VG150-voice-dial-entity1558] match-template 1558

[VG150-voice-dial-entity1558] line 0

[VG150-voice-dial-entity1558] quit

[VG150-voice-dial] entity 1559 pots

[VG150-voice-dial-entity1559] match-template 1559

[VG150-voice-dial-entity1559] line 0

[VG150-voice-dial-entity1559] quit

[VG150-voice-dial] entity 1600 pots

[VG150-voice-dial-entity1600] match-template 1600

[VG150-voice-dial-entity1600] line 0

[VG150-voice-dial-entity1600] quit

# Configure the GK client.

[VG150-voice] gk-client

[VG150-voice-gk] gw-id gw150

[VG150-voice-gk] gw-address ethernet 0

[VG150-voice-gk] gk-id gkserver02 gk-addr 192.168.80.232 1719

2.3.3 OFFICE-GROUP-PS Backup Configuration Example

I. Network requirements

l XE IP PBX 1 serves as an LS (Location Server 1) and a PS (Process Server 1), in centralized networking; The LS mode of the PS is “local”.

l XE IP PBX 2 serves as an LS (Location Server 2) and a PS (Process Server 2), in centralized networking; The LS mode of the PS is “local”.

l XE IP PBX 3 serves as an PS (Process Server 3), of which the LS mode is “remote”; the LS on XE IP PBX 2 (Location Server 2) is designated as the remote LS.

l Configure user “8801” on SIP User Agent 1, and then register the user to Location Server 1 through Process Server 1.

l Configure user “9901” on SIP User Agent 2, and then register to Location Server 2 through Process Server 2.

l Configure office group og1 on Location Server 1. Set the static route number for og1 to 9001, and assign office device offce1 (corresponding to Process Server 3, with a priority level of 11) and office device offce2 (corresponding to Process Server 2, with a priority level of 10) to this office group.

l Configure office group og2 on Location Server 2. Set the static route number for og2 to 8801, and assign office device offce3 (corresponding to Process Server 1, with a priority level of 10) to this office group.

l When the primary office PS (Process Server 3) fails, the secondary office PS (Process Server 2) takes over the work of the failed PS to ensure that user 8801 can call user 9901 normally.

II. Network diagram

Figure 2-6 Network diagram for OFFICE-GROUP-PS backup configuration

III. Configuration procedure

& Note:

This example is based on the assumption that SIP User Agent 1, SIP User Agent 2, XE IP PBX 1, XE IP PBX 2, and XE IPPBX 3 are accessible to one another via available routes and does not cover the route configuration. Configure the routes according to your network environment.

1) Configure SIP User Agent 1

# Configure the Ethernet interface

[VG1] interface ethernet 0

[VG1-Ethernet0] ip address 192.168.1.2 255.255.255.0

[VG1-Ethernet0] quit

# Configure voice entities

[VG1] voice-setup

[VG1-voice] dial-program

[VG1-voice-dial] entity 8888 voip

[VG1-voice-dial-entity8888] address sip proxy

[VG1-voice-dial-entity8888] match-template ....

[VG1-voice-dial-entity8888] quit

[VG1-voice-dial] entity 8801 pots

[VG1-voice-dial-entity8801] line 0

[VG1-voice-dial-entity8801] match-template 8801

[VG1-voice-dial-entity8801] return

# Configure SIP

[VG1] voice-setup

[VG1-voice] sip

[VG1-voice-sip] sip-server master 192.168.2.2

[VG1-voice-sip] sip-id ua1

[VG1-voice-sip] register-enable on

2) Configure SIP User Agent 2

# Configure the Ethernet interface

[VG2] interface ethernet 0

[VG2-Ethernet0] ip address 192.168.7.2 255.255.255.0

[VG2-Ethernet0] quit

# Configure voice entities

[VG2] voice-setup

[VG2-voice] dial-program

[VG2-voice-dial] entity 8888 voip

[VG2-voice-dial-entity8888] address sip proxy

[VG2-voice-dial-entity8888] match-template ....

[VG2-voice-dial-entity8888] quit

[VG2-voice-dial] entity 9901 pots

[VG2-voice-dial-entity9901] line 0

[VG2-voice-dial-entity9901] match-template 9901

[VG2-voice-dial-entity9901] return

# Configure SIP

[VG2] voice-setup

[VG2-voice] sip

[VG2-voice-sip] sip-server master 192.168.5.2

[VG2-voice-sip] sip-id ua2

[VG2-voice-sip] register-enable on

3) Configure XE IP PBX 1 (containing Process Server 1 and Location Server 1)

# Configure the Ethernet interface

[XE1] interface ethernet 0/0

[XE1-Ethernet0/0] ip address 192.168.2.2 255.255.255.0

[XE1-Ethernet0/0] quit

# Configure the SIP proxy server

[XE1] process-server

[XE1-ps] ps-config ps1 interface Ethernet 0/0

[XE1-ps] heartbeat password ps1key

[XE1-ps] ls-mode 0 local

[XE1-ps] start

[XE1-ps] sip

[XE1-ps-sip] start

[XE1-ps-sip] quit

[XE1-ps] quit

# Configure the LS

[XE1] location-server

[XE1-ls] ls-config interface Ethernet 0/0 port 13579

[XE1-ls] call-mode sip routed

[XE1-ls] start

[XE1-ls] process-server ps1

[XE1-ls-ps-ps1] heartbeat password ps1key

[XE1-ls] gateway ua1

[XE1-ls-gw-ua1] device-type sip

[XE1-ls-gw-ua1] dynamic-ip enable

[XE1-ls-gw-ua1] quit

# Configure office information

[XE1-ls]office-group og1

[XE1-ls-og-og1]prefix 9901

[XE1-ls-og-og1 9901]quit

[XE1-ls-og-og1]office office1

[XE1-ls-og-og1 office1]ip-address 192.168.6.2

[XE1-ls-og-og1 office1]port 5060

[XE1-ls-og-og1 office1]priority 11

[XE1-ls-og-og1 office1]register-port 5060

[XE1-ls-og-og1 office1]device-type sip

[XE1-ls-og-og1 office1]device-status normal

[XE1-ls-og-og1 office1]quit

[XE1-ls-og-og1] office office2

[XE1-ls-og-og1 office2]ip-address 192.168.5.2

[XE1-ls-og-og1 office2]port 5060

[XE1-ls-og-og1 office2]priority 10

[XE1-ls-og-og1 office2]register-port 5060

[XE1-ls-og-og1 office2]device-type sip

[XE1-ls-og-og1 office2]device-status normal

[XE1-ls-og-og1 office2]quit

4) Configure XE IP PBX 2 (containing Process Server 2 and Location Server 2)

# Configure the Ethernet interface

[XE2] interface ethernet 0/0

[XE2-Ethernet0/0] ip address 192.168.5.2 255.255.255.0

[XE2-Ethernet0/0] quit

# Configure the SIP proxy server

[XE2] process-server

[XE2-ps] ps-config ps2 interface Ethernet 0/0

[XE2-ps] heartbeat password ps2key

[XE2-ps] ls-mode 0 local

[XE2-ps] start

[XE2-ps] sip

[XE2-ps-sip] start

[XE2-ps-sip] quit

[XE2-ps] quit

# Configure the LS

[XE2] location-server

[XE2-ls] ls-config interface Ethernet 0/0 port 13579

[XE2-ls] call-mode sip routed

[XE2-ls] start

[XE2-ls] process-server ps2

[XE2-ls-ps-ps2] heartbeat password ps2key

[XE2-ls-ps-ps2] quit

[XE2-ls] process-server ps3

[XE2-ls-ps-ps3] heartbeat password ps3key

[XE2-ls-ps-ps3] quit

[XE2-ls] gateway ua2

[XE2-ls-gw-ua2] device-type sip

[XE2-ls-gw-ua2] dynamic-ip enable

[XE2-ls-gw-ua2] quit

# Configure office information

[XE2-ls]office-group og2

[XE2-ls-og-og2]prefix 8801

[XE2-ls-og-og2 8801]quit

[XE2-ls-og-og2]office office3

[XE2-ls-og-og2 office3]ip-address 192.168.2.2

[XE2-ls-og-og2 office3]port 5060

[XE2-ls-og-og2 office3]priority 10

[XE2-ls-og-og2 office3]register-port 5060

[XE2-ls-og-og2 office3]device-type sip

[XE2-ls-og-og2 office3]device-status normal

[XE2-ls-og-og2 office3]quit

5) Configure XE IP PBX 3 (containing Process Server 3)

# Configure the Ethernet interface

[XE3] interface ethernet 0/0

[XE3-Ethernet0/0] ip address 192.168.6.2 255.255.255.0

[XE3-Ethernet0/0] quit

# Configure the SIP proxy server

[XE3] process-server

[XE3-ps] ps-config ps3 interface Ethernet 0/0

[XE3-ps] heartbeat password ps3key

[XE3-ps] ls-mode 0 remote ip-address 192.168.5.2

[XE3-ps] start

[XE3-ps] sip

[XE3-ps-sip] start

[XE3-ps-sip] quit

[XE3-ps] quit

Chapter 3 Overload Protection

3.1 Introduction to Overload Protection

In a large VoIP network constructed using the XE 200/2000, an XE IP PBX can be overloaded as the result of an unreasonable load sharing policy, burst call requests, and/or excessive concurrent registration requests. To avoid decreased performance of the XE IP PBX and ensure the operation of the VoIP network, overload protection is provided.

3.2 Overload Protection Mechanism

The idea of overload protection is to decrease the load of a PS by dropping call requests according to the specified call reject policy when the PS detects that it is overloaded.

For SIP calls, the system drops INVITE messages and sends back responses in the range 500 through 599.

For H.323 calls, the system drops ARQ messages and sends back ARJ messages.

3.3 Overload Protection Configuration

3.3.1 Entering Overload Protection View

Execute the following command in system view.

Table 3-1 Enter overload protection view

Operation	Command
Enter overload protection view	overload-protection

3.3.2 Configuring Overload Protection Table

For a PS, you can configure an overload protection table, mapping CPU usage rate to packet drop rate. This allows the system to drop a defined number of call requests randomly when the CPU usage rate of the PS reaches certain value. You can configure up to five entries.

& Note:

When configuring overload protection table, you need to comply with a rule that the higher CPU usage rate is, the higher the packet drop rate will be.

Perform the following configuration in overload protection view.

Table 3-2 Configure a protection configuration entry

Operation	Command
Configure a protection configuration entry	cpu value discard chance
Delete one or all protection configuration entries	undo cpu { value \| all }

3.3.3 Enabling/Disabling Overload Protection

Perform the following configuration in overload protection view.

Table 3-3 Enable/disable overload protection

Operation	Command
Enable overload protection	start
Disable overload protection	stop

By default, overload protection is disabled.

3.3.4 Displaying the Overload Protection Configuration

Execute the following command in any view.

Table 3-4 Display the overload protection configuration

Operation	Command
Display the overload protection configuration	display overload

Chapter 4 VoIP RADIUS Accounting Configuration

4.1 RADIUS Accounting Feature of XE IP PBX

The Remote Access Dial-In User Service (RADIUS) protocol is an industry standard protocol for authentication, authorization, and accounting (AAA) of access server connections.

The VoIP RADIUS function provided by the XE IP PBX is a simple accounting function, not supporting authentication and authorization for the time being. It is suitable for use by enterprise-level users for VoIP call accounting. When a VoIP call takes place, the XE IP PBX encapsulates the user information and call information in the RADIUS accounting packet and send the packet to the RADIUS server to trigger accounting on the user; when the call ends, the XE IP PBX reports the statistics information of the call, including the calling number, called number, and call duration to the RADIUS server to complete the call accounting.

The XE IP PBX processes call accounting packets in the “start-stop” manner. Namely, the XE IP PBX sends an accounting request message to the RADIUS server at the beginning the end of call setup. Nevertheless, the XE IP PBX directly initiates or releases the VoIP call, having or having not received a response from the RADIUS server or not.

The accounting policy of the XE IP PBX is based on the calling user, rather than the called user.

4.2 RADIUS Accounting Process of XE IP PBX

I. Network diagram

Figure 4-1 Network diagram for RADIUS accounting of the XE IP PBX

II. Basic process of RADIUS accounting

When the XE IP PBX implements accounting on a call, the basic process is as follows:

1) The calling user initiates a call, and a call connection is set up through the XE IP PBX; during the call setup process, the XE IP PBX sends an account start request message (Acct-Req-Start) to the RADIUS accounting server.

2) Upon receiving the Acct-Req-Start message, the RADIUS accounting server locates the calling user, and responds with an Acct-Rsp-Start message.

3) At the end of the call, the XE IP PBX sends an account stop request message (Acct-Req-Stop) to the RADIUS accounting server to report the call duration information to the RADIUS accounting server, and then end the call.

4) Upon receiving the Acct-Req-Stop message, the RADIUS accounting server completes the accounting on the calling user based on such information as the call duration, and responds with an Acct-Rsp-Stop message to the XE IP PBX.

4.3 Configuring RADIUS Accounting Feature of XE IP PBX

4.3.1 Enabling/Disabling AAA

Perform the following configuration in system view.

Table 4-1 Enable/Disable AAA

Operation	Command
Enable AAA	aaa enable
Disable AAA	undo aaa enable

4.3.2 Configuring RADIUS Accounting Server Information

Use the radius server command to configure the information of the RADIUS accounting server used by the XE IP PBX. After the RADIUS accounting server configuration, if a connection is established between the XE IP PBX and the RADIUS accounting server, this means that the accounting operation can be implemented. When the RADIUS accounting server fails, the XE IP PBX will periodically attempt to connect the RADIUS accounting server. If a connection is successfully established after the RADIUS accounting server resumes working, the accounting operation can proceed. You must enable the AAA function before you can this command.

Perform the following configuration in system view.

Table 4-2 Configure RADIUS accounting server

Operation	Command
Configure RADIUS accounting server	radius server { radius-server-name \| radius-server-ip } [ accounting-port accounting-port ]
Delete the specified RADIUS accounting server	undo radius server

4.3.3 Configuring Shared Key for RADIUS Accounting Server

The shared access password configured on the XE IP PBX must be the same as configured on the RADIUS accounting server.

Perform the following configuration in system view.

Table 4-3 Configure the shared access password for the RADIUS accounting server

Operation	Command
Configure the shared access password of the RADIUS accounting server	radius shared-key pwd
Delete the shared access password of the RADIUS accounting server	undo radius shared-key

4.3.4 Configuring Authentication Request Retry Times

The system sends an authentication request to the RADIUS server. If the system does not receive a response before the specified timeout timer expires, it needs to retransmit the authentication request. The user can set a limit on the request retry times. Thus, when the request retry attempts exceed the allowed retry times, the system will assume that the server has failed and will set its state to the FAILED state.

Perform the following configuration in system view.

Table 4-4 Configure authentication request retry times

Operation	Command
Configure the allowed authentication request retry times.	radius retry times
Restore the default authentication request retry times.	undo radius retry

By default, the system retries to send an authentication request to a RADIUS Server 3 times. You can set 1 to 254 retry times.

4.3.5 Configuring a Timeout Timer for Sending a Request to a RADIUS Server

When the XE IP PBX sends an authentication request to the RADIUS server, the system starts a timeout timer for the response (to the authentication request, for example). After the timer expires, the system retransmits the request and resets the timer.

Perform the following configuration in system view.

Table 4-5 Configure the timeout timer for the XE IP PBX to send authentication request packets to the RADIUS server

Operation	Command
Configure the timeout timer for the XE IP PBX to send an authentication request packet to the RADIUS server.	radius timer response-timeout seconds
Restore the timeout timer to the default value.	undo radius timer response-timeout

By default, the interval for the XE IP PBX to send authentication request packets to a RADIUS Server is 5 seconds. The interval you can set ranges from 1 to 300 seconds.

4.3.6 Specifying a Source IP address for the RADIUS Packets to be Transmitted

You may specify a source IP address for the RADIUS packets sent from different interfaces on the XE IP PBX. In this way, the RADIUS server will contact the XE IP PBX only at that IP address.

An RADIUS server requires the administrator to register all the RADIUS clients, which are determined on the basis of source IP address. Therefore, the interfaces with different IP addresses on the same XE IP PBX will be regarded by the RADIUS server as different clients. Whenever the RADIUS server receives a packet carrying an unregistered source IP address, it will regarded the packet as illegal and hence make no processing on it. For this reason, you may configure a source IP address for the transmitted RADIUS packets on the XE IP PBX to get free of the work of registering the IP addresses for all the interfaces on the XE IP PBX with the server.

Caution:

Make sure that the specified source IP address is the IP address of some interface on the XE IP PBX, and the server maintains the route to that IP address.

Perform the following configuration in system view.

Table 4-6 Specify the source IP address for the transmitted RADIUS packets

Operation	Command
Configure the source IP address for the transmitted RADIUS packets	radius source-address ip-address
Remove the source IP address specified for the RADIUS packets to be transmitted	undo radius source-address

By default, no specified source IP address is configured for sending RADIUS packets.

4.3.7 Enabling/Disabling Accounting Process for Office Devices

After the accounting process is enabled for office devices, when a user on an office device calls a user in the LS domain, accounting will be implemented on the calling user. Perform this configuration with care to avoid repeated accounting on calling users.

Perform the following configuration in LS-OFFICEGROUP-OFFICE view.

Table 4-7 Enable/disable accounting process for office devices

Operation	Command
Enable accounting process for office devices	acct enable
Disable accounting process for office devices	acct disable

TOP

H3C reserves the right to modify its collaterals without any prior notice. For the latest information of the collaterals, please consult H3C sales or call 400 hotline.