Merge "Documentation outline for centinel."
[docs.git] / manuals / user-guide / src / main / asciidoc / controller / netconf / odl-netconf-testtool-user.adoc
1 === NETCONF testtool
2 *NETCONF testtool is a set of standalone runnable jars that can:*
3
4 * Simulate NETCONF devices(suitable for scale testing)
5 * Stress/Performance test NETCONF devices
6 * Stress/Performance test RESTCONF devices
7
8 These jars are part of OpenDaylight's controller project and are built from the
9 NETCONF codebase in OpenDaylight.
10
11 TIP: Download testtool from OpenDaylight Nexus at: http://nexus.opendaylight.org/#nexus-search;quick~netconf-testtool
12
13 *Nexus contains 3 executable tools:*
14
15 * executable.jar - device simulator
16 * stress.client.tar.gz - NETCONF stress/performance measuring tool
17 * perf-client.jar - RESTCONF stress/performance measuring tool
18
19 TIP: Each executable tool provides help. Just invoke +java -jar
20 <name-of-the-tool.jar> --help+
21
22 ==== NETCONF device simulator
23 Detailed information for NETCONF device simulator can be found at: https://wiki.opendaylight.org/view/OpenDaylight_Controller:Netconf:Testtool
24 ////
25 TODO migrate the guide from wiki here
26 ////
27
28 ==== NETCONF stress/performance measuring tool
29 This is basically a NETCONF client that puts NETCONF servers under
30 heavy load of NETCONF RPCs and measures the time until a configurable
31 amount of them is processed.
32
33 ////
34 TODO add a guide on how to do this with OpenDaylight
35 ////
36
37 ==== RESTCONF stress-performance measuring tool
38 Very similar to NETCONF stress tool with the difference of using
39 RESTCONF protocol instead of NETCONF.
40
41 ////
42 TODO add a guide on how to do this with OpenDaylight
43 ////