Commands: sccp through service-type call-check

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.

sccp

To enable the Skinny Client Control Protocol (SCCP) protocol and its related applications (transcoding and conferencing), use the sccp command in global configuration mode. To disable the protocol, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

The router on which this command is used must be equipped with one or more digital T1/E1 packet voice trunk network modules (NM-HDVs) or high-density voice (HDV) transcoding/conferencing DSP farms (NM-HDV-FARMs) to provide digital-signal-processor (DSP) resources.

SCCP and its related applications (transcoding and conferencing) become enabled only if digital-signal-processor (DSP) resources for these applications are configured, DSP-farm service is enabled, and the Cisco CallManager registration process is completed.

The no form of this command disables SCCP and its applications by unregistering from the active Cisco CallManager, dropping existing connections, and freeing allocated resources.

Examples

Related Commands

sccp ccm

Command	Description
dspfarm (DSP farm)	Enables DSP-farm service.
show dspfarm	Displays summary information about DSP resources.
show sccp	Displays the SCCP configuration information and current status.

To add a Cisco CallManager server to the list of available servers and set various parameters—including IP address or Domain Name System (DNS) name, port number, and version number—use the sccp ccm command in global configuration mode. To remove a particular server from the list, use the no form of this command.

sccp ccm {ip-address | dns} identifier identifier-number [priority priority] [port port-number]
[version version-number]

sccp ccm {ip-address | dns} priority priority [port port-number] [version 3.0 | 3.1+]

Syntax Description


ip-address	IP address of the Cisco CallManager server.
dns	DNS name.
identifier identifier-number	Number that identifies the Cisco CallManager server. Range is 1 to 65535.
priority priority	Priority of this Cisco CallManager server relative to other connected servers. Range is 1 (highest) to 4 (lowest). Note This keyword is required only for NM-HDV and NM-HDV-FARM modules. Ignore this keyword if you are using the NM-HDV2 or NM-HD-1V/2V/2VE; set the priority using the associate ccm command in the Cisco CallManager group.
port port-number	(Optional) TCP port number. Range is 1025 to 65535. Default is 2000.
version version-number	(Optional) Cisco CallManager version. Valid versions are 3.0, 3.1, 3.2, 3.3, and 4.0. Default is 3.1.

Defaults

Command Modes

Command History


Release	Modification
12.1(5)YH	This command was introduced on the Cisco VG200.
12.2(13)T	This command was implemented on the Cisco 2600 series, Cisco 3620, Cisco 3640, Cisco 3660, and Cisco 3700 series.
12.3(8)T	The identifier keyword and additional values for Cisco CallManager versions were added.

Usage Guidelines

You can configure up to four Cisco CallManager servers—a primary and up to three backups—to support digital-signal-processor (DSP) farm services. To add the Cisco CallManager server to a Cisco CallManager group, use the associate ccm command.

Examples

The following example adds the Cisco CallManager server whose IP address is 10.0.0.0:

Related Commands


Command	Description
associate ccm	Associates a Cisco CallManager server with a Cisco CallManager group and establishes its priority within the group.
sccp	Enables SCCP and its associated transcoding and conferencing applications.
sccp ccm group	Creates a Cisco CallManger group and enters SCCP Cisco CallManager configuration mode.
sccp local	Selects the local interface that SCCP applications use to register with Cisco CallManager.
show sccp	Displays SCCP configuration information and current status.

sccp ccm group

To create a Cisco CallManager group and enter SCCP Cisco CallManager configuration mode, use the sccp ccm group command in global configuration mode. To remove a particular Cisco CallManager group, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

group-number	Number that identifies the Cisco CallManager group. Range is 1 to 65535.

Release	Modification
12.3(8)T	This command was introduced.

Use this command to group Cisco CallManager servers that are defined using the sccp ccm command. You can associate designated DSP farm profiles using the associate profile command so that the DSP services are controlled by the Cisco CallManager servers in the group.

Examples

The following example enters SCCP Cisco CallManager configuration mode and associates Cisco CallManager 25 with Cisco CallManager group 10:

Related Commands


Command	Description
associate ccm	Associates a Cisco CallManager server with a Cisco CallManager group and establishes its priority within the group.
associate profile	Associates a DSP farm profile with a Cisco CallManager group.
bind interface	Binds an interface with a Cisco CallManager group.
connect interval	Specifies the amount of time that a DSP farm profile waits before attempting to connect to a Cisco CallManager when the current Cisco CallManager fails to connect.
connect retries	Specifies the number of times that a DSP farm attempts to connect to a Cisco CallManager when the current Cisco CallManager connections fails.
sccp ccm	Adds a Cisco CallManager server to the list of available servers.

sccp ip precedence

To set the IP precedence value to be used by Skinny Client Control Protocol (SCCP), use the sccp ip precedence command in global configuration mode. To reset to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp local

value	IP precedence value. Range is from 1 (highest) to 7 (lowest).

Command	Description
dspfarm (DSP farm)	Enables DSP-farm service.
sccp	Enables SCCP and its associated transcoding and conferencing applications.
show sccp	Displays the SCCP configuration information and current status.

To select the local interface that Skinny Client Control Protocol (SCCP) applications (transcoding and conferencing) use to register with Cisco CallManager, use the sccp local command in global configuration mode. To deselect the interface, use the no form of this command.

Syntax Description


interface-type	Interface type that the SCCP application uses to register with Cisco CallManager. The type can be an interface address or a virtual-interface address such as Ethernet.
interface-number	Interface number that the SCCP application uses to register with Cisco CallManager.
port port-number	(Optional) Port number used by the selected interface. Range is 1025 to 65535. Default is 2000.

Defaults

Command Modes

Command History

Usage Guidelines

The router must be equipped with one or more voice network modules that provide DSP resources.

Release	Modification
12.1(5)YH	This command was introduced.
12.2(13)T	This command was integrated into Cisco IOS Release 12.2(13)T.
12.3(14)T	The port keyword and port-number argument were added.

Note If the default port is used by another application, the SCCP application fails to register to Cisco CallManager. Use the port keyword with the port-number argument to specify a different port for SCCP to use for registering with Cisco CallManager.

