CSCF Routes Configuration Mode Commands


CSCF Routes Configuration Mode Commands
 
 
The CSCF Routes Configuration Mode is used to configure session forwarding within the system.
 
Important: The commands or keywords/variables that are available are dependent on platform type, product version, and installed license(s).
 
after
Places the CSCF route entry at the bottom or end of the route list. Use this command in conjunction with the route command.
Product
SCM (P-CSCF, S-CSCF, SIP Proxy)
Privilege
Administrator
Syntax
after
Usage
Add this command before the route command to place the entry at the end of the route list.
 
before
Places the CSCF route entry at the top or beginning of the route list. Use this command in conjunction with the route command.
Product
SCM (P-CSCF, S-CSCF, SIP Proxy)
Privilege
Administrator
Syntax
before
Usage
Add this command before the route command to place the entry at the beginning of the route list.
 
end
Exits the current mode and returns to the Exec Mode.
Product
All
Privilege
Administrator
Syntax
end
Usage
Change the mode back to the Exec mode.
 
exit
Exits the current mode and returns to the previous mode.
Product
All
Privilege
Administrator
Syntax
exit
Usage
Return to the previous mode.
 
route
Configure the routing parameters for the context.
Product
SCM (P-CSCF, S-CSCF, SIP Proxy)
Privilege
Administrator
Syntax
route { domain name | local { icscf | pcscf | scscf } | nexthop-address address | peer-servers group_name | vpn name } [ [ mod-req-uri ] base-criteria criteria [ filter-criteria1 criteria ] [ filter-criteria2 criteria ] ] [ log ]
no route { domain name | local { icscf | pcscf | scscf } | nexthop-address address | peer-servers group_name | vpn name } base-criteria criteria [ filter-criteria1 criteria ] [ filter-criteria2 criteria ]
domain name
Specifies a valid next-hop domain name. name must be from 1 to 79 alpha and/or numeric characters in length.
local { icscf | pcscf | scscf }
Specifies a local interrogating, serving, or proxy call/session control function to which all calls processed by the context will be routed.
nexthop-address ip_address
Specifies a next-hop address.
ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
peer-servers group_name
Specifies a configured peer server group.
group_name must be the name of a configured peer server group on this system.
vpn name
Specifies a configured VPN context on the system.
name must be a configured context name.
mod-req-uri
Specifies that a route lookup should be performed and the request URI modified.
base-criteria criteria
Specifies the base criteria that packets will be compared against. The following criteria is supported:
access-type type: Filters sessions based on a specific access-type used by the subscriber. Possible access types are:
3gpp-geran: 3GPP Access Type
3gpp-utran-fdd: 3GPP Access Type
3gpp-utran-tdd: 3GPP Access type
3gpp2-1x: 3GPP2 Access Type
3gpp2-1x-hrpd: 3GPP2 Access Type
3gpp2-umb: 3GPP2-UMB
adsl: FixedLine Access Type
adsl2: FixedLine Access Type
adsl2p: FixedLine Access Type ADSL2+
docsis: DOCSIS
gshdsl: Fixed Line Access Type G.SHDSL
hdsl: Fixed Line Access Type
hdsl2: Fixed Line Access Type
idsl: Fixed Line Access Type
ieee-80211: WLAN Access Type
ieee-80211a: WLAN Access Type
ieee-80211b: WLAN Access Type
ieee-80211g: WLAN Access Type
ieee-80216e: Wireless MAN Access Type
radsl: Fixed Line Access Type
sdsl: Fixed Line Access Type
vdsl: Fixed Line Access Type
any: Filters all CSCF sessions.
carrier-id name: Filters sessions based on the carrier’s ID. name must be from 1 to 79 alpha and/or numeric characters in length.
destination aor aor: Filters sessions based on the destination AoR. aor must be an existing AoR from 1 to 79 characters in length.
Important: The destination aor and carried-id criteria cannot occur in the same route rule.
plmn-id mcc mcc_code mnc mnc_code: Filters sessions based on the mobile country and network codes. mcc_code must be a three-digit integer from 200 to 999. mnc_code must be a two or three-digit integer from 00 to 999.
source address ip_address: Filters sessions based on source IP address. ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
source aor aor: Filters sessions based on the source AoR. aor must be an existing AoR from 1 to 79 characters in length.
time-of-day: Filters sessions based on the time of the day. Additional filter criteria for time-of-day is as follows:
day-of-month day: Filters session based on the day of the month. day must be an integer from 1 to 31.
day-of-week day: Filters session based on the day of the week. day must be an integer from 1 to 7 with 1 signifying Sunday and 7 signifying Saturday.
start date/time [ end date/time ]: Filters sessions based on a start time to, optionally, an end time during the day. date/time must be integers in either of the following formats: YYYY:MM:DD:HH:mm or YYYY:MM:DD:mm:ss. YYYY: year range 2005 to 2099 MM: months (integer range 1 to 12) DD: days (integer range 1 to 31) HH: hours (integer range 0 to 23) mm: minutes (integer range 0 to 59) ss: seconds (integer range 0 to 59)
week-of-month week: Filters sessions based on the week of the month. week must be an integer from 1 to 5.
Important: AoR regular expressions are supported. Refer to the SCM Engineering Rules Appendix in the Session Control Manager Administration Guide for more information about regular expressions.
filter-criteria1 criteria
Specifies the filter criteria that packets that have passed the base criteria will be compared against. The following criteria is supported:
access-type type: Filters sessions based on a specific access-type used by the subscriber. Possible access types are:
3gpp-geran: 3GPP Access Type
3gpp-utran-fdd: 3GPP Access Type
3gpp-utran-tdd: 3GPP Access type
3gpp2-1x: 3GPP2 Access Type
3gpp2-1x-hrpd: 3GPP2 Access Type
3gpp2-umb: 3GPP2-UMB
adsl: FixedLine Access Type
adsl2: FixedLine Access Type
adsl2p: FixedLine Access Type ADSL2+
docsis: DOCSIS
gshdsl: Fixed Line Access Type G.SHDSL
hdsl: Fixed Line Access Type
hdsl2: Fixed Line Access Type
idsl: Fixed Line Access Type
ieee-80211: WLAN Access Type
ieee-80211a: WLAN Access Type
ieee-80211b: WLAN Access Type
ieee-80211g: WLAN Access Type
ieee-80216e: Wireless MAN Access Type
radsl: Fixed Line Access Type
sdsl: Fixed Line Access Type
vdsl: Fixed Line Access Type
any: Filters all CSCF sessions.
carrier-id name: Filters sessions based on the carrier’s ID. name must be from 1 to 79 alpha and/or numeric characters in length.
destination aor aor: Filters sessions based on the destination AoR. aor must be an existing AoR from 1 to 79 characters in length.
Important: The destination aor and carried-id criteria cannot occur in the same route rule.
plmn-id mcc mcc_code mnc mnc_code: Filters sessions based on the mobile country and network codes. mcc_code must be a three-digit integer from 200 to 999. mnc_code must be a two or three-digit integer from 00 to 999.
source address ip_address: Filters sessions based on source IP address. ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
source aor aor: Filters sessions based on the source AoR. aor must be an existing AoR from 1 to 79 characters in length.
time-of-day: Filters sessions based on the time of the day. Additional filter criteria for time-of-day is as follows:
day-of-month day: Filters session based on the day of the month. day must be an integer from 1 to 31.
day-of-week day: Filters session based on the day of the week. day must be an integer from 1 to 7 with 1 signifying Sunday and 7 signifying Saturday.
start date/time [ end date/time ]: Filters sessions based on a start time to, optionally, an end time during the day. date/time must be integers in either of the following formats: YYYY:MM:DD:HH:mm or YYYY:MM:DD:mm:ss. YYYY: year range 2005 to 2099 MM: months (integer range 1 to 12) DD: days (integer range 1 to 31) HH: hours (integer range 0 to 23) mm: minutes (integer range 0 to 59) ss: seconds (integer range 0 to 59)
week-of-month week: Filters sessions based on the week of the month. week must be an integer from 1 to 5.
Important: AoR regular expressions are supported. Refer to the SCM Engineering Rules Appendix in the Session Control Manager Administration Guide for more information about regular expressions.
filter-criteria2 criteria
Specifies the filter criteria that packets that have passed the base criteria and filter-criteria1 will be compared against. The following criteria is supported:
access-type type: Filters sessions based on a specific access-type used by the subscriber. Possible access types are:
3gpp-geran: 3GPP Access Type
3gpp-utran-fdd: 3GPP Access Type
3gpp-utran-tdd: 3GPP Access type
3gpp2-1x: 3GPP2 Access Type
3gpp2-1x-hrpd: 3GPP2 Access Type
3gpp2-umb: 3GPP2-UMB
adsl: FixedLine Access Type
adsl2: FixedLine Access Type
adsl2p: FixedLine Access Type ADSL2+
docsis: DOCSIS
gshdsl: Fixed Line Access Type G.SHDSL
hdsl: Fixed Line Access Type
hdsl2: Fixed Line Access Type
idsl: Fixed Line Access Type
ieee-80211: WLAN Access Type
ieee-80211a: WLAN Access Type
ieee-80211b: WLAN Access Type
ieee-80211g: WLAN Access Type
ieee-80216e: Wireless MAN Access Type
radsl: Fixed Line Access Type
sdsl: Fixed Line Access Type
vdsl: Fixed Line Access Type
any: Filters all CSCF sessions.
carrier-id name: Filters sessions based on the carrier’s ID. name must be from 1 to 79 alpha and/or numeric characters in length.
destination aor aor: Filters sessions based on the destination AoR. aor must be an existing AoR from 1 to 79 characters in length.
Important: The destination aor and carried-id criteria cannot occur in the same route rule.
plmn-id mcc mcc_code mnc mnc_code: Filters sessions based on the mobile country and network codes. mcc_code must be a three-digit integer from 200 to 999. mnc_code must be a two or three-digit integer from 00 to 999.
source address ip_address: Filters sessions based on source IP address. ip_address must be expressed in dotted decimal notation for IPv4 or colon notation for IPv6.
source aor aor: Filters sessions based on the source AoR. aor must be an existing AoR from 1 to 79 characters in length.
time-of-day: Filters sessions based on the time of the day. Additional filter criteria for time-of-day is as follows:
day-of-month day: Filters session based on the day of the month. day must be an integer from 1 to 31.
day-of-week day: Filters session based on the day of the week. day must be an integer from 1 to 7 with 1 signifying Sunday and 7 signifying Saturday.
start date/time [ end date/time ]: Filters sessions based on a start time to, optionally, an end time during the day. date/time must be integers in either of the following formats: YYYY:MM:DD:HH:mm or YYYY:MM:DD:mm:ss. YYYY: year range 2005 to 2099 MM: months (integer range 1 to 12) DD: days (integer range 1 to 31) HH: hours (integer range 0 to 23) mm: minutes (integer range 0 to 59) ss: seconds (integer range 0 to 59)
week-of-month week: Filters sessions based on the week of the month. week must be an integer from 1 to 5.
Important: AoR regular expressions are supported. Refer to the SCM Engineering Rules Appendix in the Session Control Manager Administration Guide for more information about regular expressions.
log
Enables logging for CSCF sessions meeting the criteria specified in the ACL. The logs can be viewed by executing the logging filter active facility cscf-acl-log command in the Exec mode.
no route { domain name | local { icscf | pcscf | scscf } | nexthop-address address | peer-servers group_name | vpn name } base-criteria criteria [ filter-criteria1 criteria ] [ filter-criteria2 criteria ]
Removes the specified routing parameters for the CSCF service.
Usage
Use this command to configure routing parameters for the service.
Important: Use the before or after command to place the route entry in the route list.
Example
The following command is placed at the end of the route list and routes sessions to a peer server group named icscf_peer5, filters sessions with a base criteria of the source address (1.2.3.4) and a filter criteria of the destination AoR ($.@test.com):
after route peer-servers icscf_peer5 base-criteria source address 1.2.3.4 filter-criteria1 destination aor $.@test.com
 
 

Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883