cc/td/doc/product/voice/srst/srst34
hometocprevnextglossaryfeedbacksearchhelp
PDF

Table Of Contents

Command Reference: A through M

after-hour exempt (voice register pool)

alias (voice register pool)

application (voice register global)

application (voice register pool)

b2bua

call-forward b2bua all (voice register dn and voice register pool)

call-forward b2bua busy (voice register dn and voice register pool)

call-forward b2bua mailbox (voice register dn and voice register pool)

call-forward b2bua noan (voice register dn and voice register pool)

codec (voice register pool)

cor (voice register pool)

debug voice register errors

debug voice register events

dialplan-pattern (voice register pool)

dtmf-relay (voice register pool)

external-ring (voice register global)

id (voice register pool)

incoming called-number (voice register pool)

max-pool (voice register global)

max registrations (voice register pool)


Command Reference: A through M


This chapter contains commands to configure and maintain a typical Cisco SIP Survivable Remote Site Telephony (SRST) environment. The commands are presented in alphabetical order. Some commands required for configuring voice may be found in other Cisco IOS command references. Use the command reference master index or search online to find these commands.

For detailed information on how to configure Cisco SIP SRST applications and features, see the Cisco IOS SIP SRST Version 3.4 System Administrator Guide.

after-hour exempt (voice register pool)

alias (voice register pool)

application (voice register global)

application (voice register pool)

b2bua

call-forward b2bua all (voice register dn and voice register pool)

call-forward b2bua busy (voice register dn and voice register pool)

call-forward b2bua mailbox (voice register dn and voice register pool)

call-forward b2bua noan (voice register dn and voice register pool)

codec (voice register pool)

cor (voice register pool)

debug voice register errors

debug voice register events

dialplan-pattern (voice register pool)

dtmf-relay (voice register pool)

external-ring (voice register global)

id (voice register pool)

incoming called-number (voice register pool)

max-pool (voice register global)

max registrations (voice register pool)

after-hour exempt (voice register pool)

To specify that for a particular voice register pool no outgoing calls are blocked even though global system call blocking is enabled, use the after-hours exempt command in voice register pool configuration mode. To return to the default, use the no form of this command.

after-hour exempt

no after-hour exempt

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled (global call blocking remains active, as configured).

Command Modes

Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

This command exempts individual Cisco SIP phones and phone extensions from call blocking.

Call blocking on Cisco IP phones is defined in the following way. First, define one or more patterns of outgoing digits by using the after-hours block pattern command in either telephony-service configuration mode for Cisco CME or in call-manager-fallback configuration mode for Cisco SIP SRST. Next, define one or more time periods during which calls that match those patterns are to be blocked are by using the after-hours date or after-hours day command or both. By default, all Cisco IP phones in a Cisco CME or Cisco SIP SRST system are restricted during the specified time if at least one pattern and at least one time period are defined.

A phone extension is exempt as long as the after-hour exempt command is configured in voice register dn or in voice register pool configuration mode.


Note The id (voice register pool) command is required before Cisco CME or Cisco SIP SRST can accept registrations. Configure the id (voice register pool) command before any other voice register pool command.


Examples

The following example exempts blocking of outgoing calls from SIP phone 23:

Router(config)# voice register pool 23
Router(config-register-pool)# after-hour exempt

The following example specifies that outgoing calls from extension 5001 under voice register pool 2 are not blocked:

Router(config)# voice register pool 2
Router(config-register-pool)# number 5001
Router(config-register-pool)# after-hour exempt

Related Commands

Command
Description

after-hours block pattern

Defines a pattern of digits for blocking outgoing calls from IP phones.

after-hours block pattern (call-manager- fallback)

Defines a pattern of digits for blocking outgoing calls from IP phones.

after-hours date

Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours date (call-manager- fallback)

Defines a recurring period based on date during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours day

Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hours day (call-manager- fallback)

Defines a recurring period based on day of the week during which outgoing calls that match defined block patterns are blocked on IP phones.

after-hour exempt (voice register dn)

Specifies that an individual extension on a SIP phone does not have any of its outgoing calls blocked even though global system call blocking is enabled.

call-manager-fallback

Enables Cisco SIP SRST support and enter call-manager-fallback configuration mode.

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones.

telephony-service

Enters telephony-service configuration mode to configure a Cisco CallManager Express (Cisco CME) system.

voice register dn

Enters voice register dn configuration mode to define an extension for a SIP phone line.

voice register pool

Enters voice register pool configuration mode for Cisco SIP IP phones.


alias (voice register pool)

To allow Cisco SIP IP phones to handle inbound PSTN calls to telephone numbers that are unavailable when the main proxy is not available, use the alias command in voice register pool configuration mode. To disable rerouting of unmatched call destination calls, use the no form of this command.

alias tag pattern to target [preference value]

no alias tag

Syntax Description

tag

Number from 1 to 5 and the distinguishing factor when there are multiple alias commands.

pattern

Prefix number that represents a pattern against which to match the incoming telephone number. It may include wildcards.

to

Connects the number pattern to the target (alternate number).

target

Target number. An alternate telephone number to route incoming calls that match the number pattern. The target must be a full E.164 number.

preference value

(Optional) Assigns a dial-peer preference value to the alias. The value argument is the value of the associated dial peer. The range is from 1 to 10. There is no default.


Defaults

None

Command Modes

Voice register pool configuration

Command History

Release
Modification

12.2(15)ZJ

This command was introduced.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

The alias command services calls placed to telephone numbers that are unavailable because the main proxy is not available. The alias command is activated when a Cisco SIP IP phone that has an extension number matching the target number registers.

When a phone with the target number registers, calls that match the number pattern are rerouted to the target number. The target number must be a local phone number to enable rerouting of a range of number patterns. When a Cisco SIP IP phone registers with a target number, an additional VoIP dial peer is created using the target number IP address as a session target and destination pattern as configured with the alias pattern command. For the alias command to work, the VoIP dial peer must be set with a translation rule to translate the called number to the target number. Translation rules can be configured under voice register pool configuration mode.

If other Cisco SIP IP phones register that have specific phone numbers that fall within the alias range or if another static dial peer exists for this pattern, the call is routed using the appropriate dial peer in preference to being rerouted to this alternate alias number (according to normal dial-peer longest-match, preference, and huntstop rules).


