docs/developer-guide/ttp-cli-tools-developer-guide.rst

   1 .. _ttp_cli_tools_dev_guide:
   2
   3 TTP CLI Tools Developer Guide
   4 =============================
   5
   6 Overview
   7 --------
   8
   9 Table Type Patterns are a specification developed by the `Open
  10 Networking Foundation <https://www.opennetworking.org/>`__ to enable the
  11 description and negotiation of subsets of the OpenFlow protocol. This is
  12 particularly useful for hardware switches that support OpenFlow as it
  13 enables the to describe what features they do (and thus also what
  14 features they do not) support. More details can be found in the full
  15 specification listed on the `OpenFlow specifications
  16 page <https://www.opennetworking.org/sdn-resources/onf-specifications/openflow>`__.
  17
  18 The TTP CLI Tools provide a way for people interested in TTPs to read
  19 in, validate, output, and manipulate TTPs as a self-contained,
  20 executable jar file.
  21
  22 TTP CLI Tools Architecture
  23 --------------------------
  24
  25 The TTP CLI Tools use the TTP Model and the YANG Tools/RESTCONF codecs
  26 to translate between the Data Transfer Objects (DTOs) and JSON/XML.
  27
  28 Command Line Options
  29 --------------------
  30
  31 This will cover the various options for the CLI Tools. For now, there
  32 are no options and it merely outputs fixed data using the codecs.
  33