Cisco IOS XR Session Border Controller Command Reference, Release 3.7
SBC Session Initiation Protocol Commands on Cisco IOS XR Software

Table Of Contents

SBC Session Initiation Protocol Commands on Cisco IOS XR Software

blacklist (SBC SBE SIP)

description (SBC SBE SIP)

header (SBC SBE SIP)

hold-media-timeout

invite-timeout (SBC SBE SIP)

method (SBC SBE SIP)

pass-body (SBC SBE SIP)

redirect-limit

redirect-mode

show services sbc sbe redirect-limit

show services sbc sbe sip essential-headers

show services sbc sbe sip essential-methods

show services sbc sbe sip essential-options

show services sbc sbe sip header-profile

show services sbc sbe sip header-profiles

show services sbc sbe sip hunting-trigger

show services sbc sbe sip method-profile

show services sbc sbe sip method-profiles

show services sbc sbe sip timers

sip encryption key

sip header-profile (SBC SBE SIP)

sip home network identifier (SBC SBE SIP)

sip hunting-trigger (SBC SBE SIP)

sip inherit profile (SBC SBE SIP)

sip max-connections

sip method-profile (SBC SBE SIP)

sip option-profile (SBC SBE SIP)

sip timer (SBC SBE SIP)

tcp-connect-timeout (SBC SBE SIP)

tcp-idle-timeout (SBC SBE SIP)

tls-idle-timeout (SBC SBE SIP)

udp-first-retransmit-interval (SBC SBE SIP)

udp-max-retransmit-interval (SBC SBE SIP)

udp-response-linger-period (SBC SBE SIP)


SBC Session Initiation Protocol Commands on Cisco IOS XR Software


This module describes the Session Initiation Protocol (SIP) commands used to configure and monitor the Session Border Controller (SBC).

For detailed information about SBC concepts, configuration tasks, and examples, refer to Cisco IOS XR Session Border Controller Configuration Guide.

blacklist (SBC SBE SIP)

To configure SIP header or method blacklist profiles on a Session Initiation Protocol (SIP) message, use the blacklist command in the appropriate configuration mode. To configure the profile as a whitelist, use the no form of this command.

blacklist

no blacklist

Syntax Description

This command has no arguments or keywords.

Defaults

The profile is a whitelist.

Command Modes

SBE SIP header-profile configuration

SBE SIP method configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to use the blacklist command to configure the SIP header profile test1 as a blacklist:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip header-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr)# blacklist

The following example shows how to use the blacklist command to configure the SIP method profile test1 as a blacklist:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-mth)# blacklist

Related Commands

Command
Description

sip header-profile (SBC SBE SIP)

Configures a header profile in the mode of an SBE entity.

sip method-profile (SBC SBE SIP)

Configures a method profile in the mode of an SBE entity.


description (SBC SBE SIP)

To configure the description for the SIP header-profile or SIP method-profile, use the description command in the appropriate configuration mode. To remove this configuration, use the no form of this command.

description description

no description description

Syntax Description

description

Description of the object you are describing for the SIP header-profile or SIP method-profile.


Defaults

No default behavior or values

Command Modes

SBE SIP header configuration

SBE SIP method configuration

Command History

Release
Modification

Release 3.3.0

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.4.0

No modification.

Release 3.4.1

This command was modified on the Cisco XR 12000 Series Router to add the following configuration modes:

SIP header configuration

SIP method configuration

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to add description text "myheaderprofile" for SIP header profile Profile1:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip header-profile Profile1
RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr)# description "myheaderprofile"

The following example shows how to add description text "mymethodprofile" for SIP method profile Profile1:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile Profile1
RP/0/0/CPU0:router(config-sbc-sbe-sip-mth)# description "mymethodprofile"

Related Commands

Command
Description

sip header-profile (SBC SBE SIP)

Configures a header profile in the mode of an SBE entity.

sip method-profile (SBC SBE SIP)

Configures a method profile in the mode of an SBE entity.


header (SBC SBE SIP)

To add a header with a specified name to a SIP message profile, use the header command in SBE SIP header-profile configuration mode. To remove the method from the profile, use the no form of this command.

header {header name}

no header {header name}

Syntax Description

header name

Name of the header added to the header profile. Valid names are 1 to 32 characters in length (inclusive) and are case-sensitive.


Defaults

No default behavior or values

Command Modes