Note The id (voice register pool) command must be configured before any other voice register pool commands, including the alias command. The id command identifies a locally available individual Cisco SIP IP phone or sets of Cisco SIP IP phones.

Before the alias command is configured, translation rules must be set using the translate-outgoing (voice register pool) command. Translation rules are a general-purpose number-manipulation mechanism that perform operations such as automatically adding telephone area and prefix codes to dialed numbers.


Examples

The following example configures calls to numbers in the 5000 to 5099 range that are not otherwise explicitly resolved to a specific extension number to be routed to the phone with extension 5001. Phone calls intended for phones that are not given fallback service can then be redirected to the specified extension number.

Router(config)# voice register pool
Router(config-register-pool)# alias 1 50.. to 5001

Related Commands

Command
Description

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

show dial-peer voice

Displays information for voice dial peers.

translate-outgoing (voice register pool)

Applies a translation rule to manipulate dialed digits on an outbound POTS or VoIP call leg.

voice register pool

Enables SIP SRST voice register pool configuration commands.


application (voice register global)

To select the session-level application for all dial peers associated with SIP phones, use the application command in voice register global configuration mode. To disable use of the application, use the no form of this command.

application application-name

no application

Syntax Description

application-name

Interactive voice response (IVR) application name.


Defaults

Default application on router

Command Modes

Voice register global configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

During Cisco CME or Cisco SIP SRST registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.


Note Configure the id (voice register pool) command before any other voice register pool commands, including the application command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.


Examples

The following example shows how to set the Tcl IVR application globally for all SIP phones:

Router(config)# voice register global
Router(config-register-global)# mode cme
Router(config-register-global)# application sipapp2

Related Commands

Command
Description

application (dial-peer)

Enables a specific application on a dial peer.

application (voice register pool)

Selects the session-level application for the dial peer associated an individual SIP phone in a Cisco CME environment or for a group of phones in a Cisco SIP SRST environment.

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.

show call application voice summary

Displays information about voice applications.

show dial-peer voice

Displays information for dial peers.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.

voice register pool

Enters voice register pool configuration mode for SIP phones.


application (voice register pool)

To select the session-level application for the dial peer associated an individual SIP phone in a Cisco CME environment or for a group of phones in a Cisco SIP SRST environment, use the application command in voice register pool configuration mode. To disable use of the application, use the no form of this command.

application application-name

no application

Syntax Description

application-name

Name of the selected interactive voice response (IVR) application name.


Defaults

Default application on router

Command Modes

Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.2(15)ZJ

Cisco SIP SRST 3.0

This command was introduced.

12.3(4)T

Cisco SIP SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

During Cisco  CME or Cisco SIP SRST registration, a dial peer is created for each SIP phone and that dial peer includes the default session application. The application command allows you to change the default application for all dial peers associated with the Cisco SIP IP phones, if desired. The applied application (or TCL IVR script) must support call redirection. Use the show call application voice summary command to display a list of applications.

The application command in voice register pool configuration mode takes precedence over this command in voice register global configuration mode.


Note Configure the id (voice register pool) command before any other voice register pool commands, including the application command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.


Examples

The following example shows how to set the IVR application for the SIP phone specified by the voice register pool command:

Router(config)# voice register pool 1
Router(config-register-pool) application sipapp2

The following partial sample output from the show running-config command shows that voice register pool 1 has been set up to use the SIP.app application:

voice register pool 1
 id network 172.16.0.0 mask 255.255.0.0
 application SIP.app
 voice-class codec 1

Related Commands

Command
Description

application (dial-peer)

Enables a specific application on a dial peer.

application (voice register global)

Selects the session-level application for all dial peers associated with SIP phones.

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.

show call application voice summary

Displays information about voice applications.

show dial-peer voice

Displays information for dial peers.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.

voice register pool

Enters voice register pool configuration mode for SIP phones.


b2bua

To configure a dial peer associated with an individual SIP phone in a Cisco CME environment or a group of phones in a Cisco SIP SRST environment to point to Cisco Unity Express, use the b2bua command in dial-peer configuration mode. To disable B2BUA call flow on the dial peer, use the no form of this command.

b2bua

no b2bua

Syntax Description

This command has no arguments or keywords.

Defaults

Disabled

Command Modes

Dial-peer configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

Use the b2bua command to set the Cisco CME source address as the 302 redirect contact address for all calls forwarded to Cisco Unity Express.


Note Use the b2bua command to configure Cisco SIP SRST 3.4 only after using the allow-connections command to enable B2BUA call flow on the SRST gateway.


Examples

The following example shows b2bua included in the configuration for voice dial peer 1:

dial-peer voice 1 voip
 destination-pattern 4...
 session target ipv4:10.5.49.80
 session protocol sipv2
 dtmf-relay sip-notify
 b2bua

Related Commands

Command
Description

allow-connections

Enables calls between SIP endpoints in a VoIP network.

dial-peer voice

Defines a dial peer and enters dial-peer configuration mode.

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.

show dial-peer voice

Displays information for dial peers.

source-address (voice register global)

Identifies the IP address and port through which SIP phones communicate with a Cisco CME router.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.


call-forward b2bua all (voice register dn and voice register pool)

To enable call forwarding for a SIP back-to-back user agent (B2BUA) so that all incoming calls are forwarded to another extension, use the call-forward b2bua all command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.

call-forward b2bua all directory-number

no call-forward b2bua all

Syntax Description

directory-number

Telephone number to which calls are forwarded. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.


Defaults

Disabled (no incoming call forwarding to another extension).

Command Modes

Voice register dn configuration
Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

You can apply call forward to an individual extension (voice register dn) or to the phone on which the extension appears (voice register pool). Use this command in voice register pool configuration mode to enable call forwarding for all extensions on a Cisco SIP IP phone. Use this command in voice register dn configuration mode to enable call forwarding for an individual extension.

If information is configured in both voice register dn and voice register pool mode, the information under voice register dn mode takes precedence.

It is recommended that you do not use this command with hunt groups. If the command is used, consider removing the phone from any assigned hunt groups, unless you want to forward calls to all phones in the hunt group.

The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.


Note This command in voice register dn configuration mode is not commonly used for Cisco SIP SRST.


Examples

The following example shows how to forward all incoming calls to extension 5001 on directory number 4, to extension 5005.

