SRST commands -- Basic SRST commands -- authenticate realm

Use authenticate realm to configure the realm name carried in 401 responses.

Use undo address sip to restore the default.

Syntax

authenticate realm string

undo authenticate realm

Default

No realm name is carried in 401 responses.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

string: Specifies the realm name carried in 401 responses, a case-sensitive string of 1 to 50 characters.

Usage guidelines

During registration, SIP UAs select credentials based on the realm name carried in 401 responses.

This command does not take effect on a local survivable voice server.

Examples

# Configure the realm name carried in 401 responses as server1.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] authenticate realm server1

Related commands

authenticate register

mode

SRST commands -- Basic SRST commands -- authenticate register

Use authenticate register to enable SIP register authentication globally.

Use undo authenticate register to disable SIP register authentication globally.

Syntax

authenticate register

undo authenticate register

Default

SIP register authentication is disabled globally.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

This command enables the device to challenge and authenticate SIP UAs as a SIP registrar. You can use the username command in register pool view to configure credentials, and use the authenticate realm command to configure the realm name.

This command does not take effect on a local survivable voice server.

Examples

# Enable SIP register authentication globally.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] authenticate register

Related commands

mode

SRST commands -- Basic SRST commands -- caller-group

Use caller-group to bind a subscriber group to a register pool.

Use undo caller-group to remove a subscriber group from a register pool.

Syntax

caller-group { deny | permit } group-id

undo caller-group { { deny | permit } group-id | all }

Default

No subscriber group is bound to a register pool.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

deny: Denies calls from numbers in the subscriber group.

permit: Permits calls from numbers in the subscriber group.

group-id: Specifies a subscribe group ID in the range of 1 to 2147483647.

all: Specifies all subscribe groups.

Usage guidelines

You can bind a nonexistent subscriber group to a register pool. The subscriber group takes effect only after you create the subscriber group by using the subscriber-group command.

You can bind only one subscriber group to a register pool. If you execute the command multiple times, the most recent configuration takes effect.

Examples

# Bind subscriber group 1 to register pool 100 to permit calls from numbers in the subscribe group.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] caller-group permit 1

Related commands

subscriber-group

SRST commands -- Basic SRST commands -- codec

Use codec to configure a codec for a register pool.

Use undo codec to delete the configured codec.

Syntax

codec { g711alaw | g711ulaw | g723r53 | g723r63 | g726r16 | g726r24 | g726r32 | g726r40 | g729a | g729br8 | g729r8 } [ bytes payload-size ]

undo codec

Default

No codec is configured for a register pool.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

g711alaw: Specifies the G711 A-Law codec at 64 kbps (without compression), which is typically used in Europe.

g711ulaw: Specifies the G711 μ-Law codec at 64 kbps (without compression), which is typically used in North America and Japan.

g723r53: Specifies the G723.1 Annex A codec at 5.3 kbps.

g723r63: Specifies the G723.1 Annex A codec at 6.3 kbps.

g726r16: Specifies the G726 Annex A codec at 16 kbps. Support for this keyword depends on the line card.

g726r24: Specifies the G726 Annex A codec at 24 kbps. Support for this keyword depends on the line card.

g726r32: Specifies the G726 Annex A codec at 32 kbps. Support for this keyword depends on the line card.

g726r40: Specifies the G726 Annex A codec at 40 kbps. Support for this keyword depends on the line card.

g729a: Specifies the G729 Annex A codec (a simplified version of G.729) at 8 kbps.

g729br8: Specifies the G729 Annex B codec at 8 kbps.

g729r8: Specifies the G729 codec at 8 kbps.

bytes payload-size: Specifies the number of bytes sent per second.

Table 1 Value range and default of payload-size for codecs

Codec | Value range (in bytes) | Default (in bytes)
g711alaw g711ulaw | 16 to 80 in multiples of 8, 80 to 240 in multiples of 80 | 160
g723r53 | 20 to 120 in multiples of 20 | 20
g723r63 | 24 to 144 in multiples of 24 | 24
g726r16 | 20 to 220 in multiples of 20 | 60
g726r24 | 30 to 210 in multiples of 30 | 90
g726r32 | 40 to 200 in multiples of 40 | 120
g726r40 | 50 to 200 in multiples of 50 | 150
g729a g729br8 g729r8 | 10 to 180 in multiples of 10 | 30

Usage guidelines

To establish a call, you must make sure the calling party and the called party use the same codec.

If you execute this command multiple times, the most recent configuration takes effect.

You can use this command to directly configure a codec for a register pool, or use the voice-class codec command to apply a codec template to a register pool.

The g711alaw and g711ulaw codecs provide high-quality voice transmission but consume high bandwidth.

The g723r53 and g723r63 codecs provide silence suppression technology and comfortable noise. The g723r63 codec is based on multipulse multiquantitative level technology and provides relatively high voice quality. The g723r53 codec is based on the Algebraic-Code-Excited Linear-Prediction technology and provides greater flexibility for applications.

The g729r8 and g729a codecs provide a voice quality (nearly toll quality) similar to the 32-kbps adaptive differential pulse code modulation (ADPCM). These two codecs feature low bandwidth, short delay, and medium processing complexity.

Table 2 Voice quality for codecs

Codec | Voice quality
g711alaw g711ulaw | Excellent
g726r16 g726r24 g726r32 g726r40 | Good
g729a g729br8 g729r8 | Good
g723r53 g723r63 | Average

Examples