SIP header-profile configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how the header command adds a header test to the header profile MyProfile:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip header-profile MyProfile
RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr-prf)# header test

Related Commands

Command
Description

blacklist (SBC SBE SIP)

Configures SIP header or method blacklist profiles on a Session Initiation Protocol (SIP) message.

description (SBC SBE SIP)

Configures descriptive text for a SIP header.


hold-media-timeout

To configure the length of time SBE waits after receiving a media timeout notification from the DBE for an on-hold call before tearing down that call, use the hold-media-timeout command in SBE configuration mode. To return to the default value, use the no form of this command.

hold-media-timeout {timeout-value}

no hold-media-timeout

Syntax Description

timeout-value

Time, in seconds, that the SBE waits before ending an on hold call. The range is from 1 to 2000000. Unless you set a specific duration, on-hold calls never time out.


Defaults

This command is not enabled.

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the SBE on-hold timeout value to 200 seconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# hold-media-timeout 200

invite-timeout (SBC SBE SIP)

To configure the time that SBC waits for a final response to an outbound SIP invite request, use the invite-timeout command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

invite-timeout {interval-value}

no invite-timeout

Syntax Description

interval-value

Time, in seconds, SBC waits before timing out an outbound invite request.


Defaults

The default wait interval is 180 seconds. If no response is received during that time, an internal 408 request timeout response is generated and is sent to the caller.

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the SBC to time out invite transactions after 60 seconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe) sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-tmr) # invite-timeout 60

Related Commands

Command
Description

udp-response-linger-period (SBC SBE SIP)

Configures the time period that SBC retains negative UDP responses to invite requests.


method (SBC SBE SIP)

To add a method with a specified name to a SIP message profile, use the method command in SBE SIP method configuration mode. To remove the method from the profile, use the no form of this command.

method {method name}

no method {method name}

Syntax Description

method name

Name of the method added to the method profile. Valid names are 1 to 32 characters in length (inclusive) and are case-sensitive.


Defaults

No default behavior or values

Command Modes

SBE SIP method configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to add a method test to the method profile MyProfile:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile MyProfile
RP/0/0/CPU0:router(config-sbc-sbe-sip-mth)# method test

Related Commands

Command
Description

blacklist (SBC SBE SIP)

Configures SIP header or method blacklist profiles on a Session Initiation Protocol (SIP) message.

description (SBC SBE SIP)

Configures the description for the SIP header-profile or SIP method-profile.

pass-body (SBC SBE SIP)

Permits SIP message bodies to pass through [for non-vital SIP methods accepted by a method profile] in the SIP method profile mode of an SBE entity.

sip method-profile (SBC SBE SIP)

Configures a method profile in the mode of an SBE entity.


pass-body (SBC SBE SIP)

To permit SIP message bodies to pass through [for non-vital SIP methods accepted by a method profile] in the SIP method profile mode of an SBE entity, use the pass-body command in SBE SIP method configuration mode. To remove the message bodies out of nonvital SIP messages accepted by the method profile, use the no form of this command.

pass-body

no pass-body

Syntax Description

This command has no arguments or keywords.

Defaults

By default, the message bodies are removed out of non-vital SIP messages.

Command Modes

SBE SIP method configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to permit SIP message bodies to pass through for non-vital SIP methods accepted by method profile test1:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-mth)# pass-body

Related Commands

Command
Description

sip method-profile (SBC SBE SIP)

Configures a method profile in the mode of an SBE entity.


redirect-limit

To configure the maximum number of redirections that SBC performs on a call, use the redirect-limit command in SBE configuration mode. To return to the adjacency for the default behavior, use the no version of this command.

redirect-limit {limit}

no redirect-limit {limit}

Syntax Description

limit

Maximum number of SIP 3xx retry attempts. The range is 0 to 200.


Defaults

The default number of redirections is 2.

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the maximum number of SIP 3xx retries as 4:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# redirect-limit 4

Related Commands

Command
Description

redirect-mode

Configures the behavior of SBC on receipt of a 3xx response to an invite from the SIP adjacency.


redirect-mode

To configure the behavior of SBC on receipt of a 3xx response to an invite from the SIP adjacency, use the redirect-mode command in SBE adjacency SIP configuration mode. To return the adjacency to the default behavior, use the no version of this command.

redirect-mode {pass-through | recurse}

no redirect-mode {pass-through | recurse}

Syntax Description

pass-through

