Copyright © 2007 FhG FOKUS
Copyright © 2012 Smile Communications
Copyright © 2015 ng-voice GmbH
Copyright © 2016 Core Network Dynamics GmbH
Table of Contents
rx_dest_realm
(string)
rx_forced_peer
(string)
rx_auth_expiry
(integer)
cdp_event_latency
(integer)
cdp_event_threshold
(integer)
cdp_event_latency_log
(integer)
authorize_video_flow
(integer)
cdp_event_list_size_threshold
(integer)
audio_default_bandwidth
(integer)
video_default_bandwidth
(integer)
early_qosrelease_reason
(String)
confirmed_qosrelease_headers
(String)
regex_sdp_ip_prefix_to_maintain_in_fd
(String)
terminate_dialog_on_rx_failure
integer
delete_contact_on_rx_failure
integer
include_rtcp_fd
integer
List of Examples
rx_dest_realm
parameter usagerx_forced_peer
parameter usagerx_auth_expiry
parameter usagecdp_event_latency
parameter usagecdp_event_threshold
parameter usagecdp_event_latency_log
parameter
usageauthorize_video_flow
parameter
usagecdp_event_list_size_threshold
parameter
usageaudio_default_bandwidth
parameter
usagevideo_default_bandwidth
parameter
usageearly_qosrelease_reason
parameter
usageconfirmed_qosrelease_headers
parameter
usageregex_sdp_ip_prefix_to_maintain_in_fd
parameter
usageterminate_dialog_on_rx_failure
parameter
usagedelete_contact_on_rx_failure
parameter
usageinclude_rtcp_fd
parameter
usageTable of Contents
rx_dest_realm
(string)
rx_forced_peer
(string)
rx_auth_expiry
(integer)
cdp_event_latency
(integer)
cdp_event_threshold
(integer)
cdp_event_latency_log
(integer)
authorize_video_flow
(integer)
cdp_event_list_size_threshold
(integer)
audio_default_bandwidth
(integer)
video_default_bandwidth
(integer)
early_qosrelease_reason
(String)
confirmed_qosrelease_headers
(String)
regex_sdp_ip_prefix_to_maintain_in_fd
(String)
terminate_dialog_on_rx_failure
integer
delete_contact_on_rx_failure
integer
include_rtcp_fd
integer
This module contains all method related to the IMS policy and charging control functions performed by an Application Function (e.g. P-CSCF) over the Rx interface. This module is dependent on the CDP (C Diameter Peer) modules for communicating with PCRF as specified in 3GPP specification TS 29.214.
The Following modules must be loaded before this module:
Dialog
Usrloc PCSCF
TM - Transaction Manager
CDP - C Diameter Peer
CDP_AVP - CDP AVP Applications
This is the name of the Diameter realm of the Diameter server (typically a PCRF).
Default value is 'ims.smilecoms.com'.
Example 1.1. rx_dest_realm
parameter usage
... modparam("ims_qos", "rx_dest_realm", "ims.smilecoms.com") ...
FQDN of the Diameter server (typically a PCRF) to communicate with. If not set then realm routing is used. If you use this, the routing defined in your diameter xml configuration file (CDP) will be ignored and as a result you will lose the benefits of load balancing and failover.
Default value is ''.
Example 1.2. rx_forced_peer
parameter usage
... modparam("ims_qos", "rx_forced_peer", "pcrf.ims.smilecoms.com") ...
This is the expiry length in seconds of the initiated Diameter sessions.
Default value is 7200.
This is a flag to determine whether or slow CDP responses should be reported in the log file. 1 is enabled and 0 is disabled.
Default value is 1.
This time in milliseconds is the limit we should report a CDP response as slow. i.e. if a CDP response exceeds this limit it will be reported in the log file. This is only relevant is cdp_event_latency is enabled (set to 0).
Default value is 500.
Example 1.5. cdp_event_threshold
parameter usage
... modparam("ims_qos", "cdp_event_threshold", 500) ...
This time log level at which we should report slow CDP responses. 0 is ERROR, 1 is WARN, 2 is INFO and 3 is DEBUG. This is only relevant is cdp_event_latency is enabled (set to 0)
Default value is 0.
Example 1.6. cdp_event_latency_log
parameter
usage
... modparam("ims_qos", "cdp_event_latency_log", 1) ...
This is a flag that specifies whether or not to authorize video flows. 1 means video flows will be authorized over Rx and 0 means video flows will not be authorized over Rx
Default value is 1.
Example 1.7. authorize_video_flow
parameter
usage
... modparam("ims_qos", "authorize_video_flow", 0) ...
This is a threshold on the size of the cdp event list. Once the queue exceeds this length a warning is logged. 0 disables this feature
Default value is 0.
Example 1.8. cdp_event_list_size_threshold
parameter
usage
... modparam("ims_qos", "cdp_event_list_size_threshold", 10) ...
This parameters defines the default bandwidth for Audio, if no "b=AS"-Parameter is found in the SDP.
Default value is 64 (64 kBit)
Example 1.9. audio_default_bandwidth
parameter
usage
... modparam("ims_qos", "audio_default_bandwidth", 32) ...
This parameters defines the default bandwidth for Video, if no "b=AS"-Parameter is found in the SDP.
Default value is 128 (128 kBit)
Example 1.10. video_default_bandwidth
parameter
usage
... modparam("ims_qos", "video_default_bandwidth", 256) ...
This sets the default Reason, when a call is terminated in early stage due to QoS-failure.
Default value is "QoS released", a call in early stage would be released with "488 QoS released".
Example 1.11. early_qosrelease_reason
parameter
usage
... modparam("ims_qos", "early_qosrelease_reason", "Sorry - QoS failed") ...
These headers are added to the BYE-Message, when a confirmed call is terminated due to a QoS failure.
Default value is "", no Extra-Headers
The headers must end with CRLF.
Example 1.12. confirmed_qosrelease_headers
parameter
usage
... modparam("ims_qos", "confirmed_qosrelease_headers", "X-Reason: QoS failed\r\n") ...
The flow-description AVP is typically populated using IP:port information present in the SDP. Certain (buggy) UEs can change ports midway during calls which causes the flow-description to no longer match the traffic. This parameter allows the flow-description AVP to use to the any keyword instead of certain IP:port combinations in the SDP. The parameter is a regex that if set adds an extra filter for all IPs that do not match the regex with the any keyword in the flow-description AVP
Default value is "", no extra filters added
Example 1.13. regex_sdp_ip_prefix_to_maintain_in_fd
parameter
usage
... modparam("ims_qos", "regex_sdp_ip_prefix_to_maintain_in_fd", "10.21.0.1") ...
If set then active dialogs associated with an Rx session are torn down in the Rx session fails
Default value is 1, dialogs are torn down
Example 1.14. terminate_dialog_on_rx_failure
parameter
usage
... modparam("ims_qos", "terminate_dialog_on_rx_failure", 0) ...
Perform an AAR on Diameter RX interface to subscribe to signalling status. This purpose of this is tell a Diameter server (typically a PCRF) to inform the requesting Diameter client on changes to the status of signalling bearer for the same framed IP address. For more details see 3GGP TS 29.214.
Meaning of the parameters is as follows:
Route block to resume after async UAR Diameter reply.
domain that usrloc_pcscf uses to store user information.
Return codes:
-1 - error: There was an error, so we must either ignore it (no subscription) or send 403 (depends on behaviour you want)
0 - Success: AAR-Request sent, reply is processed asynchronously.
1 - Success: No need to send AAR-Request, as a subscription still exists (continue as normal)
This function can be used from REQUEST_ROUTE.
p.s. this is executed asynchronously. See example on how to retrieve return value
Example 1.17. Rx_AAR_Register
... if(Rx_AAR_Register("REG_AAR_REPLY","location")==0){ exit; } ... route[REG_AAR_REPLY] { switch ($avp(s:aar_return_code)) { case 1: xlog("L_DBG", "Diameter: AAR success on subscription to signalling\n"); break; default: xlog("L_ERR", "Diameter: AAR failed on subscription to signalling\n"); t_reply("403", "Can't register to QoS for signalling"); exit; } ...
Perform an AAR on Diameter RX interface to request resource authorisation from a Diameter server (typically a PCRF). For more details see 3GGP TS 29.214.
Meaning of the parameters is as follows:
Route block to resume after async UAR Diameter reply.
direction of this message - orig, term, etc.
subscription_id to hard code subscription ID for AAR. Used for some broken PCRFs. Leave blank to use default
subscription_id_type to hard code subscription ID type for AAR. Only applicable if subscription_id is set. Set to -1 to use default. This is as per RFC 4006: END_USER_E164 0, END_USER_IMSI 1, END_USER_SIP_URI 2, END_USER_NAI 3, END_USER_PRIVATE 4
This function can be used from REQUEST_ROUTE or ONREPLY_ROUTE.
p.s. this is executed asynchronously. See example on how to retrieve return value
Example 1.18. Rx_AAR
... if(Rx_AAR("ORIG_SESSION_AAR_REPLY","orig","",-1)==0){ exit; } ... route[ORIGN_SESSION_AAR_REPLY] { if ($avp(s:aar_return_code) != 1) { xlog("L_ERR", "IMS: AAR failed Orig\n"); dlg_terminate("all", "Sorry no QoS available"); } else { xlog("L_DBG", "Diameter: Orig AAR success on media authorization\n"); } } ...