# Configure the g711alaw codec for register pool 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] codec g711alaw

SRST commands -- Basic SRST commands -- display voice register entity

Use display voice register entity to display information about dynamic VoIP entities created in register pools.

Syntax

display voice register entity { all | pool tag }

Views

Any view

Predefined user roles

network-admin

network-operator

mdc-admin

mdc-operator

Parameters

pool tag: Specifies a register pool by its tag in the range of 0 to 200.

all: Specifies all register pools.

Examples

# Display information about dynamic VoIP entities created in register pool 2.

<Sysname> display voice register entity pool 2

Entities created dynamically on register pool 2:

entity 40003 voip

match-template 2000$

address sip ip 192.168.4.101 port 10003

session transport udp

priority 1

entity 40004 voip

match-template 2000$

address sip ip 10.1.1.2 port 5060 : VoIP entity available

session transport global

Table 3 Command output

Field | Description
entity 40003 voip | VoIP entity created dynamically in the register pool. Dynamic VoIP entities are numbered from 40001. If a number greater than 40000 is used by a statically configured POTS or VoIP entity, the number is skipped.
match-template | Number template for the dynamic VoIP entity.
address sip | Call destination.
ip | Call destination IP address.
port | Call destination port.
session transport | Transport protocol for SIP calling: TCP, TLS, or UDP.
priority | Priority for the dynamic VoIP entity. This field is displayed for dynamic VoIP entities with call destinations as SIP UAs.
VoIP entity | Status of the remote voice server: available or unavailable.

SRST commands -- Basic SRST commands -- display voice register pool all brief

Use display voice register pool all brief to display registration information for all register pools.

Syntax

display voice sip register pool all brief

Views

Any view

Predefined user roles

network-admin

network-operator

mdc-admin

mdc-operator

Examples

# Display registration information for all register pools.

<Sysname> display voice register pool all brief

Pool ID IP Address Ln DN Number State

-------------------------------------------------------------------------------------

1 192.168.4.100 192.168.4.100 1 1 1000$ Registered

2 2000 Unregistered

2 192.168.4.101 192.168.4.101 1 2000$ Registered

Table 4 Command output

Field | Description
Pool | Tag of a register pool.
ID | Address configured by the id command. It is used by the SIP registrar to authenticate SIP UAs.
IP Address | IP address of the SIP UA that has successfully registered.
Ln | Tag of the register number template.
DN | Tag of the Directory Number (DN) that is applied to the register pool.
Number | Phone number in the register pool. This field displays a phone number ending with a dollar sign ($) if the SIP UA has successfully registered. This field displays a number template if the SIP UA fails to register.
State | Registration state: Unregistered or Registered.

SRST commands -- Basic SRST commands -- id

Use id to configure SIP UAs that can register based on address.

Use undo id to restore the default.

Syntax

id { ip ip-address | network network [ mask { mask-length | mask } ] | mac mac-address }

undo id

Default

All SIP UAs can register.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

ip ip-address: Specifies a SIP UA by its IP address.

network network: Specifies SIP UAs on an IP subnet.

mask { mask-length | mask }: Specifies the subnet mask of the IP subnet. The mask-length argument represents the subnet mask length. The mask argument represents the subnet mask in the range of 0 to 32. If you do not specify this option, the system uses the subnet mask is 0.0.0.0, and all SIP UAs are not permitted to register.

mac mac-address: Specifies a SIP UA by its MAC address in the format of H-H-H.

Usage guidelines

You can configure SIP UAs that can register based on address by using the id command or based on number by using the number command. You must configure either of the commands for a register pool. If you configure both of them for a register pool, only SIP UAs with matching addresses and phone numbers can register.

If you configure an id command for a register pool already configured with the number command, the system deletes all existing dynamic VoIP entities.

Examples

# In register pool 100, permit the SIP UA with MAC address 1cbd-b9e3-b2e4 to register.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] id mac 1cbd-b9e3-b2e4

Related commands

number (register pool view)

SRST commands -- Basic SRST commands -- max-dn

Use max-dn to set the maximum number of DNs.

Use undo max-dn to restore the default.

Syntax

max-dn max-dn

undo max-dn

Default

The maximum number of DNs is 0, and you cannot create DNs.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

max-dn: Specifies the maximum number of DNs, in the range of 1 to 200.

Usage guidelines

After phone numbers in DNs successfully register and dynamic VoIP entities are created, you can increase or decrease the maximum number of DNs. To decrease the maximum number of DNs, you must first delete DNs whose tags are greater than the expected maximum number. To delete a DN, use the undo voice register dn command.

Examples

# Set the maximum number of DNs to 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] max-dn 100

Related commands

voice register dn

SRST commands -- Basic SRST commands -- max-pool

Use max-pool to set the maximum number of register pools.

Use undo max-pool to restore the default.

Syntax

max-pool max-pool

undo max-pool

Default

The maximum number of register pools is 0, and you cannot create register pools.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

max-pool: Specifies the maximum number of register pools, in the range of 1 to 200.

Usage guidelines

After phone numbers in register pools successfully register and dynamic VoIP entities are created, you can increase or decrease the maximum number of register pools. To decrease the maximum number of register pools, you must first delete register pools whose tags are greater than the expected maximum number. To delete a register pool, use the undo voice register pool command.

Examples

# Set the maximum number of register pools to 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] max-pool 100

Related commands

voice register pool

SRST commands -- Basic SRST commands -- mode

Use mode to configure the device as a voice server and specify an operating mode.

