-
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
h323-gateway voip bind srcaddr
h323zone-id (voice source group)
http client connection idle timeout
http client connection persistent
http client connection timeout
Cisco IOS Voice Commands:
H
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.
h225 timeout setup
To configure the timeout value for the response of the outgoing SETUP message, use the h225 timeout setup command in voice class configuration mode. To remove the timeout value, use the no form of this command.
h225 timeout setup seconds
no h225 timeout setup
Syntax Description
Defaults
15 seconds
Command Modes
Voice class configuration
Command History
Examples
The following example configures a timeout setup value of 10 seconds:
Router(config-class)# h225 timeout setup 10Related Commands
h225 timeout tcp call-idle
Sets a timer for an idle call connection.
h225 timeout tcp establish
Configures the H.225 TCP timeout.
h225 timeout tcp call-idle
To set a timer for an idle call connection, use the h225 timeout tcp call-idle command in voice service h323 configuration mode. To reset to the default, use the no form of this command.
h225 timeout tcp call-idle {value value | never}
no h225 timeout tcp call-idle
Syntax Description
Defaults
10 minutes
Command Modes
Voice service h323 configuration
Command History
Usage Guidelines
This command specifies the time to maintain an established H.225 TCP connection when there are no calls on that connection. If the timer expires, the connection is closed. If the timer is running and any new call is made on that connection, the timer stops. When all the calls are cleared on that connection, the timer starts again.
Examples
The following example sets the timer for an idle call connection to 10 minutes:
Router(conf-voi-serv)# h323Router(conf-serv-h323)# h225 timeout tcp call-idle value 10Related Commands
h225 timeout tcp establish
To set the H.225 TCP timeout value for Voice over IP (VoIP) dial peers, use the h225 timeout tcp establish command in voice class configuration mode. To reset to the default, use the no form of this command.
h225 timeout tcp establish seconds
no h225 timeout tcp establish
Syntax Description
seconds
Number of seconds for the timeout. Range is 0 to 30. The default is 15. If you specify 0, the H.225 TCP timer is disabled.
Defaults
15 seconds
Command Modes
Voice class configuration
Command History
Examples
The following example sets a timeout of 10 seconds, which is associated with the H.323 voice class labeled 1:
voice class h323 1h225 timeout tcp establish 10Related Commands
h323
To enable the H.323 voice service configuration commands, use the h323 command in voice service configuration mode.
h323
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
voice service configuration
Command History
Examples
The following example enters H.323 voice service configuration mode:
Router(conf-voi-serv)# h323Related Commands
h323 asr
To enable application-specific routing (ASR) and specify the maximum bandwidth for a proxy, use the h323 asr command in interface configuration mode. To remove a bandwidth setting but keep ASR enabled, use no form of this command.
h323 asr [bandwidth max-bandwidth]
no h323 asr [bandwidth max-bandwidth]
Syntax Description
Defaults
ASR is disabled.
Command Modes
Interface configuration
Command History
11.3(2)NA
This command was introduced on the Cisco 2500 series and Cisco 3600 series.
12.0(3)T
This command was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
This command is independent of the h323 interface command.
This command is not supported on Frame Relay or ATM interfaces for the Cisco MC3810 multiservice concentrator.
Note
Specifying the no h323 asr bandwidth max-bandwidth command removes the bandwidth setting but leaves ASR enabled. You must enter the no h323 asr command to disable ASR.
Examples
The following example enables ASR and specifies a maximum bandwidth of 10,000 kbps:
h323 asr bandwidth 10000h323 call start
To force the H.323 Version 2 gateway to use Fast Connect or Slow Connect procedures for all H.323 calls, use the h323 call start command in voice-service configuration mode. To reset to the default, use the no form of this command.
h323 call start {fast | slow}
no h323 call start
Syntax Description
fast
Gateway uses H.323 Version 2 (Fast Connect) procedures.
slow
Gateway uses H.323 Version 1 (Slow Connect) procedures.
Defaults
fast
Command Modes
Voice-service configuration
Command History
Usage Guidelines
In Cisco IOS Release 12.1(3)XI and later releases, H.323 Voice over IP (VoIP) gateways by default use H.323 Version 2 (Fast Connect) for all calls including those initiating RSVP. Previously, gateways used only Slow Connect procedures for RSVP calls. To enable Cisco IOS Release 12.1(3)XI gateways to be backward compatible with earlier releases of Cisco IOS Release 12.1 T, the h323 call start command forces the originating gateway to initiate calls using Slow Connect.
This h323 call start command is configured as part of the global voice-service configuration for VoIP services. It does not take effect unless the call start system voice-class configuration command is configured in the VoIP dial peer.
Examples
The following example selects Slow Connect procedures for the gateway:
voice service voiph323 call start slowRelated Commands
h323 gatekeeper
To specify the gatekeeper associated with a proxy and to control how the gatekeeper is discovered, use the h323 gatekeeper command in interface configuration mode. To disassociate the gatekeeper, use the no form of this command.
h323 gatekeeper [id gatekeeper-id] {ipaddr ipaddr [port] | multicast}
no h323 gatekeeper [id gatekeeper-id] {ipaddr ipaddr [port] | multicast}
Syntax Description
Defaults
No gatekeeper is configured for the proxy
Command Modes
Interface configuration
Command History
11.3(2)NA
This command was introduced on Cisco 2500 series and Cisco 3600 series.
Usage Guidelines
You must enter the h323 interface and h323 h323-id commands before using this command. The h323 gatekeeper command must be specified on your Cisco IOS platform or the proxy does not go online. The proxy uses the interface address as its RAS signaling address.
Examples
The following example sets up a unicast discovery to a gatekeeper whose name is unknown:
h323 gatekeeper ipaddr 192.168.5.2The following example sets up a multicast discovery for a gatekeeper of a particular name:
h323 gatekeeper id gk.zone5.com multicastRelated Commands
h323 h323-id
Registers an H.323 proxy alias with a gatekeeper.
h323 interface
Specifies the interface from which the proxy takes its IP address.
h323 h323-id
To register an H.323 proxy alias with a gatekeeper, use the h323 h323-id command in interface configuration mode. To remove an H.323 proxy alias, use the no form of this command.
h323 h323-id h323-id
no h323 h323-id h323-id
Syntax Description
h323-id
Name of the proxy. It is recommended that this name be a fully qualified e-mail ID, with the domain name being the same as that of its gatekeeper.
Defaults
No H.323 proxy alias is registered
Command Modes
Interface configuration
Command History
11.3(2)NA
This command was introduced on Cisco 2500 and Cisco 3600 series routers.
12.0(3)T
This command was integrated into Cisco IOS Release 12.0(3)T.
Usage Guidelines
Each entry registers a specified H.323 ID proxy alias to a gatekeeper. Typically, these aliases are either simple text strings or legitimate e-mail IDs.
Note
Examples
The following example registers an H.323 proxy alias called proxy1@zone5.com with a gatekeeper:
h323 h323-id proxy1@zone5.comRelated Commands
h323 interface
To select an interface whose IP address is used by the proxy to register with the gatekeeper, use the h323 interface command in interface configuration mode. To reset to the default port, use the no h323 interface command and then the h323 interface command.
h323 interface [port-number]
no h323 interface [port-number]
Syntax Description
Defaults
Default port number is image dependent as described in the Syntax Description.
Command Modes
Interface configuration
Command History
Usage Guidelines
At proxy startup, Cisco IOS software checks for the presence of the VoIP gateway subsystem. If the subsystem is found to be present, the proxy code opens and listens for call setup requests on the new port. The proxy then registers this port with the gatekeeper.
Examples
The following example configures Ethernet interface 0 for incoming call-setup requests:
interface ethernet0h323 interfaceRelated Commands
h323 qos
To enable quality of service (QoS) on the proxy, use the h323 qos command in interface configuration mode. To disable QoS, use the no form of this command.
h323 qos {ip-precedence value | rsvp {controlled-load | guaranteed-qos}}
no h323 qos {ip-precedence value | rsvp {controlled-load | guaranteed-qos}}
Syntax Description
ip-precedence value
RTP streams set their IP precedence bits to the specified value.
rsvp controlled-load
Controlled load class of service.
rsvp guaranteed-qos
Guaranteed QoS class of service.
Defaults
No QoS is configured
Command Modes
Interface configuration
Command History
11.3(2)NA
This command was introduced on Cisco 2500 and Cisco 3600 series routers.
Usage Guidelines
You must execute the h323 interface command before using this command.
Both IP precedence and RSVP QoS can be configured by invoking this command twice with the two different QoS forms.
Examples
The following example enables QoS on the proxy:
interface Ethernet0ip address 172.21.127.38 255.255.255.192no ip redirectsip rsvp bandwidth 7000 7000ip route-cache same-interfacefair-queue 64 256 1000h323 interfaceh323 qos rsvp controlled-loadh323 h323-id px1@zone1.comh323 gatekeeper ipaddr 172.21.127.39Related Commands
h323 interface
Specifies the interface from which the proxy takes its IP address.
h323 t120
To enable the T.120 capabilities on your router and to specify bypass or proxy mode, use the h323 t120 command in interface configuration mode.
h323 t120 {bypass | proxy}
Syntax Description
Defaults
Bypass mode
Command Modes
Interface configuration
Command History
12.1(5)T
This command was introduced on the following platforms: Cisco 2600 series, Cisco 3600 series, Cisco 7200, and Cisco MC3810.
Usage Guidelines
The no form of this command has no function—the only possible commands are h323 t120 bypass and h323 t120 proxy.
Examples
The following example enables T.120 capabilities:
proxy h323interface ethernet0h323 t120 proxyRelated Commands
h323-annexg
To enable the border element (BE) on the gatekeeper and to enter BE configuration mode, use the h323-annexg command in gatekeeper configuration mode. To disable the BE, use the no form of this command.
h323-annexg border-element-id cost cost priority priority
no h323-annexg
Syntax Description
Defaults
Cost: 50
Priority: 50Command Modes
Gatekeeper configuration
Command History
Usage Guidelines
The Annex G border element must be configured using the call-router command before the gatekeeper can be associated with the Annex G border element. The h323-annexg command associates the gatekeeper with a previously configured Annex G border element and indicates that the gatekeeper should interact with the BE in address resolution.
Examples
The following example enables Annex G configuration for a BE named "be20":
Router(config-gk)# h323-annexg be20 cost 10 priority 40Router(config-gk-annexg)#Related Commands
call-router
Enables the Annex G border element configuration commands.
prefix
Restricts the prefixes for which the gatekeeper should query the Annex G BE.
h323-gateway voip bind srcaddr
To designate a source IP address for the voice gateway, use the h323-gateway voip bind srcaddr command in interface configuration mode. To remove the source IP address, use the no form of the command.
h323-gateway voip bind srcaddr ip-address
no h323-gateway voip bind srcaddr
Syntax Description
Defaults
No default behaviors or values
Command Modes
Interface configuration
Command History
12.1(2)T
This command was introduced on the following platforms: Cisco 1700, Cisco 2500, Cisco 2600 series, Cisco 3600 series, Cisco 7200, Cisco S5300, and Cisco uBR924.
Usage Guidelines
You do not have to issue this command on the interface that you defined as the voice gateway interface (although it may be more convenient to do so). Use this command the interface that contains the IP address to which you want to bind.
Examples
The following example assigns a source IP address of 10.1.1.1:
h323-gateway voip bind srcaddr 10.1.1.1h323-gateway voip h323-id
To configure the H.323 name of the gateway that identifies this gateway to its associated gatekeeper, use the h323-gateway voip h323-id command in interface configuration mode. To disable this defined gateway name, use the no form of this command.
h323-gateway voip h323-id interface-id
no h323-gateway voip h323-id interface-id
Syntax Description
Defaults
No gateway identification is defined
Command Modes
Interface configuration
Command History
Examples
The following example configures Ethernet interface 0.0 as the gateway interface. In this example, the gateway ID is GW13@cisco.com.
interface Ethernet0/0ip address 172.16.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.16.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip id
To define the name and location of the gatekeeper for a specific gateway, use the h323-gateway voip id command in interface configuration mode. To disable this gatekeeper identification, use the no form of this command.
h323-gateway voip id gatekeeper-id {ipaddr ip-address [port-number] | multicast}
[priority number]no h323-gateway voip id gatekeeper-id {ipaddr ip-address [port-number] | multicast}
[priority number]Syntax Description
Defaults
No gatekeeper identification is defined.
Command Modes
Interface configuration
Command History
Usage Guidelines
This command tells the H.323 gateway associated with this interface which H.323 gatekeeper to talk to and where to locate it. The gatekeeper ID configured here must exactly match the gatekeeper ID in the gatekeeper configuration.
You can configure one or two alternate gatekeepers.
The IP address of the gatekeeper does not have to be explicit; you can also use the multicast option. Multicasting saves bandwidth by forcing the network to replicate packets only when necessary. The multicast option, shown below, notifies every gatekeeper in the LAN using a universal address, 224.0.1.41.
h323-gateway voip id GK1 multicast h323-gateway voip id GK2 ipaddr 172.18.193.65 1719Examples
The following example configures Ethernet interface 0.0 as the gateway interface and defines a specific gatekeeper for it. In this example, the gatekeeper ID is GK15.cisco.com, and its IP address is 172.16.53.15 (using port 1719).
interface Ethernet0/0ip address 172.16.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.16.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip interface
To configure an interface as an H.323 gateway interface, use the h323-gateway voip interface command in interface configuration mode. To disable H.323 gateway functionality for an interface, use the no form of this command.
h323-gateway voip interface
no h323-gateway voip interface
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Interface configuration
Command History
Examples
The following example configures Ethernet interface 0.0 as the gateway interface. In this example, the h323-gateway voip interface command configures this interface as an H.323 interface.
interface Ethernet0/0ip address 172.16.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.16.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323-gateway voip tech-prefix
To define the technology prefix that the gateway registers with the gatekeeper, use the h323-gateway voip tech-prefix command in interface configuration mode. To disable this defined technology prefix, use the no form of this command.
h323-gateway voip tech-prefix prefix
no h323-gateway voip tech-prefix prefix
Syntax Description
Defaults
Disabled
Command Modes
Interface configuration
Command History
Usage Guidelines
This command defines a technology prefix that the gateway then registers with the gatekeeper. Technology prefixes can be used as a discriminator so that the gateway can tell the gatekeeper that a certain technology is associated with a particular call (for example, 15# could mean a fax transmission), or it can be used like an area code for more generic routing. No standard currently defines what the numbers in a technology prefix mean. By convention, technology prefixes are designated by a pound sign (#) as the last character.
Note
Examples
The following example configures Ethernet interface 0.0 as the gateway interface. In this example, the technology prefix is defined as 13#.
interface Ethernet0/0ip address 172.16.53.13 255.255.255.0h323-gateway voip interfaceh323-gateway voip id GK15.cisco.com ipaddr 172.16.53.15 1719h323-gateway voip h323-id GW13@cisco.comh323-gateway voip tech-prefix 13#Related Commands
h323zone-id (voice source group)
To specify the zone identification for an incoming H.323 call, use the h323zone-id command in voice source-group configuration mode. To delete the zone ID, use the no form of this command.
h323zone-id name
no h323zone-id name
Syntax Description
Defaults
No default behavior or values
Command Modes
Voice source-group configuration
Command History
Usage Guidelines
Use this command to specify the zone to use for incoming H.323 calls in the voice source-group definition. The zone ID name matches the source zone ID of an incoming H.323 call.
Note
Examples
The following example associates zone ID "5400-gw1" with incoming calls for source IP group "northcal":
Router(config)# voice source-group northcalRouter(cfg-source-grp)# h323zone-id 5400-gw1Related Commands
h450 h450-2 timeout
To specify timeout values for call transfers using the ITU-T H.450.2 standard, use the h450 h450-2 timeout command in H.323 voice service configuration mode. To return to the default, use the no form of this command.
h450 h450-2 timeout {T1 | T2 | T3 | T4} milliseconds
no h450 h450-2 timeout {T1 | T2 | T3 | T4}
Syntax Description
Defaults
T1 timer is 2000 milliseconds.
T2 timer is 5000 milliseconds.
T3 timer is 5000 milliseconds.
T4 timer is 5000 milliseconds.Command Modes
H323 voice service configuration
Command History
12.2(11)YT
This command was introduced.
12.2(15)T
This command was integrated into Cisco IOS Release 12.2(15)T.
Usage Guidelines
Use this command with Cisco IOS Telephony Service (ITS) V2.1 or a later version.
This command is primarily used when the default settings for these timers do not match your network delay parameters. Refer to the ITU-T H.450.2 specification for more information on these timers.
Examples
The following example defines a T1 timeout of 3000 milliseconds:
Router(config)# voice service voipRouter(conf-voi-serv)# h323Router(conf-serv-h323)# h450 h450-2 timeout T1 3000Related Commands
h323
Enables H.323 voice service configuration commands.
voice service
Enters voice-service configuration mode.
h450 h450-3 timeout
To specify timeout values for call forwarding using the ITU-T H.450.3 standard, use the h450 h450-3 timeout command in H.323 voice service configuration mode. To return to the default, use the no form of this command.
h450 h450-3 timeout T1 milliseconds
no h450 h450-3 timeout T1
Syntax Description
T1
Timeout value to wait for a rerouting response.
milliseconds
Number of milliseconds. Range is from 500 to 60000. Default is 5000.
Defaults
T1 timer is 5000 milliseconds.
Command Modes
H323 voice service configuration
Command History
12.2(11)YT
This command was introduced.
12.2(15)T
This command was integrated into Cisco IOS Release 12.2(15)T.
Usage Guidelines
Use this command with Cisco IOS Telephony Service (ITS) V2.1 or a later version.
This command is primarily used when the default setting for this timer does not match your network delay parameters. Refer to the ITU-T H.450.3 specification for more information on these timers.
Examples
The following example defines a T1 timeout of 3000 milliseconds:
Router(config)# voice service voipRouter(conf-voi-serv)# h323Router(conf-serv-h323)# h450 h450-3 timeout T1 3000Related Commands
h323
Enables H.323 voice service configuration commands.
voice service
Enters voice-service configuration mode.
hold-alert (ephone-dn)
To set audible alert notification on the Cisco IP phone for alerting the user about on-hold calls, use the hold-alert command in ephone-dn configuration mode. To disable this feature, use the no form of this command.
hold-alert timeout {idle | originator | shared}
no hold-alert timeout {idle | originator | shared}
Syntax Description
Defaults
Audible alert for on-hold calls is disabled by default. Only a visual indication is provided.
Command Modes
Ephone-dn
Command History
Usage Guidelines
The hold-alert command sets audible alert notification on the Cisco IP phone for alerting the user about on-hold calls. The timeout parameter specifies the time interval in seconds from the time the call is placed on hold to the time the on-hold audible alert is generated. The alert is repeated every timeout seconds.
When the idle keyword is enabled, a one-second burst of ringing on the phone is generated on the IP phone that placed the call into the hold state, only if the phone is in the idle state. If the phone is in active use, no on-hold alert is generated.
When the originator keyword is enabled, a one-second burst of ringing is generated on the phone that placed the call into the hold state if the phone is in the idle state. If the phone is in use on another call, an audible beep is generated (call-waiting beep).
Note
When the shared keyword is enabled, a one-second ring burst is generated for all the idle phones that share the same line appearance. If the phones are in use, they do not get an audio beep alert. Only the phone that initiated the call, if busy, hears a call-waiting beep.
Examples
The following example sets audible alert notification to idle on the Cisco IP phone for alerting the user about on-hold calls:
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 1111Router(config-ephone-dn)# name phone1Router(config-ephone-dn)# hold-alert 10 idleRelated Commands
hopcount
To specify the maximum number of border element (BE) hops through which an address resolution request can be forwarded, use the hopcount command in Annex G configuration mode. To restore the default, use the no form of this command.
hopcount hopcount-value
no hopcount
Syntax Description
hopcount-value
Maximum number of BE hops through which an address resolution request can be forwarded. Range is from 1 to 255. The default is 7.
Defaults
7 hops
Command Modes
Annex G configuration
Command History
Examples
The following example sets address-resolution forwarding to a maximum of 10 hops:
Router(config)# call-router h323-annexg be20Router(config-annexg)# hopcount 10Related Commands
call-router
Enables the Annex G border element configuration commands.
show call-router status
Displays the Annex G BE status.
http client cache memory
To set the memory limits for the HTTP client cache, use the http client cache memory command in global configuration mode. To reset to the default, use the no form of this command.
http client cache memory {file size | pool size}
no http client cache memory {file | pool}
Syntax Description
Defaults
File memory size: 2 KB
Pool memory size: 100 KBCommand Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
A larger cache size may permit caching of frequently used files, decreasing the fetching time between the client and server and increasing performance. Allocation of memory to increase file size or pool size does not reduce the amount of memory available. Cache memory is used only when needed, and afterward returns to being memory shared with other resources.
The amount of memory required for an expected level of performance depends on a number of factors, including the type of voice gateway (for example, Cisco AS5300 or Cisco AS5400).
The recommended maximum file size is 10 MB; the recommended maximum pool size is 100 MB.
The gateway might accept invalid characters such as "#" or "!" when you input the value for this command. The gateway ignores any invalid characters.
Note
Examples
The following example sets the HTTP client cache memory pool to 50,000 KB:
http client cache memory pool 50000The following example sets the HTTP client cache memory file to 8000 KB:
http client cache memory file 8000Related Commands
http client cache refresh
To set the time limit for how long a cached entry is considered current by the HTTP client, use the http client cache refresh command in global configuration mode. To reset to the default, use the no form of this command.
http client cache refresh seconds
no http client cache refresh
Syntax Description
seconds
Lifetime of a cached HTTP entry, in seconds. Range is from 1 to 864000. The default is 86400 (24 hours).
Defaults
86,400 seconds (24 hours)
Command Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
This command must be used to set the refresh time only if the HTTP server does not provide the necessary information in the HTTP header to calculate this value.
The gateway might accept invalid characters such as "#" or "!" when you input the value for this command. The gateway ignores any invalid characters.
When a request is made to an expired cached entry (that is, an entry that is the same age as or older than the refresh time), the HTTP client sends the server a conditional request for an update.
An expired entry is not automatically updated unless a request from the user hits the same cached entry. Expired entries are not cleaned up until 70 percent or more of the cache pool memory is consumed; then all expired entries that lack a user reference are deleted from the cache table.
Note
Examples
The following example shows the HTTP client cache refresh to be 10 seconds:
http client cache refresh 10Related Commands
http client connection idle timeout
To set the number of seconds for which the HTTP client waits before terminating an idle connection, use the http client connection idle timeout command in global configuration mode. To reset to the default, use the no form of this command.
http client connection idle timeout seconds
no http client connection idle timeout
Syntax Description
seconds
How long, in seconds, the HTTP client waits before terminating an idle connection. Range is from 1 to 60. The default is 2.
Defaults
2 seconds
Command Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
The setting of this command determines when the HTTP client is disconnected from the HTTP server, which is necessary when the server does not disconnect the client after a desirable length of time.
The default value is recommended and should normally not be changed.
In the show http client connection command output, this parameter is displayed as connection idle timeout.
The gateway might accept invalid characters such as "#" or "!" when you input the value for this command. The gateway ignores any invalid characters.
Examples
The following example sets the timeout to 40 seconds:
http client connection idle timeout 40Related Commands
http client connection persistent
To enable HTTP persistent connections so that multiple files can be loaded using the same connection, use the http client connection persistent command in global configuration mode. To disable HTTP persistent connections, use the no form of this command.
http client connection persistent
no http client connection persistent
Syntax Description
This command has no arguments or keywords.
Defaults
Persistent connections are enabled
Command Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
The setting of this command determines whether the HTTP client requests a keepalive or closed connection from the server. The HTTP server is responsible for granting or denying the keepalive connection request from the client.
Enabling persistent connections is recommended.
In the show http client connection command output, activation of this command is displayed as persistent connection.
Examples
The following example shows the HTTP client connection persistent parameter to be enabled:
http client connection persistentRelated Commands
http client connection timeout
To set the number of seconds for which the HTTP client waits for a server to establish a connection before abandoning its connection attempt, use the http client connection timeout command in global configuration mode. To reset to the default, use the no form of this command.
http client connection timeout seconds
no http client connection timeout
Syntax Description
seconds
How long, in seconds, the HTTP client waits for a server to establish a connection before abandoning its connection attempt. Range is from 1 to 60. The default is 5.
Defaults
5 seconds
Command Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
The setting of this command determines when the HTTP client abandons its attempt to connect to the server, which is necessary when a connection to the server cannot be established after a desirable length of time.
The default value is recommended and should normally not be changed.
In the show http client connection command output, activation of this command is displayed as initial socket connection timeout.
The gateway might accept invalid characters such as "#" or "!" when you input the value for this command. The gateway ignores any invalid characters.
Examples
The following example shows the HTTP client connection timeout parameter to be 20 seconds:
http client connection timeout 20Related Commands
http client response timeout
To configure the number of seconds for which the HTTP client waits for a server response, use the http client response timeout command in global configuration mode. To reset to the default, use the no form of this command.
http client response timeout seconds
no http client response timeout
Syntax Description
seconds
How long, in seconds, the HTTP client waits for a response from the server after making a request. Range is from 1 to 300. The default is 10.
Defaults
10 seconds
Command Modes
Global configuration
Command History
12.2(2)XB
This command was introduced on the Cisco AS5300, Cisco AS5350, and Cisco AS5400.
12.2(11)T
This command was implemented on the Cisco 3640 and Cisco 3660.
Usage Guidelines
This command is used to adjust the time allowed for the HTTP client to wait for the server to respond to a request before declaring a timeout error. Under normal conditions, the default of 10 seconds is sufficient. If more or less server response time is desired, use this command. For example, if your server responds slowly to the HTTP client requests, you may want to set this timer to wait longer.
In the show running-config command output, the value is displayed only if it is set to other than the default.
The gateway might accept invalid characters such as "#" or "!" when you input the value for this command. The gateway ignores any invalid characters.
Examples
The following example shows the HTTP client response timeout to be 5 seconds:
http client response timeout 5Related Commands
show http client cache
Displays the HTTP client cache.
show http client connection
Displays the HTTP client connection.
hunt-scheme least-idle
To enable the least-idle search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme least-idle command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of the command.
hunt-scheme least-idle [both | even | odd]
no hunt-scheme
Syntax Description
Defaults
Hunt scheme: least-used
Channel number: bothCommand Modes
Trunk group configuration
Command History
Usage Guidelines
Use the least-idle hunt scheme in situations where you want to reuse the most recently selected channel.
The least-idle hunt scheme looks for the channel that has just become available. The software looks at all the channels in the trunk group, regardless of member precedence, and selects the channel that has most recently come into the available queue.
If no channels are available at the time of the call request, the software returns a cause code determined by the application configured on the inbound dial peer.
If the even quantifier is set, the even-numbered channel with the shortest idle time is selected. If the odd quantifier is set, the odd-numbered channel with the shortest idle time is selected. If both is set, the most recently available channel, regardless of channel number, is selected.
Examples
The following example searches for an even-numbered idle channel having the shortest idle time within a trunk group:
Router(config)# trunk group northwestsalesRouter(config-trunk-group)# hunt-scheme least-idle evenRelated Commands
hunt-scheme longest-idle
Enables the longest-idle hunt scheme.
trunk group
Initiates a trunk group profile.
hunt-scheme least-used
To enable the least used search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme least-used command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of the command.
hunt-scheme least-used [both | even | odd [up | down]]
no hunt-scheme
Syntax Description
Defaults
Hunt scheme: least-used
Channel number: both
Direction: upCommand Modes
Trunk group configuration
Command History
Usage Guidelines
The least-used search method selects an idle channel from a trunk group member that has the highest number of available channels at the time that the hunt request is initiated. The high number of unused channels indicates that the trunk group member has not been very active in comparison with other trunk group members.
After selecting the trunk group member, the software searches the channels by direction and then by channel number:
•
•
•
•
If no channel is available in any of the trunk group members, the software returns the standard "no service" message.
Examples
The following example searches in ascending order for an even-numbered idle channel in a trunk group member having the highest number of available channels:
Router(config)# trunk group northwestsalesRouter(config-trunk-group)# hunt-scheme least-used even upRelated Commands
hunt-scheme longest-idle
To enable the longest-idle search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme longest-idle command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of this command.
hunt-scheme longest-idle [both | even | odd]
no hunt-scheme
Syntax Description
Defaults
Hunt scheme: least-used
Channel number: bothCommand Modes
Trunk group configuration
Command History
Usage Guidelines
The longest-idle hunt schemes attempts to route a call using a channel from the trunk group member that has been idle for the longest time.
If the even qualifier is set, the search looks for an even-numbered idle channel from the trunk group member that has been idle the longest. If no even-numbered idle channel is found, the search looks for an odd-numbered idle channel from the trunk group member that has the shortest idle time.
If the odd qualifier is set, the search begins looking for an odd-numbered channel from the trunk group member that has been idle the longest. If no odd-numbered idle channel is found, the search looks for an even-numbered idle channel from the trunk group member that has the shortest idle time.
If the both qualifier is set, the search looks for any (odd or even) idle channel in the trunk group member that has been idle the longest.
If no channel is available in any of the trunk group members, the software returns the standard "no service" message.
Examples
The following example searches in ascending order for an even-numbered idle channel in the trunk group member having the largest idle time:
Router(config)# trunk group northwestsalesRouter(config-trunk-group)# hunt-scheme longest-idle evenRelated Commands
hunt-scheme least-idle
Enables the least-idle hunt scheme.
trunk group
Initiates a trunk group profile.
hunt-scheme random
To enable the random search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme random command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of this command.
hunt-scheme random
no hunt-scheme
Syntax Description
This command has no arguments or keywords.
Defaults
Hunt scheme: least-used
Command Modes
Trunk group configuration
Command History
Usage Guidelines
The random search method selects trunk group member at random for an idle channel. After the trunk group member is selected, a channel is chosen at random. If that channel is not available, another trunk group member is chosen at random, and one of its channels is randomly chosen.
If no channel is available, the software returns the standard "no service" message.
Examples
The following example searches trunk group members in random order for an idle channel:
Router(config)# trunk group northwestsalesRouter(config-trunk-group)# hunt-scheme randomRelated Commands
hunt-scheme round-robin
To enable the round robin search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of this command.
hunt-scheme round-robin [both | even | odd [up | down]]
no hunt-scheme
Syntax Description
Defaults
Hunt scheme: least-used
Channel number: bothCommand Modes
Trunk group configuration
Command History
Usage Guidelines
The round-robin hunt scheme searches trunk group members one after the other for an idle channel. The history of the most recently used trunk group member is saved to identify the next trunk group member to use for a new idle channel request. This method tries to balance the load of channel use across trunk group members.
For example, suppose a trunk group has three trunk group members: A, B, and C. Trunk group member A has the highest preference, B has the next highest, and C has the lowest. The software starts the search with A:
•
•
•
•
•
•
If none of the trunk group members has an idle channel available for the current channel request, the software returns the standard "no service" message.
Compare this hunt scheme with hunt-scheme sequential, in which the next request for an idle channel always starts with the first trunk group member of the trunk group, regardless of where the last idle channel was found.
If the even qualifier is set, the search looks for an even-numbered idle channel starting with the trunk group member having the highest preference. If no even-numbered idle channel is found, the search looks for an even-numbered idle channel in the next trunk group member. If no even-numbered idle channel is found in any trunk group member, the search repeats the process for an odd-numbered channel.
If the odd qualifier is set, the search begins looking for an odd-numbered channel, and if none is found in any of the trunk group members, the search repeats the process for an even-numbered channel.
If the both qualifier is set, the search looks for any idle channel in the trunk group member.
Examples
The following example searches for an even-numbered idle channel starting with the trunk group member next in order after the previously used member:
Router(config)# trunk group northwestregionRouter(config-trunk-group)# hunt-scheme round-robin evenRelated Commands
hunt-scheme sequential
Enables a "sequential idle channel" hunt scheme.
trunk group
Initiates a trunk group profile definition.
hunt-scheme sequential
To specify the sequential search method for finding an available channel in a trunk group for outgoing calls, use the hunt-scheme sequential command in trunk group configuration mode. To delete the hunt scheme from the trunk group profile, use the no form of this command.
hunt-scheme sequential [both | even | odd [up | down]]
no hunt-scheme
Syntax Description
Defaults
Hunt scheme: least-used
Channel number: both
Direction: upCommand Modes
Trunk group configuration
Command History
Usage Guidelines
The sequential hunt scheme selects an idle channel, starting with the trunk group member that has the highest preference within the trunk group. Regardless of where the last idle channel was found, an idle channel request starts searching with this highest-preference trunk group member.
For example, suppose a trunk group has three trunk group members: A, B, and C. Trunk group member A has the highest preference, B has the next highest, and C has the lowest. The software starts the search with trunk group A:
•
•
•
•
•
•
Compare this hunt scheme with hunt-scheme round-robin, where the next request for an idle channel starts with the next unused trunk group member of the trunk group.
If the even qualifier is set, the search looks for an even-numbered idle channel starting with the trunk group member having the highest preference. If no even-numbered idle channel is found, the search looks for an even-numbered idle channel in the next trunk group member. If no even-numbered idle channel is found, the search repeats the process for an odd-numbered idle channel.
If the odd qualifier is set, the search begins looking for an odd-numbered channel, starting with the trunk group member having the highest preference. If none is found in any of the trunk group members, the search repeats the process for an even-numbered channel.
If the both qualifier is set, the search looks for any idle channel in the trunk group member.
Use the sequential hunt scheme in situations that benefit from a predictable channel allocation. In addition, if one end of the routing path is defined with sequential even up and the other end with sequential odd up, glare conditions are avoided.
Examples
The following example searches in ascending order for an even-numbered idle channel starting with the trunk group member of highest precedence:
Router(config)# trunk group northwestsalesRouter(config-trunk-group)# hunt-scheme sequential even upRelated Commands
hunt-scheme round-robin
Enables a round-robin hunt scheme.
trunk group
Initiates a trunk group profile definition.
huntstop
To disable all dial-peer hunting if a call fails when using hunt groups, use the huntstop command in dial-peer configuration mode. To reenable dial-peer hunting, use the no form of this command.
huntstop
no huntstop
Syntax Description
This command has no arguments or keywords.
Defaults
Disabled
Command Modes
Dial-peer configuration
Command History
Usage Guidelines
Once you enter this command, no further hunting is allowed if a call fails on the specified dial peer.
Note
Examples
The following example shows how to disable dial-peer hunting on a specific dial peer:
dial peer voice 100 vofrhuntstopThe following example shows how to reenable dial-peer hunting on a specific dial peer:
dial peer voice 100 vofrno huntstopRelated Commands
dial-peer voice
Enters dial-peer configuration mode and specifies the method of voice-related encapsulation.
huntstop (cm-fallback)
To set the huntstop attribute for the dial peers associated with the Cisco IP phone dial peers created during CallManager fallback, use the huntstop command in call-manager-fallback configuration mode. To disable huntstop, use the no form of this command.
huntstop
no huntstop
Syntax Description
This command has no arguments or keywords.
Defaults
Huntstop is enabled by default
Command Modes
Call-manager-fallback configuration
Command History
Usage Guidelines
In call-manager-fallback configuration mode, the huntstop attribute by default is set uniformly to all Cisco IP phone lines (for example, to all or to none).
Note
Examples
The following example shows how to disable huntstop for all the Cisco IP phones:
Router(config)# call-manager-fallbackRouter(config-cm-fallback)# no huntstopRelated Commands
huntstop (ephone-dn)
To set the huntstop attribute for the dial peers associated with the Cisco IP phone lines, use the huntstop command in ephone-dn configuration mode. To disable huntstop, use the no form of this command.
huntstop
no huntstop
Syntax Description
This command has no arguments or keywords.
Defaults
Huntstop is set by default
Command Modes
Ephone-dn configuration
Command History
Usage Guidelines
In the ephone-dn configuration mode, the huntstop attribute is set by default for the dial peers associated with the Cisco IP phone lines on a line-by-line basis. This allows you to prevent hunt-on-busy from redirecting a call to a busy phone into a dial-peer setup with a catch-all default destination.
Note
Examples
The following example shows how to disable huntstop for the destination dial peer with the extension 5001. The huntstop for the dial peer is set to OFF and prevents calls to extension 5001 from being rerouted to the on-net H.323 dial-peer for 5... (the three decimal points are used as wildcards) destination when 5001 is busy.
Router(config)# ephone-dn 1Router(config-ephone-dn)# number 5001Router(config-ephone-dn)# no huntstopThe following example shows a typical configuration in which ephone-dn huntstop (default) is required:
ephone-dn 1number 5001ephone 4button 1:1mac-address 0030.94c3.8724dial-peer voice 5000 voipdestination-pattern 5...session target ipv4:223.223.223.223In the previous example, the huntstop attribute is set to ON by default and prevents calls to extension 5001 from being rerouted to the on-net H.323 dial-peer for 5... when the 5001 extension is busy.
The following example shows another instance in which huntstop is not desired and is explicitly disabled:
ephone-dn 1number 5001no huntstoppreference 1call-forward noan 6000ephone-dn 2number 5001preference 2call-forward busy 6000call-forward noan 6000ephone 4button 1:1 2:2mac-address 0030.94c3.8724dial-peer voice 6000 potsdestination-pattern 6000huntstopport 1/0/0description answering-machineIn this example, ephone 4 is configured with two lines, each with the same extension number 5001. This is done in order to allow the second line to provide call waiting notification for extension number 5001 when the first line is in use. Setting no huntstop on the first line (ephone-dn 1) allows incoming calls to hunt to the second line (ephone-dn 2) on ephone 4 when the ephone-dn 1 line is busy.
The ephone-dn 2 has call forwarding set to extension 6000, which corresponds to a locally attached answering machine connected to a foreign exchange station (FXS) voice port. In this example, the plain old telephone service (POTS) dial-peer for extension 6000 also has the dial-peer huntstop attribute explicitly set to prevent further hunting.
Related Commands
ephone-dn
Enters ephone-dn configuration mode.
huntstop (dial-peer)
Disables all further dial-peer hunting if a call fails using hunt groups.
