Sandbox:Toolpack:Creating a Line Service restful 1

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(simplify formating)
(fix typo)
 
(2 intermediate revisions by one user not shown)
Line 42: Line 42:
 
'''Path'''
 
'''Path'''
 
<pre>
 
<pre>
/configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''
+
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]
 
</pre>
 
</pre>
  
 
'''Parameters (text)'''
 
'''Parameters (text)'''
 
<pre>
 
<pre>
/configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''
+
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]
 
local_index = 0
 
local_index = 0
name        = '''''[line_service_name]'''''
+
name        = @[line_service_name]
  
/configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''/parameters
+
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]/parameters
 
audio_companding = "AUTO"
 
audio_companding = "AUTO"
 
framing          = "AUTO"
 
framing          = "AUTO"
Line 57: Line 57:
 
loop_time        = false
 
loop_time        = false
  
/configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''/state
+
/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]/state
 
loopback_type = "None"
 
loopback_type = "None"
 
</pre>
 
</pre>
Line 64: Line 64:
 
<pre>
 
<pre>
 
{
 
{
   "'''''[line service name]'''''" : {
+
   "@[line service name]" : {
 
     "local_index" : 0,
 
     "local_index" : 0,
     "name" : "'''''[line service name]'''''",
+
     "name" : "@[line service name]",
 
     "parameters" : {
 
     "parameters" : {
      "***meta***" : {
 
        "valid_url" : false
 
      },
 
 
       "audio_companding" : "AUTO",
 
       "audio_companding" : "AUTO",
 
       "framing" : "AUTO",
 
       "framing" : "AUTO",
Line 77: Line 74:
 
     },
 
     },
 
     "state" : {
 
     "state" : {
      "***meta***" : {
 
        "valid_url" : false
 
      },
 
 
       "loopback_type" : "None"
 
       "loopback_type" : "None"
 
     }
 
     }

Latest revision as of 08:59, 6 October 2015

Applies to version(s): v2.9.

A line service defines the type of paylaod that a line interface carries or it defines another line service. The definition of a line service ends when it reaches the E1/J1/T1 line service.

The E1/J1/T1 line services are also known as trunks or spans.

To create a new line service:


1- Select TDM Line Interfaces from the navigation panel

CreateLineService 0.png


2- Select the line interface for which you would like to create a line service.

CreateLineService 1.png


3- Click Create new child line service

CreateLineService 1a.png


4- Enter a name for the new line service

  • Select a line service type.
  • Select an available local index.
  • Select a framingmode.
  • Click Create.

CreateLineService 2.png


5- The new line service is displayed in the Line Services list

CreateLineService 3.png


Path

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]

Parameters (text)

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]
local_index = 0
name        = @[line_service_name]

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]/parameters
audio_companding = "AUTO"
framing          = "AUTO"
idle_code        = 85
loop_time        = false

/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]/state
loopback_type = "None"

Parameters (json)

{
  "@[line service name]" : {
    "local_index" : 0,
    "name" : "@[line service name]",
    "parameters" : {
      "audio_companding" : "AUTO",
      "framing" : "AUTO",
      "idle_code" : 85,
      "loop_time" : false
    },
    "state" : {
      "loopback_type" : "None"
    }
  }
}


List of Parameters

Advanced Parameters

Personal tools