Sandbox:Toolpack:Creating a Line Service restful 1

From TBwiki
(Difference between revisions)
Jump to: navigation, search
(fix text file)
(Remove unnecessary text + add collapsible section)
Line 37: Line 37:
 
[[Image:CreateLineService_3.png]]
 
[[Image:CreateLineService_3.png]]
  
==RESTFUL provisioning API ==
+
==RESTFUL provisioning API==
  
 +
<div class="mw-collapsible mw-collapsed" data-collapsetext="RESTFUL provisioning API" data-expandtext="RESTFUL provisioning API" style="width: 400px;">
 
'''Path'''
 
'''Path'''
 
  /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]'''''
'''Parameters (list 1)'''
 
  local_index  : [Integer]
 
  name        : [Text]
 
  parameters  ...
 
    audio_companding  : [Text]  "AUTO"
 
    framing          : [Text]  "AUTO"
 
    idle_code        : [Integer]  85
 
    loop_time        : [true/false]  false
 
  state      ...
 
    loopback_type  : [Text]  "None"
 
  
'''Parameters (list 2)'''
+
 
   local_index : 0
+
'''Parameters (text)'''
   name         : "'''''[line service name]'''''"
+
  /configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''
   parameters ...
+
   local_index = 0
    audio_companding : "AUTO"
+
   name       = '''''[line_service_name]'''''
    framing           : "AUTO"
+
    
    idle_code         : 85
+
  /configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''/parameters
    loop_time         : false
+
  audio_companding = "AUTO"
   state       ...
+
  framing         = "AUTO"
    loopback_type : "None"
+
  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)'''
 
'''Parameters (json)'''
Line 86: Line 81:
 
   }
 
   }
  
'''Parameters (text)'''
+
</div>
  /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"
+
 
+
  
 
==List of Parameters==
 
==List of Parameters==

Revision as of 11:25, 1 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

RESTFUL provisioning API

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" : {
       "***meta***" : {
         "valid_url" : false
       },
       "audio_companding" : "AUTO",
       "framing" : "AUTO",
       "idle_code" : 85,
       "loop_time" : false
     },
     "state" : {
       "***meta***" : {
         "valid_url" : false
       },
       "loopback_type" : "None"
     }
   }
 }

List of Parameters

Advanced Parameters

Personal tools