Examples

The following example selects a Fast Ethernet interface for SCCP applications to use to register with Cisco CallManager:

Related Commands

sccp switchback timeout guard

Command	Description
dsp services dspfarm	Enables DSP-farm services.
sccp	Enables SCCP and its associated transcoding and conferencing applications.
show sccp	Displays the SCCP configuration information and current status.

To set the Skinny Client Control Protocol (SCCP) switchback guard timer, use the sccp switchback timeout guard command in global configuration mode. To reset to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

You can use the guard timer value for the switchback algorithm that follows the Graceful Timer method.

Examples

The following example sets the switchback guard timer value to 180 seconds (3 minutes):

Related Commands

sctp

seconds	Guard timer value, in seconds. Range is from 180 to 7200. Default is 1200.

Command	Description
dspfarm (DSP farm)	Enables DSP-farm service.
sccp	Enables SCCP and its associated transcoding and conferencing applications.
show sccp	Displays the SCCP configuration information and current status.

To enter the Stream Control Transmission Protocol (SCTP) configuration, use the sctp command in IDSN User Adaptation Layer (IUA) configuration mode. To disable, use the no form of this command.

sctp [[t1-init milliseconds][t3-rtx-min seconds][t3-rtx-max milliseconds][startup-rtx number][assoc-rtx number][path-rtx number]]

Syntax Description


t1-init milliseconds	Timer T1 initiation value in milliseconds. Valid values are from 1000 to 60000. The t1-init configurable option applies only during the creation of an SCTP instance.
t3-rtx-min seconds	Timer T3 retransmission minimum timeout in seconds. Valid values are from 1 to 300.
t3-rtx-max milliseconds	Timer T3 retransmission maximum timeout in milliseconds. Valid values are from 1000 to 60000.
startup-rtx number	Maximum startup retransmissions. The startup-rtx configurable option applies only during the creation of an SCTP instance. Valid values are from 2 to 20.
assoc-rtx number	Maximum association retransmissions. Valid values are from 2 to 20.
path-rtx number	Maximum path retransmissions. Valid values are from 2 to 20.

Defaults

Command Modes

Command History

Usage Guidelines

Release	Modification
12.2(15)T	This command was introduced on the Cisco 2420, Cisco 2600 series, Cisco 3600 series, and Cisco 3700 series; and Cisco AS5300, Cisco AS5350, Cisco AS5400, and Cisco AS5850 network access server (NAS) platforms.

To enter SCTP configuration commands, you must first enter IUA configuration mode and then enter sctp at the Router(config-iua)# prompt to enter SCTP configuration mode.

Examples

The following is an example of how to set failover time (in milliseconds) between 1 and 10 seconds as part of SCTP configuration of the T1 initiation timer. This example uses the lowest failover timer value allowed (1 second):

The following is an example of how to set SCTP maximum startup retransmission interval. This example uses the maximum startup retransmission interval value allowed:

The following is an example of how to configure the number of SCTP streams for this AS. This example uses the maximum SCTP streams allowed:

The following is an example of how to configure the SCTP T1 initiation timer (in milliseconds). This example uses the maximum timer value allowed:

Related Commands

security

Command	Description
pri-group (pri-slt)	Specifies an ISDN PRI on a channelized T1 or E1 controller.

To enable authentication and authorization on a gatekeeper, use the security command in gatekeeper configuration mode. To disable security, use the no form of this command.

security {any | h323-id | e164} {password default password | password separator character}

no security {any | h323-id | e164} {password default password | password separator character}

Syntax Description


any	Uses the first alias of an incoming registration, admission, and status (RAS) protocol registration, regardless of its type, to identify the user to RADIUS/TACACS+.
h323-id	Uses the first H.323 ID type alias to identify the user to RADIUS/TACACS+.
e164	Uses the first E.164 address type alias to identify the user to RADIUS/TACACS+.
password default password	Default password that the gatekeeper associates with endpoints when authenticating them with an authentication server. The password must be identical to the password on the authentication server.
password separator character	Character that endpoints use to separate the H.323-ID from the piggybacked password in the registration. Specifying this character allows each endpoint to supply a user-specific password. The separator character and password are stripped from the string before it is treated as an H.323-ID alias to be registered. Note that passwords may only be piggybacked in the H.323-ID, not the E.164 address, because the E.164 address allows a limited set of mostly numeric characters. If the endpoint does not wish to register an H.323-ID, it can still supply an H.323-ID consisting of just the separator character and password. This H.323-ID consisting of just the separator character and password are understood to be a password mechanism and no H.323-ID is registered.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command to enable identification of registered aliases by RADIUS/TACACS+. If the alias does not exist in RADIUS/TACACS+, the endpoint is not allowed to register.

A RADIUS/TACACS+ server and encryption key must have been configured in Cisco IOS software for security to work.

Only the first alias of the proper type is identified. If no alias of the proper type is found, the registration is rejected.

Release	Modification
11.3(2)NA	This command was introduced on the Cisco 2600 series and Cisco 3600 series.

This command does not allow you to define the password mechanism unless the security type (h323-id or e164 or any) has been defined. Although the no security password command undefines the password mechanism, it leaves the security type unchanged, so security is still enabled. However, the no security command disables security entirely, including removing any existing password definitions.

Examples

The following example enables identification of registrations using the first H.323 ID found in any registration:

The following example enables security, authenticating all users by using their H.323-IDs and a password of qwerty2x:

The next example enables security, authenticating all users by using their H.323-IDs and the password entered by the user in the H.323-ID alias he or she registers:

Now if a user registers with an H.323-ID of joe!024aqx, the gatekeeper authenticates user joe with password 024aqx, and if that is successful, registers the user with the H.323-ID of joe. If the exclamation point is not found, the user is authenticated with the default password, or a null password if no default has been configured.

The following example enables security, authenticating all users by using their E.164 IDs and the password entered by the user in the H.323-ID alias he or she registers:

