Toolpack:Enabling RADIUS D

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(Created page with "=== '''''Applies to version(s): v2.9''''' === {{DISPLAYTITLE:Toolpack: Enabling and Configuring RADIUS}} This article describes how to enable and configure a TMG system to cap...")
 
m
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
=== '''''Applies to version(s): v2.9''''' ===
+
=== '''''Applies to version(s): v2.9, v2.10, v3.0, v3.1''''' ===
 
{{DISPLAYTITLE:Toolpack: Enabling and Configuring RADIUS}}
 
{{DISPLAYTITLE:Toolpack: Enabling and Configuring RADIUS}}
−
This article describes how to enable and configure a TMG system to capture CDRs, using a RADIUS server.
+
This article describes how to enable and configure a TMG system to capture Call Detail Records ([[CDR]]s), using a [[RADIUS]] server.
 
<br><br>
 
<br><br>
 
'''''Enabling RADIUS'''''
 
'''''Enabling RADIUS'''''
Line 17: Line 17:
 
3- Configure the CDR behavior in the '''CDR Options''' section:
 
3- Configure the CDR behavior in the '''CDR Options''' section:
 
* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
 
* '''Enable periodic CDR update''' will add one entry in the CDR per '''Periodic CDR update time''', in minutes.
−
* Select the '''CDR Mode''':
+
* Select one of the '''RADIUS CDR''' mode from the '''CDR Mode''' :
 
**'''Text CDR only''': Will store the CDRs in a flat file. See [[Text Call Detail Records (CDR)|Text CDR]]
 
**'''Text CDR only''': Will store the CDRs in a flat file. See [[Text Call Detail Records (CDR)|Text CDR]]
 
**'''RADIUS CDR only''': Will send the CDR to an external RADIUS Server. See [[RADIUS|Radius CDR]]
 
**'''RADIUS CDR only''': Will send the CDR to an external RADIUS Server. See [[RADIUS|Radius CDR]]
Line 23: Line 23:
 
**'''RADIUS CDR with Text CDR Fallback''': Will send the CDR to an external RADIUS Server and if the RADIUS server cannot handle the load of CDRs, they will be stored in a flat file.
 
**'''RADIUS CDR with Text CDR Fallback''': Will send the CDR to an external RADIUS Server and if the RADIUS server cannot handle the load of CDRs, they will be stored in a flat file.
 
* Click '''Save''' to save your changes.
 
* Click '''Save''' to save your changes.
−
 
−
[[Image:EnableCdr_2.png|border]]
 
  
 
4- Verify that the '''Gateway configuration was successfully updated.''' message appears.
 
4- Verify that the '''Gateway configuration was successfully updated.''' message appears.
Line 35: Line 33:
 
'''Path'''
 
'''Path'''
 
<pre>
 
<pre>
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]
 
</pre>
 
</pre>
  
 
'''Parameters (text)'''
 
'''Parameters (text)'''
 
<pre>
 
<pre>
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]
 +
cdr_system_id                = 5448
 +
routing_script                = "default_routing_script"
 +
translate_privacy_information = false
 +
use_cdr_behavior              = true
 +
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]/advanced_parameters
 +
enable_call_recording            = false
 +
forward_connected_number        = false
 +
forward_redirecting_number      = true
 +
forward_redirection_number      = true
 +
forward_ss7_raw_message_bytes    = true
 +
forward_user_to_user_information = true
 +
route_retry_mode                = "Call Alerted"
 +
route_retry_relay_progress_msgs  = true
 +
route_retry_timeout              = "10 seconds"
 +
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]/advanced_parameters/call_recording_options
 +
called                                = ""
 +
calling                              = ""
 +
incoming_nap                          = "(Any)"
 +
outgoing_nap                          = "(Any)"
 +
record_all_legs_of_a_call_to_one_file = false
 +
termination_name                      = ""
 +
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]/cdr_options
 +
cdr_mode                  = "RADIUS CDR only"
 +
enable_periodic_cdr_update = false
 +
periodic_cdr_update_time  = "0 minute"
 +
reverse_cdr_call_origin    = false
 +
 +
/configurations/@[configuration_name]/gateways/@[gateway_name]/sip_privacy_options
 +
use_alternate_anonymous_address = false
 
</pre>
 
</pre>
  
 
'''Parameters (json)'''
 
'''Parameters (json)'''
 
<pre>
 
<pre>
 +
{
 +
  "advanced_parameters" : {
 +
    "call_recording_options" : {
 +
      "called" : "",
 +
      "calling" : "",
 +
      "incoming_nap" : "(Any)",
 +
      "outgoing_nap" : "(Any)",
 +
      "record_all_legs_of_a_call_to_one_file" : false,
 +
      "termination_name" : ""
 +
    },
 +
    "enable_call_recording" : false,
 +
    "forward_connected_number" : false,
 +
    "forward_redirecting_number" : true,
 +
    "forward_redirection_number" : true,
 +
    "forward_ss7_raw_message_bytes" : true,
 +
    "forward_user_to_user_information" : true,
 +
    "route_retry_mode" : "Call Alerted",
 +
    "route_retry_relay_progress_msgs" : true,
 +
    "route_retry_timeout" : "10 seconds"
 +
  },
 +
  "cdr_options" : {
 +
    "cdr_mode" : "RADIUS CDR only",
 +
    "enable_periodic_cdr_update" : false,
 +
    "periodic_cdr_update_time" : "0 minute",
 +
    "reverse_cdr_call_origin" : false
 +
  },
 +
  "cdr_system_id" : 5448,
 +
  "routing_script" : "default_routing_script",
 +
  "sip_privacy_options" : {
 +
    "use_alternate_anonymous_address" : false
 +
  },
 +
  "translate_privacy_information" : false,
 +
  "use_cdr_behavior" : true
 +
}
 
