Sandbox:Toolpack:Creating a Line Service restful 1: Difference between revisions

Latest revision as of 09: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

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

3- Click Create new child line service

4- Enter a name for the new line service

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

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

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

@@ Line 37: / Line 37: @@
 [[Image:CreateLineService_3.png]]
-==RESTFUL provisioning API ==
+<div class="mw-collapsible mw-collapsed" data-collapsetext="RESTFUL provisioning API" data-expandtext="RESTFUL provisioning API" style="width: 400px;">
 '''Path'''
- /configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''
+<pre>
-'''Parameters (list 1)'''
+/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]
-  local_index  : [Integer]
+</pre>
-  name         : [Text]
-  parameters  ...
+'''Parameters (text)'''
-    audio_companding  : [Text]  "AUTO"
+<pre>
-    framing           : [Text]  "AUTO"
+/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]
-    idle_code         : [Integer]  85
+local_index = 0
-    loop_time         : [true/false]  false
+name        = @[line_service_name]
-  state       ...
-    loopback_type  : [Text]  "None"
+/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
-'''Parameters (list 2)'''
+/configurations/@[configuration_name]/hardware_units/@[hardware_name]/tdm_line_interfaces/@[line_interface_name]/line_services/@[line_service_name]/state
-  local_index  : 0
+loopback_type = "None"
-  name         : "'''''[line service name]'''''"
+</pre>
-  parameters  ...
-    audio_companding  : "AUTO"
-    framing           : "AUTO"
-    idle_code         : 85
-    loop_time         : false
-  state       ...
-    loopback_type  : "None"
 '''Parameters (json)'''
-  {
+<pre>
-    "'''''[line service name]'''''" : {
+{
-      "local_index" : 0,
+  "@[line service name]" : {
-      "name" : "'''''[line service name]'''''",
+    "local_index" : 0,
-      "parameters" : {
+    "name" : "@[line service name]",
-        "***meta***" : {
+    "parameters" : {
-          "valid_url" : false
+      "audio_companding" : "AUTO",
-        },
+      "framing" : "AUTO",
-        "audio_companding" : "AUTO",
+      "idle_code" : 85,
-        "framing" : "AUTO",
+      "loop_time" : false
-        "idle_code" : 85,
+    },
-        "loop_time" : false
+    "state" : {
-      },
+      "loopback_type" : "None"
-      "state" : {
-        "***meta***" : {
-          "valid_url" : false
-        },
-        "loopback_type" : "None"
-      }
      }
    }
+}
-'''Parameters (text)'''
+</pre>
-  /configurations/'''''[configuration_name]'''''/hardware_units/'''''[hardware_name]'''''/tdm_line_interfaces/'''''[line_interface_name]'''''/line_services/'''''[line_service_name]'''''
+</div>
-  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"