Migrate general installation instructions to reST
[docs.git] / manuals / getting-started-guide / src / main / asciidoc / ch-controller-version.adoc
1 == Controller Version
2
3 === Overview
4
5 This feature allows NETCONF/RESTCONF users to determine the version of
6 OpenDaylight they are communicating with.
7
8 === Install the Version Feature
9
10 Follow these steps to install the version feature:
11
12 . Navigate to the directory in which you installed OpenDaylight
13 . Start Karaf:
14 +
15  ./bin/karaf
16 +
17 . Install Version feature:
18 +
19  feature:install odl-distribution-version
20
21 NOTE: For RESTCONF access, it is recommended to install odl-restconf
22 and odl-netconf-connector-ssh.
23
24 === Version Feature Usage
25
26 Example of RESTCONF request using curl from bash:
27 ```
28 $ curl -u 'admin:admin' localhost:8181/restconf/config/network-topology:network-topology/topology/topology-netconf/node/controller-config/yang-ext:mount/config:modules/module/odl-distribution-version:odl-version/odl-distribution-version
29 ```
30 Example response (formatted):
31 ```
32 {
33  "module": [
34   {
35    "type": "odl-distribution-version:odl-version",
36    "name": "odl-distribution-version",
37    "odl-distribution-version:version": "0.5.0-SNAPSHOT"
38   }
39  ]
40 }
41 ```