Use undo mode to restore the default.

Syntax

mode { alive | alone }

undo mode

Default

The device does not act as a voice server.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

alone: Specifies the remote mode.

alive: Specifies the local survivable mode.

Usage guidelines

After you change the operating mode of the voice server, the system deletes all registration information of SIP UAs.

Examples

# Configure the device to operate as a voice server in remote mode.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] mode alone

SRST commands -- Basic SRST commands -- number (DN view)

Use number to configure a register number template for a DN.

Use undo number to restore the default.

Syntax

number number

undo number

Default

No register number template is configured for a DN.

Views

DN view

Predefined user roles

network-admin

mdc-admin

Parameters

number: Specifies a string of 1 to 31 characters that can include digits 0 through 9 and dollar sign ($). The dollar sign ($) is a terminator, and can be used only at the end of the string. The register number must exactly match the portion of the string before the dollar sign.

Usage guidelines

A register number template defines a template for numbers that can register with the voice server. For example, if you execute the number 1000 command, all numbers beginning with 1000 (such as 10001, 10002, and 10003) can register with the voice server. If you execute the number 1000$ command, only number 1000 can register with the voice server.

You can configure only one register number template for a DN.

Examples

# Configure the register number template as 1000 for DN 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 100

[Sysname-voice-register-dn100] number 1000

SRST commands -- Basic SRST commands -- number (register pool view)

Use number to configure a register number template for a register pool.

Use undo number to delete a register number template from a register pool.

Syntax

number tag { number | dn dn-tag }

undo number tag

Default

No register number template is configured for a register pool.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

tag: Specifies a tag for a group of numbers that can register, in the range of 1 to 10.

number: Specifies a register number template, a string of 1 to 31 characters that can include digits 0 through 9 and dollar sign ($).The dollar sign ($) is a terminator, and can be used only at the end of the string. The register number must exactly match the portion of the string before the dollar sign.

dn dn-tag: Specifies an existing DN by its DN tag in the range of 1 to 200. The command permits all numbers in the DN to register.

Usage guidelines

You can configure SIP UAs that can register based on address by using the id command or based on number by using the number command. You can configure either or both of the commands for a register pool. If you configure both of them for a register pool, only SIP UAs with matching addresses and phone numbers can register.

This command deletes existing dynamic VoIP entities that are created based on addresses and do not match the register number template in the register pool.

A register number template defines a template for numbers that can register with the voice server. For example, if you execute the number 1000 command, all numbers beginning with 1000 (such as 10001, 10002, and 10003) can register with the voice server. If you execute the number 1000$ command, only the number 1000 can register with the voice server.

You can configure a maximum of 10 groups of numbers that can register for a register pool.

Examples

# In register pool 100, permit SIP UAs whose numbers begin with 1000 to register.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] number 1000

Related commands

voice register dn

SRST commands -- Basic SRST commands -- outband

Use outband to enable out-of-band DTMF signaling.

Use undo outband to restore the default.

Syntax

outband { nte | sip }

undo outband

Default

Inband DTMF signaling is used.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

nte: Enables NTE mode of out-of-band DTMF signaling.

sip: Enables SIP mode of out-of-band DTMF signaling.

Examples

# Enable NTE mode of out-of-band DTMF signaling for register pool 10.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 10

[Sysname-voice-register-pool10] outband nte

SRST commands -- Basic SRST commands -- priority

Use priority to set the priority for dynamic VoIP entities with call destinations as SIP UAs.

Use undo priority to restore the default.

Syntax

priority priority

undo priority

Default

The priority of dynamic VoIP entities with call destinations as SIP UAs is 0.

Views

DN view

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

priority: Specifies a priority for dynamic VoIP entities with call destinations as SIP UAs, in the range of 0 to 10. The smaller the value, the higher the priority.

Examples

# In DN 100, set the register number template to 1000, and set the priority to 5 for dynamic VoIP entities with call destinations as SIP UAs.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 100

[Sysname-voice-register-dn100] number 1000

[Sysname-voice-register-dn100] priority 5

# In register pool 10, set the priority to 6 for dynamic VoIP entities with call destinations as SIP UAs, and set the register number template to 2000.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 10

[Sysname-voice-register-pool10] priority 6

[Sysname-voice-register-pool10] number 2000

Related commands

number (DN view)

number (register pool view)

SRST commands -- Basic SRST commands -- proxy

Use proxy to specify remote voice servers and optionally enable keepalive.

Use undo proxy to restore the default.

Syntax

proxy ip ip1 [ port main-port-number ] [ monitor probe sip [ ip2 [ port backup-port-number ] ] ] [ priority priority ]

undo proxy

Default

No remote voice servers are specified.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

ip ip1: Specifies the IP address of the primary remote voice server.

port main-port-number: Specifies the port number of the primary remote voice server, in the range of 1 to 65535. The default is 5060.

monitor probe sip: Enables keepalive.

ip2: Specifies the IP address of the backup remote voice server.

port backup-port-number: Specifies the port number of the backup remote voice server, in the range of 1 to 65535. The default is 5060.

priority: Specifies the priority for dynamic VoIP entities, in the range of 0 to 10. The default is 0.

Usage guidelines

This command takes effect only on a local survivable voice server.

The keepalive feature uses the keepalive settings configured by using the voice-class sip options-keepalive command. Dynamic VoIP entities with call destinations as remote voice servers return the availability of the servers.

Examples

