From a334a00e2a087ee8c241a60e9c801054bd207102 Mon Sep 17 00:00:00 2001 From: Colin Dixon Date: Thu, 18 Aug 2016 16:55:32 -0400 Subject: [PATCH] Migrate CAPWAP user docs to rst Change-Id: I9ba4450f75f3bdb39f39542f6205f94a198c2c13 Signed-off-by: Colin Dixon --- docs/user-guide/capwap-user-guide.rst | 95 +++++++++++++++++++ .../src/main/asciidoc/capwap/capwap-user.adoc | 60 +----------- 2 files changed, 96 insertions(+), 59 deletions(-) create mode 100644 docs/user-guide/capwap-user-guide.rst diff --git a/docs/user-guide/capwap-user-guide.rst b/docs/user-guide/capwap-user-guide.rst new file mode 100644 index 000000000..26bd3b87a --- /dev/null +++ b/docs/user-guide/capwap-user-guide.rst @@ -0,0 +1,95 @@ +CAPWAP User Guide +================= + +This document describes how to use the Control And Provisioning of +Wireless Access Points (CAPWAP) feature in OpenDaylight. This document +contains configuration, administration, and management sections for the +feature. + +Overview +-------- + +CAPWAP feature fills the gap OpenDaylight Controller has with respect to +managing CAPWAP compliant wireless termination point (WTP) network +devices present in enterprise networks. Intelligent applications (e.g. +centralized firmware management, radio planning) can be developed by +tapping into the WTP network device’s operational states via REST APIs. + +CAPWAP Architecture +------------------- + +The CAPWAP feature is implemented as an MD-SAL based provider module, +which helps discover WTP devices and update their states in MD-SAL +operational datastore. + +Scope of CAPWAP Project +----------------------- + +In the Lithium release, CAPWAP project aims to only detect the WTPs and +store their basic attributes in the operational data store, which is +accessible via REST and JAVA APIs. + +Installing CAPWAP +----------------- + +To install CAPWAP, download OpenDaylight and use the Karaf console to +install the following feature: + +odl-capwap-ac-rest + +Configuring CAPWAP +------------------ + +As of Lithium, there are no configuration requirements. + +Administering or Managing CAPWAP +-------------------------------- + +After installing the odl-capwap-ac-rest feature from the Karaf console, +users can administer and manage CAPWAP from the APIDOCS explorer. + +Go to +`http://${ipaddress}:8181/apidoc/explorer/index.html `__, +sign in, and expand the capwap-impl panel. From there, users can execute +various API calls. + +Tutorials +--------- + +Viewing Discovered WTPs +~~~~~~~~~~~~~~~~~~~~~~~ + +Overview +^^^^^^^^ + +This tutorial can be used as a walk through to understand the steps for +starting the CAPWAP feature, detecting CAPWAP WTPs, accessing the +operational states of WTPs. + +Prerequisites +^^^^^^^^^^^^^ + +It is assumed that user has access to at least one hardware/software +based CAPWAP compliant WTP. These devices should be configured with +OpenDaylight controller IP address as a CAPWAP Access Controller (AC) +address. It is also assumed that WTPs and OpenDaylight controller share +the same ethernet broadcast domain. + +Instructions +^^^^^^^^^^^^ + +1. Run the OpenDaylight distribution and install odl-capwap-ac-rest from + the Karaf console. + +2. Go to + `http://${ipaddress}:8181/apidoc/explorer/index.html `__ + +3. Expand capwap-impl + +4. Click /operational/capwap-impl:capwap-ac-root/ + +5. Click "Try it out" + +6. The above step should display list of WTPs discovered using ODL + CAPWAP feature. + diff --git a/manuals/user-guide/src/main/asciidoc/capwap/capwap-user.adoc b/manuals/user-guide/src/main/asciidoc/capwap/capwap-user.adoc index 2cefb2c54..f8ea92658 100644 --- a/manuals/user-guide/src/main/asciidoc/capwap/capwap-user.adoc +++ b/manuals/user-guide/src/main/asciidoc/capwap/capwap-user.adoc @@ -1,61 +1,3 @@ == CAPWAP User Guide -This document describes how to use the Control And Provisioning of Wireless -Access Points (CAPWAP) feature in OpenDaylight. This document contains -configuration, administration, and management sections for the feature. -=== Overview -CAPWAP feature fills the gap OpenDaylight Controller has with respect to managing -CAPWAP compliant wireless termination point (WTP) network devices present -in enterprise networks. Intelligent applications (e.g. centralized firmware -management, radio planning) can be developed by tapping into the -WTP network device's operational states via REST APIs. - -=== CAPWAP Architecture -The CAPWAP feature is implemented as an MD-SAL based provider module, which -helps discover WTP devices and update their states in MD-SAL operational datastore. - -=== Scope of CAPWAP Project -In the Lithium release, CAPWAP project aims to only detect the WTPs and store their -basic attributes in the operational data store, which is accessible via REST -and JAVA APIs. - -=== Installing CAPWAP -To install CAPWAP, download OpenDaylight and use the Karaf console to install -the following feature: - -odl-capwap-ac-rest - -=== Configuring CAPWAP - -As of Lithium, there are no configuration requirements. - -=== Administering or Managing CAPWAP - -After installing the odl-capwap-ac-rest feature from the Karaf console, users -can administer and manage CAPWAP from the APIDOCS explorer. - -Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand -the capwap-impl panel. From there, users can execute various API calls. - -=== Tutorials - -==== Viewing Discovered WTPs - -===== Overview -This tutorial can be used as a walk through to understand the steps for -starting the CAPWAP feature, detecting CAPWAP WTPs, accessing the -operational states of WTPs. - -===== Prerequisites -It is assumed that user has access to at least one hardware/software based CAPWAP -compliant WTP. These devices should be configured with OpenDaylight controller -IP address as a CAPWAP Access Controller (AC) address. It is also assumed that -WTPs and OpenDaylight controller share the same ethernet broadcast domain. - -===== Instructions -. Run the OpenDaylight distribution and install odl-capwap-ac-rest from the Karaf console. -. Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html -. Expand capwap-impl -. Click /operational/capwap-impl:capwap-ac-root/ -. Click "Try it out" -. The above step should display list of WTPs discovered using ODL CAPWAP feature. +This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/user-guide/capwap-user-guide.html -- 2.36.6