Freeze upstream versions
[netvirt.git] / resources / commons / README
1
2 This directory contains all the associated scripts and configuration files that can be used by developers and
3 administrators working on ovsdb project in general.
4
5 Contents
6 --------
7
8 - localhost.json.postman_environment : Environment that associates address and port to localhost:8080 in templates for the collections below.
9
10 - Mininet_Demo_OVSDB_OF.json.postman_collection : Collection of REST-APIs used in the Mininet demo (http://www.youtube.com/watch?v=8iWhMVlflwE)
11
12 - Neutron-v2.0-LBaaS-API-Examples_July15.json.postman_collection.txt : Collection of REST-APIs to interact with LBaas pool/pool member/loadbalancer.
13
14 - showOvsdbMdsal.py : Dumps mdsal related info from running ODL that is related to ovsdb and netvirt. Use 'showOvsdbMdsal.py -h' for usage
15
16 - ODL-Clustering.json.postman_collection : Collection contains Restconf request to fetch clustering service related data to check the state of 3 node cluster and inventory/topology shards.
17     - Please import and load 3-Node-Cluster-Setup-Environment-Variables.postman_environment file, because Restconf request present in this collection depends on the variable defined in this collection.
18
19 - Ovsdb-Southbound-Collection-for-Single-Node-Cluster.json.postman_collection : Collection contains Restconf request for doing CRUD operations (connection, bridge, termination point) on southbound plugin running in standalone controller.
20     - Please import and load Single-Node-Cluster-Setup-Environment-Variables.postman_environment file, because Restconf request present in this collection depends on the variable defined in this collection.
21
22 - Ovsdb-Southbound-Collection-for-3-Node-Cluster.json.postman_collection :
23     - Please import and load 3-Node-Cluster-Setup-Environment-Variables.postman_environment file, because Restconf request present in this collection depends on the variable defined in this collection.
24
25
26 - Single-Node-Cluster-Setup-Environment-Variables.postman_environment : Postman environment file that defines variables for Restconf request for southbound plugin running in Single controller instance
27
28 - 3-Node-Cluster-Setup-Environment-Variables.postman_environment : Postman environment file that defines variables for Restconf request for southbound plugin running in 3 node cluster environment
29
30 - NetvirtSfc.json.postman_collection : Collection of REST-APIs to interact with Netvirt-Sfc.
31
32 - Ovsdb-HwvtepSouthbound-Collection.json.postman_collection : Collection contains Restconf request for doing CRUD operations (hwvtep global node, physical switch, logical switch, physical locator, and physical port) on hwvtepsouthbound plugin running in standalone controller.
33
34 - Qos-and-Queue-Collection-Environment-Variables.postman_environment : Postman environment file that defines variables used by the Qos-and-Queue-Collection.json.postman_collection
35
36 - Qos-and-Queue-Collection.json.postman_collection - Collection of Postman Restconf commands for doing CRUD operations on Qos and Queue entries.
37
38 - readable_flows.py : script for formatting ovs-ofctl dump-flows output into a more readable format. Run w/ -h for help
39
40 - pplogs.py : script for reformatting serialized nested objects in OpenDaylight log lines. Run w/ -h for help
41
42 - VPN-Service-NetVirt.postman_collection.json : restconf requests to get datapath id's and create transport zone.
43   - Make sure to update the dpn-id's, portnames and ip-addresses for your VTEPs in "Create TZA"
44