Router(config)# voice register dn 4
Router(config-register-dn)# number 5001
Router(config-register-dn)# call-forward b2bua all 5005

The following example forwards to extension 5005 all incoming calls to extension 5001 on pool number 4.

Router(config)# voice register pool 4
Router(config-register-pool)# number 5001
Router(config-register-pool)# call-forward b2bua all 5005

Related Commands

Command
Description

call-forward b2bua busy (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to a busy extension are forwarded to another extension.

call-forward b2bua mailbox (voice register dn and voice register pool)

Controls the specific voice-mail box selected in a voice-mail system at the end of a call forwarding exchange.

call-forward b2bua noan (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to an extension that does not answer after a configured amount of time are forwarded to another extension.

call-forward b2bua unreachable (voice register dn and voice register pool)

Enables call forwarding for a SIP b2bua so that incoming calls to an extension that is not registered in Cisco CME are forwarded to another extension.

call-waiting (voice register pool)

Enables call waiting on a SIP phone.

number (voice register dn)

Associates an extension number with a voice register dn.

voice register dn

Enters voice register dn configuration mode to define an extension for a SIP phone line.

voice register pool

Enters voice register pool configuration mode for SIP phones.


call-forward b2bua busy (voice register dn and voice register pool)

To enable call forwarding for a SIP back-to-back user agent (B2BUA) so that incoming calls to a busy extension are forwarded to another extension, use the call-forward b2bua busy command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.

call-forward b2bua busy directory-number

no call-forward b2bua busy

Syntax Description

directory-number

Telephone number to which calls are forwarded. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.


Defaults

Disabled (no incoming calls to a busy extension are forwarded).

Command Modes

Voice register dn configuration
Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

The call-forward b2bua busy response is triggered when a call is sent to a Cisco SIP IP phone using a VoIP dial peer and a busy response is received back from the phone. This command functions only with phones that are registered to a Cisco SIP SRST or Cisco CME router.

You can apply call forward to an individual extension (voice register dn) or to the SIP phone on which the extension appears (voice register pool). Use this command in voice register pool configuration mode to enable call forwarding for all extensions on a SIP phone. Use this command in voice register dn configuration mode to enable call forwarding for a specific extension. If information is configured in both voice register dn and voice register pool mode, the information under voice register dn takes precedence.

It is recommended that you do not use this command with hunt groups. If the command is used, consider removing the phone from any assigned hunt groups, unless you want to forward calls to all phones in the hunt group.

The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.


Note This command in voice register dn configuration mode is not commonly used for Cisco SIP SRST.


Cisco CME

Call forward busy can also get invoked if a number is unreachable but the call forward b2bua unreachable command is not configured.

Examples

The following example forwards calls to extension 5005 when extension 5001 in pool number 4 is busy.

Router(config)# voice register pool 4
Router(config-register-pool)# number 5001
Router(config-register-pool)# call-forward b2bua busy 5005

Related Commands

Command
Description

call-forward b2bua all (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that all incoming calls are forwarded to another extension.

call-forward b2bua mailbox (voice register dn and voice register pool)

Controls the specific voice-mail box selected in a voice-mail system at the end of a call forwarding exchange.

call-forward b2bua noan (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to an extension that does not answer after a configured amount of time are forwarded to another extension.

call-forward b2bua unreachable (voice register dn and voice register pool)

Enables call forwarding for a SIP b2bua so that incoming calls to an extension that is not registered in Cisco CME are forwarded to another extension.

call-waiting (voice register pool)

Enables call waiting on a SIP phone.

number (voice register dn)

Associates an extension number with a voice register dn.

voice register dn

Enters voice register dn configuration mode to define an extension for a SIP phone line.

voice register pool

Enters voice register pool configuration mode for SIP phones.


call-forward b2bua mailbox (voice register dn and voice register pool)

To control the specific voice-mail box selected in a voice-mail system at the end of a call forwarding exchange, use the call-forward b2bua mailbox command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.

call-forward b2bua mailbox directory-number

no call-forward b2bua mailbox

Syntax Description

directory-number

Telephone number to which calls are forwarded when the forwarded destination is busy or does not answer. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.


Defaults

Disabled (no voice-mail box is selected for call forwarding).

Command Modes

Voice register dn configuration
Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

Use this command to denote the voice-mail box to use at the end of a chain of call forwards to busy or no answer destinations. It can be used to forward calls to a voice-mail box that has a different number than the forwarding extension. A sample of this would be in the case of a shared voice-mail box, for instance one between a manager and her assistant. This command functions only with phones that are registered to a Cisco CME or Cisco SIP SRST router.

If information is configured in both voice register dn and voice register pool mode, the information under voice register dn takes precedence.

It is recommended that you do not use the call-forward b2bua mailbox command with hunt groups. If the command is used, consider removing the phone from any assigned hunt groups, unless you want to forward calls to all phones in the hunt group.

This command is used in conjunction with the call-forward b2bua all, call-forward b2bua busy, and call-forward b2bua noan commands.


Note This command in voice register dn configuration mode is not commonly used for Cisco SIP SRST.


Examples

The following example forwards calls to extension 5005 if an incoming call is forwarded to extension 5001 on pool number 4 and extension 5001 is busy or does not answer.

Router(config)# voice register pool 4
Router(config-register-pool)# number 5001
Router(config-register-pool)# call-forward b2bua mailbox 5005

Related Commands

Command
Description

call-forward b2bua all (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that all incoming calls are forwarded to another extension.

call-forward b2bua busy (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to a busy extension are forwarded to another extension.

call-forward b2bua noan (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to an extension that does not answer after a configured amount of time are forwarded to another extension.

call-forward b2bua unreachable (voice register dn and voice register pool)

Enables call forwarding for a SIP b2bua so that incoming calls to an extension that is not registered in Cisco CME are forwarded to another extension.

call-waiting (voice register pool)

Enables call waiting on a SIP phone.

number (voice register dn)

Associates an extension number with a voice register dn.

voice register dn

Enters voice register dn configuration mode to define an extension for a SIP phone line.

voice register pool

Enters voice register pool configuration mode for SIP phones.


call-forward b2bua noan (voice register dn and voice register pool)

To enable call forwarding for a SIP back-to-back user agent (B2BUA) so that incoming calls to an extension that does not answer after a configured amount of time are forwarded to another extension, use the call-forward b2bua noan command in voice register dn or voice register pool configuration mode. To disable call forwarding, use the no form of this command.

call-forward b2bua noan directory-number timeout seconds

no call-forward b2bua noan

Syntax Description

directory-number

Telephone number to which calls are forwarded. Represents a fully qualified E.164 number. Maximum length of the telephone number is 32.

timeout seconds

Number of seconds that a call can ring with no answer before the call is forwarded to another extension. Range is 3 to 60000. Default is 20.


Defaults

Disabled (no incoming calls to an extension that does not answer are forwarded).

Command Modes

Voice register dn configuration
Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

This command functions only with phones that are registered to a Cisco SIP SRST or Cisco CME router. You can apply call forward to an individual extension (voice register dn) or to the SIP phone on which the extension appears (voice register pool). Use this command in voice register pool configuration mode to enable call forwarding for all extensions on a SIP phone. Use this command in voice register dn configuration mode to enable call forwarding for a specific extension.

If information is configured in both voice register dn and voice register pool mode, the information under voice register dn takes precedence.

It is recommended that you do not use this command with hunt groups. If the command is used, consider removing the phone from any assigned hunt groups, unless you want to forward calls to all phones in the hunt group.

The call-forward b2bua all command takes precedence over the call-forward b2bua busy and call-forward b2bua noan commands.


Note This command in voice register dn configuration mode is not commonly used for Cisco SIP SRST.


Examples

The following example forwards calls to extension 5005 when extension 5001 on pool number 4 is unanswered. The timeout before the call is forwarded to extension 5005 is 10 seconds.

Router(config)# voice register pool 4
Router(config-register-pool)# number 5001
Router(config-register-pool)# call-forward b2bua noan 5005 timeout 10

Related Commands

Command
Description

call-forward b2bua all (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that all incoming calls are forwarded to another extension.

call-forward b2bua busy (voice register dn and voice register pool)

Enables call forwarding for a SIP B2BUA so that incoming calls to a busy extension are forwarded to another extension.

call-forward b2bua mailbox (voice register dn and voice register pool)

Controls the specific voice-mail box selected in a voice-mail system at the end of a call forwarding exchange.

call-forward b2bua unreachable (voice register dn and voice register pool)

Enables call forwarding for a SIP b2bua so that incoming calls to an extension that is not registered in Cisco CME are forwarded to another extension.

call-waiting (voice register pool)

Enables call waiting on a SIP phone.

number (voice register dn)

Associates an extension number with a voice register dn.

voice register dn

Enters voice register dn configuration mode to define an extension for a SIP phone line.

voice register pool

Enters voice register pool configuration mode for SIP phones.


codec (voice register pool)

To specify the codec supported by a single Cisco SIP phone or a VoIP dial peer in a Cisco SIP SRST or a Cisco CME environment, use the codec command in voice register pool configuration mode. To disable a specified codec, use the no form of this command.

codec codec-type [bytes]

no codec

Syntax Description

codec-type

Specifies the preferred codec:

g711alaw—G.711 a-law 64,000 bps

g711ulaw—G.711 mu-law 64,000 bps.

g729r8—G.729 8000 bps (this is the default).

bytes

(Optional) Specifies the number of bytes in the voice payload of each frame.


Defaults

g729r8

Command Modes

Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

This command sets the codec configuration for an individual phone and overrides any previously configured codec selection set with the voice-class codec command.


Note Configure the id (voice register pool) command before any other voice register pool commands. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.


Examples

The following example shows codec complexity set to g729r8 for a Cisco SIP IP phone in pool 1:

Router(config)# voice register pool 1
Router(config-register-pool)# codec g729r8

Related Commands

Command
Description

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones.

voice-class codec

Assigns a previously configured codec selection preference list.

voice register pool

Enters voice register pool configuration mode for SIP phones.


cor (voice register pool)

To configure a class of restriction (COR) on the VoIP dial peers associated with directory numbers, use the cor command in voice register pool configuration mode. To disable a COR associated with directory numbers, use the no form of this command.

cor {incoming | outgoing} cor-list-name {cor-list-number starting-number [- ending-number] | default}

no cor {incoming | outgoing} cor-list-name {cor-list-number starting-number [- ending-number] | default}

Syntax Description

incoming

COR list to be used by incoming dial peers.

outgoing

COR list to be used by outgoing dial peers.

cor-list-name

COR list name.

cor-list-number

COR list identifier.

starting-number

Start of a directory number range, if an ending number is included. Can also be a standalone number.

-

(Optional) Indicator that a full range is configured.

ending-number

(Optional) End of a directory number range.

default

Instructs the COR list to assume behavior according to a predefined default COR list.


Defaults

None

Command Modes

Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.2(15)ZJ

Cisco SIP SRST 3.0

This command was introduced.

12.3(4)T

Cisco SIP SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

The cor command sets the dial-peer COR parameter for dynamically created VoIP dial peers. A list-based mechanism assigns COR parameters to specific set of number ranges. The COR functionality provides the ability to deny certain call attempts on the basis of the incoming and outgoing class of restrictions provisioned on the dial peers. This functionality provides flexibility in network design, allows users to block calls (for example, calls to 900 numbers), and applies different restrictions to call attempts from different originators.

COR specifies which incoming dial peer can use which outgoing dial peer to make a call. Each dial peer can be provisioned with an incoming and an outgoing COR list.

A default COR is assigned to the directory numbers that do not match any COR list number or number range. During Cisco SIP SRST registration, a dial peer is created and that dial peer includes a default COR value. The cor command allows you to change the automatically selected default.

In dial-peer configuration mode, build your COR list and add members. Then in voice register pool configuration mode, use the cor command to apply the name of the dial-peer COR list.

You can have up to four COR lists for the Cisco SIP SRST configuration, comprised of incoming or outgoing dial peers. The first four COR lists are applied to a range of phone numbers. The phone numbers that do not have a COR list configuration are assigned to the default COR list, providing that a default COR list has been defined.


Note Configure the id (voice register pool) command before any other voice register pool commands, including the cor command. The id command identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.


Examples

The following is sample output from the show running-config command:

.
.
.
voice register pool 1
id mac 0030.94C2.A22A
preference 5
cor incoming call91 1 91011
translate-outgoing called 1
proxy 10.2.161.187 preference 1 monitor probe icmp-ping
alias 1 94... to 91011 preference 8
voice-class codec 1
.
.
.
dial-peer cor custom
name 95
name 94
name 91
!
dial-peer cor list call91
member 91
!
dial-peer voice 91500 pots
corlist incoming call91
corlist outgoing call91
destination-pattern 91500
port 1/0/0
.
.
.

Related Commands

Command
Description

dial-peer cor custom

Specifies that named CORs apply to dial peers.

dial-peer cor list

Defines a COR list name.

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones.

member (dial-peer cor list)

Adds a member to a dial-peer COR list.

name (dial-peer custom cor)

Provides a name for a custom COR.

show dial-peer voice

Displays information for voice dial peers.

voice register pool

Enables Cisco SIP SRST voice register pool configuration commands.


debug voice register errors

To display debug information on voice register module errors during registration in a Cisco CME or Cisco SIP SRST environment, use the debug voice register errors command in privileged EXEC mode. To disable debugging, use the no form of the command.

debug voice register errors

no debug voice register errors

Syntax Description

This command has no arguments or keywords

Defaults

Disabled

Command Modes

Privileged EXEC mode

Command History

Cisco IOS Release
Version
Modification

12.2(15)ZJ

Cisco SIP SRST 3.0

This command was introduced.

12.3(4)T

Cisco SIP SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

Registration errors include failure to match pools or any internal errors that happen during registration.

Examples

Cisco SIP SRST

The following is sample output from this command:

Router# debug voice register errors

*Apr 22 11:52:54.523 PDT: VOICE_REG_POOL: Contact doesn't match any pools
*Apr 22 11:52:54.539 PDT: VOICE_REG_POOL: Register request for (33015) from (10.2.152.39)
*Apr 22 11:52:54.539 PDT: VOICE_REG_POOL: Contact doesn't match any pools.
*Apr 22 11:52:54.559 PDT: VOICE_REG_POOL: Register request for (33017) from (10.2.152.39)
*Apr 22 11:53:04.559 PDT: VOICE_REG_POOL: Maximum registration threshold for pool(3) hit

If there are no voice register pools configured for a particular registration request, the message "Contact doesn't match any pools" is displayed.

If the max registrations command is configured, when registration requests reach the maximum limit, the "Maximum registration threshold for pool(x) hit" message is displayed for the particular pool.

Table 1 describes the significant fields shown in the display.

Table 1 debug voice register errors Field Descriptions 

Field
Description

Contact (doesn't match any pools)

Contact refers to the location of the SIP devices and the IP address.

Register request for (telephone number) from (IP address).

The unique key for each registration is the telephone number.


Related Commands

Command
Description

debug voice register events

Displays debug information on voice register module events during SIP phone registrations in a Cisco CME or Cisco SIP SRST environment.


debug voice register events

To display debug information on voice register module events during SIP phone registrations in a Cisco CME or Cisco SIP SRST environment, use the debug voice register events command in privileged EXEC mode. To disable debugging, use the no form of this command.

debug voice register errors

no debug voice register errors

Syntax Description

This command has no arguments or keywords

Defaults

Disabled

Command Modes

Privileged EXEC mode

Command History

Cisco IOS Release
Version
Modification

12.2(15)ZJ

Cisco SIP SRST 3.0

This command was introduced.

12.3(4)T

Cisco SIP SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

Using the debug voice register events command should suffice to view registration activity.

Registration activity includes matching of pools, registration creation, and automatic creation of dial

peers. For more details and error conditions, you can use the debug voice register errors command.

Cisco SIP SRST

The following is sample output from this command:

Router# debug voice register events

Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: Contact matches pool 1
Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: key(91011) contact(192.168.0.2) add to contact table
Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: key(91011) exists in contact table
Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: contact(192.168.0.2) exists in contact table, ref updated
Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: Created dial-peer entry of type 1
Apr 22 10:50:21.731 PDT: VOICE_REG_POOL: Registration successful for 91011, registration id is 257

The phone number 91011 registered successfully, and type 1 is reported in the debug, which means that there is a preexisting VoIP dial peer.

Apr 22 10:50:38.119 PDT: VOICE_REG_POOL: Register request for (91021) from (192.168.0.3)
Apr 22 10:50:38.119 PDT: VOICE_REG_POOL: Contact matches pool 2
Apr 22 10:50:38.123 PDT: VOICE_REG_POOL: key(91021) contact(192.168.0.3) add to contact table
Apr 22 10:50:38.123 PDT: VOICE_REG_POOL: key(91021) exists in contact table
Apr 22 10:50:38.123 PDT: VOICE_REG_POOL: contact(192.168.0.3) exists in contact table, ref updated
Apr 22 10:50:38.123 PDT: VOICE_REG_POOL: Created dial-peer entry of type 1
Apr 22 10:50:38.123 PDT: VOICE_REG_POOL: Registration successful for 91021, registration id is 258

A dynamic VoIP dial peer has been created for entry 91021. The dial peer can be verified using the show voice register dial-peers and show sip-ua status registrar commands.

Apr 22 10:51:08.971 PDT: VOICE_REG_POOL: Register request for (95021) from (10.2.161.50)
Apr 22 10:51:08.971 PDT: VOICE_REG_POOL: Contact matches pool 3
Apr 22 10:51:08.971 PDT: VOICE_REG_POOL: key(95021) contact(10.2.161.50) add to contact table
Apr 22 10:51:08.971 PDT: VOICE_REG_POOL: No entry for (95021) found in contact table
Apr 22 10:51:08.975 PDT: VOICE_REG_POOL: key(95021) contact(10.2.161.50) added to contact table
Apr 22 10:51:08.979 PDT: VOICE_REG_POOL: Created dial-peer entry of type 0
Apr 22 10:51:08.979 PDT: VOICE_REG_POOL: Registration successful for 95021, registration id is 259
Apr 22 10:51:09.019 PDT: VOICE_REG_POOL: Register request for (95012) from (10.2.161.50)
Apr 22 10:51:09.019 PDT: VOICE_REG_POOL: Contact matches pool 3
Apr 22 10:51:09.019 PDT: VOICE_REG_POOL: key(95012) contact(10.2.161.50) add to contact table
Apr 22 10:51:09.019 PDT: VOICE_REG_POOL: No entry for (95012) found in contact table
Apr 22 10:51:09.023 PDT: VOICE_REG_POOL: key(95012) contact(10.2.161.50) added to contact table
Apr 22 10:51:09.027 PDT: VOICE_REG_POOL: Created dial-peer entry of type 0
Apr 22 10:51:09.027 PDT: VOICE_REG_POOL: Registration successful for 95012, registration id is 260
Apr 22 10:51:09.071 PDT: VOICE_REG_POOL: Register request for (95011) from (10.2.161.50)
Apr 22 10:51:09.071 PDT: VOICE_REG_POOL: Contact matches pool 3
Apr 22 10:51:09.071 PDT: VOICE_REG_POOL: key(95011) contact(10.2.161.50) add to contact table
Apr 22 10:51:09.071 PDT: VOICE_REG_POOL: No entry for (95011) found in contact table
Apr 22 10:51:09.075 PDT: VOICE_REG_POOL: key(95011) contact(10.2.161.50) added to contact table
Apr 22 10:51:09.079 PDT: VOICE_REG_POOL: Created dial-peer entry of type 0
Apr 22 10:51:09.079 PDT: VOICE_REG_POOL: Registration successful for 95011, registration id is 261
Apr 22 10:51:09.123 PDT: VOICE_REG_POOL: Register request for (95500) from (10.2.161.50)
Apr 22 10:51:09.123 PDT: VOICE_REG_POOL: Contact matches pool 3
Apr 22 10:51:09.123 PDT: VOICE_REG_POOL: key(95500) contact(10.2.161.50) add to contact table
Apr 22 10:51:09.123 PDT: VOICE_REG_POOL: No entry for (95500) found in contact table
Apr 22 10:51:09.127 PDT: VOICE_REG_POOL: key(95500) contact(10.2.161.50) added to contact table
Apr 22 10:51:09.131 PDT: VOICE_REG_POOL: Created dial-peer entry of type 0
Apr 22 10:51:09.131 PDT: VOICE_REG_POOL: Registration successful for 95500, registration id is 262
*Apr 22 11:52:54.523 PDT: VOICE_REG_POOL: Contact doesn't match any pools
*Apr 22 11:52:54.539 PDT: VOICE_REG_POOL: Register request for (33015) from (10.2.152.39)
*Apr 22 11:52:54.539 PDT: VOICE_REG_POOL: Contact doesn't match any pools
*Apr 22 11:52:54.559 PDT: VOICE_REG_POOL: Register request for (33017) from (10.2.152.39)

Table 2 describes the significant fields shown in the display.

Table 2 debug voice register events Field Descriptions 

Field
Description

Contact

Indicates the location of the SIP devices and may indicate the IP address.

contact table

The table that maintains the location of the SIP devices.

key

The phone number is used as the unique key to maintain registrations of SIP devices.

multiple contact

More than one registration matches the same phone number.

no entry

The incoming registration was not found.

type 0

Normal dial peer.

type 1

Existing normal dial peer.

type 2

Proxy dial peer.

type 3

Existing proxy dial peer.

type 4

Dial-plan dial peer.

type 5

Existing dial-plan dial peer.

type 6

Alias dial peer.

type 7

Existing alias dial peer.

un-registration successful

The incoming unregister was successful.

Register request/registration id number

The internal unique number for each registration; useful for debugging particular registrations.


Related Commands

Command
Description

debug voice register errors

Displays debug information on voice register module errors during registration in a Cisco CME or Cisco SIP SRST environment.

show sip-ua status registrar

Displays all the SIP endpoints that are currently registered with the contact address.

show voice register dial-peers

Displays details of SIP SRST configuration and of all dynamically created VoIP dial peers.


dialplan-pattern (voice register pool)


Note Effective with Cisco IOS Release 12.4(4)T, the dialplan-pattern command is not visible in Cisco IOS software. For similar functionality, use the translation-rule command.


To create a global prefix that can be used to expand the abbreviated extension numbers (automatically obtained from the Cisco IP phone) into fully qualified E.164 telephone numbers, use the dialplan-pattern command in voice register pool configuration mode. To disable a global prefix, use the no form of this command.

dialplan-pattern tag pattern extension-length length [extension-pattern extension-pattern]

no dialplan-pattern tag

Syntax Description

tag

Dial-plan string tag used before a 10-digit telephone number. The range is from 1 to 5.

pattern

Dial-plan pattern, such as the area code, the prefix, and the first one or two digits of the extension number, plus dots (.) for the remainder of the extension number digits.

extension-length length

Sets the number of extension digits. The range is from 1 to 32.

extension-pattern extension-pattern

(Optional) Sets an extension number's leading digit pattern when it is different from the E.164 telephone number's leading digits defined in the pattern argument. The argument extension-pattern consists of one or more digits and wildcard markers or dots (.). For example, 5.. would include extensions 500 to 599, and 5... would include extensions 5000 to 5999.


Defaults

Global prefixes are disabled.

Command Modes

Voice register pool configuration

Command History

Release
Modification

12.2(15)ZJ

This command was introduced.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

This command was removed.


Usage Guidelines

The dialplan-pattern command creates a global prefix that can be used to expand the abbreviated extension numbers into fully qualified E.164 telephone numbers. The extension number should be greater than or equal to the extension length. Otherwise, the extension number cannot be converted into a qualified E.164 number.

The extension-length keyword enables the system to convert a full E.164 telephone number back into an extension number. For example, a company uses extension number range 0100 to 0199 across several sites, with only the extensions 0100 to 0199 present on the local router. An incoming call to 0199 arrives as 4085550199 in its full E.164 format. The dialplan-pattern command translates to the extension number and routes the call to Cisco SIP IP phone extension 0199. The dialplan-pattern command creates an additional VoIP dial peer with a destination pattern of 4085550199 when extension 0199 registers to SIP SRST. Then the IP address of extension 0199 is used as the session target. In order for full E.164 telephone calls to be accepted by Cisco SIP IP phone 0199, a translation rule must be applied in a voice register pool to convert the full E.164 telephone called number into the extension number.

The number of extension-pattern characters must match the extension length (for example, if the extension length is three, the extension pattern can be 8.., 1.., 5...0).


Note The id (voice register pool) command must be configured before any other voice register pool commands, including the dialplan-pattern command. The id command identifies a locally available individual Cisco SIP IP phone or sets of Cisco SIP IP phones.

Before configuring the dialplan-pattern command, translation rules must be set using the translate-outgoing command. Translation rules are a general-purpose number-manipulation mechanism that perform operations such as automatically adding telephone area and prefix codes to dialed numbers.


Examples

The following example shows how to create dial-plan pattern 1 for extension numbers 0100 to 0199 with the telephone prefix starting with 408555. If the following commands are configured, the routers recognize that the number 4085550100 matches dial-plan pattern 1 and use the extension-length keyword to extract the last four digits of the number 4085550100 and present this as the caller ID for the incoming call.

Router(config)# voice register pool
Router(config-register-pool)# dialplan-pattern 1 40855501.. extension-length 4

Related Commands

Command
Description

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

translate-outgoing

Applies a translation rule to manipulate dialed digits on an outbound POTS or VoIP call leg.

translation-rule

Creates a translation name and enters translation-rule configuration mode to apply rules to the translation name.

voice register pool

Enables SIP SRST voice register pool configuration commands.



dtmf-relay (voice register pool)

To specify the list of DTMF relay methods that can be used to relay dual-tone multifrequency (DTMF) audio tones between Session Initiation Protocol (SIP) endpoints, use the dtmf-relay command in voice register pool configuration mode. To send the DTMF audio tones as part of an audio stream, use the no form of this command.

dtmf-relay [cisco-rtp] [rtp-nte] [sip-notify]

no dtmf-relay

Syntax Description

cisco-rtp

(Optional) Forwards DTMF audio tones by using Real-Time Transport Protocol (RTP) with a Cisco proprietary payload type. This keyword is supported only for dial peers that are created by incoming REGISTERs from a SIP gateway. It is not supported for dial peers that are created by a SIP Cisco IP phone.

rtp-nte

(Optional) Forwards DTMF audio tones by using Real-Time Transport Protocol (RTP) with a Named Telephone Event (NTE) payload.

sip-notify

(Optional) Forwards DTMF audio tones by using SIP-NOTIFY messages. This keyword is supported only for dial peers that are created by incoming REGISTERs from a SIP gateway. It is not supported for dial peers that are created by a SIP Cisco IP phone.


Defaults

DTMF tones are disabled and sent in-band. That is, they remain in the audio stream.

Command Modes

Voice register pool configuration

Command History

Cisco IOS Release
Version
Modification

12.3(4)T

Cisco SIP SRST 3.0

This command was introduced.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

During Cisco SIP SRST or Cisco CME registration, a dial peer is created and that dial peer has a default DTMF relay of in-band. The dtmf-relay command allows you to change the default to a desired value.

DTMF audio tones are generated when you press a button on a touchtone phone. The tones are compressed at one end of the call and when the digits are decompressed at the other end, there is a risk that they can become distorted. DTMF relay reliably transports the DTMF audio tones generated after call establishment out-of-band.

The SIP Notify method sends Notify messages bidirectionally between the originating and terminating gateways for a DTMF event during a call. If multiple DTMF relay mechanisms are enabled on a SIP dial peer and are negotiated successfully, the SIP Notify method takes precedence.

SIP Notify messages are advertised in an Invite message to the remote end only if the dtmf-relay command is set.

For SIP calls, the most appropriate methods to transport DTMF tones are RTP-NTE or SIP-NOTIFY.


NoteThe cisco-rtp keyword is a proprietary Cisco implementation. If the proprietary Cisco implementation is not supported, the DTMF relay feature does not function, and the gateway sends DTMF tones in-band.

The sip-notify keyword is available only if the VoIP dial peer is configured for SIP.


Examples

Cisco CME

The following example enables the RTP-NTE and SIP-NOTIFY mechanisms for DTMF relay for SIP phone 4:

Router(config)# voice register pool 4
Router(config-register-pool)# dtmf-relay rtp-nte sip-notify

Cisco SIP SRST

The following is sample output from the show running-config command that shows that voice register pool 1 has been set up to send DTMF tones:

voice register pool 1
 application SIP.app
 incoming called-number 308
 voice-class codec 1
 dtmf-relay rtp-nte

Related Commands

Command
Description

dtmf-relay (voice over IP)

Specifies how an H.323 or SIP gateway relays DTMF tones between telephony interfaces and an IP network.

voice register pool

Enters voice register pool configuration mode for SIP phones.


external-ring (voice register global)

To specify the type of ring sound used on Cisco SIP or Cisco SCCP IP phones for external calls, use the external-ring command in voice register global configuration mode. To return to the default ring sound, use the no form of this command.

external-ring {bellcore-dr1 | bellcore-dr2 | bellcore-dr3 | bellcore-dr4 | bellcore-dr5}

no external-ring

Syntax Description

bellcore-dr1 bellcore-dr2 bellcore-dr3 bellcore-dr4 bellcore-dr5

Each bellcore-dr keyword supports standard distinctive ringing patterns as defined in the standard GR-506-CORE, LSSGR: Signaling for Analog Interfaces.


Defaults

The default ring sound is an internal ring pattern.

Command Modes

Voice register global configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

When set, this command defines varying ring tones so that you can discriminate between internal and external calls from Cisco SIP or Cisco SCCP IP phones.

Examples

The following example specifies that Bellcore DR1 be used for external ringing on Cisco SIP IP phones:

Router(config)# voice register global
Router(config-register-global)# external-ring bellcore-dr1

Related Commands

Command
Description

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.


id (voice register pool)

To explicitly identify a locally available individual Cisco SIP IP phone, or when running Cisco SIP SRST, set of Cisco SIP IP phones, use the id command in voice register pool configuration mode. To remove local identification, use the no form of this command.

id {network address mask mask | ip address mask mask | mac address}

no id {network address mask mask | ip address mask mask | mac address}

Syntax Description

network address
mask mask

The network address mask mask keyword/argument combination is used to accept SIP Register messages for the indicated phone numbers from any IP phone within the specified IP subnet.

ip address mask mask

The ip address mask mask keyword/argument combination is used to identify an individual phone.

mac address

The mac address keyword/argument combination is used to identify the MAC address of a particular Cisco IP phone.


Command Default

None

Command Modes

Voice register pool configuration

Command History

Release
Version
Modification

12.2(15)ZJ

Cisco SIP SRST 3.0

This command was introduced.

12.3(4)T

Cisco SIP SRST 3.0

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was added to Cisco CME.


Usage Guidelines

Configure the id (voice register pool) command before any other voice register pool commands.

The id command allows explicit identification of an individual Cisco SIP IP phone to support a degree of authentication, which is required to accept registrations, based upon the following:

Verification of the local Layer 2 MAC address using the router's Address Resolution Protocol (ARP) cache.

Verification of the known single static IP address (or DHCP dynamic IP address within a specific subnet) of the Cisco SIP IP phone.

When the mac address keyword and argument are used, the IP phone must be in the same subnet as that of the router's LAN interface, such that the phone's MAC address is visible in the router's Address Resolution Protocol (ARP) cache. Once a MAC address is configured for a specific voice register pool, remove the existing MAC address before changing to a new MAC address.


Note For Cisco SIP SRST, this command also allows explicit identification of locally available set of Cisco SIP IP phones.


Examples

The following is partial sample output from the show running-config command. The id command identifies the MAC address of a particular Cisco IP phone. The output shows that voice register pool 1 has been set up to accept SIP Register messages from a specific IP phone through the use of the id command.


voice register pool 1
 id mac 0030.94C2.A22A
 preference 5
 cor incoming call91 1 91011
 translate-outgoing called 1
 proxy 10.2.161.187 preference 1 monitor probe icmp-ping
 alias 1 94... to 91011 preference 8
 voice-class codec 1

Related Commands

Command
Description

mode (voice register global)

Enables the mode for provisioning SIP phones in a Cisco CallManager Express (Cisco CME) system.

voice register pool

Enters voice register pool configuration mode for SIP phones.


incoming called-number (voice register pool)

To apply incoming called-number parameters to dynamically created dial peers, use the incoming called-number command in voice register pool configuration mode. To remove incoming called-number parameters from a dial peer, use the no form of this command.

incoming called-number [number]

no incoming called-number

Syntax Description

number

(Optional) Sequence of digits that represent a phone number prefix.


Defaults

None

Command Modes

Voice register pool configuration

Command History

Release
Modification

12.2(15)ZJ

This command was introduced.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T.


Usage Guidelines

The id (voice register pool) command must be configured before any other voice register pool commands, including the incoming called-number command. The id command identifies a locally available individual Cisco SIP IP phone or a set of Cisco SIP IP phones.

Examples

The following is partial sample output from the show running-config command that applies the prefix 308 to dynamically created dial peers:

voice register pool 1
 application SIP.app
 incoming called-number 308
 voice-class codec 1

Related Commands

Command
Description

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

incoming called-number (dial-peer)

Specifies an incoming called number of an MMoIP or POTS dial peer.

show dial-peer voice

Displays information for voice dial peers.

voice register pool

Enables SIP SRST voice register pool configuration commands.


max-pool (voice register global)

To set the maximum number of SIP voice register pools that are supported in a Cisco SIP SRST or Cisco CME environment, use the max-pool command in voice register global configuration mode. To reset the maximum number to the default, use the no form of this command.

max-pool max-voice-register-pools

no max-pool

Syntax Description

max-voice-register-      pools

Maximum number of SIP voice register pools supported by the Cisco router. The upper limit of voice register pools is version- and platform-dependent; see Cisco IOS command-line interface (CLI) help. Default is 0.


Defaults

Default is 0 pools.

Command Modes

Voice register global configuration

Command History

Cisco IOS Release
Version
Modification

12.4(4)T

Cisco CME 3.4 and Cisco SIP SRST 3.4

This command was introduced.


Usage Guidelines

This command limits the number of SIP phones supported by a Cisco CME or Cisco SIP SRST environment. The max-pool command is platform specific and defines the limit for the voice register pool command. The max-dn command similarly limits the number of directory numbers (extensions) in a Cisco CME system.


Note You can increase the number of phones; but after the maximum allowable number is configured, you cannot reduce the limit of the SIP phones without rebooting the router.


Examples

The following example sets the maximum number of Cisco SIP IP phones in a Cisco SIP SRST environment to 24:

Router(config)# voice register global
Router(config-register-global)# max-pool 24

Related Commands

Command
Description

max-dn (voice register global)

Set the maximum number of SIP phone directory numbers (extensions) that are supported by a Cisco CallManager Express (Cisco CME) router.

voice register global

Enters voice register global configuration mode in order to set global parameters for all supported Cisco SIP phones in a Cisco CME or Cisco SIP SRST environment.

voice register pool

Enters voice register pool configuration mode for Cisco SIP IP phones.


max registrations (voice register pool)


Note Effective with Cisco IOS Release 12.4(4)T, the max registrations command is not visible in Cisco IOS software. For similar functionality, use the max-pool (voice register global) command.


To set the maximum number of registrations accepted by the voice register pool, use the max registrations command in voice register pool configuration mode. To disable registration setup, use the no form of this command.

max registrations value

no max registrations

Syntax Description

value

Digit, beginning with 0, that represents the maximum number of registrations. The maximum registration value is platform dependent.


Defaults

The maximum number of IP phones that can be configured per platform

Command Modes

Voice register pool configuration

Command History

Release
Modification

12.2(15)ZJ

This command was introduced.

12.3(4)T

This command was integrated into Cisco IOS Release 12.3(4)T.

12.4(4)T

This command was removed.


Usage Guidelines

The id (voice register pool) command must be configured before any other voice register pool commands, including the max registrations command. The id command identifies a locally available individual Cisco SIP IP phone or sets of Cisco SIP IP phones.

If two phones attempt to register the same phone number, only the first phone can register the number. You can control which phone is accepted by using multiple voice register pools. In general, the best usage is one pool per phone; with multiple pools, some flexibility is granted.

Examples

The following partial sample output from the show running-config command shows that 5 is the maximum number of SIP telephone registrations accepted.

voice register pool 3
id network 10.2.161.0 mask 255.255.255.0
number 1 95... preference 1
 cor outgoing call95 1 95011
 max registrations 5
voice-class codec 1

Related Commands

Command
Description

id (voice register pool)

Explicitly identifies a locally available individual Cisco SIP IP phone or set of Cisco SIP IP phones.

voice register pool

Enables SIP SRST voice register pool configuration commands.



hometocprevnextglossaryfeedbacksearchhelp

Posted: Tue Dec 13 12:26:35 PST 2005
All contents are Copyright © 1992--2005 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.