Passes all 3xx responses back to the caller.

recurse

Resends the invite to the first listed contact address, or else passes the 3xx responses back on 300, 301, 302 and 305 invite responses.


Defaults

The pass-through keyword.

Command Modes

SBE adjacency SIP configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to resend an invite to the first listed contact address or else pass the 3xx responses back to the sender:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# adjacency sip test1
RP/0/0/CPU0:router(config-sbc-sbe-adj-sip)# redirect-mode recurse

Related Commands

Command
Description

redirect-limit

Configures the maximum number of redirections SBC performs on a call.


show services sbc sbe redirect-limit

To display the current limit on the maximum number of redirections that a call can undergo, use the show services sbc sbe redirect-limit command in EXEC mode.

show services sbc sbc-name sbe redirect-limit

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output displays the limit on the maximum number of redirections that a call can undergo:

RP/0/0/CPU0:router# show service sbc mysbc sbe redirect-limit
Call redirect limit is 4

show services sbc sbe sip essential-headers

To display a list of the essential SIP headers, use the show services sbc sbe sip essential-headers command in EXEC mode.

show services sbc sbc-name sbe sip essential-headers

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows a list of all essential headers:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip essential-headers
Vital headers:
        AUTHORIZATION CALL-ID CONTACT CONTENT-LENGTH 
        CONTENT-TYPE CSEQ EVENT EXPIRES FROM MAX-FORWARDS 
        MIN-EXPIRES PROXY-AUTHORIZATION 
        PROXY-AUTHENTICATE PROXY-REQUIRE RACK 
        RECORD-ROUTE REFERRED-BY REFER-TO REPLACES 
        REQUIRE ROUTE RSEQ SUBSCRIPTION-STATE SUPPORTED 
        TO VIA WWW-AUTHENTICATE 

Related Commands

Command
Description

show services sbc sbe sip header-profiles

Displays a list of all configured SIP header profiles.


show services sbc sbe sip essential-methods

To display a list of the essential SIP methods, use the show services sbc sbe sip essential-methods command in EXEC mode.

show services sbc sbc-name sbe sip essential-methods

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows how to display a list of all essential methods:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip essential-methods
Essential methods:
        ACK BYE CANCEL INVITE NOTIFY PRACK REFER REGISTER 
        SUBSCRIBE 

Related Commands

Command
Description

show services sbc sbe sip method-profiles

Displays a list of all SIP method profiles.


show services sbc sbe sip essential-options

To display a list of the essential SIP options, use the show services sbc sbe sip essential-options command in EXEC mode.

show services sbc sbc-name sbe sip essential-options

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.7.0

This command was introduced on the Cisco XR 12000 Series Router.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows how to display a list of all essential options:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip essential-options
Essential options:
        100REL 

Related Commands

Command
Description

show services sbc sbe sip method-profiles

Displays a list of all SIP method profiles.


show services sbc sbe sip header-profile

To display details of the specified SIP header profile, use the show services sbc sbe sip header-profile command in EXEC mode.

show services sbc sbc-name sbe sip header-profile {profile-name}

Syntax Description

sbc-name

Name of the SBC service.

profile-name

Name of the header profile. If you enter the name default, the details of the default header profile are displayed.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows how to display details of the specified header profile:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip header-profile Profile1
Header profile "Profile1"
Type:    Blacklist
Headers:
       Myheader
In use by:
       Adjacency:SipAdj1

Table 19 describes the significant fields shown in the display.

Table 19 show services sbc sbe sip header-profile Field Descriptions 

Field
Description

Type

Whether the profile is permissive (whitelist) or restrictive (blacklist).

Headers

List of headers that are being controlled by this profile.

In use by

List of adjacencies using this profile.


Related Commands

Command
Description

show services sbc sbe sip header-profiles

Displays a list of all configured SIP header profiles.


show services sbc sbe sip header-profiles

To display a list of all configured SIP header profiles, use the show services sbc sbe sip header-profiles command in EXEC mode.

show services sbc sbc-name sbe sip header-profiles

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows a list of all configured header profiles:

RP/0/0/CPU0:router# show services sbc test sbe sip header-profiles
Header profiles for SBC service ''test''
  Name                          In use
  ====================================
