-
Cisco IOS Voice Command Reference
-
About Cisco IOS Software Documentation
-
Using Cisco IOS Software
-
New and Modified Commands
-
Commands: A
-
Commands: B
-
Commands: cache --> call fallback jitter-probe num-packets
-
Commands: call fallback jitter-probe precedence --> ces connect
-
Commands: ces initial-delay --> codec preference
-
Commands: comfort-noise --> customer-id
-
Commands: default (MGCP profile) through direct-inward-dial
-
Commands: E
-
Commands: F
-
Commands: G
-
Commands: H
-
Commands: I
-
Commands: K
-
Commands: L
-
Commands: M
-
Commands: N
-
Commands: O
-
Commands: P through Q
-
Commands: R
-
Commands: SCCP through sgcp tse payload
-
Commands: show aal2 profile through show controllers timeslots
-
Commands: show controllers voice through show mgcp
-
Commands: show mgcp connection through show ss7 sm session
-
Commands: show ss7 sm set through shutdown (voice-port)
-
Commands: signal through suppress
-
Commands: T
-
Commands: U
-
Commands: V through W
-
Commands: Z
-
Feedback
Table Of Contents
Cisco IOS Voice Commands:
B
This chapter contains commands to configure and maintain Cisco IOS voice applications. 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 these applications and features, refer to the Cisco IOS Voice Configuration Guide.
backhaul-session-manager
To enter backhaul session manager configuration mode, use the backhaul-session-manager command in global configuration mode.
backhaul-session-manager
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
Use the backhaul-session-manager command to switch to backhaul session manager configuration mode from global configuration mode. Use the exit command to exit backhaul session manager configuration mode and return to global configuration mode. Table 3 lists the backhaul session manager configuration mode commands.
Examples
The following example enters backhaul session manager configuration mode:
Router(config)# backhaul-session-managerRouter(config-bsm)#Related Commands
bandwidth
To specify the maximum aggregate bandwidth for H.323 traffic and verify the available bandwidth of the destination gatekeeper, use the bandwidth command in gatekeeper configuration mode. To disable maximum aggregate bandwidth, use the no form of this command.
bandwidth {interzone | total | session} {default | zone zone-name} bandwidth-size
no bandwidth {interzone | total | session} {default | zone zone-name}
Syntax Description
Defaults
Maximum aggregate bandwidth is unlimited by default
Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
This command, in conjunction with the bandwidth remote command, replaces the zone gatekeeper command.
To specify maximum bandwidth for traffic between one zone and any other zone, use the default keyword with the interzone keyword.
To specify maximum bandwidth for traffic within one zone or for traffic between that zone and another zone (interzone or intrazone), use the default keyword with the total keyword.
To specify maximum bandwidth for a single session within a specific zone, use the zone keyword with the session keyword.
To specify maximum bandwidth for a single session within any zone, use the default keyword with the session keyword.
Examples
The following example configures the default maximum bandwidth for traffic between one zone and another zone to 5000 kbps:
gatekeeperbandwidth interzone default 5000The following example configures the default maximum bandwidth for all zones to 5000 kbps:
gatekeeperbandwidth total default 5000The following example configures the default maximum bandwidth for a single session within any zone to 2000 kbps:
gatekeeperbandwidth session default 2000The following example configures the default maximum bandwidth for a single session with a specific zone to 1000 kbps:
gatekeeperbandwidth session zone denver 1000The following example enables the checking of the available bandwidth of the destination zone:
gatekeeperbandwidth check-destinationRelated Commands
bandwidth check-destination
To enable the gatekeeper to verify available bandwidth resources at the destination endpoint, use the bandwidth check-destination command in gatekeeper configuration mode. To disable resource verification, use the no form of this command.
bandwidth check-destination
no bandwidth check-destination
Syntax Description
This command has no arguments or keywords.
Defaults
Resource verification is disabled by default
Command Modes
Gatekeeper configuration
Command History
Examples
The following example activates bandwidth resource verification at the destination:
gatekeeperbandwidth check-destinationRelated Commands
bandwidth remote
To specify the total bandwidth for H.323 traffic between this gatekeeper and any other gatekeeper, use the bandwidth remote command in gatekeeper configuration mode. To disable total bandwidth specified, use the no form of this command.
bandwidth remote bandwidth-size
no bandwidth remote
Syntax Description
Defaults
Total bandwidth is unlimited by default
Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
This command, in conjunction with the bandwidth command, replaces the zone gatekeeper command.
Examples
The following example configures the remote maximum bandwidth to 100,000 kbps:
gatekeeperbandwidth remote 100000Related Commands
battery-reversal
To specify battery polarity reversal on a Foreign Exchange Office (FXO) or Foreign Exchange Station (FXS) port, use the battery-reversal command in voice-port configuration mode. To disable battery reversal, use the no form of this command.
battery-reversal [answer]
no battery-reversal [answer]
Syntax Description
answer
(Optional) Configures an FXO port to support answer supervision by detection of battery reversal.
Defaults
Battery reversal is enabled
Command Modes
Voice-port configuration
Command History
Usage Guidelines
The battery-reversal command applies to FXO and FXS voice ports. On Cisco 2600 and 3600 series routers, only analog voice ports in VIC-2FXO-M1 and VIC-2FXO-M2 voice interface cards are able to detect battery reversal; analog voice ports in VIC-2FXO and VIC-2FXO-EU voice interface cards do not detect battery reversal. On digital voice ports, battery reversal is supported only on E1 Mercury Exchange Limited Channel Associated Signaling (MEL CAS); it is not supported in T1 channel associated signaling (CAS) or E1 CAS.
FXS ports normally reverse battery upon call connection. If an FXS port is connected to an FXO port that does not support battery reversal detection, you can use the no battery-reversal command on the FXS port to prevent unexpected behavior.
FXO ports in loopstart mode normally disconnect calls when they detect a second battery reversal (back to normal). You can use the no battery-reversal command on FXO ports to disable this action.
The battery-reversal command restores voice ports to their default battery-reversal operation.
If an FXO voice port is connected to the PSTN and supports battery reversal, use the battery-reversal command with the answer keyword to configure answer supervision. This configures the FXO voice port to detect when a call is answered in order to provide correct billing information.
If the voice port, PSTN, or PBX does not support battery reversal, do not use the battery-reversal command because it prevents outgoing calls from being connected. Use the supervisory answer dualtone command instead.
If an FXO port or its peer FXS port does not support battery reversal, avoid configuring battery-reversal or battery-reversal answer on the FXO port. On FXO ports that do not support battery reversal, the battery-reversal command can cause unpredictable behavior, and the battery-reversal answer command prevents calls from being answered. To ensure that battery reversal answer is disabled on FXO ports that do not support battery reversal, use the no battery-reversal command.
The following example disables battery reversal on voice port 1/1 on a Cisco MC3810 multiservice access concentrator:
voice-port 1/1no battery-reversalThe following example disables battery reversal on voice port 1/0/0 on a Cisco 2600 or 3600 series router:
voice-port 1/0/0no battery-reversalThe following example enables battery reversal to provide answer supervision on voice port 1/0/0 on a Cisco 2600 or 3600 series router:
voice-port 1/0/0battery-reversal answerRelated Commands
bind
To bind the source address for signaling and media packets to the IP address of a specific interface, use the bind command in SIP configuration mode. To disable binding, use the no form of this command.
bind {control | all} source-interface interface-id
no bind
Syntax Description
Note
Async, Ethernet, Fast Ethernet, Loopback, and Serial (including Frame Relay) are tested interfaces within the SIP application.
Defaults
Binding is disabled (no bind)
Command Modes
SIP configuration
Command History
Usage Guidelines
If the bind command is not enabled, the IP layer still provides the best local address.
Enter SIP configuration mode from voice-service configuration mode, as shown in the example:
Examples
The following example sets up binding on a SIP network:
Router(config)# voice serv voipRouter(conf-voi-serv)# sipRouter(conf-serv-sip)# bind control source-interface FastEthernet 0Related Commands
block-caller
To configure call blocking on caller ID, use the block-caller command in dial peer voice configuration mode. To disable call blocking on caller ID, use the no form of this command.
block-caller number
no block-caller number
Syntax Description
Defaults
Call blocking is disabled; the router does not block any calls for any listed directory numbers (LDNs) based on caller ID numbers
Command Modes
Dial peer voice configuration
Command History
Modification
12.1(2)XF
This command was introduced on the Cisco 800 series routers.
12.1(5)T
This command was integrated into Cisco IOS Release 12.1(5)T.
This command is available on Cisco 800 series routers that have plain old telephone service (POTS) ports. For each dial peer, you can enter up to ten caller ID numbers to block. The routers do not accept additional caller ID numbers if ten numbers are already present. In that case, a number must be removed before another caller ID number can be added for blocking.
If you do not specify the block-caller command for a local directory, all voice calls to that local directory are accepted. If you specify the block-caller command for a local directory, the router verifies that the incoming calling-party number does not match any caller ID numbers in that local directory before processing or accepting the voice call. Each specified caller ID number and incoming calling-party number is compared from right to left, up to the number of digits in the specified caller ID number or incoming calling-party number, whichever has fewer digits.
This command is effective only if you subscribe to caller ID service. If you enable call blocking on caller ID without subscribing to the caller ID service, the routers do not perform the verification process on calling-party numbers and do not block any calls.
Examples
The following example configures a router to block calls from a caller whose caller ID number is 408-555-1234.
dial-peer voice 1 potsblock-caller 4085551234Related Commands
busyout action graceful
To place a voice port into the graceful busyout state when triggered by the busyout monitor, use the busyout action graceful command in voice-port configuration mode. To remove the voice port from the graceful busyout state, use the no form of this command.
busyout action graceful
no busyout action graceful
Syntax Description
This command has no arguments or keywords.
Defaults
Forced busyout
Command Modes
Voice-port configuration
Command History
12.2(13)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 2600XM, Cisco 2691, Cisco 3640, Cisco 3660, Cisco 3725, and the Cisco VG200.
Usage Guidelines
Use this command to control the busyout behavior that is triggered by the busyout monitor command. The busyout action graceful command busies out the voice port immediately if the busyout behavior is triggered, but if there is an active call on this voice port, it will wait until the call is over.
Examples
The following example shows the analog voice-port busyout state set to graceful:
voice-port 1/1/1busyout action graceful
Related Commands
busyout action shutdown
To specify that the D channel is to be brought down when the busyout condition is triggered on a PRI voice port, use the busyout action shutdown command in voice-port configuration mode. To cancel this action, use the no form of this command.
busyout action shutdown
no busyout action shutdown
Syntax Description
This command has no arguments or keywords.
Defaults
Default voice busyout behavior for PRI is to transmit B-channel out-of-service (OOS) messages for ISDN switch types that support such service messages, and to keep the D channel active. For ISDN switch types that do not support service messages, the default voice busyout behavior is to bring down the D channel.
ISDN switch types that support service messages are NI, 4ESS (user side only), 5ESS (user side only), and DMS100.
Command Modes
Voice-port configuration
Command History
Usage Guidelines
Prior to Cisco IOS Release 12.2(8)T, when the voice busyout condition is triggered on a PRI voice port, the D channel is deactivated until the busyout trigger is cleared. Some ISDN switch types however, support in-service and OOS Q.931 messages that permit the B channels to be taken out of service while still keeping the D channel active. Starting in Release 12.3(8)T for these ISDNswitch types, OOS messages are sent and the D channel is kept active when the voice busyout condition is triggered.
To specify that the D channel is to be brought down whenever the busyout condition is triggered, regardless of the ISDN switch type, the busyout action shutdown command was introduced in Cisco IOS Release 12.3(6).
This command is available only under PRI voice ports.
Examples
The following example shows an E1 PRI voice-port busyout state set to shutdown:
voice-port 1/1:15 (E1 PRI)busyout monitor gatekeeperbusyout action shutdownThe following example shows a T1 PRI voice-port busyout state set to shutdown:
voice-port 0/1:23 (T1 PRI)busyout monitor gatekeeperbusyout action shutdownRelated Commandsbusyout action graceful
busyout forced
To force a voice port into the busyout state, use the busyout forced command in voice-port configuration mode. To remove the voice port from the busyout state, use the no form of this command.
busyout forced
no busyout forced
Syntax Description
This command has no arguments or keywords.
Defaults
The voice-port is not in the busyout state
Command Modes
Voice-port configuration
Command History
Usage Guidelines
If a voice port is in the forced busyout state, only the no busyout forced command can restore the voice port to service.
To avoid conflicting command-line interface (CLI) commands, do not use the busyout forced command and the ds0 busyout command on the same controller.
Examples
The following example forces analog voice port 1/1 on a Cisco MC3810 multiservice concentrator into the busyout state:
voice-port 1/1busyout forcedThe following example forces digital voice port 0:8 on a Cisco MC3810 multiservice concentrator into the busyout state:
voice-port 0:8busyout forcedThe following example forces analog voice port 3/1/1 on a Cisco 3600 router into the busyout state:
voice-port 3/1/1busyout forcedThe following example forces digital voice port 0/0:12 on a Cisco 3600 router into the busyout state:
voice-port 0/0:12busyout forcedRelated Commands
busyout monitor
To place a voice port into the busyout monitor state, enter the busyout monitor command in voice-port configuration mode. To remove the busyout monitor state from the voice port, use the no form of this command.
busyout monitor {serial interface-number | ethernet interface-number} [in-service]
no busyout monitor {serial interface-number | ethernet interface-number}
Syntax Description
Defaults
The voice port does not monitor any interfaces
Command Modes
Voice-port configuration
Command History
Usage Guidelines
When you place a voice port in the busyout monitor state, the voice port monitors the specified interface and enters the busyout state when the interface is down. This down state forces the rerouting of calls.
The command monitors only the up or down status of an interface—not end-to-end TCP/IP connectivity.
When an interface is operational, a busied-out voice port returns to its normal state.
This feature can monitor LAN, WAN, and virtual interfaces as well as subinterfaces.
The Cisco 2600 and Cisco 3600 series and the MC3810 support ATM interfaces. To monitor an ATM interface, enter ATM and the interface number.
A voice port can monitor multiple interfaces at the same time. To configure a voice port to monitor multiple interfaces, reenter the busyout monitor command for each additional interface to be monitored.
If you specify more than one monitored interface for a voice port, all the monitored interfaces must be down to trigger busyout on the voice port.
You can combine in-service and out-of-service monitoring on a voice port. The following rule describes the actions if monitored interfaces change state.
A voice port is busied out if either of the following occurs:
•
•
Examples
The following example shows configuration of analog voice port 1/1 on a Cisco MC3810 to busyout if serial ports 1 and 0:0 both go out of service:
voice-port 1/1busyout monitor serial 0:0busyout monitor serial 1The following example shows configuration of analog voice port 1/2 on a Cisco MC3810 to busy out if serial port 0 or 1 comes into service:
voice-port 1/2busyout monitor serial 0 in-servicebusyout monitor serial 1 in-serviceThe following example shows configuration of digital voice port 1/2/2 on a Cisco 3600 series router to busy out if serial port 0 goes out of service:
voice-port 1/2/2 busyout monitor serial 0The following example shows configuration of digital voice port 0:6 on a Cisco MC3810 to busy out if both Ethernet port 0 and serial port 0 go out of service:
voice-port 0:6busyout monitor ethernet 0busyout monitor serial 0The following example shows configuration of the voice port to monitor two serial interfaces and an Ethernet interface. When all these interfaces are down, the voice port is busied out. When at least one interface is operating, the voice port is put back into a normal state.
voice-port 3/0:0busyout monitor ethernet 0/0busyout monitor serial 1/0busyout monitor serial 2/0Related Commands
busyout monitor gatekeeper
To configure a voice port to enter the busyout state if connectivity to the gatekeeper is lost, use the busyout monitor gatekeeper command in voice-port configuration mode. To disable the busyout monitoring state for the gatekeeper, use the no form of this command.
busyout monitor gatekeeper
no busyout monitor gatekeeper
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Voice-port configuration
Command History
12.2(13)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 2600XM, Cisco 2691, Cisco 3640, Cisco 3660, Cisco 3725 and Cisco VG200.
Usage Guidelines
Use this command to monitor the connection between the gateway and gatekeeper.
Examples
The following example shows the busyout monitor state set to busyout the part according to the state of the gatekeeper:
voice-port 1/1/1busyout monitor gatekeeper
Related Commands
busyout monitor probe
To configure a voice port to enter the busyout state if a Service Assurance Agent (SAA) probe signal returned from a remote, IP-addressable interface crosses a specified delay or loss threshold, use the busyout monitor probe command in voice-port configuration mode. To configure a voice port not to monitor SAA probe signals, use the no form of this command.
busyout monitor probe ip-address [codec codec-type] [icpif number | loss percent delay milliseconds]
no busyout monitor probe ip-address
Syntax Description
Defaults
If the busyout monitor probe command is not entered, the voice port does not monitor SAA probe signals.
If the busyout monitor probe command is entered with no optional keywords or arguments, the default codec type is G.711 alaw, and the default loss and delay thresholds are the threshold values configured with the pstn fallback command.
Command Modes
Voice-port configuration
Command History
12.1(3)T
This command was introduced on the Cisco 2600 and Cisco 3600 series and on the Cisco MC3810.
Usage Guidelines
A voice port can monitor multiple interfaces at the same time. To configure a voice port to monitor multiple interfaces, enter the busyout monitor probe command for each additional interface to be monitored.
The busyout monitor probe command is effective only if the call fallback function is enabled on this router and the SAA responder is enabled on the target router.
The SAA probe is transmitted periodically with a period determined by the call fallback function.
Refer to the PSTN Fallback feature module for Cisco IOS Release 12.1(3)T for details of the call fallback function and ICPIF values.
Lower thresholds of ICPIF, loss, and delay result in earlier busyout when the link deteriorates, thereby raising the voice minimum quality level. Higher thresholds prevent busyout until loss and delay are greater, allowing transmission of lower-quality voice.
Caution
Examples
The following example configures analog voice port 1/1 on a Cisco MC3810 multiservice concentrator to use an SAA probe with a G.711alaw profile to probe the link to two remote interfaces that have IP addresses and to busy out the voice port. Both links have a loss exceeding 25 percent or a packet delay of more than 1.5 seconds.
voice-port 1/1busyout monitor probe 209.165.202.128 codec g711a loss 25 delay 1500busyout monitor probe 209.165.202.129 codec g711a loss 25 delay 1500Related Commands
busyout seize
To change the busyout action for a Foreign Exchange Office (FXO) or Foreign Exchange Station (FXS) voice port, use the busyout seize command in voice-port configuration mode. To restore the default busyout action, use the no form of this command.
busyout seize {ignore | repeat}
no busyout seize
Syntax Description
ignore
Specifies the type of ignore procedure, depending on the type of voice port signaling. See Table 4 for more information.
repeat
Specifies the type of repeat procedure, depending on the type of voice port signaling. See Table 4 for more information.
Defaults
See Table 4 for the default actions for different voice ports and signaling types
Command Modes
Voice-port configuration
Command History
Usage Guidelines
The busyout seize command is valid for both analog and digital voice ports. On digital voice ports, the busyout actions are valid whether the busyout results from a voice-port busyout event or from the ds0-busyout command.
The voice port returns to an idle state when the event that triggered the busyout disappears.
Table 4 describes the busyout actions for the busyout seize settings on each voice port type.
The busyout action for E and M voice ports is to seize the far end by setting lead busy.
Examples
The following example shows configuration of analog voice port 1/1 to perform the ignore actions when busied out:
voice-port 1/1 busyout seize ignoreThe following example shows configuration of digital voice port 0:2 to perform the repeat actions when busied out:
voice-port 0:2 busyout seize repeatRelated Commands
button (ephone)
To associate directory numbers (ephone-dns) with individual buttons on a Cisco IP phone and specify ring behavior, use the button command in ephone configuration mode. To delete DNs from buttons on a Cisco IP phone, use the no form of this command.
button button-number{: | b | s}dn-tag [[button-number{: | b | s}dn-tag] ...]
no button button-number{: | b | s}dn-tag [[button-number{: | b | s}dn-tag] ...]
Syntax Description
Defaults
No default behavior or values
Command Modes
Ephone configuration
Command History
Usage Guidelines
The button command assigns telephone lines to the Cisco IP phones by assigning a button number to a Cisco IP phone directory number.
Telephone services such as call waiting and three-party conferences require a minimum of two phone lines (directory numbers defined with the ephone-dn command) to be available and configured on a Cisco IP phone. The Cisco IP Phone 7910 has only one physical line button. To support call waiting and three-party conferences on a Cisco IP Phone 7910, a second (hidden) line is required. This line cannot be selected directly using a line button. You can access the second line when you press the Conference button.
Silent ring can be configured with the s or b keyword in Cisco IOS Telephony Service (ITS) V2.1 or a later version. Silent ring can be configured on any type of phone, but typically you would only configure silent ring on a phone with multiple lines, such as a Cisco IP Phone 7940, a Cisco IP Phone 7960, or a Cisco IP Phone Expansion Module 7914.
Examples
The following example assigns four button numbers on the phone to directory number tags, and button 4 has a silent ring:
Router(config)# ephone 1Router(config-ephone)# button 1:1 2:4 3:16 4s19Related Commands