Now if a user registers with an E.164 address of 5551212 and an H.323-ID of !hs8473q6, the gatekeeper authenticates user 5551212 and password hs8473q6. Because the H.323-ID string supplied by the user begins with the separator character, no H.323-ID is registered, and the user is known only by the E.164 address.

Related Commands


Command	Description
accounting (gatekeeper)	Enables the accounting security feature on the gatekeeper.
radius-server host	Specifies a RADIUS server host.
radius-server key	Sets the authentication and encryption key for all RADIUS communications between the router and the RADIUS daemon.

security acl answerarq

To configure the gatekeeper to use tokenless call authorization, use the security acl answerarq command in gatekeeper configuration mode. To disable, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

access-list-number	Number of an access list that was configured using the access-list command. This is a decimal number from 1 to 99 or from 1300 to 1999. Only standard IP access lists numbered 1 through 99 are supported for the Tokenless Call Authorization feature.

Release	Modification
12.2(15)T	This command was introduced on the Cisco 2610, Cisco 2611, Cisco 2611XM, Cisco 2613, Cisco 2620, Cisco 2620XM, Cisco 2621, Cisco 2621XM, Cisco 2650, Cisco 2650XM, Cisco 2651, Cisco 2651XM, Cisco 3620, Cisco 3640, Cisco 3660, and Cisco 3725.

Use this command in conjunction with the access-list command to configure tokenless call authorization on a gatekeeper. The IP access list contains endpoints that are not in the gatekeeper's administrative domain, but from which calls should be accepted. This command configures the gatekeeper to use the IP access list for security.

Examples

The following example shows how to configure a gatekeeper to use a previously configured IP access list with an IP access list number of 20 for call authorization:

Related Commands

sequence-numbers

Command	Description
access-list	Configures the access list mechanism for filtering frames by protocol type or vendor code.

To enable the generation of sequence numbers in each frame generated by the digital signal processor (DSP) for Voice over Frame Relay applications, use the sequence-numbers command in dial-peer configuration mode. To disable the generation of sequence numbers, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Sequence numbers on voice packets allow the digital signal processor (DSP) at the playout side to detect lost packets, duplicate packets, or out-of-sequence packets. This helps the DSP to mask out occasional drop-outs in voice transmission at the cost of one extra byte per packet. The benefit of using sequence numbers versus the cost in bandwidth of adding an extra byte to each voice packet on the Frame Relay network must be weighed to determine whether to disable this function for your application.

Another factor to consider is that this command does not affect codecs that require a sequence number, such as G.726. If you are using a codec that requires a sequence number, the DSP generates one regardless of the configuration of this command.

Examples

The following example disables generation of sequence numbers for VoFR frames for VoFR dial peer 200:

Related Commands

Release	Modification
12.0(3)XG	This command was introduced on the Cisco 2600 series, Cisco 3600 series, and Cisco MC3810.
12.0(4)T	This command was integrated into Cisco IOS Release 12.0(4)T.


Command	Description
called-number (dial-peer)	Enables an incoming VoFR call leg to get bridged to the correct POTS call leg when using a static FRF.11 trunk connection.
codec (dial-peer)	Specifies the voice coder rate of speech for a Voice over Frame Relay dial peer.
cptone	Specifies a regional analog voice interface-related tone, ring, and cadence setting.
destination-pattern	Specifies either the prefix, the full E.164 telephone number, or an ISDN directory number (depending on the dial plan) to be used for a dial peer.
dtmf-relay (Voice over Frame Relay)	Enables the generation of FRF.11 Annex A frames for a dial peer.
session protocol (Voice over Frame Relay)	Establishes a session protocol for calls between the local and remote routers via the packet network.
session target	Specifies a network-specific address for a specified dial peer or destination gatekeeper.
signal-type	Sets the signaling type to be used when connecting to a dial peer.

server (RLM)

To identify an RLM server, use the server RLM configuration command. To remove the identification, use the no form of this command

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

The following example identifies the RLM server and defines the associated IP addresses:

Related Commands

name-tag	Name to identify the server configuration so that multiple entries of server configuration can be entered.

Release	Modification
11.3(7)	This command was introduced.


Command	Description
clear interface	Resets the hardware logic on an interface.
clear rlm group	Clears all RLM group time stamps to zero.
interface	Defines the IP addresses of the server, configures an interface type, and enters interface configuration mode.
link (RLM)	Specifies the link preference.
protocol rlm port	Reconfigures the port number for the basic RLM connection for the whole rlm-group.
retry keepalive	Allows consecutive keepalive failures a certain amount of time before the link is declared down.
show rlm group statistics	Displays the network latency of the RLM group.
show rlm group status	Displays the status of the RLM group.
show rlm group timer	Displays the current RLM group timer values.
shutdown (RLM)	Shuts down all of the links under the RLM group.
timer	Overwrites the default setting of timeout values.

server absent reject

To configure the gatekeeper to reject new registrations or calls when the connection to the Gatekeeper Transaction Message Protocol (GKTMP) server is down, use the server absent reject command in gatekeeper configuration mode. To disable, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

This command configures the gatekeeper to reject new registrations or calls when it is unable to reach the GKTMP server because the TCP connection between the gatekeeper and GKTMP server is down. If multiple GKTMP servers are configured, the gatekeeper tries all of them and rejects registrations or calls only if none of the servers respond. You can also use this feature for security or service denial if a connection with the server is required to complete a registration.

arq	Reject call admission request (ARQ) messages.
rrq	Reject registration request (RRQ) messages.

Release	Modification
12.2(11)T	This command was introduced on the Cisco 3660 and Cisco MC3810.

Note This command assumes that RRQ and ARQ triggers are used between the gatekeeper and GKTMP server.

Examples

The following example directs the gatekeeper to reject registrations when it cannot connect to the GKTMP server:

server flow-control

To enable flow control on the Cisco IOS gatekeeper (GK) and reset all thresholds to default, use the server flow-control command in gatekeeper configuration mode. To disable GK flow control, use the no form of this command.

server flow-control [onset value] [abatement value] [qcount value]

Syntax Description


