lsoapi API documentation

CRUD Instances of MEF Defined Services

/svcmgr/webapi/svc/epl post

CRUD Instances MEF EPL Service, returns JSON representing created EPL instance

post

Create an new EPL instance

Request
Response

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

HTTP status code 200

JSON representing created EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

/svcmgr/webapi/svc/epl/{eplid} put get delete

put

Modify an existing EPL instance

get

Query an existing EPL instance

delete

delete an existing EPL instance

Modify an existing EPL instance

Request
Response

URI Parameters

eplid: required (string)

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

HTTP status code 200

JSON representing modified EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

Query an existing EPL instance

Request
Response

URI Parameters

eplid: required (string)

HTTP status code 200

JSON representing the queried EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

delete an existing EPL instance

Request
Response

URI Parameters

eplid: required (string)

HTTP status code 200

JSON representing deleted EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "numCustLocations": {
+      "required": true,
+      "type": "long"
+  },
+  "custAddressList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniHostIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "cos": {
+      "required": true,
+      "type": "long"
+  },
+  "evcId": {
+      "required": true,
+      "type": "long"
+  }
+}        
+

Example:

{
+  "id": "epl-1",
+  "numCustLocations": 2,
+  "custAddressList": [
+    "1111 MEF Dr, Honolulu HI, USA",
+    "2222 UNI Dr, Boston MA, MAS"
+  ],
+  "uniHostMacList": [
+    "00:B0:95:9d:68:16",
+    "00:A0:C9:14:C8:29"
+  ]
+  "uniHostIpList": [
+    "192.168.1.10",
+    "192.168.1.11"s
+  ],
+  "cos": "gold",
+  "evcId": "evc-1",
+}
+

/svcmgr/webapi/svc/epl/list get

Get a list of all EPL instances

get

Query a list of all existing EPL instances

CRUD MEF EVC Instances

/evcmgr/webapi post

post

Create an new EVC instance

Request
Response

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

HTTP status code 200

JSON representing created EVC instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

/evcmgr/webapi/{evcid} put get delete

put

Modify an existing EVC instance

get

Query an existing EVC instance

delete

delete an existing EPL instance

Modify an existing EVC instance

Request
Response

URI Parameters

evcid: required (string)

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

HTTP status code 200

JSON representing modified EVC instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

Query an existing EVC instance

Request
Response

URI Parameters

evcid: required (string)

HTTP status code 200

JSON representing the queried EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

delete an existing EPL instance

Request
Response

URI Parameters

evcid: required (string)

HTTP status code 200

JSON representing deleted EVC instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "evcType": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "POINT_TO_POINT", 
+        "MULTIPOINT_TO_MULTIPOINT", 
+        "ROOTED_MULTIPOINT" 
+        ]
+  },
+  "maxUnis": {
+      "required": true,
+      "type": "long"
+  },
+  "unicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "multicastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "broadcastFrameDelivery": {
+      "required": true,
+      "type": "string",
+      "enum" : [ 
+        "DISCARD", 
+        "UNCONDITIONAL", 
+        "CONDITIONAL" 
+        ]
+  },
+  "uniIdList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniIpList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "uniMacList": {
+      "required": true,
+      "type": "array",
+      "items": { "type" : "string" },
+      "uniqueItems": true
+  },
+  "ceVLanIdPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "ceVlanCosPreservation": {
+      "required": true,
+      "type": "boolean"
+  },
+  "cosId": {
+      "required": true,
+      "type": "string"
+  },
+  "evcMaxSvcFrameSize": {
+      "required": true,
+      "type": "long"
+  },
+  "oneWayAvailability": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "oneWayFrameLossRatio": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "evc-1",
+  "evcType": "POINT_TO_POINT",
+  "maxUnis": 2,
+  "unicastFrameDelivery": "UNCONDITIONAL"
+  "multicastFrameDelivery": "UNCONDITIONAL",
+  "broadcastFrameDelivery": "UNCONDITIONAL",
+  "uniIdList": [
+    "UNI-1",
+    "UNI-2"
+  ],
+  "uniIpList": [
+    "192.168.1.1",
+    "192.168.1.2"
+  ],
+  "uniMacList": [
+    "11:00:11:11:11:11",
+    "11:00:22:22:22:22"
+  ],
+  "ceVLanIdPreservation": true,
+  "ceVlanCosPreservation": true,
+  "cosId": "gold",
+  "evcMaxSvcFrameSize": 1600,
+  "oneWayAvailability": .99,
+  "oneWayFrameDelay": .32,
+  "oneWayFrameLossRatio": .01
+}
+

/evcmgr/webapi/list get

Get a list of all EVC instances

get

Query a list of all existing EVC instances

CRUD MEF CoS Instances

/cosmgr/webapi post

post

Create an new COS instance

Request
Response

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

HTTP status code 200

JSON representing created COS instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

/cosmgr/webapi/{cosid} put get delete

put

Modify an existing COS instance

get

Query an existing COS instance

delete

delete an existing EPL instance

Modify an existing COS instance

Request
Response

URI Parameters

cosid: required (string)

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

HTTP status code 200

JSON representing modified COS instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

Query an existing COS instance

Request
Response

URI Parameters

cosid: required (string)

HTTP status code 200

JSON representing the queried EPL instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

delete an existing EPL instance

Request
Response

URI Parameters

cosid: required (string)

HTTP status code 200

JSON representing deleted COS instance

Body

Type: application/json

Schema:

{
+  "id": {
+      "required": true,
+      "type": "string"
+  },
+  "commitedInfoRate": {
+      "required": true,
+      "type": "long"
+  },
+  "availbility": {
+      "required": true,
+      "type": "double"
+  },
+  "frameDelay": {
+      "required": true,
+      "type": "double"
+  },
+  "frameLoss": {
+      "required": true,
+      "type": "double"
+  },
+  "jitter": {
+      "required": true,
+      "type": "double"
+  }
+}
+

Example:

{
+  "id": "gold",
+  "commitedInfoRate": 100,
+  "availbility": 0.99,
+  "frameDelay": 17.43,
+  "frameLoss": 0.01,
+  "jitter": 2.43
+}
+

/cosmgr/webapi/list get

Get a list of all COS instances

get

Query a list of all existing COS instances

lsoapi API documentation version v1

CRUD Instances of MEF Defined Services

post /svcmgr/webapi/svc/epl

Body

HTTP status code 200

Body

put /svcmgr/webapi/svc/epl/{eplid}

URI Parameters

Body

HTTP status code 200

Body

get /svcmgr/webapi/svc/epl/{eplid}

URI Parameters

HTTP status code 200

Body

delete /svcmgr/webapi/svc/epl/{eplid}

URI Parameters

HTTP status code 200

Body

get /svcmgr/webapi/svc/epl/list

CRUD MEF EVC Instances

post /evcmgr/webapi

Body

HTTP status code 200

Body

put /evcmgr/webapi/{evcid}

URI Parameters

Body

HTTP status code 200

Body

get /evcmgr/webapi/{evcid}

URI Parameters

HTTP status code 200

Body

delete /evcmgr/webapi/{evcid}

URI Parameters

HTTP status code 200

Body

get /evcmgr/webapi/list

CRUD MEF CoS Instances

post /cosmgr/webapi

Body

HTTP status code 200

Body

put /cosmgr/webapi/{cosid}

URI Parameters

Body

HTTP status code 200

Body

get /cosmgr/webapi/{cosid}

URI Parameters

HTTP status code 200

Body

delete /cosmgr/webapi/{cosid}

URI Parameters

HTTP status code 200

Body

get /cosmgr/webapi/list