manuals/developer-guide/src/main/asciidoc/usc/odl-usc-channel-dev.adoc

   1 == Unified Secure Channel
   2
   3 === Overview
   4 The Unified Secure Channel (USC) feature provides REST API, manager, and plugin for unified
   5 secure channels.  The REST API provides a northbound api.  The manager
   6 monitors, maintains, and provides channel related services.  The plugin
   7 handles the lifecycle of channels.
   8
   9 === USC Channel Architecture
  10 * USC Agent
  11   ** The USC Agent provides proxy and agent functionality on top of all standard protocols supported by the device.  It initiates call-home with the controller, maintains live connections with with the controller, acts as a demuxer/muxer for packets with the USC header, and authenticates the controller.
  12 * USC Plugin
  13   ** The USC Plugin is responsible for communication between the controller and the USC agent .  It responds to call-home with the controller, maintains live connections with the devices, acts as a muxer/demuxer for packets with the USC header, and provides support for TLS/DTLS.
  14 * USC Manager
  15   ** The USC Manager handles configurations, high availability, security, monitoring, and clustering support for USC.
  16 * USC UI
  17   ** The USC UI is responsible for displaying a graphical user interface representing the state of USC in the OpenDaylight DLUX UI.
  18
  19 === USC Channel APIs and Interfaces
  20 This section describes the APIs for interacting with the unified secure
  21 channels.
  22
  23 ==== USC Channel Topology API
  24 The USC project maintains a topology that is YANG-based in MD-SAL.  These models are available via RESTCONF.
  25
  26 * Name: view-channel
  27 * URL: http://${IPADDRESS}:8181/restconf/operations/usc-channel:view-channel
  28 * Description: Views the current state of the USC environment.
  29
  30 === API Reference Documentation
  31 Go to http://${IPADDRESS}:8181/apidoc/explorer/index.html, sign in, and expand the usc-channel panel.  From there, users can execute various API calls to test their USC deployment.
  32