Profile1                       Yes  default                        Yes
  preset-acc-in-hdr              No
  preset-std-in-hdr              No
  preset-acc-out-hdr             No
  preset-core-in-hdr             No
  preset-std-out-hdr             No
  preset-core-out-hdr            No
  preset-ipsec-in-hdr            No
  preset-ipsec-out-hdr           No
  preset-ibcf-ext-in-hdr         No
  preset-ibcf-int-in-hdr         No
  preset-ibcf-utr-in-hdr         No
  preset-ibcf-ext-out-hdr        No
  preset-ibcf-int-out-hdr        No
  preset-ibcf-utr-out-hdr        No

Table 20 describes the significant fields shown in the display.

Table 20 show services sbc sbe sip header-profiles Field Descriptions 

Field
Description

Name

List of defined header profiles.

In use

Whether any adjacency is using the corresponding profile


Related Commands

Command
Description

show services sbc sbe sip header-profile

Displays details of the specified SIP header profile.


show services sbc sbe sip hunting-trigger

To display the SIP hunting triggers, use the show services sbc sbe hunting-trigger command in EXEC mode.

show services sbc sbc-name sbe {sip} hunting-trigger

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows sample data for the media timeout timer for on-hold calls:

RP/0/0/CPU0:router#show services sbc mysbc sbe sip hunting-trigger
SIP Hunting Triggers
--------------------
415 480

show services sbc sbe sip method-profile

To display details of the specified SIP method profile, use the show services sbc sbe sip method-profile command in EXEC mode.

show services sbc sbc-name sbe sip method-profile {profile-name}

Syntax Description

sbc-name

Name of the SBC service.

profile-name

Name of the method profile. If you enter the profile-name default, the details of the default method profile are displayed.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows the details of the specified method profile:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip method-profile Profile1
Method profile "Profile1"
Type:    Blacklist
Methods:
      Method1
    In use by:
       Not in use with any adjacencies

Table 21 describes the significant fields shown in the display.

Table 21 show services sbc sbe sip method-profile Field Descriptions 

Field
Description

Type

Whether the profile is permissive (whitelist) or restrictive (blacklist).

Methods

List of headers that are being controlled by this profile.

In use by

List of adjacencies using this profile.


Related Commands

Command
Description

show services sbc sbe sip method-profiles

Displays a list of all configured SIP method profiles.


show services sbc sbe sip method-profiles

To display a list of all SIP method profiles, use the show services sbc sbe sip method-profiles command in EXEC mode.

show services sbc sbc-name sbe sip method-profiles

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows a list of all configured method profiles:

RP/0/0/CPU0:router# show services sbc mySbc sbe sip method-profiles
Name In use 
==================================== 
Profile1 Yes 
default Yes 
preset-acc-in-mth No 
preset-std-in-mth No 
preset-acc-out-mth No 
preset-core-in-mth No 
preset-std-out-mth No 
preset-core-out-mth No 
preset-ipsec-in-mth No 
preset-ipsec-out-mth No 
preset-ibcf-ext-in-mth No 
preset-ibcf-int-in-mth No 
preset-ibcf-utr-in-mth No 
preset-ibcf-ext-out-mth No 
preset-ibcf-int-out-mth No 
preset-ibcf-utr-out-mth No 

Table 22 describes the significant fields shown in the display.

Table 22 show services sbc sbe sip method-profiles Field Descriptions 

Field
Description

Name

List of defined header profiles.

In use

Whether any adjacency is using the corresponding profile


Related Commands

Command
Description

show services sbc sbe sip method-profile

Displays details of the specified SIP method profile.


show services sbc sbe sip timers

To display the current configuration of SIP-related timers, use the show services sbc sbe sip timers command in EXEC mode.

show services sbc sbc-name sbe sip timers

Syntax Description

sbc-name

Name of the SBC service.


Defaults

No default behavior or values

Command Modes

EXEC

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read


Examples

The following sample output shows how to list the configurations of SIP-related timers:

RP/0/0/CPU0:router# show services sbc mysbc sbe sip timers
SIP timer configuration:
TCP connect timeout: 0 ms
TCP idle timeout: 120000 ms
TLS idle timeout: 3600000 ms
invite timeout: 180 s
UDP first retransmit interval: 500 ms
UDP max retransmit interval: 4000 ms
UDP response linger period: 5000 ms

Table 23 describes the significant fields shown in the display.

Table 23 show services sbc sbe sip timers Field Descriptions 

Field
Description

TCP connect timeout

