Cbilodeau: creation

2017-04-19T19:58:13Z

creation

New page

=== '''''Applies to version v3.0''''' ===
{{DISPLAYTITLE:Adding Telecom Hardware}}

When you receive a new system, at least one hardware configuration is available (by default) in the [[Toolpack]] application server. To add other hardware devices, use the Tmedia [[Web Portal]].

In order to add one or more additional hardware devices to the Toolpack system configuration, their serial numbers must be registered with the Toolpack application server.

'''To add a hardware device:'''

1- Click '''Hardware Units''' in the navigation panel

[[Image:Hardware_0_A.png]]

2- Click '''Create New Unit''', to add a new hardware device

[[Image:Hardware_1_A.png]]

3- Enter information for the following parameters:
* Enter a '''name''' for the hardware device
* Enter the '''serial number''' of the new hardware device (filling in the Serial Number field will cause auto-completion of the field to occur).
* Select the appropriate '''hardware device''' from the Type field.
* Enter the location in which the hardware device is installed.
* Enter a meaningful description about the use or purpose of the hardware device.
* Select '''Enabled''' from the Target State field.
* Select the type of TDM lines that the hardware device will support.
* Indicate if the device will operate as a backup in an 1+1 or N+1 configuration. If this is the first device being added, leave this field empty.
* Provide the amount of time in seconds, that the system will wait for calls to complete before shutting down for an upgrade.
* Click '''Create'''

[[Image:Hardware_2_B.png]]

'''NOTE'''
The following image shows the 1+1 Backup field set. This is done for the addition of a secondary device that will operate as the designated 1+1 backup in a 1+1 or N+1 group.

[[Image:Hardware_3_B.png]]

4- Verify that the '''Unit was successfully created''' message appears, and that the newly added hardware device appears in the '''Hardware List'''.

[[Image:Hardware_4_A.png]]

<div class="mw-collapsible mw-collapsed" data-collapsetext="Northbound Interface" data-expandtext="Northbound Interface" style="width: 400px;">

