Migrating DLUX, Clustering, Version and XSQL to reST
[docs.git] / docs / getting-started-guide / common-features / version.rst
1 OpenDaylight Version
2 ====================
3
4 Overview
5 --------
6
7 This feature allows NETCONF/RESTCONF users to determine the version of
8 OpenDaylight they are communicating with.
9
10 Install the Version Feature
11 ---------------------------
12
13 Follow these steps to install the version feature:
14
15 #. Navigate to the directory in which you installed OpenDaylight
16 #. Start Karaf::
17
18       ./bin/karaf
19
20 #. Install Version feature::
21
22       feature:install odl-distribution-version
23
24 .. note:: For RESTCONF access, it is recommended to install odl-restconf
25           and odl-netconf-connector-ssh.
26
27 Version Feature Usage
28 ---------------------
29
30 Example of RESTCONF request using curl from bash::
31
32     $ 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
33
34 Example response (formatted)::
35
36    {
37     "module": [
38      {
39       "type": "odl-distribution-version:odl-version",
40       "name": "odl-distribution-version",
41       "odl-distribution-version:version": "0.5.0-SNAPSHOT"
42      }
43     ]
44    }