Time to wait for the SIP-TCP remote endpoint to complete connection.

TCP idle timeout

Time to wait for the SIP-TCP connection to remain idle.

TLS idle timeout

Time to wait for the SIP-TLS connection to remain idle.

invite timeout

Time to wait for the terminating endpoint to respond to the INVITE message.

UDP first retransmit interval

First time interval to wait before starting retransmission.

UDP max retransmit interval

Maximum time interval to wait before starting retransmission.

UDP response linger period

Time for SBC to retain negative UDP responses to invite requests.


Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.


sip encryption key

To configure a global encryption key on a SIP IBCF adjacency, use the sip encryption key command in the SBE configuration mode. To deconfigure the global encryption key, use the no form of this command.

sip encryption key {key}

no sip encryption key {key}

Syntax Description

key

Name of the encryption key.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.5.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure global encryption key on a SIP IBCF adjacency:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip encryption key code1

Related Commands

Command
Description

sip inherit profile (SBC SBE SIP)

Configures a default profile that is inherited by all adjacencies.


sip header-profile (SBC SBE SIP)

To configure a header profile in the mode of an SBE entity, use the sip header-profile command in SBE configuration mode. To remove the header profile, use the no form of this command.

sip header-profile {profile-name | default}

no sip header-profile

Syntax Description

profile name

Name of the header profile.

default

Configures the default header profile for an SBE entity. Unless specified, all adjacencies use the default profile. However, SBC allows the default profile to be modified, which lets all adjacencies to have modified the default profile.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Use the sip header-profile command to enter SBE SIP header configuration mode.

If you enter the default keyword, the default profile is configured. This profile is used for all adjacencies which do not have a specific profile configured.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure a header profile with the name of test1:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip header-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-hdr)#

Related Commands

Command
Description

sip method-profile (SBC SBE SIP)

Configures a method profile in the mode of an SBE entity.


sip home network identifier (SBC SBE SIP)

To configure a home network identifier on a SIP Proxy Call Session Controller Function (P-CSCF) adjacency, use the sip home network identifier command in SBE configuration mode. To deconfigure the visited network identifier, use the no form of this command.

sip home network identifier {domain-name}

no sip home network identifier

Syntax Description

domain-name

Name of the visited network identifier.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.5.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to use the sip home network identifier command to configure a home network identifier on a P-CSCF-access adjacency.

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip home network identifier cisco.com2

Related Commands

Command
Description

home network identifier (SBC SBE adjacency)

Configures a home network identifier on all SIP IBCG adjacencies.


sip hunting-trigger (SBC SBE SIP)

To configure failure SIP return codes to trigger hunting, use the sip hunting-trigger command in SBE configuration mode. To clear all error codes, use the no form of this command.

sip hunting-trigger {error-codes}

no sip hunting-trigger {error-codes}

Syntax Description

error-codes

Space-separated list of SIP numeric error codes.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

If you enter sip hunting-trigger x followed by sip hunting-trigger y, the value of x is replaced with y.

To set both x and y to be hunting triggers, you must enter sip hunting-trigger x y command.

If you enter the no version of this command with codes x and y, these codes are removed from the configured list.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure SIP to retry routing if it receives a 415 (media unsupported) or 480 (temporarily unavailable) error:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router (config-sbc-sbe)# sip hunting trigger 416 480

Related Commands

Command
Description

show services sbc sbe sip hunting-trigger

Displays the SIP hunting triggers.


sip inherit profile (SBC SBE SIP)

To configure a default profile that is inherited by all adjacencies, use the sip inherit profile command in SBE configuration mode. To deconfigure the default profile, use the no form of this command.

sip inherit profile {preset -ibcf-ext-untrusted | preset -ibcf-external | preset -ibcf-internal | preset-p-cscf-access | preset-p-cscf-core | preset-standard-non-ims}

no sip inherit profile

Syntax Description

preset-ibcf-ext-untrusted

Specifies a preset IBCF untrusted profile

preset-ibcf-external

Specifies a preset IBCF external profile

preset-ibcf-internal

Specifies a presetIBCF internal profile

preset-p-cscf-access

Specifies a preset P-CSCF-access profile

preset-p-cscf-core

Specifies a preset P-CSCF-core profile

preset-standard-non-ims

Specifies a preset standard-non-IMS profile


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.5.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure a P-CSCF-access default profile:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip inherit profile preset-p-cscf-access

