docs/user-guide/capwap-user-guide.rst

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