'''Path'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]
</pre>

'''Parameters (text)'''
<pre>
/configurations/@[configuration_name]/hardware_units/@[hardware_name]
description = ""
graceful_upgrade_timeout = 0
is_np1_backup = false
location = ""
name = "@[hardware_name]"
serial_number = "@[serial_number]"
target_state = "Enabled"
tdm_line_type = "E1_T1_J1"
type = "TDM/IP Gateway"

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/advanced_parameters
casr2_cpu0_load = 50
dsp_reserved_for_play_record = 1
enable_http = true
enable_mgmt_port_redundancy = true
enable_telnet = true
enable_v34 = false
enable_vbd_autoswitch = false
isdn_primary_cpu_load_percent = 50
load_cas_on_secondary_cpu = false
load_isdn_on_secondary_cpu = false
load_iua_on_secondary_cpu = true
load_lapd_on_secondary_cpu = true
load_m2pa_on_secondary_cpu = true
load_m2ua_on_secondary_cpu = true
load_m3ua_on_secondary_cpu = true
load_sip_on_secondary_cpu = true
sip_cong_start_thresh = 2
sip_cong_stop_thresh = 4
sip_critical_cong_start_thresh = 1
sip_critical_cong_stop_thresh = 3
sip_dynamic_mem_size = "0 KB"
sip_event_mem_size = "0 KB"
sip_extra_mem = true
sip_reduced_timer_start_thresh = 4
sip_reduced_timer_stop_thresh = 5
sip_signal_mem_size = "0 KB"
sip_signal_sizes = ""
tdm_companding = "aLaw"
voip_codec_AMR = 0
voip_codec_ECHO_H = 0
voip_codec_ECHO_L = 0
voip_codec_ECHO_M = 0
voip_codec_EFR = 0
voip_codec_EVRC = 0
voip_codec_FR = 0
voip_codec_G711_5 = 0
voip_codec_G711_10 = 0
voip_codec_G711_20 = 0
voip_codec_G722_2 = 0
voip_codec_G723 = 0
voip_codec_G726_10 = 0
voip_codec_G726_20 = 0
voip_codec_G728 = 0
voip_codec_G729A = 0
voip_codec_G729EG_8 = 0
voip_codec_G729EG_11_8 = 0
voip_codec_ILBC13 = 0
voip_codec_ILBC15 = 0
voip_codec_mode = "Mixed Mode"
voip_codec_QCELP8 = 0
voip_codec_QCELP13 = 0
voip_codec_SMV = 0
voip_codec_T38 = 0

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/call_rate_limiting
maximum_cas_call_burst = 0
maximum_cas_calls_per_second = 0
maximum_isdn_call_burst = 0
maximum_isdn_calls_per_second = 0
maximum_sip_call_burst = 0
maximum_sip_calls_per_second = 0

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/congestion_threshold
nb_calls_per_period = 10
period_duration = "1 minute"
</pre>

'''Parameters (json)'''
<pre>
{
"advanced_parameters" : {
"casr2_cpu0_load" : 50,
"dsp_reserved_for_play_record" : 1,
"enable_http" : true,
"enable_mgmt_port_redundancy" : true,
"enable_telnet" : true,
"enable_v34" : false,
"enable_vbd_autoswitch" : false,
"isdn_primary_cpu_load_percent" : 50,
"load_cas_on_secondary_cpu" : false,
"load_isdn_on_secondary_cpu" : false,
"load_iua_on_secondary_cpu" : true,
"load_lapd_on_secondary_cpu" : true,
"load_m2pa_on_secondary_cpu" : true,
"load_m2ua_on_secondary_cpu" : true,
"load_m3ua_on_secondary_cpu" : true,
"load_sip_on_secondary_cpu" : true,
"sip_cong_start_thresh" : 2,
"sip_cong_stop_thresh" : 4,
"sip_critical_cong_start_thresh" : 1,
"sip_critical_cong_stop_thresh" : 3,
"sip_dynamic_mem_size" : "0 KB",
"sip_event_mem_size" : "0 KB",
"sip_extra_mem" : true,
"sip_reduced_timer_start_thresh" : 4,
"sip_reduced_timer_stop_thresh" : 5,
"sip_signal_mem_size" : "0 KB",
"sip_signal_sizes" : "",
"tdm_companding" : "aLaw",
"voip_codec_AMR" : 0,
"voip_codec_ECHO_H" : 0,
"voip_codec_ECHO_L" : 0,
"voip_codec_ECHO_M" : 0,
"voip_codec_EFR" : 0,
"voip_codec_EVRC" : 0,
"voip_codec_FR" : 0,
"voip_codec_G711_5" : 0,
"voip_codec_G711_10" : 0,
"voip_codec_G711_20" : 0,
"voip_codec_G722_2" : 0,
"voip_codec_G723" : 0,
"voip_codec_G726_10" : 0,
"voip_codec_G726_20" : 0,
"voip_codec_G728" : 0,
"voip_codec_G729A" : 0,
"voip_codec_G729EG_8" : 0,
"voip_codec_G729EG_11_8" : 0,
"voip_codec_ILBC13" : 0,
"voip_codec_ILBC15" : 0,
"voip_codec_mode" : "Mixed Mode",
"voip_codec_QCELP8" : 0,
"voip_codec_QCELP13" : 0,
"voip_codec_SMV" : 0,
"voip_codec_T38" : 0
},
"call_rate_limiting" : {
"maximum_cas_call_burst" : 0,
"maximum_cas_calls_per_second" : 0,
"maximum_isdn_call_burst" : 0,
"maximum_isdn_calls_per_second" : 0,
"maximum_sip_call_burst" : 0,
"maximum_sip_calls_per_second" : 0,
"maximum_ss7_call_burst" : 0,
"maximum_ss7_calls_per_second" : 0,
"maximum_total_call_burst" : 0,
"maximum_total_calls_per_second" : 0
},
"congestion_threshold" : {
"nb_calls_per_period" : 10,
"period_duration" : "1 minute"
},
"description" : "",
"graceful_upgrade_timeout" : 0,
"is_np1_backup" : false,
"location" : "",
"name" : "@[hardware_name]",
"serial_number" : "@[serial_number]",
"target_state" : "Enabled",
"tdm_line_type" : "E1_T1_J1",
"type" : "TDM/IP Gateway",
"bondings" : {
},
"cas_stacks" : {
},
"ethernet_ports" : {
},
"ip_interfaces" : {
},
"isdn_stacks" : {
},
"iua_stacks" : {
},
"m2pa_stacks" : {
},
"m2ua_stacks" : {
},
"mtp2_stacks" : {
},
"rtp_port_ranges" : {
},
"sctp_stacks" : {
},
"tdm_line_interfaces" : {
},
"tunnels" : {
},
"virtual_ports" : {
}
}
</pre>
</div>

==List of Parameters==

* [[Parameter: Name|Name]]
* [[Parameter: Serial|Serial]]
* [[Parameter: Adapter Type|Type]]
* [[Parameter: Location|Location]]
* [[Parameter: Description|Description]]
* [[Parameter: Target State|Target State]]
* [[Parameter: TDM Lines Type|TDM Lines Type]]
* [[Parameter: Is N+1 Backup|Is N+1 Backup]]
* [[Parameter: Graceful Upgrade Timeout|Graceful Upgrade Timeout]]

<br>

<div class="mw-collapsible mw-collapsed" data-collapsetext="Advanced Parameters" data-expandtext="Advanced Parameters" style="width: 400px;">
{| class="wikitable"
|-
* [[Parameter: Enable management port redundancy|Enable management port redundancy]]
* [[Parameter: Enable HTTP access|Enable HTTP access]]
* [[Parameter: Enable Telnet access|Enable Telnet access]]
* [[Parameter: Enable V.34 FAX|Enable V.34 FAX]]
* [[Parameter: Enable V.152 VBD|Enable V.152 VBD]]
* [[Parameter: ISDN primary CPU load|ISDN primary CPU load]]
* [[Parameter: Load CAS on secondary CPU|Load CAS on secondary CPU]]
* [[Parameter: Load ISUP on secondary CPU|Load ISUP on secondary CPU]]
* [[Parameter: Load M2PA on secondary CPU|Load M2PA on secondary CPU]]
* [[Parameter: Load M2UA on secondary CPU|Load M2UA on secondary CPU]]
* [[Parameter: Load M3UA on secondary CPU|Load M3UA on secondary CPU]]
* [[Parameter: Load SIP on secondary CPU|Load SIP on secondary CPU]]
* [[Parameter: Load IUA on secondary CPU|Load IUA on secondary CPU]]
* [[Parameter: Load LAPD on secondary CPU|Load LAPD on secondary CPU]]
* [[Parameter: Increase SIP Stack Allowed RAM|Increase SIP Stack Allowed RAM]]
* [[Parameter: SIP Dynamic memory size|SIP Dynamic memory size]]
* [[Parameter: SIP Event memory size|SIP Event memory size]]
* [[Parameter: SIP Signal memory size|SIP Signal memory size]]
* [[Parameter: SIP Signal pool sizes|SIP Signal pool sizes]]

* Reduced Timer
** [[Parameter: Timer Start Threshold|Start Threshold]]
** [[Parameter: Timer Stop Threshold|Stop Threshold]]

* Congestion
** [[Parameter: Congestion Start Threshold|Start Threshold]]
** [[Parameter: Congestion Stop Threshold|Stop Threshold]]

* Critical Congestion
** [[Parameter: Critical Congestion Start Threshold|Start Threshold]]
** [[Parameter: Critical Congestion Stop Threshold|Stop Threshold]]

* [[Parameter: TDM Companding|TDM Companding]]
* [[Parameter: VOIP Codec Mode|VOIP Codec Mode]]
* [[Parameter: Fixed density for G711 (20 ms packets)|Fixed density for G711 (20 ms packets)]]
* [[Parameter: Fixed density for G711 (10 ms packets)|Fixed density for G711 (10 ms packets)]]
* [[Parameter: Fixed density for G711 (5 ms packets)|Fixed density for G711 (5 ms packets)]]
* [[Parameter: Fixed density for G726 (20 ms packets)|Fixed density for G726 (20 ms packets)]]
* [[Parameter: Fixed density for G726 (10 ms packets)|Fixed density for G726 (10 ms packets)]]
* [[Parameter: Fixed density for G729A|Fixed density for G729A]]
* [[Parameter: Fixed density for G723|Fixed density for G723]]
* [[Parameter: Fixed density for G728|Fixed density for G728]]
* [[Parameter: Fixed density for G729EG 8 Kbps|Fixed density for G729EG 8 Kbps]]
* [[Parameter: Fixed density for G729EG 11.8 Kbps|Fixed density for G729EG 11.8 Kbps]]
* [[Parameter: Fixed density for AMR|Fixed density for AMR]]
* [[Parameter: Fixed density for EVRC|Fixed density for EVRC]]
* [[Parameter: Fixed density for QCELP8|Fixed density for QCELP8]]
* [[Parameter: Fixed density for QCELP13|Fixed density for QCELP13]]
* [[Parameter: Fixed density for SMV|Fixed density for SMV]]
* [[Parameter: Fixed density for EFR|Fixed density for EFR]]
* [[Parameter: Fixed density for T38|Fixed density for T38]]
* [[Parameter: Fixed density for ECHO high-latency|Fixed density for ECHO high-latency]]
* [[Parameter: Fixed density for ECHO medium-latency|Fixed density for ECHO medium-latency]]
* [[Parameter: Fixed density for ECHO low-latency|Fixed density for ECHO low-latency]]
* [[Parameter: Fixed density for FR|Fixed density for FR]]
* [[Parameter: Fixed density for ILBC 13 Kbps|Fixed density for ILBC 13 Kbps]]
* [[Parameter: Fixed density for ILBC 15 Kbps|Fixed density for ILBC 15 Kbps]]
* [[Parameter: Fixed density for G722.2|Fixed density for G722.2]]
|}
</div>

<br>

<div class="mw-collapsible mw-collapsed" data-collapsetext="Call Rate Limiting Parameters" data-expandtext="Call Rate Limiting Parameters" style="width: 400px;">
{| class="wikitable"
|-
* [[Parameter: Maximum SS7 calls per second|Maximum SS7 calls per second]]
* [[Parameter: Maximum SS7 call burst|Maximum SS7 call burst]]
* [[Parameter: Maximum ISDN calls per second|Maximum ISDN calls per second]]
* [[Parameter: Maximum ISDN call burst|Maximum ISDN call burst]]
* [[Parameter: Maximum CAS calls per second|Maximum CAS calls per second]]
* [[Parameter: Maximum CAS call burst|Maximum CAS call burst]]
* [[Parameter: Maximum SIP calls per second|Maximum SIP calls per second]]
* [[Parameter: Maximum SIP call burst|Maximum SIP call burst]]
* [[Parameter: Maximum total calls per second|Maximum total calls per second]]
* [[Parameter: Maximum total call burst|Maximum total call burst]]
|}
</div>

<div class="mw-collapsible mw-collapsed" data-collapsetext="Congestion Threshold" data-expandtext="Congestion Threshold" style="width: 400px;">
{| class="wikitable"
|-
* [[Parameter: Number of calls per period|Number of calls per period]]
* [[Parameter: Period Duration|Period Duration]]

|}
</div>

Toolpack:Adding an Adapter G - Revision history

Cbilodeau: creation