</pre>
 
</pre>
 
</div>
 
</div>
−
 
−
 
−
==List of Parameters==
 
−
 
−
* [[Parameter: CDR log file path|CDR log file path]]
 
−
* [[Parameter: CDR format (start)|CDR format (start)]]
 
−
* [[Parameter: CDR format (update)|CDR format (update)]]
 
−
* [[Parameter: CDR format (end)|CDR format (end)]]
 
−
* [[Parameter: Rotation delay in seconds|Rotation Delay]]
 
−
* [[Parameter: Max total size of gzipped CDR logs|Max total size of gzipped CDR logs]]
 
−
* [[Parameter: Maximum CDR log file segment size|Maximum CDR log file segment size]]
 

Latest revision as of 09:12, 1 May 2019

Applies to version(s): v2.9, v2.10, v3.0, v3.1

This article describes how to enable and configure a TMG system to capture Call Detail Records (CDRs), using a RADIUS server.

Enabling RADIUS

1- Select Gateway from the navigation panel.

EnableCdr 0.png


2- Verify that the box Use CDR behavior is checked.

EnableRadius 0.png


3- Configure the CDR behavior in the CDR Options section:

  • Enable periodic CDR update will add one entry in the CDR per Periodic CDR update time, in minutes.
  • Select one of the RADIUS CDR mode from the CDR Mode :
    • Text CDR only: Will store the CDRs in a flat file. See Text CDR
    • RADIUS CDR only: Will send the CDR to an external RADIUS Server. See Radius CDR
    • Text and RADIUS CDR: Will store the CDRs in a flat file and send the CDR to an external RADIUS Server.
    • RADIUS CDR with Text CDR Fallback: Will send the CDR to an external RADIUS Server and if the RADIUS server cannot handle the load of CDRs, they will be stored in a flat file.
  • Click Save to save your changes.

4- Verify that the Gateway configuration was successfully updated. message appears.

EnableCdr 3.png


Path 

/configurations/@[configuration_name]/gateways/@[gateway_name]

Parameters (text) 

/configurations/@[configuration_name]/gateways/@[gateway_name]
cdr_system_id                 = 5448
routing_script                = "default_routing_script"
translate_privacy_information = false
use_cdr_behavior              = true

/configurations/@[configuration_name]/gateways/@[gateway_name]/advanced_parameters
enable_call_recording            = false
forward_connected_number         = false
forward_redirecting_number       = true
forward_redirection_number       = true
forward_ss7_raw_message_bytes    = true
forward_user_to_user_information = true
route_retry_mode                 = "Call Alerted"
route_retry_relay_progress_msgs  = true
route_retry_timeout              = "10 seconds"

/configurations/@[configuration_name]/gateways/@[gateway_name]/advanced_parameters/call_recording_options
called                                = ""
calling                               = ""
incoming_nap                          = "(Any)"
outgoing_nap                          = "(Any)"
record_all_legs_of_a_call_to_one_file = false
termination_name                      = ""

/configurations/@[configuration_name]/gateways/@[gateway_name]/cdr_options
cdr_mode                   = "RADIUS CDR only"
enable_periodic_cdr_update = false
periodic_cdr_update_time   = "0 minute"
reverse_cdr_call_origin    = false

/configurations/@[configuration_name]/gateways/@[gateway_name]/sip_privacy_options
use_alternate_anonymous_address = false

Parameters (json) 

{
  "advanced_parameters" : {
    "call_recording_options" : {
      "called" : "",
      "calling" : "",
      "incoming_nap" : "(Any)",
      "outgoing_nap" : "(Any)",
      "record_all_legs_of_a_call_to_one_file" : false,
      "termination_name" : ""
    },
    "enable_call_recording" : false,
    "forward_connected_number" : false,
    "forward_redirecting_number" : true,
    "forward_redirection_number" : true,
    "forward_ss7_raw_message_bytes" : true,
    "forward_user_to_user_information" : true,
    "route_retry_mode" : "Call Alerted",
    "route_retry_relay_progress_msgs" : true,
    "route_retry_timeout" : "10 seconds"
  },
  "cdr_options" : {
    "cdr_mode" : "RADIUS CDR only",
    "enable_periodic_cdr_update" : false,
    "periodic_cdr_update_time" : "0 minute",
    "reverse_cdr_call_origin" : false
  },
  "cdr_system_id" : 5448,
  "routing_script" : "default_routing_script",
  "sip_privacy_options" : {
    "use_alternate_anonymous_address" : false
  },
  "translate_privacy_information" : false,
  "use_cdr_behavior" : true
}
Retrieved from "https://docs.telcobridges.com/mediawiki/index.php?title=Toolpack:Enabling_RADIUS_D&oldid=27311"
Personal tools