manuals/user-guide/src/main/asciidoc/capwap/capwap-user.adoc

   1 == CAPWAP User Guide
   2 This document describes how to use the Control And Provisioning of Wireless
   3 Access Points (CAPWAP) feature in OpenDaylight.  This document contains
   4 configuration, administration, and management sections for the feature.
   5
   6 === Overview
   7 CAPWAP feature fills the gap OpenDaylight Controller has with respect to managing
   8 CAPWAP compliant wireless termination point (WTP) network devices present
   9 in enterprise networks. Intelligent applications (e.g. centralized firmware
  10 management, radio planning) can be developed by tapping into the
  11 WTP network device's operational states via REST APIs.
  12
  13 === CAPWAP Architecture
  14 The CAPWAP feature is implemented as an MD-SAL based provider module, which
  15 helps discover WTP devices and update their states in MD-SAL operational datastore.
  16
  17 === Scope of CAPWAP Project
  18 In the Lithium release, CAPWAP project aims to only detect the WTPs and store their
  19 basic attributes in the operational data store, which is accessible via REST
  20 and JAVA APIs.
  21
  22 === Installing CAPWAP
  23 To install CAPWAP, download OpenDaylight and use the Karaf console to install
  24 the following feature:
  25
  26 odl-capwap-ac-rest
  27
  28 === Configuring CAPWAP
  29
  30 As of Lithium, there are no configuration requirements.
  31
  32 === Administering or Managing CAPWAP
  33
  34 After installing the odl-capwap-ac-rest feature from the Karaf console, users
  35 can administer and manage CAPWAP from the APIDOCS explorer.
  36
  37 Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand
  38 the capwap-impl panel.  From there, users can execute various API calls.
  39
  40 === Tutorials
  41
  42 ==== Viewing Discovered WTPs
  43
  44 ===== Overview
  45 This tutorial can be used as a walk through to understand the steps for
  46 starting the CAPWAP feature, detecting CAPWAP WTPs, accessing the
  47 operational states of WTPs.
  48
  49 ===== Prerequisites
  50 It is assumed that user has access to at least one hardware/software based CAPWAP
  51 compliant WTP. These devices should be configured with OpenDaylight controller
  52 IP address as a CAPWAP Access Controller (AC) address. It is also assumed that
  53 WTPs and OpenDaylight controller share the same ethernet broadcast domain.
  54
  55 ===== Instructions
  56 . Run the OpenDaylight distribution and install odl-capwap-ac-rest from the Karaf console.
  57 . Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html
  58 . Expand capwap-impl
  59 . Click /operational/capwap-impl:capwap-ac-root/
  60 . Click "Try it out"
  61 . The above step should display list of WTPs discovered using ODL CAPWAP feature.