ci: docs: adds docs for uuid flag (#339)

* docs: adds docs for uuid flag * docs(reference): add strong warning on uuid flag --------- Co-authored-by: bwendlandt-intel <[email protected]>
open-amt-cloud-toolkit · Oct 2, 2023 · 9b162e7 · 9b162e7
1 parent a46c7e2
commit 9b162e7
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 64 deletions.
diff --git a/2.15/Reference/RPC/commandsRPC/index.html b/2.15/Reference/RPC/commandsRPC/index.html
@@ -2637,6 +2637,10 @@ <h4 id="activate-remote-specific-options"><code>activate</code> Remote-Specific
 <td>-u string</td>
 <td>WebSocket address of server to activate against</td>
 </tr>
+<tr>
+<td>-uuid string</td>
+<td>Override AMT device UUID for use with <strong>non-<abbr title="Client Initiated Remote Access - An out-of-band (OOB) management communication protocol that network clients can use to initiate a secure connection with a server.">CIRA</abbr></strong> workflow and deployments. This is for specific use cases where the hardware does not have a correctly assigned or formatted UUID. This is <strong>NOT recommended</strong> in other situations and could potentially break features. <br><br> Input must match standard UUID alphanumeric, hyphenated format (e.g. 4c4c4544-005a-3510-8047-b4c04f564433).</td>
+</tr>
 </tbody>
 </table>
 <h4 id="activate-local-specific-options"><code>activate</code> Local-Specific Options<a class="headerlink" href="#activate-local-specific-options" title="Permanent link">&para;</a></h4>

diff --git a/2.15/Reference/RPC/libraryRPC/index.html b/2.15/Reference/RPC/libraryRPC/index.html
@@ -1845,6 +1845,13 @@
     (150-199) Maintenance Errors
   </a>
 
+</li>
+
+          <li class="md-nav__item">
+  <a href="#1000-3000-amt-pt-status-code-block" class="md-nav__link">
+    (1000-3000) AMT PT Status Code Block
+  </a>
+
 </li>
 
       </ul>
@@ -2533,6 +2540,22 @@ <h4 id="20-69-input-errors-to-rpc">(20-69) Input errors to <abbr title="Remote P
 <td>33</td>
 <td>Invalid Parameter Combination</td>
 </tr>
+<tr>
+<td>34</td>
+<td>Failed Reading Configuration</td>
+</tr>
+<tr>
+<td>35</td>
+<td>Missing Or Invalid Configuration</td>
+</tr>
+<tr>
+<td>36</td>
+<td>Invalid User Input</td>
+</tr>
+<tr>
+<td>37</td>
+<td>Invalid UUID</td>
+</tr>
 </tbody>
 </table>
 <h4 id="70-99-connection-errors">(70-99) Connection Errors<a class="headerlink" href="#70-99-connection-errors" title="Permanent link">&para;</a></h4>
@@ -2665,6 +2688,21 @@ <h4 id="150-199-maintenance-errors">(150-199) Maintenance Errors<a class="header
 </tr>
 </tbody>
 </table>
+<h4 id="1000-3000-amt-pt-status-code-block">(1000-3000) AMT PT Status Code Block<a class="headerlink" href="#1000-3000-amt-pt-status-code-block" title="Permanent link">&para;</a></h4>
+<table>
+<thead>
+<tr>
+<th>Error Code</th>
+<th>Message</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>1000</td>
+<td>AMT Pt Status Code Base</td>
+</tr>
+</tbody>
+</table>
 
 
 

diff --git a/2.15/search/search_index.json b/2.15/search/search_index.json