manuals/user-guide/src/main/asciidoc/ttp/ttp-cli-tools-user.adoc

   1 == TTP CLI Tools User Guide
   2
   3 === Overview
   4 Table Type Patterns are a specification developed by the
   5 https://www.opennetworking.org/[Open Networking Foundation] to enable
   6 the description and negotiation of subsets of the OpenFlow protocol.
   7 This is particularly useful for hardware switches that support OpenFlow
   8 as it enables the to describe what features they do (and thus also what
   9 features they do not) support. More details can be found in the full
  10 specification listed on the
  11 https://www.opennetworking.org/sdn-resources/onf-specifications/openflow[OpenFlow
  12 specifications page].
  13
  14 === TTP CLI Tools Architecture
  15 The TTP CLI Tools use the TTP Model and the YANG Tools/RESTCONF codecs
  16 to translate between the Data Transfer Objects (DTOs) and JSON/XML.
  17
  18 // === Configuring <feature>
  19 //
  20 // Describe how to configure the feature or the project after installation.
  21 // Configuration information could include day-one activities for a project
  22 // such as configuring users, configuring clients/servers and so on.
  23 //
  24 // === Administering or Managing <feature>
  25 // Include related command reference or  operations that you could perform
  26 // using the feature. For example viewing network statistics, monitoring
  27 // the network,  generating reports, and so on.
  28 //
  29 // NOTE:  Ensure that you create a step procedure whenever required and
  30 // avoid concepts.
  31 //
  32 // For example:
  33 //
  34 // .To configure L2switch components perform the following steps.
  35 // . Step 1:
  36 // . Step 2:
  37 // . Step 3:
  38
  39 // === Using the CLI Tools
  40 //
  41 // TODO: provide a few examples of using the CLI tools.
  42
  43 // <optional>
  44 // If there is only one tutorial, you skip the "Tutorials" section and
  45 // instead just lead with the single tutorial's name.
  46 //
  47 // ==== <Tutorial Name>
  48 // Ensure that the title starts with a gerund. For example using,
  49 // monitoring, creating, and so on.
  50 //
  51 // ===== Overview
  52 // An overview of the use case.
  53 //
  54 // ===== Prerequisites
  55 // Provide any prerequisite information, assumed knowledge, or environment
  56 // required to execute the use case.
  57 //
  58 // ===== Target Environment
  59 // Include any topology requirement for the use case. Ideally, provide
  60 // visual (abstract) layout of network diagrams and any other useful visual
  61 // aides.
  62 //
  63 // ===== Instructions
  64 // Use case could be a set of configuration procedures. Including
  65 // screenshots to help demonstrate what is happening is especially useful.
  66 // Ensure that you specify them separately. For example:
  67 //
  68 // . *Setting up the VM*
  69 // To set up a VM perform the following steps.
  70 // .. Step 1
  71 // .. Step 2
  72 // .. Step 3
  73 //
  74 // . *Installing the feature*
  75 // To install the feature perform the following steps.
  76 // .. Step 1
  77 // .. Step 2
  78 // .. Step 3
  79 //
  80 // . *Configuring the environment*
  81 // To configure the system perform the following steps.
  82 // .. Step 1
  83 // .. Step 2
  84 // .. Step 3