Related Commands

Command
Description

inherit profile (SBC SBE adjacency SIP)

Configures a global inherit profile.


sip max-connections

To configure the maximum number of SIP connections that are allowed, use the sip max-connections command in SBE configuration mode. To disable this feature, use the no form of this command.

sip max-connections {connections}

no sip max-connections {connections}

Syntax Description

connections

Number of maximum connections. The range is from 0 to 4294967295.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.7.0

This command was introduced on the Cisco XR 12000 Series Router.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

If not specified, no limit is set on the number of existing SIP connections.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the maximum number of SIP connections:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip max-connections 500

sip method-profile (SBC SBE SIP)

To configure a method profile in the mode of an SBE entity, use the sip method-profile command in SBE configuration mode. To remove the method profile, use the no form of this command.

sip method-profile {profile-name | default}

no sip method-profile

Syntax Description

profile name

Name of the method profile.

default

Configures the default method profile.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Use the sip method-profile command to enter SBE SIP method configuration mode.

If you use the default keyword, the default profile is configured. This profile is used for all adjacencies which do not have a specific profile configured.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure a method profile with the name of test1.

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-mth)#

sip option-profile (SBC SBE SIP)

To configure a option profile in the mode of an SBE entity for a SIP option whitelist or blacklist profile, use the sip option-profile command in SBE configuration mode. To remove the option profile, use the no form of this command.

sip option-profile {profile-name | default}

no sip option-profile {profile-name | default}

Syntax Description

profile name

Name of the method profile.

default

Configures the default option profile.


Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.7.0

This command was introduced on the Cisco XR 12000 Series Router.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Use the sip option-profile command to enter SBE SIP option configuration mode.

If you use the default keyword, the default profile is configured. This profile is used for all adjacencies which do not have a specific profile configured.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure a option profile with the name of test1.

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip method-profile test1
RP/0/0/CPU0:router(config-sbc-sbe-sip-opt)#

Related Commands

Command
Description

blacklist (SBC SBE SIP)

Configures SIP header or method blacklist profiles on a Session Initiation Protocol (SIP) message.

description (SBC SBE SIP)

Configures the description for the SIP header-profile or SIP method-profile.

method (SBC SBE SIP)

Adds a method with a specified name to a SIP message profile.

pass-body (SBC SBE SIP)

Permits SIP message bodies to pass through [for non-vital SIP methods accepted by a method profile] in the SIP method profile mode of an SBE entity.


sip timer (SBC SBE SIP)

To enter SIP timer configuration mode, use the sip timer command in SBE configuration mode. To return to the default value, use the no form of this command.

sip timer

no sip timer

Syntax Description

This command has no arguments or keywords.

Defaults

No default behavior or values

Command Modes

SBE configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Use the sip timer command to enter SBE SIP timer configuration mode.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to enter SBE SIP timer configuration mode:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-tmr)

Related Commands

Command
Description

show services sbc sbe sip timers

Displays the current configuration of SIP-related timers.


tcp-connect-timeout (SBC SBE SIP)

To configure the time that SBC waits for a SIP TCP connection to a remote peer to complete before failing that connection, use the tcp-connect-timeout command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

tcp-connect-timeout interval

no tcp-connect-timeout

Syntax Description

interval

Time, in milliseconds, that the SIP TCP connection to a remote peer stays alive before timing out. The range is from 1 to 30000.


Defaults

Default interval is 30000 milliseconds.

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to set the TCP connection timeout to 30 seconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mySbc 
RP/0/0/CPU0:router(config-sbc)# sbe 
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-tmr)# tcp-connect-timeout 30000

Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.

show services sbc sbe sip timers

Displays the current configuration of SIP-related timers.

tcp-idle-timeout (SBC SBE SIP)

Configures the length of time that the TCP connection should stay active when in the idle state.


tcp-idle-timeout (SBC SBE SIP)

To configure the length of time that the TCP connection should stay active when in the idle state, use the tcp-idle-timeout command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

tcp-idle-timeout {interval}

no tcp-idle-timeout

Syntax Description

interval

Minimum time, in milliseconds, that the TCP connection stays active when it is not processing any traffic. After this time, the TCP connection closes. The range is from 1 to 4294967295.

Note The value for this command might not be precise since the idle timers are checked every 12 seconds.


Defaults

