resources/commons/Qos-and-Queue-Collection.json.postman_collection

   1 {
   2     "id": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
   3     "name": "Qos and Queue Collection",
   4     "description": "This collection demonstrates how to:\n\n- create Qos and Queue entries in the OVSDB\n- add or delete Queue entries from a Qos entry\n- add or delete a Qos entry from a termination point\n- delete Qos and Queue entries",
   5     "order": [
   6         "400b68fe-7e92-8da8-29ed-ffc964e03eb3",
   7         "479d3281-ac30-3b30-d727-80b0b8505140",
   8         "d263138d-3ef5-733b-4337-87de3eccbecc",
   9         "0105b240-9b36-79be-0251-9c2510563c71",
  10         "a0b5092f-2bd2-3d6d-7891-a25df8d55d31",
  11         "bdfa43fb-1d49-2433-da72-9a13f564680f",
  12         "a0eb2758-39dd-2603-ba63-fd96abe51a9d",
  13         "6034d635-e823-b733-e4b5-a9e2cefb27bd",
  14         "9aa6926b-70db-1d22-dc30-db269e424bec",
  15         "4298de9f-d2e0-a7c0-da4b-71ce9ecc7260",
  16         "8ff38d91-00ee-e7c6-ef1a-e3d236f59641",
  17         "ba67cc34-62d4-60e7-86be-7a187b4a9334",
  18         "1468ceac-807b-d3c3-f07a-a6fd86c98ea0",
  19         "a2f4d7cd-1de9-806e-e2e4-03ac2b618e66",
  20         "14a55d30-ab5d-4007-3905-791a111457eb",
  21         "494db14f-97e9-ce5b-5964-5504c9630a20",
  22         "6293d31b-ea45-d504-ebac-8d765f46cb45",
  23         "8dd9ab66-f999-6376-8584-ddc9729fb60c"
  24     ],
  25     "folders": [],
  26     "timestamp": 1454567977189,
  27     "owner": 0,
  28     "public": false,
  29     "hasRequests": true,
  30     "requests": [
  31         {
  32             "id": "0105b240-9b36-79be-0251-9c2510563c71",
  33             "headers": "Content-Type: application/json\n",
  34             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/",
  35             "preRequestScript": "",
  36             "pathVariables": {},
  37             "method": "PUT",
  38             "data": [],
  39             "dataMode": "raw",
  40             "version": 2,
  41             "tests": "",
  42             "currentHelper": "normal",
  43             "helperAttributes": {},
  44             "time": 1454572576470,
  45             "name": "Add a QoS entry to a qos-entries list",
  46             "description": "This restconf request will create or update a Qos entry for the ovsdb node 'HOST1'.",
  47             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
  48             "responses": [],
  49             "rawModeData": "{\n  \"ovsdb:qos-entries\": [\n    {\n      \"qos-id\": \"QOS-1\",\n      \"qos-type\": \"ovsdb:qos-type-linux-htb\",\n      \"qos-other-config\": [\n        {\n          \"other-config-key\": \"max-rate\",\n          \"other-config-value\": \"3300000\"\n        }\n      ]\n    }\n  ]\n}"
  50         },
  51         {
  52             "id": "1468ceac-807b-d3c3-f07a-a6fd86c98ea0",
  53             "headers": "",
  54             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/",
  55             "preRequestScript": "",
  56             "pathVariables": {},
  57             "method": "DELETE",
  58             "data": [],
  59             "dataMode": "params",
  60             "version": 2,
  61             "tests": "",
  62             "currentHelper": "normal",
  63             "helperAttributes": {},
  64             "time": 1454572816260,
  65             "name": "Delete a QoS entry from a node",
  66             "description": "This restconf command will delete a Qos entry from an ovsdb node.",
  67             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
  68             "responses": []
  69         },
  70         {
  71             "id": "14a55d30-ab5d-4007-3905-791a111457eb",
  72             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\nAccept: application/json\n",
  73             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1%2Fbridge%2Fbr-test/termination-point/testport/",
  74             "preRequestScript": "",
  75             "pathVariables": {},
  76             "method": "PUT",
  77             "data": [],
  78             "dataMode": "raw",
  79             "version": 2,
  80             "tests": "",
  81             "currentHelper": "normal",
  82             "helperAttributes": {},
  83             "time": 1466010716484,
  84             "name": "Add existing QoS ID to a termination point",
  85             "description": "This restconf request will specify the QoS ID of a Qos entry to associate with a port (termination point).\n\nThe QoS ID is the ODL identifier for identifying the QoS entry.  The actual UUID of the QoS entry will looked up and used to update the OVSDB port qos attributes.",
  86             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
  87             "responses": [],
  88             "rawModeData": "{\n  \"network-topology:termination-point\": [\n    \t{\n \t  \t\t\"ovsdb:name\": \"testport\",\n \t\t\t\"tp-id\": \"testport\",\n \t\t\t\"ovsdb:qos-entry\": [\n                {\n                    \"qos-key\": 1,\n                    \"qos-ref\": \"/network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id='ovsdb:HOST1']/ovsdb:qos-entries[ovsdb:qos-id='QOS-1']\"\n                }\n            ]\n  \t\t}\n    ]\n}"
  89         },
  90         {
  91             "id": "400b68fe-7e92-8da8-29ed-ffc964e03eb3",
  92             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nAccept: application/json\nContent-Type: application/json\n",
  93             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/",
  94             "preRequestScript": "",
  95             "pathVariables": {},
  96             "method": "POST",
  97             "data": [],
  98             "dataMode": "raw",
  99             "version": 2,
 100             "tests": "",
 101             "currentHelper": "normal",
 102             "helperAttributes": {},
 103             "time": 1454573115055,
 104             "name": "POST to create OVSDB NODE HOST1",
 105             "description": "Fire this Restconf request if you want to initiate the connection to ovsdb node from controller. It assumes that ovsdb node is listening for tcp connection in passive mode. To configure the ovsdb node for listening incoming connection, please fire following command at ovsdb node machine\n\n\"ovs-vsctl set-manager tcp:16640\"",
 106             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 107             "responses": [],
 108             "rawModeData": "\r\n        {\r\n            \"node\": [\r\n                {\r\n                    \"node-id\": \"ovsdb:HOST1\",\r\n                    \"connection-info\": {\r\n                        \"ovsdb:remote-ip\": \"{{HYPERVISOR-IP}}\",\r\n                        \"ovsdb:remote-port\": \"{{HYPERVISOR-OVSDB-PORT}}\"\r\n                    }\r\n                }\r\n            ]\r\n        }\r\n"
 109         },
 110         {
 111             "id": "479d3281-ac30-3b30-d727-80b0b8505140",
 112             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
 113             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1%2Fbridge%2Fbr-test",
 114             "preRequestScript": "",
 115             "pathVariables": {},
 116             "method": "PUT",
 117             "data": [],
 118             "dataMode": "raw",
 119             "version": 2,
 120             "tests": "",
 121             "currentHelper": "normal",
 122             "helperAttributes": {},
 123             "time": 1461790310464,
 124             "name": "Create bridge br-test on HOST1",
 125             "description": "Create bridge \"br-test\" on OVSDB node \"ovsdb:HOST1\"",
 126             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 127             "responses": [],
 128             "rawModeData": "{\n  \"network-topology:node\": [\n        {\n            \"node-id\": \"ovsdb:HOST1/bridge/br-test\",\n             \"ovsdb:bridge-name\": \"br-test\",\n             \"ovsdb:managed-by\": \"/network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id='ovsdb:HOST1']\"\n        }\n    ]\n}"
 129         },
 130         {
 131             "id": "494db14f-97e9-ce5b-5964-5504c9630a20",
 132             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\nAccept: application/json\n",
 133             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1%2Fbridge%2Fbr-test/termination-point/testport/qos-entry/1",
 134             "preRequestScript": "",
 135             "pathVariables": {},
 136             "method": "DELETE",
 137             "data": [],
 138             "dataMode": "raw",
 139             "version": 2,
 140             "tests": "",
 141             "currentHelper": "normal",
 142             "helperAttributes": {},
 143             "time": 1466012030265,
 144             "name": "Delete QoS Entry from a termination point",
 145             "description": "This restconf request specifies the QopS ID of a Qos entry to delete from the QoS entry list of the termination point.",
 146             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 147             "responses": [],
 148             "rawModeData": ""
 149         },
 150         {
 151             "id": "6034d635-e823-b733-e4b5-a9e2cefb27bd",
 152             "headers": "Content-Type: application/json\n",
 153             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/",
 154             "preRequestScript": "",
 155             "pathVariables": {},
 156             "method": "PUT",
 157             "data": [],
 158             "dataMode": "raw",
 159             "version": 2,
 160             "tests": "",
 161             "currentHelper": "normal",
 162             "helperAttributes": {},
 163             "time": 1454572737919,
 164             "name": "Add a Queue List to a QoS entry (deprecated)",
 165             "description": "This restconf adds a Queue to a Qos entry by specifying a queue-list\nin the Qos entry which uses the operational queue UUID value.\n\nNote - Queues can now be added to QoS entries using the ODL Queue ID value.",
 166             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 167             "responses": [],
 168             "rawModeData": "{\n  \"ovsdb:qos-entries\": [\n    {\n      \"qos-id\": \"QOS-1\",\n      \"queue-list\": [\n          {\n              \"queue-number\": \"0\",\n              \"queue-uuid\": \"8100a05f-d3fa-4e65-bbd1-6e886713f592\"\n          }\n        ]\n    }\n  ]\n}"
 169         },
 170         {
 171             "id": "6293d31b-ea45-d504-ebac-8d765f46cb45",
 172             "headers": "Content-Type: application/json\n",
 173             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/",
 174             "preRequestScript": "",
 175             "pathVariables": {},
 176             "method": "PUT",
 177             "data": [],
 178             "dataMode": "raw",
 179             "version": 2,
 180             "tests": "",
 181             "currentHelper": "normal",
 182             "helperAttributes": {},
 183             "time": 1465849834924,
 184             "name": "Add existing Queue ID entry to a QoS entry",
 185             "description": "Add a Queue to a QoS entry using the ODL Queue ID as the identifier for the Queue entry.",
 186             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 187             "responses": [],
 188             "rawModeData": "{\n    \"ovsdb:qos-entries\": [\n        {\n            \"qos-id\": \"QOS-1\",\n            \"queue-list\": [\n                {\n                    \"queue-number\": \"0\",\n                    \"queue-ref\": \"/network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id='ovsdb:HOST1']/ovsdb:queues[ovsdb:queue-id='QUEUE-1']\"\n                }\n            ]\n        }\n    ]\n}"
 189         },
 190         {
 191             "id": "8dd9ab66-f999-6376-8584-ddc9729fb60c",
 192             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\nAccept: application/json\n",
 193             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1%2Fbridge%2Fbr-test/termination-point/testport/",
 194             "pathVariables": {},
 195             "preRequestScript": "",
 196             "method": "PUT",
 197             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 198             "data": [],
 199             "dataMode": "raw",
 200             "name": "Set ingress policing attributes of a termination point",
 201             "description": "Set the ingress policing attributes of an ovsdb interface by updating the termination point.\ningress-policing-rate\ningress-policing-burst\n\nNote - This is an update to a termination point's attributes.  If there is also a QoS entry configured for the termination point, then it must be supplied in the body as well.  Otherwise, not including the QoS entry in the body will result in the QoS entry being removed from the port.",
 202             "descriptionFormat": "html",
 203             "time": 1463685062091,
 204             "version": 2,
 205             "responses": [],
 206             "tests": "",
 207             "currentHelper": "normal",
 208             "helperAttributes": {},
 209             "rawModeData": "{\n    \"network-topology:termination-point\": [\n    \t{\n\t  \t\t\"ovsdb:name\": \"testport\",\n  \t\t\t\"tp-id\": \"testport\",\n            \"ovsdb:ingress-policing-rate\": 1000,\n            \"ovsdb:ingress-policing-burst\": 2000\n\t\t}\n    ]\n}"
 210         },
 211         {
 212             "id": "9aa6926b-70db-1d22-dc30-db269e424bec",
 213             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\n",
 214             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/queue-list/0/",
 215             "preRequestScript": "",
 216             "pathVariables": {},
 217             "method": "DELETE",
 218             "data": [],
 219             "dataMode": "params",
 220             "version": 2,
 221             "tests": "",
 222             "currentHelper": "normal",
 223             "helperAttributes": {},
 224             "time": 1454572752090,
 225             "name": "Delete a Queue entry from a Qos entry",
 226             "description": "This restconf command will delete a queue entry from a qos entry.\n\nThe queue entry is identified by it's key value (the queue number) in\nthe queue-list which is part of the qos entry.",
 227             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 228             "responses": []
 229         },
 230         {
 231             "id": "a0b5092f-2bd2-3d6d-7891-a25df8d55d31",
 232             "headers": "Content-Type: application/json\n",
 233             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:queues/QUEUE-1/",
 234             "preRequestScript": "",
 235             "pathVariables": {},
 236             "method": "PUT",
 237             "data": [],
 238             "dataMode": "raw",
 239             "version": 2,
 240             "tests": "",
 241             "currentHelper": "normal",
 242             "helperAttributes": {},
 243             "time": 1454572671919,
 244             "name": "Add a Queue entry to the queues list of aovsdb node 'HOST1'",
 245             "description": "This restconf request will create or update a Queue entry on ovsdb node 'HOST1'.",
 246             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 247             "responses": [],
 248             "rawModeData": "{\n  \"ovsdb:queues\": [\n    {\n      \"queue-id\": \"QUEUE-1\",\n      \"dscp\": 25,\n      \"queues-other-config\": [\n        {\n          \"queue-other-config-key\": \"max-rate\",\n          \"queue-other-config-value\": \"3600000\"\n        }\n      ]\n    }\n  ]\n}"
 249         },
 250         {
 251             "id": "a0eb2758-39dd-2603-ba63-fd96abe51a9d",
 252             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
 253             "url": "http://{{CONTROLLER-IP}}:8181/restconf/operational/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:queues/QUEUE-1/",
 254             "preRequestScript": "",
 255             "pathVariables": {},
 256             "method": "GET",
 257             "data": [],
 258             "dataMode": "params",
 259             "version": 2,
 260             "tests": "",
 261             "currentHelper": "normal",
 262             "helperAttributes": {},
 263             "time": 1454572710554,
 264             "name": "Get a specific operaiontal Queue entry",
 265             "description": "This restconf command will query the operational md-sal for a specified Queue entry (e.g. 'QUEUE-1') which has previously been added to the config md-sal.",
 266             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 267             "responses": []
 268         },
 269         {
 270             "id": "a2f4d7cd-1de9-806e-e2e4-03ac2b618e66",
 271             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
 272             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1",
 273             "preRequestScript": "",
 274             "pathVariables": {},
 275             "method": "PUT",
 276             "data": [],
 277             "dataMode": "raw",
 278             "version": 2,
 279             "tests": "",
 280             "currentHelper": "normal",
 281             "helperAttributes": {},
 282             "time": 1466012434801,
 283             "name": "Create a QoS and linked Queue entry to an OVSDB Node",
 284             "description": "This restconf command will create new QoS and Queue entries.  The Queue entry is assigned to the QoS queueu list.",
 285             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 286             "responses": [],
 287             "rawModeData": "{\r\n    \"network-topology:node\": [\r\n        {\r\n            \"node-id\": \"ovsdb:HOST1\",\r\n            \"ovsdb:qos-entries\": [\r\n                {\r\n                    \"qos-id\": \"QOS-1\",\r\n                    \"qos-other-config\": [\r\n                        {\r\n                            \"other-config-key\": \"max-rate\",\r\n                            \"other-config-value\": \"3300000\"\r\n                        }\r\n                    ],\r\n                    \"qos-type\": \"ovsdb:qos-type-linux-htb\",\r\n                    \"queue-list\": [\r\n                        {\r\n                            \"queue-number\": \"0\",\r\n                            \"queue-ref\": \"/network-topology:network-topology/network-topology:topology[network-topology:topology-id='ovsdb:1']/network-topology:node[network-topology:node-id='ovsdb:HOST1']/ovsdb:queues[ovsdb:queue-id='QUEUE-1']\"\r\n                        }\r\n                    ]\r\n                }\r\n            ],\r\n            \"ovsdb:queues\": [\r\n                {\r\n                    \"queue-id\": \"QUEUE-1\",\r\n                    \"dscp\" : 51,\r\n                    \"queues-other-config\": [\r\n                        {\r\n                            \"queue-other-config-key\": \"max-rate\",\r\n                            \"queue-other-config-value\": \"1230000\"\r\n                        },\r\n                        {\r\n                            \"queue-other-config-key\": \"min-rate\",\r\n                            \"queue-other-config-value\": \"1000000\"\r\n                        }\r\n                    ],\r\n                    \"queues-external-ids\": [\r\n                        {\r\n                            \"queues-external-id-key\": \"Big\",\r\n                            \"queues-external-id-value\": \"Dog\"\r\n                        }\r\n                    ]\r\n                }\r\n            ]\r\n        }\r\n    ]\r\n}"
 288         },
 289         {
 290             "id": "ba67cc34-62d4-60e7-86be-7a187b4a9334",
 291             "headers": "",
 292             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:queues/QUEUE-1/",
 293             "preRequestScript": "",
 294             "pathVariables": {},
 295             "method": "DELETE",
 296             "data": [],
 297             "dataMode": "params",
 298             "version": 2,
 299             "tests": "",
 300             "currentHelper": "normal",
 301             "helperAttributes": {},
 302             "time": 1454572803238,
 303             "name": "Delete a Queue entry from an ovsdb node",
 304             "description": "This restconf command will delete a Qos entry.",
 305             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 306             "responses": []
 307         },
 308         {
 309             "id": "bdfa43fb-1d49-2433-da72-9a13f564680f",
 310             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\n",
 311             "url": "http://{{CONTROLLER-IP}}:8181/restconf/operational/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1/ovsdb:qos-entries/QOS-1/",
 312             "preRequestScript": "",
 313             "pathVariables": {},
 314             "method": "GET",
 315             "data": [],
 316             "dataMode": "params",
 317             "version": 2,
 318             "tests": "",
 319             "currentHelper": "normal",
 320             "helperAttributes": {},
 321             "time": 1454572690160,
 322             "name": "Get Operational QoS Entry from Qos Entry list",
 323             "description": "This restconf queries the operational md-sal for a specific Qos entry which was previously created by restconf (e.g. 'QOS-1').",
 324             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 325             "responses": []
 326         },
 327         {
 328             "id": "d263138d-3ef5-733b-4337-87de3eccbecc",
 329             "headers": "Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\nAccept: application/json\n",
 330             "url": "http://{{CONTROLLER-IP}}:8181/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:HOST1%2Fbridge%2Fbr-test/termination-point/testport/",
 331             "preRequestScript": "",
 332             "pathVariables": {},
 333             "method": "PUT",
 334             "data": [],
 335             "dataMode": "raw",
 336             "version": 2,
 337             "tests": "",
 338             "currentHelper": "normal",
 339             "helperAttributes": {},
 340             "time": 1454573176142,
 341             "name": "Create Termination Point",
 342             "description": "This restconf request creates a port/interface (`testport`) and attaches it to bridge 'br-test'. \n",
 343             "collectionId": "b96ed27e-7aee-47e1-daa6-e3dbe3f176af",
 344             "responses": [],
 345             "rawModeData": "{\n  \"network-topology:termination-point\": [\n    \t{\n\t  \t\t\"ovsdb:name\": \"testport\",\n  \t\t\t\"tp-id\": \"testport\"\n\t\t}\n    ]\n}"
 346         }
 347     ]
 348 }