# Specify a remote proxy server with the IP address 1.1.1.1 and enable keepalive.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] proxy ip 1.1.1.1 monitor probe sip

Related commands

voice-class sip options-keepalive

SRST commands -- Basic SRST commands -- registrar server

Use registrar server to enable the SIP registrar and optionally set the global registration expiration time.

Use undo registrar server to disable the SIP registrar.

Syntax

registrar server [ expires { max max | min min } * ]

undo registrar server

Default

The SIP registrar is disabled.

Views

SIP view

Predefined user roles

network-admin

mdc-admin

Parameters

expires: Specifies the global registration expiration time.

max: Specifies the global maximum registration expiration time in the range of 120 to 86400 seconds. The default is 3600 seconds.

min: Specifies the global minimum registration expiration time in the range of 60 to 3600 seconds. The default is 60 seconds.

Usage guidelines

This command enables the device to process SIP register messages as a SIP registrar. If the registration expiration time in register messages is not in the configured range, the registrar notifies SIP UAs of the acceptable range.

If you disable SIP registrar, the voice server denies new register messages. Existing registration information is removed until the registration expiration time is reached.

If you do not configure the registration expiration time in register pool view, the global configuration in SIP view applies. If you configure the registration expiration time in both register pool view and SIP view, the configuration in register pool view takes priority.

Examples

# Enable the SIP registrar, and set the maximum and minimum registration expiration time to 3000 and 100 seconds, respectively.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] sip

[Sysname-voice-sip] registrar server expires max 3000 min 100

Related commands

mode

voice register global

SRST commands -- Basic SRST commands -- registration-timer

Use registration-timer to set the registration expiration time for a register pool.

Use undo registration-timer to restore the default.

Syntax

registration-timer max max min min

undo registration-timer

Default

The global registration expiration time applies.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

max: Specifies the maximum registration expiration time in the range of 120 to 86400 seconds.

min: Specifies the minimum registration expiration time in the range of 60 to 3600 seconds.

Usage guidelines

If you configure the registration expiration time in both register pool view and SIP view, the configuration in register pool view takes priority.

Examples

# In register pool 100, set the maximum and minimum registration expiration time to 2000 and 300, respectively.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] registration-timer max 2000 min 300

Related commands

registrar server

SRST commands -- Basic SRST commands -- substitute

Use substitute to apply a number substitution rule list to a register pool.

Use undo substitute to remove the substitution rule list from a register pool.

Syntax

substitute { called | calling } list-number

undo substitute { called | calling }

Default

No number substitution rule is applied to a register pool (number substitution is not performed).

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

called: Applies the substitution rule list to called numbers.

calling: Applies the substitution rule list to calling numbers.

list-number: Specifies a number substitution rule list by its ID in the range of 1 to 2147483647.

Usage guidelines

You can apply a nonexistent substitution rule list to a register pool. The substitution rule list takes effect only after you perform the following tasks:

1. Create the substitution rule list by using the number-substitute command.

2. Create a number substitution rule by using the rule command.

You can apply only one substitution rule list to a register pool. If you execute this command multiple times, the most recent configuration takes effect.

Examples

# Apply substitution rule list 6 to called numbers in register pool 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] substitute called 6

Related commands

number-substitute

rule

SRST commands -- Basic SRST commands -- username

Use username to configure SIP credentials for a register pool.

Use undo username to remove the configuration.

Syntax

username username password { cipher | simple } string

undo username

Default

No SIP credentials exist, and SIP UAs are not authenticated.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

username: Specifies a username, a case-sensitive string of 1 to 63 characters.

cipher: Specifies a password in encrypted form.

simple: Specifies a password in plaintext form. For security purposes, the password specified in plaintext form will be stored in encrypted form.

string: Specifies the password. Its plaintext form is a case-sensitive string of 1 to 16 characters. Its encrypted form is a case-sensitive string of 1 to 53 characters.

Usage guidelines

When you enable SIP register authentication, the SIP registrar uses the configured credentials to authenticate SIP UAs.

This command does not take effect on a local survivable voice server.

This configuration is not synchronized to dynamic VoIP entities in the register pool.

Examples

# In register pool 100, configure SIP credentials that include username abcd and a password 1234 in plaintext form.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] username abcd password simple 1234

Related commands

authenticate register

SRST commands -- Basic SRST commands -- voice register dn

Use voice register dn to create a DN and enter its view, or enter the view of an existing DN.

Use undo voice register dn to delete a DN.

Syntax

voice register dn dn-tag

undo voice register dn dn-tag

Default

No DNs exist.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

dn-tag: Specifies a DN by its tag in the range of 1 to 200.

Usage guidelines

DNs allow you to make configurations specific to SIP UAs with matching phone numbers. Dynamic VoIP entities created for these numbers inherit the configurations in the DN rather than those in the register pool.

For example, dynamic VoIP entities are created for IP phones on the subnet 10.1.1.0 in a register pool. The priority of the dynamic VoIP entities in the register pool is 3. To change the priority only for the dynamic VoIP entities created for number 1000 to 1, perform the following tasks:

1. Create a DN.

2. Set the register number template for the DN to 1000.

3. Set the priority of dynamic VoIP entities in the DN to 1.

4. Apply the DN to the register pool.

Examples

# Create DN 100 and enter its view.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 100

[Sysname-voice-register-dn100]

Related commands

max-dn

SRST commands -- Basic SRST commands -- voice register global

Use voice register global to create a global register pool and enter its view, or enter the view of the existing global register pool.