onset value	(Optional) Percentage of the server timeout value that is used to mark the server as usable or unusable. Range is from 1 to 100. The default is 80.
abatement value	(Optional) Percentage of the server timeout value that is used to mark the server as unusable or usable. Range is from 1 to 100. The default is 50. Note The abatement value must be less than the onset value.
qcount value	(Optional) Threshold length of the outbound queue on the GK. The queue contains messages waiting to be transmitted to the server. The TCP socket between the GK and Gatekeeper Transaction Message Protocol (GKTMP) server queues messages if it has too many to transmit. If the count of outbound queue length on the server reaches the qcount value, the server is marked unusable. Range is from 1 to 2000. The default is 50.

Defaults

Command Modes

Command History

Usage Guidelines

Suppose the server timeout value is 3 seconds, the onset value is 50, and the abatement value is 40. When the average response time from the server to the Gatekeeper Transaction Message Protocol (GKTMP) reaches 1.5 seconds (the onset percentage of the server timeout value), the server is marked as unusable. During the period that the server is marked as unusable, REQUEST ALV messages are still sent to the unusable server. When the response time is lowered to 1.2 seconds (the abatement percentage of the timeout value), the server is marked usable again, and the GKTMP resumes sending messages to the server.

Release	Modification
12.2(2)XB	This command was introduced.
12.2(8)T	This command was integrated into Cisco IOS Release 12.2(8)T.

If you change one parameter using the server flow-control command, all other parameters revert to the default values. For example, if the onset is configured at 70 percent and you use the server flow-control command to set the abatement level, the onset resets to the default (80 percent).

Examples

The following example enables the GKTMP Interface Resiliency Enhancement feature with an onset level of 50:

The following example enables the GKTMP Interface Resiliency Enhancement feature:

The following example shows the server statistics, including timeout encountered, average response time, and the server status:

Related Commands

server registration-port

Command	Description
timer server timeout	Specifies the timeout value for a response from a back-end GKTMP server.

To configure the listener port for the server to establish a connection with the gatekeeper, use the server registration-port command in gatekeeper configuration mode. To force the gatekeeper to close the listening socket so that no more new registration takes place, use the no form of this command.

Syntax Description

Defaults

port-number	Port number on which the gatekeeper listens for external server connections. Range is from 1 to 65535. There is no default.

Note If the gatekeeper is to communicate with network servers, a registration port must be configured on it.

Command Modes

Command History

Usage Guidelines

Use this command to configure a server registration port to poll for servers that want to establish connections with the gatekeeper.

Release	Modification
12.1(1)T	This command was introduced on the following platforms: Cisco 2500 series, Cisco 2600 series, Cisco 3600 series, Cisco 7200 series, and Cisco MC3810.
12.2(11)T	This command was implemented on the Cisco 3700 series.

Note The no form of this command forces the gatekeeper on this router to close the listen socket, so it cannot accept more registrations. However, existing connections between the gatekeeper and servers are left open.

Examples

The following example establishes a listener port for a server connection with a gatekeeper:

Related Commands

server routing

Command	Description
server trigger	Configure static server triggers for specific RAS messages to be forwarded to a specified server.
show gatekeeper servers	Displays the triggers configured on the gatekeeper.

To specify the type of circuit messages sent to the Gatekeeper Transaction Message Protocol (GKTMP) server, use the server routing command in gatekeeper configuration mode. To return to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Use this command to route carrier and trunk-group messages from the gatekeeper to the GKTMP server.

both	Sends both types of information in GKTMP messages.
carrier	Sends only carrier information in GKTMP messages. This is the default.
trunk-group	Sends only trunk-group information in GKTMP messages.

Release	Modification
12.2(11)T	This command was introduced.

The carrier keyword sends the "I" and "J" tags in the GKTMP messages. The trunk-group keyword sends the "P" and "Q" tags in the GKTMP messages. The both keyword sends both sets of tags.

Examples

The following example enables trunk-group information to be sent in GKTMP messages from the gatekeeper:

Related Commands

server trigger arq

Command	Description
show gatekeeper servers	Displays the triggers configured on the gatekeeper.

To configure the admission request (ARQ) trigger statically on the gatekeeper, use the server trigger arq command in gatekeeper configuration mode. Submode commands are available after the server trigger arq command is entered. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of this command.

server trigger arq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value
redirect-reason reason-number

no server trigger arq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.

After the command is entered, the software enters a submode that permits you to configure additional filters on the reliability, availability, and serviceability (RAS) message. These filters are optional, and you may configure any of them, one per command line.


info-only	Use to indicate to the Cisco IOS gatekeeper that messages that meet the specified trigger parameters should be sent to the GKTMP server application as notifications only and that the gatekeeper should not wait for a response from the Gatekeeper Transaction Message Protocol (GKTMP) server application.
shutdown	Use to temporarily disables a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.
destination-info {e164 \| email-id \| h323-id} value	Use to send ARQ RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID. •value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used: –A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
redirect-reason reason-number	Use to send ARQ RAS messages containing a specific redirect reason to the GKTMP server application. •reason-number—Range is from 0 to 65535. Currently-used values are: –0—Unknown reason. –1—Call forwarding busy or called DTE busy. –2—Call forwarded; no reply. –4—Call deflection. –9—Called DTE out of order. –10—Call forwarding by the called DTE. –15—Call forwarding unconditionally.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the admission request (ARQ) static server trigger. The gatekeeper checks incoming gateway ARQ messages for the configured trigger information. If an incoming ARQ message contains the specified trigger information, the gatekeeper sends the ARQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the ARQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the ARQ messages, the gatekeeper sends all ARQ messages to the GKTMP server application.

If the gatekeeper receives an ARQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming ARQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two ARQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two ARQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming ARQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one ARQ trigger registration message with the same priority but for different GKTMP servers, the gatekeeper retains all of the registrations.

Release	Modification
12.1(1)T	This command was introduced.
12.2(11)T	This command was implemented on the Cisco 2600 series, Cisco 3600 series, Cisco 3700 series, Cisco 7200 series, and Cisco MC3810. The irr trigger was added.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all ARQ messages to GKTMP server "Server-123":

