ttp-cli-tools-user-guide
uni-manager-plug-in-project
unified-secure-channel
+ usecplugin-aaa-user-guide
+ usecplugin-openflow-user-guide
virtual-tenant-network-(vtn)
yang-ide-user-guide
yang-push
--- /dev/null
+Usecplugin-AAA User Guide
+=========================
+
+The Usecplugin User Guide contains information about configuration,
+administration, management, using and troubleshooting the feature.
+
+Overview
+--------
+
+AAA plugin provides authorization, authentication and accounting
+services to OpenDaylight. A user logs in to OpenDaylight through the
+username and password provided by AAA plugin. Usecplugin-AAA collects
+and stores information about both successful and failed login attempts
+to OpenDaylight.
+
+Usecplugin-AAA Architecture
+---------------------------
+
+AAA plugin creates log messages about successful and failed login
+attempts to OpenDaylight. Usecplugin-AAA continuously reads this log
+file and checks for either successful and failed attempt information.
+Whenever Usecpluin-AAA identifies a new attempt entry in the log file it
+is stored in YANG Data Store and its own log file.
+
+Administering or Managing Usecplugin-AAA
+----------------------------------------
+
+- Install feature ``odl-usecplugin-aaa``
+
+- Enable odl-aaa log using command
+ ``log:set DEBUG org.opendaylight.aaa.shiro.filters``
+
+- Login to the RESTCONF documentation.
+
+- Check operational datastore for login attempts.
+
+- POST URI ::
+ http://localhost:8181/restconf/operations/usecpluginaaa:attemptFromIP
+
+ - Sample Input :: {"usecpluginaaa:input":{"ScrIP":"10.0.0.1"}}
+
+- POST URI ::
+ http://localhost:8181/restconf/operations/usecpluginaaa:attemptOnDateTime
+
+ - Sample Input :: {"usecpluginaaa:input":{"dateTime":"2016-07-27
+ 14:11:18"}}
+
--- /dev/null
+Usecplugin-OpenFlow User Guide
+==============================
+
+The Usecplugin-OpenFlow User Guide contains information about
+configuration, administration, management, using and troubleshooting the
+feature.
+
+Overview
+--------
+
+Usecplugin-OpenFlow collects information about potential OpenFlow
+Packet\_In attacks to OpenDaylight. A threshold (water mark) can be set
+for the Packet\_In rate which when breached will trigger Packet\_In
+message information collection.
+
+Usecplugin Architecture
+-----------------------
+
+Usecplugin listens on OpenFlow southbound interface for Packet\_In
+messages. When the rate of Packet\_In breaches the high water mark the
+application parses the message for header information which is
+subsequently stored in YANG Data Store and a log file. Usecplugin has
+PacketHandler class that implements the PacketProcessing interface to
+override the OnPacketReceived notification by which the application is
+notified of Packet\_In messages.
+
+Configuring Usecplugin-OpenFlow
+-------------------------------
+
+Install the Usecplugin-OpenFlow feautre in OpenDaylight with the
+``feature:install odl-usecplugin-openflow`` at the Karaf CLI.
+
+A user can set the low water mark and high water mark for Packet\_In
+rates as well as number of samples for checking the time interval to
+calculate Packet\_In rate.
+
+URI
+ http://localhost:8181/apidoc/explorer/index.html#!/usecplugin(2015-01-05)
+
+High Water Mark Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+PUT URI
+ http://localhost:8181/restconf/config/usecplugin:sample-data-hwm/
+
+Sample Input
+ ``{"usecplugin:sample-data-hwm": { "samples":"3000","highWaterMark":"3000"}}``
+
+Low Water Mark Configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+PUT URI
+ http://localhost:8181/restconf/config/usecplugin:sample-data-lwm/
+
+Sample Input
+ ``{"usecplugin:sample-data-lwm": { "samples-lwm":"2000","lowWaterMark-lwm":"2000"}}``
+
+Administering or Managing Usecplugin-OpenFlow
+---------------------------------------------
+
+Use RPC POST APIs in the following format for getting the attack related
+information.
+
+attackID
+~~~~~~~~
+
+URI
+ http://localhost:8181/restconf/operations/usecplugin:attackID
+
+Sample Input
+ ``{"usecplugin:input": { "NodeID":"openflow:1"}}``
+
+attacksFromIP
+~~~~~~~~~~~~~
+
+URI
+ http://localhost:8181/restconf/operations/usecplugin:attacksFromIP
+
+Sample Input
+ ``{"usecplugin:input": { "SrcIP":"10.0.0.1"}}``
+
+attacksToIP
+~~~~~~~~~~~
+
+URI
+ http://localhost:8181/restconf/operations/usecplugin:attacksToIP
+
+Sample Input
+ ``{"usecplugin:input": { "DstIP":"10.0.0.2"}}``
+
== Usecplugin-AAA User Guide
-The Usecplugin User Guide contains information about configuration, administration,
-management, using and troubleshooting the feature.
-=== Overview
-AAA plugin provides authorization, authentication and accounting services to OpenDaylight. A user logs in to
-OpenDaylight through the username and password provided by AAA plugin.
-Usecplugin-AAA collects and stores information about both successful and failed login attempts to OpenDaylight.
-
-
-=== Usecplugin-AAA Architecture
-AAA plugin creates log messages about successful and failed login attempts to OpenDaylight.
-Usecplugin-AAA continuously reads this log file and checks for either successful and failed attempt information.
-Whenever Usecpluin-AAA identifies a new attempt entry in the log file it is stored
-in YANG Data Store and its own log file.
-
-=== Administering or Managing Usecplugin-AAA
-* Install feature `odl-usecplugin-aaa`
-* Enable odl-aaa log using command `log:set DEBUG org.opendaylight.aaa.shiro.filters`
-* Login to the RESTCONF documentation.
-* Check operational datastore for login attempts.
-* POST URI :: http://localhost:8181/restconf/operations/usecpluginaaa:attemptFromIP
-** Sample Input :: {"usecpluginaaa:input":{"ScrIP":"10.0.0.1"}}
-* POST URI :: http://localhost:8181/restconf/operations/usecpluginaaa:attemptOnDateTime
-** Sample Input :: {"usecpluginaaa:input":{"dateTime":"2016-07-27 14:11:18"}}
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/user-guide/usecplugin-aaa-user-guide.html
== Usecplugin-OpenFlow User Guide
-The Usecplugin-OpenFlow User Guide contains information about configuration, administration,
-management, using and troubleshooting the feature.
-=== Overview
-Usecplugin-OpenFlow collects information about potential OpenFlow Packet_In attacks to OpenDaylight.
-A threshold (water mark) can be set for the Packet_In rate which when breached will trigger Packet_In message
-information collection.
-
-=== Usecplugin Architecture
-Usecplugin listens on OpenFlow southbound interface for Packet_In messages. When the rate of Packet_In
-breaches the high water mark the application parses the message for header information which is subsequently
-stored in YANG Data Store and a log file. Usecplugin has PacketHandler class that implements the PacketProcessing
-interface to override the OnPacketReceived notification by which the application is notified of Packet_In messages.
-
-=== Configuring Usecplugin-OpenFlow
-
-Install the Usecplugin-OpenFlow feautre in OpenDaylight with the `feature:install odl-usecplugin-openflow` at the Karaf CLI.
-
-A user can set the low water mark and high water mark for Packet_In rates as well as number of samples for checking the time interval to calculate Packet_In rate.
-
-URI :: http://localhost:8181/apidoc/explorer/index.html#!/usecplugin(2015-01-05)
-
-==== High Water Mark Configuration
-PUT URI :: http://localhost:8181/restconf/config/usecplugin:sample-data-hwm/
-Sample Input :: `{"usecplugin:sample-data-hwm": { "samples":"3000","highWaterMark":"3000"}}`
-
-==== Low Water Mark Configuration
-PUT URI :: http://localhost:8181/restconf/config/usecplugin:sample-data-lwm/
-Sample Input :: `{"usecplugin:sample-data-lwm": { "samples-lwm":"2000","lowWaterMark-lwm":"2000"}}`
-
-=== Administering or Managing Usecplugin-OpenFlow
-Use RPC POST APIs in the following format for getting the attack related information.
-
-==== attackID
-URI :: http://localhost:8181/restconf/operations/usecplugin:attackID
-Sample Input :: `{"usecplugin:input": { "NodeID":"openflow:1"}}`
-
-==== attacksFromIP
-URI :: http://localhost:8181/restconf/operations/usecplugin:attacksFromIP
-Sample Input :: `{"usecplugin:input": { "SrcIP":"10.0.0.1"}}`
-
-==== attacksToIP
-URI :: http://localhost:8181/restconf/operations/usecplugin:attacksToIP
-Sample Input :: `{"usecplugin:input": { "DstIP":"10.0.0.2"}}`
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/user-guide/usecplugin-openflow-user-guide.html
Code Review / docs.git / commitdiff