Merge "Add a new section SFC CLI to the User Guide"

[docs.git] / docs / user-guide / ocp-plugin-user-guide.rst

diff --git a/docs/user-guide/ocp-plugin-user-guide.rst b/docs/user-guide/ocp-plugin-user-guide.rst
index a9b4fb4e984f0190f2c300c6815668d79180d48c..9bbad764b50d1493a23dedb6747f5911a79903de 100644 (file)
--- a/docs/user-guide/ocp-plugin-user-guide.rst
+++ b/docs/user-guide/ocp-plugin-user-guide.rst
@@ -1,3 +1,5 @@
+.. _ocpplugin-user-guide:
+

 OCP Plugin User Guide
 =====================
 
 OCP Plugin User Guide
 =====================
 


@@ -54,15 +56,15 @@ The OCP Plugin project includes:
 
    -  Fault management
 
 
    -  Fault management
 

-   -  Software management (not implemented as of Boron)
+   -  Software management (not yet implemented)

 
 -  Indication processing
 
 
 -  Indication processing
 

--  Logging (not implemented as of Boron)
+-  Logging (not yet implemented)

 
 

--  AISG/Iuant interface message tunnelling (not implemented as of Boron)
+-  AISG/Iuant interface message tunnelling (not yet implemented)

 
 

--  ALD connection management (not implemented as of Boron)
+-  ALD connection management (not yet implemented)

 
 Architecture and Design
 -----------------------
 
 Architecture and Design
 -----------------------


@@ -155,7 +157,7 @@ you have to install the following features to enable RESTCONF and DLUX.
 
 ::
 
 
 ::
 

-    karaf#>feature:install odl-restconf odl-l2switch-switch odl-mdsal-apidocs odl-dlux-core odl-dlux-all
+    karaf#>feature:install odl-restconf odl-l2switch-switch odl-mdsal-apidocs odl-dlux-core odl-dluxapps-applications

 
 Then install the odl-ocpplugin-all feature which includes the
 odl-ocpplugin-southbound and odl-ocpplugin-app-ocp-service features.
 
 Then install the odl-ocpplugin-all feature which includes the
 odl-ocpplugin-southbound and odl-ocpplugin-app-ocp-service features.


@@ -182,7 +184,7 @@ Configuring the OCP plugin can be done via its configuration file,
 62-ocpplugin.xml, which can be found in the
 <odl-install-dir>/etc/opendaylight/karaf/ directory.
 
 62-ocpplugin.xml, which can be found in the
 <odl-install-dir>/etc/opendaylight/karaf/ directory.
 

-As of Boron, there are the following settings that are configurable:
+There are the following settings that are configurable:

 
 1. **port** specifies the port number on which the OCP plugin listens
    for connection requests
 
 1. **port** specifies the port number on which the OCP plugin listens
    for connection requests


@@ -219,7 +221,7 @@ from OpenDaylight Nexus Repository.
 
 ::
 
 
 ::
 

-    wget https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/ocpplugin/simple-agent/0.1.0-Boron/simple-agent-0.1.0-Boron.jar
+    wget https://nexus.opendaylight.org/content/repositories/opendaylight.release/org/opendaylight/ocpplugin/simple-agent/${ocp-version}/simple-agent-${ocp-version}.jar

 
 Then run the agent with no arguments (assuming you already have JDK 1.8
 or above installed) and it should display the usage that lists the
 
 Then run the agent with no arguments (assuming you already have JDK 1.8
 or above installed) and it should display the usage that lists the


@@ -227,7 +229,7 @@ expected arguments.
 
 ::
 
 
 ::
 

-    java -classpath simple-agent-0.1.0-Boron.jar org.opendaylight.ocpplugin.OcpAgent
+    java -classpath simple-agent-${ocp-version}.jar org.opendaylight.ocpplugin.OcpAgent

 
     Usage: java org.opendaylight.ocpplugin.OcpAgent <controller's ip address> <port number> <vendor id> <serial number>
 
 
     Usage: java org.opendaylight.ocpplugin.OcpAgent <controller's ip address> <port number> <vendor id> <serial number>
 


@@ -235,7 +237,7 @@ Here is an example:
 
 ::
 
 
 ::
 

-    java -classpath simple-agent-0.1.0-Boron.jar org.opendaylight.ocpplugin.OcpAgent 127.0.0.1 1033 XYZ 123
+    java -classpath simple-agent-${ocp-version}.jar org.opendaylight.ocpplugin.OcpAgent 127.0.0.1 1033 XYZ 123

 
 Web / Graphical Interface
 -------------------------
 
 Web / Graphical Interface
 -------------------------


@@ -295,4 +297,3 @@ the form of both northbound and southbound APIs, including:
 
 The API is documented in the OCP Plugin Developer Guide under the
 section Southbound API and Northbound API, respectively.
 
 The API is documented in the OCP Plugin Developer Guide under the
 section Southbound API and Northbound API, respectively.

-