The following example configures an ARQ trigger registration on gatekeeper "alpha", which sends to GKTMP server "Server-west" any ARQ message that contains H.323 ID "3660-gw1", e-mail ID "joe.xyz.com", or a redirect reason 1. All other ARQ messages are not sent to the GKTMP server application.

If the ARQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

Then gatekeeper "alpha" checks all incoming ARQ messages for the destination H.323 ID, e-mail ID, or redirect reason before checking for the E.164 address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the ARQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" ARQ trigger registration had been defined with a priority 1 instead of priority 2, the second server trigger definition would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those ARQ messages that contain a destination E.164 address that starts with 1800. All other ARQ messages would not be sent to the GKTMP server.

Related Commands

server trigger brq

Command	Description
server registration-port	Configures the server listening port on the gatekeeper.
show gatekeeper servers	Displays the triggers configured on the gatekeeper.

To configure the bandwidth request (BRQ) trigger statically on the gatekeeper, use the server trigger brq command in gatekeeper configuration mode. Submode commands are available after entering the server trigger brq command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger brq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
redirect-reason reason-number

no server trigger brq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message
	Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
redirect-reason reason-number	Use to send BRQ RAS messages containing a specific redirect reason to the GKTMP server application. •reason-number—Range is from 0 to 65535. Currently used values are as follows: –0—Unknown reason. –1—Call forwarding busy or called DTE busy. –2—Call forwarded; no reply. –4—Call deflection. –9—Called DTE out of order. –10—Call forwarding by the called DTE. –15—Call forwarding unconditionally.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the bandwidth request (BRQ) static server trigger. The gatekeeper checks incoming gateway BRQ messages for the configured trigger information. If an incoming BRQ message contains the specified trigger information, the gatekeeper sends the BRQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the BRQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the BRQ messages, the gatekeeper sends all BRQ messages to the GKTMP server application.

If the gatekeeper receives BRQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming BRQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two BRQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two BRQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming BRQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one BRQ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

Release	Modification
12.2(2)XB	This command was introduced.
12.2(11)T	This the command was implemented on the following platforms: Cisco 2600 series, Cisco 3600 series, Cisco 3700 series, Cisco 7200 series, and Cisco MC3810. The irr trigger was added.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all BRQ messages to GKTMP server "Server-123":

The following example configures BRQ trigger registration on gatekeeper "alpha", which sends to GKTMP server "Server-west" any BRQ message containing redirect reason 1 or redirect reason 2. All other BRQ messages are not sent to the GKTMP server application.

If the BRQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

Then gatekeeper "alpha" checks all incoming BRQ messages for redirect reasons 1 or 2 before checking for redirect reason 10. If any one of those conditions is met, the gatekeeper sends the BRQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" BRQ trigger registration had been defined with a priority 1 instead of priority 2, then the second server trigger definition would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those BRQ messages that contain a redirect reason 10. All other BRQ messages would not be sent to the GKTMP server.

Related Commands

server trigger drq

To configure the disengage request (DRQ) trigger statically on the gatekeeper, use the server trigger drq command in gatekeeper configuration mode. Submode commands are available after entering the server trigger drq command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger drq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value

no server trigger drq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message
	Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
destination-info {e164 \| email-id \| h323-id} value	Use to send ARQ RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID. •value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used: –A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the disengage request (DRQ) static server trigger. The gatekeeper checks incoming gateway DRQ messages for the configured trigger information. If an incoming DRQ message contains the specified trigger information, the gatekeeper sends the DRQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the DRQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the DRQ messages, the gatekeeper sends all DRQ messages to the GKTMP server application.

If the gatekeeper receives DRQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming DRQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two DRQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two DRQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming DRQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one DRQ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all DRQ messages to GKTMP server "Server-123":

The following example configures DRQ trigger registration on gatekeeper "alpha", which sends to GKTMP server "Server-west" any DRQ message containing an H.323 ID "3660-gw1" or e-mail ID "joe.xyz.com". All other DRQ messages are not sent to the GKTMP server application.

If the DRQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming DRQ messages for the destination H.323 ID or e-mail ID before checking for the E.164 address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the DRQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" DRQ trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server Server-west only those DRQ messages that contain a destination E.164 address starting with 1800. All other DRQ messages would not be sent to the GKTMP server.

Related Commands

server trigger irr

To configure the information request response (IRR) trigger statically on the gatekeeper, use the server trigger irr command in gatekeeper configuration mode. Submode commands are available after entering the server trigger irr command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger irr gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value
redirect-reason reason-number

no server trigger irr gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


destination-info {e164 \| email-id \| h323-id} value	Use to send IRR RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions: •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID.
	•value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used: –A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
redirect-reason reason-number	Use to send IRR RAS messages containing a specific redirect reason to the GKTMP server application. •reason-number—Range is from 0 to 65535. Currently used values are the following: –0—Unknown reason. –1—Call forwarding busy or called DTE busy. –2—Call forwarded; no reply. –4—Call deflection. –9—Called DTE out of order. –10—Call forwarding by the called DTE. –15—Call forwarding unconditionally.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the information request response (IRR) static server trigger. The gatekeeper checks incoming gateway IRR messages for the configured trigger information. If an incoming IRR message contains the specified trigger information, the gatekeeper sends the IRR message to the GKTMP server application. In addition, the IRR message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the IRR messages, the gatekeeper sends all IRR messages to the GKTMP server application.

If the gatekeeper receives an IRR trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming IRR RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two IRR trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two IRR trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming IRR messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one IRR trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all IRR messages to GKTMP server "Server-123":

The following example configures an IRR trigger registration on gatekeeper "alpha", which send to GKTMP server "Server-west" any IRR message containing an H.323 ID "3660-gw1", e-mail ID "joe.xyz.com, or a redirect reason 1. All other IRR messages are not sent to the GKTMP server application.

If the IRR registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

Then gatekeeper "alpha" checks all incoming IRR messages for the destination H.323 ID, e-mail ID, or redirect reason before checking for the E.164 address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the IRR message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" IRR trigger registration had been defined with a priority 1 instead of priority 2, then the second server trigger definition would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those IRR messages that contain a destination E.164 address starting with 1800. All other IRR messages would not be sent to the GKTMP server.

