Merge "Fix Javadoc error."
[ovsdb.git] / resources / commons / OVSDB_Southbound.postman_collection
1 {
2    "id":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
3    "name":"Ovsdb Southbound Collection",
4    "timestamp":1424977469540,
5    "order":[
6       "da6876b9-d594-5e41-80b0-858e5a6b40b8",
7       "f930747d-8044-d544-5e81-1c1a492c80a3",
8       "eaf0abfa-820e-e554-a5df-7ee96bc0ef6a",
9       "e9e14494-2ff0-4bfe-2854-6100b91832ff",
10       "37f0baee-75a7-6b2f-0890-2b5d125110bc",
11       "ec2b5fdd-dfef-ad11-40e9-c9bbe235e845",
12       "b9064b3d-351d-d529-dc3a-b7907c76f134",
13       "fe956461-edb8-90ad-b9bc-5e95951fa757",
14       "d67eac2b-f77c-6ea5-ecfc-dab88c428c88"
15    ],
16    "owner":0,
17    "sharedWithTeam":false,
18    "synced":false,
19    "subscribed":false,
20    "hasRequests":true,
21    "requests":[
22       {
23          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
24          "id":"37f0baee-75a7-6b2f-0890-2b5d125110bc",
25          "name":"Get Config Topology",
26          "description":"Fetch the config topology from configuration data store.",
27          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/",
28          "method":"GET",
29          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
30          "data":[
31
32          ],
33          "dataMode":"params",
34          "timestamp":0,
35          "responses":[
36
37          ],
38          "version":2
39       },
40       {
41          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
42          "id":"b9064b3d-351d-d529-dc3a-b7907c76f134",
43          "name":"Create Specific Config Termination Point",
44          "description":"This restconf request creates port/interface and attach it to specific bridge. Using ovsdb:option, you can pass the optional input to port/interface create optional. E.g. remote_ip=xx.xx.xx.xx.",
45          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest/termination-point/vxlanport/",
46          "method":"PUT",
47          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\nAccept: application/json\n",
48          "data":"{\n  \"network-topology:termination-point\": [\n    \t{\n  \t\t\t\"ovsdb:options\": [\n    \t\t\t{\n                  \"ovsdb:option\": \"remote_ip\",\n                  \"ovsdb:value\" : \"10.10.11.11\"\n\t\t    \t}\n\t  \t\t],\n\t  \t\t\"ovsdb:name\": \"vxlanport\",\n          \t\"ovsdb:interface-type\": \"ovsdb:interface-type-vxlan\",\n  \t\t\t\"tp-id\": \"vxlanport\",\n            \"vlan-tag\": \"1\",\n            \"trunks\": [\n                {\n                    \"trunk\": \"2\"\n                },\n                {\n                    \"trunk\": \"3\"\n                }\n            ],\n            \"vlan-mode\":\"access\"\n\t\t}\n    ]\n}",
49          "dataMode":"raw",
50          "timestamp":0,
51          "version":2
52       },
53       {
54          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
55          "id":"d67eac2b-f77c-6ea5-ecfc-dab88c428c88",
56          "name":"Get Specific Config Termination Point",
57          "description":"Fetch configuration for specific termination point of the bridge from config data store.",
58          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest/termination-point/vxlanport/",
59          "method":"GET",
60          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
61          "data":[
62
63          ],
64          "dataMode":"params",
65          "timestamp":0,
66          "version":2
67       },
68       {
69          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
70          "id":"da6876b9-d594-5e41-80b0-858e5a6b40b8",
71          "name":"Create Specific Config OvsdbNode",
72          "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\"",
73          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:16640",
74          "method":"PUT",
75          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
76          "data":"{\n  \"network-topology:node\": [\n        {\n            \"node-id\": \"ovsdb://10.10.10.10:16640\",\n            \"connection-info\": {\n              \"ovsdb:remote-port\": 16640,\n              \"ovsdb:remote-ip\": \"127.0.0.1\"\n            }\n        }\n    ]\n}",
77          "dataMode":"raw",
78          "timestamp":0,
79          "version":2,
80          "time":1428968453378
81       },
82       {
83          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
84          "id":"e9e14494-2ff0-4bfe-2854-6100b91832ff",
85          "name":"Delete Specific Config OvsdbNode",
86          "description":"This restconf request delete any node (ovsdb node or bridge node) from the config data store. You can use the same request to delete the ovsdb node by using the following URI: http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222",
87          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest",
88          "method":"DELETE",
89          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
90          "data":[
91
92          ],
93          "dataMode":"params",
94          "timestamp":0,
95          "version":2
96       },
97       {
98          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
99          "id":"eaf0abfa-820e-e554-a5df-7ee96bc0ef6a",
100          "name":"Create Specific Config Bridge",
101          "description":"This restconf request creates bridge on the specified ovsdb node.   Restconf URI contains node-id and this node-id has ip address and port. To determine the ip address and port information, fire \"Get Operational Topology\" restconf request and search for node where you want to create a bridge and then use the ip-address / port details from that output. Once you find out the ip-address/port, update the node-id and ovsdb:managed-by element in the restconf body.\n\n       Note: these %2F ('/') in the url are not there by mistake, those are there intentionally because node-id can contain '/'.\n\n    Note:Bridge name should not contain '-' in it, If you bridge name will contain '-', bridge creation will fail. It's know bug and under investigation.",
102          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest",
103          "method":"PUT",
104          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\nContent-Type: application/json\n",
105          "data":"{\n  \"network-topology:node\": [\n        {\n            \"node-id\": \"ovsdb://10.10.10.10:22222/bridge/brtest\",\n             \"ovsdb:bridge-name\": \"brtest\",\n             \"ovsdb:datapath-id\": \"00:00:b2:bf:48:25:f2:4b\",\n             \"ovsdb:protocol-entry\": [\n                {\n                  \"protocol\": \"ovsdb:ovsdb-bridge-protocol-openflow-13\"\n                }\n              ],\n              \"ovsdb:controller-entry\": [\n                {\n                  \"target\": \"tcp:11.11.11.11:6633\"\n                }\n              ],\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://10.10.10.10:22222']\"\n        }\n    ]\n}",
106          "dataMode":"raw",
107          "timestamp":0,
108          "version":2
109       },
110       {
111          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
112          "id":"ec2b5fdd-dfef-ad11-40e9-c9bbe235e845",
113          "name":"Get Specific Config OvsdbNode",
114          "description":"This restconf request fetch the configuration for specific node (ovsdb node or bridge node)",
115          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest",
116          "method":"GET",
117          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
118          "data":[
119
120          ],
121          "dataMode":"params",
122          "timestamp":0,
123          "version":2
124       },
125       {
126          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
127          "id":"f930747d-8044-d544-5e81-1c1a492c80a3",
128          "name":"Get Operational Topology",
129          "description":"This restconf request will fetch the operational topology. Operational topology details are fetch by southbound plugin from all the connected ovsdb node.",
130          "url":"http://localhost:8080/restconf/operational/network-topology:network-topology/",
131          "method":"GET",
132          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
133          "data":[
134
135          ],
136          "dataMode":"params",
137          "timestamp":0,
138          "responses":[
139
140          ],
141          "version":2
142       },
143       {
144          "collectionId":"ebc00c37-8a7e-f980-5b19-3f62212c5a58",
145          "id":"fe956461-edb8-90ad-b9bc-5e95951fa757",
146          "name":"Delete Specific ConfigTermination Point",
147          "description":"Delete configuration of specified termination point of bridge. ",
148          "url":"http://localhost:8080/restconf/config/network-topology:network-topology/topology/ovsdb:1/node/ovsdb:%2F%2F10.10.10.10:22222%2Fbridge%2Fbrtest/termination-point/vxlanport/",
149          "method":"DELETE",
150          "headers":"Authorization: Basic YWRtaW46YWRtaW4=\n",
151          "data":[
152
153          ],
154          "dataMode":"params",
155          "timestamp":0,
156          "version":2
157       }
158    ]
159 }