docs/developer-guide/capwap-developer-guide.rst

   1 CAPWAP Developer Guide
   2 ======================
   3
   4 Overview
   5 --------
   6
   7 The Control And Provisioning of Wireless Access Points (CAPWAP) plugin
   8 project aims to provide new southbound interface for controller to be
   9 able to monitor and manage CAPWAP compliant wireless termination point
  10 (WTP) network devices. The CAPWAP feature will provide REST based
  11 northbound APIs.
  12
  13 CAPWAP Architecture
  14 -------------------
  15
  16 The CAPWAP feature is implemented as an MD-SAL based provider module,
  17 which helps discover WTP devices and update their states in the MD-SAL
  18 operational datastore.
  19
  20 CAPWAP APIs and Interfaces
  21 --------------------------
  22
  23 This section describes the APIs for interacting with the CAPWAP plugin.
  24
  25 Discovered WTPs
  26 ~~~~~~~~~~~~~~~
  27
  28 The CAPWAP project maintains list of discovered CAPWAP WTPs that is
  29 YANG-based in MD-SAL. These models are available via RESTCONF.
  30
  31 -  Name: Discovered-WTPs
  32
  33 -  URL:
  34    `http://${ipaddress}:8181/restconf/operational/capwap-impl:capwap-ac-root/ <http://${ipaddress}:8181/restconf/operational/capwap-impl:capwap-ac-root/>`__
  35
  36 -  Description: Displays list of discovered WTPs and their basic
  37    attributes
  38
  39 API Reference Documentation
  40 ---------------------------
  41
  42 Go to
  43 `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__,
  44 sign in, and expand the capwap-impl panel. From there, users can execute
  45 various API calls to test their CAPWAP deployment.
  46