Related Commands

server trigger lcf

To configure the location confirm (LCF) trigger statically on the gatekeeper, use the server trigger lcf command in gatekeeper configuration mode. Submode commands are available after entering the server trigger lcf command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger lcf gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value
remote-ext-address e164 value

no server trigger lcf gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.

After the command is entered, the software enters a submode that permits you to configure additional filters on the RAS message. These filters are optional, and you may configure any of them, one per command line.


destination-info {e164 \| email-id \| h323-id} value	Use to send LCF RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions: •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID. •value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used:
	–A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
remote-ext-address e164 value	Use to send LCF RAS messages that contain a specified remote extension address to the GKTMP server application. •e164—Remote extension address is an E.164 address. •value—Value against which to compare the destination address in the RAS messages. The following wildcards can be used: –A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the location confirm (LCF) static server trigger. The gatekeeper checks incoming gateway LCF messages for the configured trigger information. If an incoming LCF message contains the specified trigger information, the gatekeeper sends the LCF message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the LCF message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the LCF messages, the gatekeeper sends all LCF messages to the GKTMP server application.

If the gatekeeper receives an LCF trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming LCF RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two LCF trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two LCF trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming LCF messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one LCF trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all LCF messages to GKTMP server "Server-123":

The following example configures an LCF trigger registration on gatekeeper "alpha", which send to GKTMP server "Server-west" any LCF message containing an H.323 ID "3660-gw1", e-mail ID joe.xyz.com, or a remote extension address starting with 1408. All other LCF messages are not sent to the GKTMP server application.

If the LCF registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming LCF messages for the destination H.323 ID, e-mail ID, or remote extension address 1408 before checking for the remote extension address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the LCF message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" LCF trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those LCF messages that contain a remote extension address E.164 address starting with 1800. All other LCF messages would not be sent to the GKTMP server.

Related Commands

server trigger lrj

To configure the location reject (LRJ) trigger statically on the gatekeeper, use the server trigger lrj command in gatekeeper configuration mode. Submode commands are available after entering the server trigger lrj command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger lrj gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value

no server trigger lrj gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the gatekeeper listens for messages from the external server connection.


destination-info {e164 \| email-id \| h323-id} value	Use to send LRJ RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions: •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID. •value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used:
	–A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the location reject (LRJ) static server trigger. The gatekeeper checks incoming gateway LRJ messages for the configured trigger information. If an incoming LRJ message contains the specified trigger information, the gatekeeper sends the LRJ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the LRJ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the LRJ messages, the gatekeeper sends all LRJ messages to the GKTMP server application.

If the gatekeeper receives an LRJ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming LRJ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two LRJ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two LRJ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming LRJ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one LRJ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all LRJ messages to GKTMP server "Server-123":

The following example configures an LRJ trigger registration on gatekeeper "alpha", which send to GKTMP server "Server-west" any LRJ message containing an H.323 ID "3660-gw1" or e-mail ID joe.xyz.com. All other LRJ messages are not sent to the GKTMP server application.

If the LRJ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming LRJ messages for the destination H.323 ID or email ID before checking for the E.164 address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the LRJ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" LRJ trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those LRJ messages that contain a destination E.164 address starting with 1800. All other LRJ messages would not be sent to the GKTMP server.

Related Commands

server trigger lrq

To configure the location request (LRQ) trigger statically on the gatekeeper, use the server trigger lrq command in gatekeeper configuration mode. Submode commands are available after entering the server trigger lrq command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger lrq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
destination-info {e164 | email-id | h323-id} value
redirect-reason reason-number

no server trigger lrq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


destination-info {e164 \| email-id \| h323-id} value	Use to send LRQ RAS messages containing a specified destination to the GKTMP server application. Configure one of the following conditions: •e164—Destination is an E.164 address. •email-id—Destination is an e-mail ID. •h323-id—Destination is an H.323 ID. •value—Value against which to compare the destination address in the RAS messages. For E.164 addresses, the following wildcards can be used:
	–A trailing series of periods, each of which represents a single character. –A trailing asterisk, which represents one or more characters.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
redirect-reason reason-number	Use to send LRQ RAS messages containing a specific redirect reason to the GKTMP server application. •reason-number—Range is from 0 to 65535. Currently used values are the following: –0—Unknown reason. –1—Call forwarding busy or called DTE busy. –2—Call forwarded; no reply. –4—Call deflection. –9—Called DTE out of order. –10—Call forwarding by the called DTE. –15—Call forwarding unconditionally.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the location request (LRQ) static server trigger. The gatekeeper checks incoming gateway LRQ messages for the configured trigger information. If an incoming LRQ message contains the specified trigger information, the gatekeeper sends the LRQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the LRQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the LRQ messages, the gatekeeper sends all LRQ messages to the GKTMP server application.

If the gatekeeper receives an LRQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming LRQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two LRQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two LRQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming LRQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one LRQ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all LRQ messages to GKTMP server "Server-123":

The following example configures an LRQ trigger registration on gatekeeper "alpha", which sends to GKTMP server "Server-west" any LRQ message containing an H.323 ID "3660-gw1", e-mail ID joe.xyz.com, or a redirect reason 1. Other LRQ messages are not sent to the GKTMP server application.

If the LRQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming LRQ messages for the destination H.323 ID, email ID, or redirect reason before checking for the E.164 address 1800 (for example, 18005551212). If any one of those conditions is met, the gatekeeper sends the LRQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" LRQ trigger registration had been defined with a priority 1 instead of priority 2, then the second server trigger definition would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those LRQ messages that contain a destination E.164 address starting with 1800. All other LRQ messages would not be sent to the GKTMP server.

Related Commands

server trigger rai

To configure the resources available indicator (RAI) trigger statically on the gatekeeper, use the server trigger rai command in gatekeeper configuration mode. Submode commands are available after entering the server trigger rai command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger rai gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
endpoint-type value
supported-prefix value

