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