Default value is 120000 ms (2 minutes).

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the minimum TCP idle timeout value to 10000 ms:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mysbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-tmr)# tcp-idle-timeout 10000

Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.

show services sbc sbe sip timers

Displays the current configuration of SIP-related timers.

tcp-connect-timeout (SBC SBE SIP)

Configures the time that SBC waits for a SIP TCP connection to a remote peer to complete before failing that connection.


tls-idle-timeout (SBC SBE SIP)

To configure the minimum time that a TLS socket can remain idle before it is closed, use the tls-idle-timeout command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

tls-idle-timeout {interval}

no tls-idle-timeout

Syntax Description

interval

Time, in milliseconds, that a TLS socket can remain idle before it is closed. The range is from 1 to 4,294,967,295.


Defaults

Default TLS idle timeout interval is 3600000 ms (1 hour).

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to configure the SBC to close TLS connections that have been idle for at least 30 minutes:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mysbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-timr) # tls-idle-timeout 1800000

Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.

show services sbc sbe sip timers

Displays the current configuration of SIP-related timers.


udp-first-retransmit-interval (SBC SBE SIP)

To configure the time that SBC waits for a UDP response or acknowledgement before sending the first retransmission of the relevant signal, use the udp-first-retransmit-interval command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

udp-first-retransmit-interval {interval}

no udp-first-retransmit-interval

Syntax Description

interval

Time interval, in milliseconds, that SBC waits for a response or acknowledgement before sending the first retransmission of a UDP signal. The range is from 1 to 4294967295.


Defaults

Default first UDP retransmission interval is 500 milliseconds.

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

If UDP response failure continues, SBC doubles subsequent retransmission intervals each time until the intervals reach a maximum that you set using the udp-max-retransmit-interval command.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following command shows how to configure the SBC to send the first UDP retransmission after waiting for 1000 milliseconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mysbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-timr) # udp-first-retransmit-interval 1000

Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.

udp-max-retransmit-interval (SBC SBE SIP)

Configures the maximum interval SBC waits before retransmitting a UDP signal.


udp-max-retransmit-interval (SBC SBE SIP)

To configure the maximum time interval that SBC waits before retransmitting a UDP signal, use the udp-max-retransmit-interval command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

udp-max-retransmit-interval {interval}

no udp-max-retransmit-interval

Syntax Description

interval

Maximum time interval, in milliseconds, that SBC waits before retransmitting a signal. The range is from 1 to 4294967295.


Defaults

Default maximum UDP retransmission interval is 4 seconds

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to set the SBC maximum retransmission interval to 8 seconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mysbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-timr)# udp-max-retransmit-interval 8000

Related Commands

Command
Description

sip timer (SBC SBE SIP)

Enters SIP timer configuration mode.

udp-first-retransmit-interval (SBC SBE SIP)

Configures the time that SBC waits for a UDP response or acknowledgement before sending the first retransmission of the relevant signal.


udp-response-linger-period (SBC SBE SIP)

To configure the time period that SBC retains negative UDP responses to invite requests, use the udp-response-linger-period command in SBE SIP timer configuration mode. To return to the default value, use the no form of this command.

udp-response-linger-period {interval}

no udp-response-linger-period

Syntax Description

interval

Time period, in milliseconds, during which SBC retains negative UDP responses to invite requests.


Defaults

Default UDP response linger period is 32000 milliseconds.

Command Modes

SBE SIP timer configuration

Command History

Release
Modification

Release 3.4.1

This command was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Release 3.7.0

No modification.


Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.

If a configuration is loaded on top of an active configuration, warnings are generated to notify that the configuration cannot be modified. If you must modify the entire configuration by loading a new one, please remove the existing configuration first.

All retransmitted responses, which are received within this time period, are answered with a negative acknowledgement. Any further retransmitted responses are ignored.

Task ID
Task ID
Operations

sbc

read, write


Examples

The following example shows how to set SBC to retain negative UDP responses for 10000 milliseconds:

RP/0/0/CPU0:router# configure
RP/0/0/CPU0:router(config)# sbc mysbc
RP/0/0/CPU0:router(config-sbc)# sbe
RP/0/0/CPU0:router(config-sbc-sbe)# sip timer
RP/0/0/CPU0:router(config-sbc-sbe-sip-tmr)# udp-response-linger-period 10000

Related Commands

Command
Description

invite-timeout (SBC SBE SIP)

Configures the time that SBC waits for a final response to an outbound SIP invite request.