no server trigger rai gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


endpoint-type value	Use to send RAI RAS messages that contain a particular endpoint type to the GKTMP server application. •value—Value against which to compare the endpoint type in the RAS messages. Valid endpoint types are the following: –gatekeeper—Endpoint is an H.323 gatekeeper. –h320-gateway—Endpoint is an H.320 gateway. –mcu—Endpoint is a multipoint control unit (MCU). –other-gateway—Endpoint is another type of gateway not specified on this list.
	–proxy—Endpoint is an H.323 proxy. –terminal—Endpoint is an H.323 terminal. –voice-gateway—Endpoint is a voice gateway.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.
supported-prefix value	Use to send RAI RAS messages that contain a specific supported prefix to the GKTMP server application. •value—Value against which to compare the supported prefix in the RAS messages. The possible values are any E.164 pattern used as a gateway technology prefix. The value string can contain any of the following: 0123456789#*.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the resources available indicator (RAI) static server trigger. The gatekeeper checks incoming gateway RAI messages for the configured trigger information. If an incoming RAI message contains the specified trigger information, the gatekeeper sends the RAI message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the RAI message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the RAI messages, the gatekeeper sends all RAI messages to the GKTMP server application.

If the gatekeeper receives an RAI trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming RAI RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two RAI trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two RAI trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming RAI messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one RAI trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all RAI messages to GKTMP server "Server-123":

The following example configures an RAI trigger registration on gatekeeper "alpha", which sends to the GKTMP server "Server-west" any RAI message that contain an MCU endpoint, an H.323 proxy endpoint, or a supported prefix 1#. All other RAI messages are not sent to the GKTMP server.

If the RAI registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

Then gatekeeper "alpha" checks all incoming RAI messages for the MCU or H.323 proxy endpoint or the supported prefix 1# before checking for the supported prefix 1234*. If any one of those conditions is met, the gatekeeper sends the RAI message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" RAI trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those RAI messages that contain a supported prefix of 1234*. All other RAI messages would not be sent to the GKTMP server.

Related Commands

server trigger rrq

To configure the registration request (RRQ) trigger statically on the gatekeeper, use the server trigger rrq command in gatekeeper configuration mode. Submode commands are available after entering the server trigger rrq command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger rrq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
endpoint-type value
supported-prefix value

no server trigger rrq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


endpoint-type value	Use to send RRQ RAS messages containing a particular endpoint type to the GKTMP server application. •value—Value against which to compare the endpoint-type in the RAS messages. Valid endpoint types are the following: –gatekeeper—Endpoint is an H.323 gatekeeper. –h320-gateway—Endpoint is an H.320 gateway. –mcu—Endpoint is a multipoint control unit (MCU). –other-gateway—Endpoint is another type of gateway not specified on this list.
	–proxy—Endpoint is an H.323 proxy. –terminal—Endpoint is an H.323 terminal. –voice-gateway—Endpoint is a voice gateway.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.
supported-prefix value	Use to send RRQ RAS messages containing a specific supported prefix to the GKTMP server application. •value—Value against which to compare the supported prefix in the RAS messages. The possible values are any E.164 pattern used as a gateway technology prefix. The value string can contain any of the following: 0123456789#*.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the registration request (RRQ) static server trigger. The gatekeeper checks incoming gateway RRQ messages for the configured trigger information. If an incoming RRQ message contains the specified trigger information, the gatekeeper sends the RRQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the RRQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the RRQ messages, the gatekeeper sends all RRQ messages to the GKTMP server application.

If the gatekeeper receives an RRQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming RRQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two RRQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two RRQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming RRQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one RRQ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all RRQ messages to GKTMP server "Server-123":

The following example configures an RRQ trigger registration on gatekeeper "alpha", which sends to the GKTMP server "Server-west" any RRQ message containing an MCU endpoint, an H.323 proxy endpoint, or a supported prefix 1#. Other RRQ messages are not sent to the GKTMP server.

If the RRQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming RRQ messages for the MCU or H.323 proxy endpoint or the supported prefix 1# before checking for the supported prefix 1234*. If any one of those conditions is met, the gatekeeper sends the RRQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" RRQ trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those RRQ messages that contain a supported prefix of 1234*. All other RRQ messages would not be sent to the GKTMP server.

Related Commands

server trigger urq

To configure the unregistration request (URQ) trigger statically on the gatekeeper, use the server trigger urq command in gatekeeper configuration mode. Submode commands are available after entering the server trigger urq command. To delete a single static trigger on the gatekeeper, use the no form of this command. To delete all static triggers on the gatekeeper, use the all form of the command.

server trigger urq gkid priority server-id server-ip-address server-port

Submode Commands:

info-only
shutdown
endpoint-type value
supported-prefix value

no server trigger urq gkid priority server-id server-ip-address server-port

Syntax Description


all	Deletes all CLI-configured triggers.
gkid	Local gatekeeper identifier.
priority	Priority for each trigger. Range is from 1 to 20; 1 is the highest priority.
server-id	ID number of the external application.
server-ip-address	IP address of the server.
server-port	Port on which the Cisco IOS gatekeeper listens for messages from the external server connection.


endpoint-type value	Use to send URQ RAS messages containing a particular endpoint type to the GKTMP server application. •value—Value against which to compare the endpoint-type in the RAS messages. Valid endpoint types are the following: –gatekeeper—Endpoint is an H.323 gatekeeper. –h320-gateway—Endpoint is an H.320 gateway. –mcu—Endpoint is a multipoint control unit (MCU). –other-gateway—Endpoint is another type of gateway not specified on this list.
	–proxy—Endpoint is an H.323 proxy. –terminal—Endpoint is an H.323 terminal. –voice-gateway—Endpoint is a voice gateway.