Use undo voice register global to restore the default.

Syntax

voice register global

undo voice register global

Default

No global register pool exists.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

The undo form of this command deletes existing DNs, register pools, and dynamic VoIP entities, and deregisters SIP UAs.

Examples

# Create a global register pool view and enter its view.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global]

SRST commands -- Basic SRST commands -- voice register pool

Use voice register pool to create a register pool and enter its view, or enter the view of an existing register pool.

Use undo voice register pool to delete a register pool.

Syntax

voice register pool pool-tag

undo voice register pool pool-tag

Default

No register pools exist.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

pool-tag: Specifies a register pool by its tag in the range of 1 to 200.

Usage guidelines

A register pool contains registration requirements that define which SIP UAs can register and also maintains registration information of SIP UAs. If a SIP UA meets the registration requirements, it can successfully register with the voice server, and dynamic VoIP entities are created.

The undo form of this command deletes all existing dynamic VoIP entities in the register pool.

Examples

# Create register pool 100 and enter its view.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100]

Related commands

max-pool

SRST commands -- Basic SRST commands -- voice-class codec

Use voice-class codec to apply a codec template to a register pool.

Use undo voice-class codec to restore the default.

Syntax

voice-class codec tag

undo voice-class codec

Default

No codec template is applied to a register pool.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

tag: Specifies a codec template by its tag in the range of 1 to 2147483647.

Usage guidelines

To establish a call, you must make sure the calling party and the called party use the same codec.

You can apply a nonexistent codec template to a register pool. The codec template takes effect only after you assign priorities to codes in the template by using the codec preference command.

You can apply only one codec template to a register pool. If you configure the command multiple times, the most recent configuration takes effect.

You can use this command to apply a codec template to a register pool, or use the codec command to directly configure a codec for a register pool.

Examples

# Apply codec template 1 to register pool 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] voice-class codec 1

Related commands

codec preference

voice class codec

SRST commands -- Basic SRST commands -- voice-class sip options-keepalive

Use voice-class sip options-keepalive to configure keepalive parameters.

Use undo voice-class sip options-keepalive to restore the default.

Syntax

voice-class sip options-keepalive [ up-interval interval ] [ down-interval interval ] [ retry retries ]

undo voice-class sip options-keepalive

Default

The up-interval is 60 seconds, the down-interval is 30 seconds, and the retry is 5 times.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

up-interval interval: Specifies the interval for sending OPTIONS packets when the remote voice server is available, in the range of 5 to 1200 seconds.

down-interval interval: Specifies the interval for sending OPTIONS packets when the remote voice server is unavailable, in the range of 5 to 1200 seconds.

retry retries: Specifies the number of retries to change the state for the remote voice server. The value range for the option is 1 to 10.

Usage guidelines

After you enable keepalive by using the proxy command, the local survivable voice server sends OPTIONS packets at the up-interval. If the local survivable voice server receives a response within the up-interval, it marks the remote voice server as available. If the local survivable voice server receives no response within the up-interval, or receives an error response, it sends OPTIONS packets at the timers options interval. (Error responses include 408, 499, and 5XX responses except for 500, 501, 502, 503, 504, and 513 responses.) If the local survivable voice server still receives no responses after the maximum number of retries is reached, it marks the remote voice server as unavailable.

Then, the local survivable voice server sends OPTIONS packets at the down-interval. If the local survivable voice server receives a response within the down-interval, it sends OPTIONS packets at the timers options interval. If the local survivable voice server still can receive responses after the number of retries is reached, it marks the remote voice server as available.

Examples

# In register pool 100, set the up-interval to 50 seconds, the down-interval to 20 seconds, and the number of retries to 2.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 100

[Sysname-voice-register-pool100] voice-class sip options-keepalive up-interval 50 down-interval 20 retry 2

Related commands

proxy

timers options

SRST commands -- SRST call service commands -- after-hours block pattern

Use after-hours block pattern to enable call blocking and configure the number template to be blocked.

Use undo after-hours block pattern to disable call blocking for a number template.

Syntax

after-hours block pattern pattern-tag pattern [ 7-24 ]

undo after-hours block pattern pattern-tag

Default

Call blocking is disabled.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

pattern-tag: Specifies the tag of a number template, in the range of 1 to 100.

pattern: Specifies a number template for called numbers to be blocked, a string of 1 to 31 characters. Table 5 shows the characters that can be included in the string and their descriptions.

Table 5 Descriptions of characters

Character | Description
0-9 | Digits 0 through 9.
Pound sign (#) or asterisk (*) | Indicates a valid digit.
Dot (.) | Wildcard, which can match any valid digit. For example, 555…. can match any 7-digit numbers beginning with 555.
Exclamation point (!) | Indicates that the preceding subexpression appears zero or one time. For example, 56!1234 can match 51234 and 561234.
Plus sign (+) | Indicates that the preceding subexpression appears one or more times. For example, 9876(54)+ can match 987654, 98765454, 9876545454, and so on.
Percent sign (%) | Indicates that the preceding subexpression appears zero or more times. For example, 9876(54)% can match 9876, 987654, 98765454, 9876545454, and so on.
Hyphen (-) | Connects two digits to indicate a range of numbers, for example, [1-9] indicates 1 to 9 inclusive. The hyphen (-) can appear only in brackets ([ ]).
Brackets ([ ]) | Indicates a range. Only numbers 0 through 9 are allowed in the range. For example, [1-36] matches 1, 2, 3, or 6.
Parentheses (( )) | Indicates a string of characters. For example, (123) indicates a character string of 123. It is usually used together with signs such as exclamation point (!), percent sign (%), and plus sign (+). For example, 408(12)+ can match the character string 40812 or 408121212, but not 408. In this pattern, 408 must be followed by one string of 12 at a minimum.

| NOTE: · An exclamation point (!), plus sign (+), or percent sign (%) must follow a valid digit or digit string. · To use brackets ([ ]) and parentheses (( )) together, use them in the form of "( [ ] )". The"( ( ) )", "[ [ ] ]", and "[ ( ) ]" forms are not allowed.

7-24: Enables call blocking 7 days a week, 24 hours a day. If you do not specify this keyword, the command blocks incoming calls during the time period specified by using the after-hours day or after-hours date command.

Usage guidelines

If a number matches multiple number templates, only the template with the smallest tag applies.

In a register pool, call blocking takes priority over DND, and DND takes priority over call forwarding.

Examples

# Enable call blocking for number 1000 for 7 days a week, 24 hours a day.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] after-hours block pattern 1 1000 7-24

Related commands

after-hours date

after-hours day

after-hours exempt

SRST commands -- SRST call service commands -- after-hours date

Use after-hours date to define a time period for call blocking based on the month and date.

Use undo after-hours date to delete the time period for call blocking based on the month and date.

Syntax

after-hours date month date start-time stop-time

undo after-hours date month date

Default

No timer period for call blocking is defined based on the month and date.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

month: Specifies a month, a case-insensitive string, which can be January, February, March, April, May, June, July, August, September, October, November, and December. The string must contain a minimum of the first three letters of a month, for example, jan.

date: Specifies a date of the month, in the range of 1 to 31.

start-time: Specifies the start time for call blocking, in the format of hh:mm (24-hour clock). The value 24:00 is invalid.

stop-time: Specifies the end time for call blocking, in the format of hh:mm (24-hour clock). The value 24:00 is invalid. If you specify 00:00, the system uses the value 23:59.

Usage guidelines

This command takes effect only when call blocking is enabled.

If you specify 00:00 for both the start time and end time, call blocking is enabled for 24 hours of the specified date.

If the end time is less than the start time, call blocking lasts to the end time of the day after the specified date.

If you also configure the after-hours day command, the time period for call blocking is the union of time periods specified in the two commands.

If you execute this command multiple times for the same day of the same month, the most recent configuration takes effect.

Examples

# Define the time period for call blocking as 8:00 to 20:00 on 1st, April.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] after-hours date apr 1 08:00 20:00

Related commands

after-hours block

after-hours day

after-hours exempt

SRST commands -- SRST call service commands -- after-hours day

Use after-hours day to define a time period for call blocking based on the day of the week.

Use undo after-hours day to delete the time period for call blocking based on the day of the week.

Syntax

after-hours day day start-time stop-time

undo after-hours day day

Default

No time period for call blocking is defined based on the day of the week.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

day: Specifies a day of the week, a case-insensitive string, which can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. The string must contain a minimum of first three letters of the day, for example, sat.

start-time: Specifies the start time for call blocking, in the format of hh:mm (24-hour clock). The value 24:00 is invalid.

stop-time: Specifies the end time for call blocking, in the format of hh:mm in (24-hour clock). The value 24:00 is invalid. If you specify 00:00, the system uses the value 23:59.

Usage guidelines

This command takes effect only when call blocking is enabled.

If you specify 00:00 for both the start time and end time, call blocking is enabled for 24 hours of the specified day.

If the end time is less than the start time, call blocking lasts to the end time of the day after the specified day.

If you also configure the after-hours date command, the time period for call blocking is the union of time periods specified in the two commands.

If you execute this command multiple times for the same day of the week, the most recent configuration takes effect.

Examples

# Define the time period for call blocking as 8:00 to 20:00 on Monday.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] after-hours day mon 08:00 20:00

Related commands

after-hours block

after-hours date

after-hours exempt

SRST commands -- SRST call service commands -- after-hours exempt

Use after-hours exempt to exempt numbers from call blocking.

Use undo after-hours to cancel the exemption from call blocking.

Syntax

after-hours exempt

undo after-hours

Default

Call blocking applies to all numbers in a DN or register pool.

Views

DN view

Register pool view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

After you configure this command for a DN or a register pool, incoming calls for numbers in the DN or the register pool are not blocked.

Examples

# Exempt number 1000 from call blocking.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 1

[Sysname-voice-register-dn1] after-hours exempt

[Sysname-voice-register-dn1] number 1000$

Related commands

after-hours block

after-hours day

after-hours date

SRST commands -- SRST call service commands -- call-forward b2bua

Use call-forward b2bua to enable call forwarding.

Use undo call-forward b2bua to disable call forwarding.

Syntax

Register pool view:

call-forward b2bua { all number | busy number | noan number [ timeout seconds ] }

undo call-forward b2bua { all | busy | noan }

DN view:

call-forward b2bua { all number | busy number | noan number [ timeout seconds ] | unregistered number }

undo call-forward b2bua { all | busy | noan | unregistered }

Default

Call forwarding is disabled.

Views

DN view

Register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

all: Enables call forwarding unconditional.

busy: Enables call forwarding busy.

noan: Enables call forwarding no reply.

unregistered: Enables call forwarding unregistered.

timeout: Triggers call forwarding no reply.

number: Specifies a forward-to number, a string of 1 to 31 digits that can include digits 0 through 9.

seconds: Specifies the timeout time for no reply, in the range of 2 to 120 seconds. The default is 20 seconds.

Usage guidelines

For this command, you can specify the all, busy, and noan options in register pool view and DN view. You can specify the unregistered option only in DN view.

For a dynamic VoIP entity, call forwarding unconditional takes priority over call forwarding busy, and call forwarding busy takes priority over call forwarding no reply. Call forwarding unregister cannot coexist with the three types of call forwarding.

You need to correctly plan forward-to numbers to avoid circular calls.

To avoid call forwarding loops, you can configure a maximum of five forward-to numbers for a call.

In a register pool, call blocking takes priority over DND, and DND takes priority over call forwarding.

Examples

# Enable call forwarding busy for number 5000 and set the forward-to number to 8000.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 3

[Sysname-voice-register-dn3] number 5000$

[Sysname-voice-register-dn3] call-forward b2bua busy 8000

# Enable call forwarding unregistered for number 3000 and set the forward-to number to 2000.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 3

[Sysname-voice-register-dn3] number 3000$

[Sysname-voice-register-dn3] call-forward unregistered 2000

SRST commands -- SRST call service commands -- display voice fac

Use display voice fac to display Feature Access Codes (FACs).

Syntax

display voice fac

Views

Any view

Predefined user roles

network-admin

network-operator

mdc-admin

mdc-operator

Usage guidelines

You can execute this command on a voice server or a voice gateway.

Examples

# Display FACs on a gateway.

<Sysname> display voice fac

Standard FACs enabled in gateway mode

callfwd all *57*

callfwd all cancel #57#

callfwd busy *40*

callfwd busy cancel #40#

callfwd noan *41*

callfwd noan cancel #41#

# Display FACs on a voice server.

<Sysname> display voice fac

Standard FACs enabled in server mode

pickup direct *80*

pickup local *81*

pickup group *82*

callfwd all *57*

callfwd all cancel #57#

callfwd busy *40*

callfwd busy cancel #40#

callfwd noan *41*

callfwd noan cancel #41#

callfwd unregistered *44*

callfwd unregistered cancel #44#

dnd *70*

dnd cancel #70#

Table 6 Command output

Field | Description
Custom | Custom FACs.
Standard | Standard FACs.
gateway mode | FACs enabled on a voice gateway.
server mode | FACs enabled on a voice server.
callfwd | Call forwarding: · all—Enables call forwarding unconditional. · all-cancel—Disables call forwarding unconditional. · busy—Enables call forwarding busy. · busy-cancel—Disables call forwarding busy. · noan—Enables call forwarding no reply. · noan-cancel—Disables call forwarding no reply. · unregistered—Enables call forwarding unregistered. · unregistered-cancel—Disables call forwarding unregistered.
dnd | DND.
pickup | Call pickup: · direct—Enables direct call pickup. · local—Enables local group pickup. · group—Enables group pickup.

SRST commands -- SRST call service commands -- dnd

Use dnd to enable Do Not Disturb (DND).

Use undo dnd to disable DND.

Syntax

dnd

undo dnd

Default

DND is disabled.

Views

Register pool view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

After you enable DND for a register pool, incoming calls for numbers in the register pool are terminated. Calling parties will hear busy tones. Outgoing calls from these numbers are allowed.

In a register pool, call blocking takes priority over DND, and DND takes priority over call forwarding.

Examples

# Enable DND for register pool 1.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register pool 1

[Sysname-voice-register-pool1] dnd

SRST commands -- SRST call service commands -- fac custom

Use fac custom to create and enable a custom FAC.

Use undo fac custom to remove the configuration.

Syntax

fac custom { alias id custom-string to existing-string | callfwd { all | all-cancel | busy | busy-cancel | noan | noan-cancel | unregistered | unregistered-cancel } string | dnd [ cancel ] string | pickup { direct | group | local } string }

undo fac custom { alias id | callfwd { all | all-cancel | busy | busy-cancel | noan | noan-cancel | unregistered | unregistered-cancel } | dnd | pickup { direct | group | local } }

Default

FACs are disabled.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

alias id: Creates an alias for a custom FAC. The value range for the id argument is 0 to 9.

custom-string: Specifies a new custom FAC, which is a string of 1 to 10 characters that can include digits 0 through 9, asterisk (*), and pound sign (#).

existing-string: Specifies an existing custom FAC, which is a string of 1 to 10 characters that can include digits 0 through 9, asterisk (*), and pound sign (#).

pickup: Enables call pickup FAC.

direct: Enables direct call pickup FAC.

group: Enables group pickup FAC.

local: Enables local group pickup FAC.

dnd: Enables DND FAC.

cancel: Disables DND FAC.

callfwd: Enables call forwarding FAC.

all: Enables call forwarding unconditional FAC.

all-cancel: Disables call forwarding unconditional FAC.

busy: Enables call forwarding busy FAC.

busy-cancel: Disables call forwarding busy FAC.

noan: Enables call forwarding no reply FAC.

noan-cancel: Disables call forwarding no reply FAC.

unregistered: Enables call forwarding unregistered FAC.

unregistered-cancel: Disables call forwarding unregistered FAC.

string: Specifies a custom FAC, a string of 1 to 10 characters that can include digits 0 through 9, asterisk (*), and pound sign (#).

Usage guidelines

This command and the fac standard command are mutually exclusive. You cannot configure these two commands on the same device.

You can configure custom FACs on a gateway or a voice server. However, on a gateway, you can configure custom FACs only for call forwarding services (excluding call forwarding unregistered and call forwarding unavailable).

As a best practice, assign a unique FAC for each call service. If you configure the same FAC for different call services, some call services cannot be enabled or disabled.

Examples

# Configure the custom FAC for call forwarding unconditional as 1234.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] fac custom callfwd all 1234

Related commands

fac standard

SRST commands -- SRST call service commands -- fac standard

Use fac standard to enable standard FACs.

Use undo fac standard to disable standard FACs.

Syntax

fac standard

undo fac standard

Default

Standard FACs are disabled.

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

This command and the fac custom command are mutually exclusive. You cannot configure these two commands on the same device.

You can enable standard FACs on a gateway or a voice service. However, on a gateway, only standard FACs for call forwarding (excluding call forwarding unregistered and call forwarding unavailable) are supported.

Examples

# Enable standard FACs.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] fac standard

Related commands

fac custom

SRST commands -- SRST call service commands -- fac terminator

Use fac terminator to configure the terminator for custom FACs.

Use undo fac terminator to restore the default.

Syntax

fac terminator character

undo fac terminator

Default

The terminator for custom FACs is a pound sign (#).

Views

Voice view

Predefined user roles

network-admin

mdc-admin

Parameters

character: Specifies a terminator for custom FACs, which is a single character that can be a digit from 0 to 9, a pound sign (#), or an asterisk (*).

Usage guidelines

You can configure this command only on a gateway configured with custom FACs.

Examples

# Configure an asterisk (*) as the terminator for custom FACs.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] fac terminator *

Related commands

fac custom

SRST commands -- SRST call service commands -- moh file

Use moh file to specify an MOH resource file.

Use undo moh file to restore the default.

Syntax

moh file filename

undo moh file

Default

No MOH resource file is specified.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

filename: Specifies the name of an MOH resource file.

Usage guidelines

You can configure the voice server to unicast and multicast the MOH stream by using the call-hold-format sendonly command and the multicast moh ip command, respectively.

Only WAV files with G711 u-Law or G711 A-Law codec are supported.

Examples

# Specify the cfa0:/g711u/moh.wav file as the MOH resource file.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] moh file cfa0:/g711u/moh.wav

Related commands

call-hold-format

multicast moh ip

SRST commands -- SRST call service commands -- multicast moh

Use multicast moh to configure the MOH multicast address.

Use undo multicast moh ip to restore the default.

Syntax

multicast moh ip multicast-address port port-number route address-list

undo multicast moh ip

Default

No MOH multicast address is configured.

Views

Global register pool view

Predefined user roles

network-admin

mdc-admin

Parameters

ip multicast-address: Specifies the MOH multicast IP address, in the range of 224.0.1.0 to 239.255.255.255.

port port-number: Specifies the MOH destination port, in the range of 2000 to 65535.

route address-list: Specifies a space-separated list of up to five MOH outgoing interface items. Each item specifies an outgoing interface or a list of outgoing interfaces.

Examples

# Set the MOH multicast address to 239.1.1.1, the destination port to 2009, and the outgoing interface address to 192.168.4.16.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register global

[Sysname-voice-register-global] multicast moh ip 239.1.1.1 port 2009 route 192.168.4.16

Related commands

moh file

SRST commands -- SRST call service commands -- mwi

Use mwi to enable MWI for a DN.

Use undo mwi to disable MWI for a DN.

Syntax

mwi

undo mwi

Default

MWI is disabled.

Views

DN view

Predefined user roles

network-admin

mdc-admin

Examples

# Enable MWI for DN 100.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 100

[Sysname-voice-register-dn100] number 1000$

[Sysname-voice-register-dn100] mwi

Related commands

mode

SRST commands -- SRST call service commands -- pickup-call any-group

Use pickup-call any-group to enable the GPickUp softkey for group pickup.

Use undo pickup-call any-group to disable the GPickUp softkey for group pickup.

Syntax

pickup-call any-group

undo pickup-call any-group

Default

The GPickUp softkey for group pickup is disabled.

Views

DN view

Predefined user roles

network-admin

mdc-admin

Usage guidelines

For example, IP phone A belongs to a pickup group, and IP phone B does not belong to the pickup group or any pickup groups. You can configure this command for the DN to which IP phone B belongs. When IP phone A rings, you can press the GPickUp softkey and the asterisk (*) key on IP phone B to answer the call.

Examples

# Enable the GPickUp softkey for number 1000 in DN 1 to implement group pickup.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 1

[Sysname-voice-register-dn1] number 1000$

[Sysname-voice-register-dn1] pickup-call any-group

SRST commands -- SRST call service commands -- pickup-group

Use pickup-group to assign a DN to a pickup group.

Use undo pickup-group to restore the default.

Syntax

pickup-group group-name

undo pickup-group

Default

A DN does not belong to any pickup group.

Views

DN view

Predefined user roles

network-admin

mdc-admin

Parameters

group-name: Specifies a pickup group, which is a case-sensitive string of 1 to 31 characters. Valid characters are digits 0 through 9, letters, comma (,), pound sign (#), and asterisk (*).

Examples

# Assign number 1000 in DN 100 to pickup group 25.

<Sysname> system-view

[Sysname] voice-setup

[Sysname-voice] voice register dn 100

[Sysname-voice-register-dn100] number 1000$

[Sysname-voice-register-dn100] pickup-group 25