info-only	Use to indicate to the gatekeeper that messages that meet the specified trigger parameters should be sent to the Gatekeeper Transaction Message Protocol (GKTMP) server application as notifications only and that the gatekeeper should not wait for a response from the GKTMP server application.
shutdown	Use to temporarily disable a trigger. The gatekeeper does not consult triggers in a shutdown state when determining what message to forward to the GKTMP server application.
supported-prefix value	Use to send URQ RAS messages containing a specific supported prefix to the GKTMP server application. •value—Value against which to compare the supported prefix in the RAS messages. The possible values are any E.164 pattern used as a gateway technology prefix. The value string can contain any of the following: 0123456789#*.

Defaults

Command Modes

Command History

Usage Guidelines

Use this command and its optional submode commands to configure the unregistration request (URQ) static server trigger. The gatekeeper checks incoming gateway URQ messages for the configured trigger information. If an incoming URQ message contains the specified trigger information, the gatekeeper sends the URQ message to the GKTMP server application. In addition, the gatekeeper processes the message according to its programmed instructions. If the URQ message does not contain the specified information, the gatekeeper processes the message but does not send it to the GKTMP server application.

If no submode commands are configured for the URQ messages, the gatekeeper sends all URQ messages to the GKTMP server application.

If the gatekeeper receives a URQ trigger registration message that contains several trigger conditions, the conditions are treated as "OR" conditions. In other words, if an incoming URQ RAS message meets any one of the conditions, the gatekeeper sends the RAS message to the GKTMP server.

If the gatekeeper receives two URQ trigger registration messages with the same priority for the same GKTMP server, the gatekeeper retains the second registration and discards the first one. If the gatekeeper receives two URQ trigger registration messages with different priorities for the same GKTMP server, the gatekeeper checks incoming URQ messages against the conditions on the higher priority registration before using the lower priority registration. If the gatekeeper receives more than one URQ trigger registration message with the same priority but for different GKTMP servers, the gatekeepers retains all of the registrations.

The the no form of the command removes the trigger definition from the Cisco IOS gatekeeper with all statically configured conditions under that trigger.

Examples

The following example configures a trigger registration on gatekeeper "sj.xyz.com" to send all URQ messages to GKTMP server "Server-123":

The following example configures a URQ trigger registration on gatekeeper "alpha", which sends to the GKTMP server "Server-west" any URQ message containing an MCU endpoint, an H.323 proxy endpoint, or a supported prefix 1#. Other URQ messages are not sent to the GKTMP server.

If the URQ registration message defined above for gatekeeper "alpha" is configured and the gatekeeper receives the following trigger registration:

then gatekeeper "alpha" checks all incoming URQ messages for the MCU or H.323 proxy endpoint or the supported prefix 1# before checking for the supported prefix 1234*. If any one of those conditions is met, the gatekeeper sends the URQ message to the GKTMP server "Server-west".

If the second gatekeeper "alpha" URQ trigger registration had been defined with a priority 1 instead of priority 2, then the second trigger registration would have overridden the first one. In other words, the gatekeeper "alpha" would send to GKTMP server "Server-west" only those URQ messages that contain a supported prefix of 1234*. All other URQ messages would not be sent to the GKTMP server.

Related Commands

service

To load and configure a specific, standalone application on a dial peer, use the service command in application configuration mode. To remove the application from the dial peer, use the no form of this command.

Syntax Description


alternate	(Optional) Alternate service to use if the service that is configured on the dial peer fails.
default	(Optional) Specifies that the default service ("DEFAULT") on the dial peer is used if the alternate service fails.
service-name	Name that identifies the voice application. This is a user-defined name and does not have to match the script name.
location	Directory and filename of the Tcl script or VoiceXML document in URL format. For example, flash memory (flash:filename), a TFTP (tftp://../filename) or an HTTP server (http://../filename) are valid locations

Defaults

Command Modes

Command History

Usage Guidelines

Use this command to load a service on the gateway. A service is a standalone application, such as a VoiceXML document or a Tcl script.

Examples

The following example shows a debitcard application configured on the dial peer.

Related Commands


Command	Description
application (application configuration)	Configure an application on a dial peer.
call application alternate	Specifies an alternate application to use if the application that is configured in the dial peer fails.
call application voice	Defines the name of a voice application and specify the location of the Tcl or VoiceXML document to load for this application.

service local-directory

To enable the availability of the local directory service on IP phones served by Cisco IOS Telephony Service (ITS), use the service local-directory command in telephony service configuration mode. To disable the display, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

The following example specifies that the directory service should not be available on the IP phones served by this ITS router:

Related Commands

service-relationship

To enter Annex G neighbor configuration mode and enable service relationships for the particular neighbor, use the service-relationship command in Annex G neighbor configuration mode. To exit this mode, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Service relationships are defined to be unidirectional. If a service relationship is established between border element A and border element B, A is entitled to send requests to B and to expect responses. For B to send requests to A and to expect responses, a second service relationship must be established. Repeat this command for each border-element neighbor that you configure.

Note The no shutdown command must be used to enable each service relationship.

Examples

Related Commands


Command	Description
access-policy	Requires that a neighbor be explicitly configured.
inbound ttl	Sets the inbound time-to-live value.
outbound retry-interval	Defines the retry period for attempting to establish the outbound relationship between border elements.
retry interval	Defines the time between delivery attempts.
retry window	Defines the total time for which a border element attempts delivery.
shutdown	Enables or disables the border element.

service-type call-check

To identify preauthentication requests to the authentication, authorization, and accounting (AAA) server, use the service-type call-check command in AAA preauthentication configuration mode. To return this setting to the default, use the no form of this command.

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Setting the service-type attribute to call-check causes preauthentication access requests to include this value, which allows AAA servers to distinguish preauthentication requests from other types of Access-Requests. This command has no effect on packets that are not of the preauthentication type.

Release	Modification
12.2(11)YT	This command was introduced.
12.2(15)T	This command was integrated into Cisco IOS Release 12.2(15)T.

Table Of Contents

Cisco IOS Voice Commands:S

sccp

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp ccm

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp ccm group

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp ip precedence

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp local

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sccp switchback timeout guard

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sctp

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

security

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

security acl answerarq

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Examples

Related Commands

sequence-numbers

Syntax Description

Defaults

Command Modes

Command History

Usage Guidelines

Cisco IOS Voice Commands:
S