Skip to content

Commit f5d6810

Browse files
ygorelikygorelik
committed
Updated release documentation
1 parent fbe1742 commit f5d6810

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+408
-203
lines changed

‎docs/_static/icon.ico

-8.34 KB
Binary file not shown.

‎docs/_static/logo.png

-2.8 KB
Loading

‎docs/_static/pygments.css

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1+
pre { line-height: 125%; }
2+
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
3+
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
4+
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
5+
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
16
.highlight .hll { background-color: #ffffcc }
2-
.highlight { background: #eeffcc; }
7+
.highlight { background: #eeffcc; }
38
.highlight .c { color: #408090; font-style: italic } /* Comment */
49
.highlight .err { border: 1px solid #FF0000 } /* Error */
510
.highlight .k { color: #007020; font-weight: bold } /* Keyword */

‎docs/about_ydk.html

+30-15
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,15 @@
9090
<li class="toctree-l1 current"><a class="current reference internal" href="">About YDK</a><ul>
9191
<li class="toctree-l2"><a class="reference internal" href="#license">License</a></li>
9292
<li class="toctree-l2"><a class="reference internal" href="#version">Version</a></li>
93-
<li class="toctree-l2"><a class="reference internal" href="#changelog">Changelog</a></li>
93+
<li class="toctree-l2"><a class="reference internal" href="#release-changes">Release Changes</a></li>
9494
</ul>
9595
</li>
9696
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
9797
<li class="toctree-l1"><a class="reference internal" href="developer_guide.html">Developer Guide</a></li>
9898
<li class="toctree-l1"><a class="reference internal" href="api_guide.html">API Guide</a></li>
9999
<li class="toctree-l1"><a class="reference internal" href="faq.html">Questions and Answers</a></li>
100-
<li class="toctree-l1"><a class="reference internal" href="ydk.models.ydktest.html">ydktest bundle API</a></li>
100+
<li class="toctree-l1"><a class="reference internal" href="ydk.models.openconfig.html">openconfig bundle API</a></li>
101+
<li class="toctree-l1"><a class="reference internal" href="ydk.models.ietf.html">ietf bundle API</a></li>
101102
</ul>
102103

103104

@@ -142,31 +143,45 @@
142143

143144
<div class="section" id="about-ydk">
144145
<h1>About YDK<a class="headerlink" href="#about-ydk" title="Permalink to this headline"></a></h1>
145-
<p>A Software Development Kit that provides API&#8217;s that are modeled in YANG.</p>
146+
<p>The YANG Development Kit (YDK) is a software development tool, which provides API for building applications based on YANG models.
147+
The YDK allows generate YANG model API and provides services to apply generated API over various communication protocols.
148+
Currently implemented protocols are: Netconf, Restconf, OpenDaylight and gNMI.
149+
YDK provides CRUD and protocol specific services over above protocols.
150+
YDK also provides codec services to translate API models to/from XML and JSON encoded strings.</p>
151+
<p>The YDK is a multi-language software. Currently supported languages are Python, Go, and C++.</p>
146152
<div class="section" id="license">
147153
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
148-
<p>Copyright 2016 Cisco Systems. All rights reserved</p>
149-
<p>Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the &#8220;License&#8221;); you may not use this file except in compliance with the License. You may obtain a copy of the License at:</p>
154+
<p>Copyright 2016-2019 Cisco Systems. All rights reserved</p>
155+
<p>Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
156+
See the NOTICE file distributed with this work for additional information regarding copyright ownership.
157+
The ASF licenses this file to you under the Apache License, Version 2.0 (the &#8220;License&#8221;);
158+
you may not use this file except in compliance with the License.
159+
You may obtain a copy of the License at:</p>
150160
<blockquote>
151161
<div><a class="reference external" href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></div></blockquote>
152-
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an &#8220;AS IS&#8221; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.</p>
162+
<p>Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an
163+
&#8220;AS IS&#8221; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
164+
See the License for the specific language governing permissions and limitations under the License.</p>
165+
<p>Some of the source files in this release have been modified by Yan Gorelik, YDK Solutions.
166+
All modifications in original files under CiscoDevNet domain introduced since October 2019 are copyrighted
167+
and protected under Apache License, Version 2.0.</p>
153168
</div>
154169
<div class="section" id="version">
155170
<h2>Version<a class="headerlink" href="#version" title="Permalink to this headline"></a></h2>
156171
<p>Version : 0.8.5.3</p>
157-
<p>This ydk-py is generated using <a class="reference external" href="https://github.com/CiscoDevNet/ydk-gen">ydk-gen</a>.</p>
158-
<p>To check out the version of ydk-gen used to generate this ydk-py, use the below commands:</p>
159-
<div class="highlight-bash"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
160-
<span class="normal">2</span></pre></div></td><td class="code"><div class="highlight"><pre><span></span>$ git clone https://github.com/ygorelik/ydk-gen.git
161-
$ git checkout 7ac01be620c9a0f631b1eb24eb405fbfb00eb143
172+
<p>This YDK documentation was generated using
173+
<a class="reference external" href="https://github.com/ygorelik/ydk-gen/blob/master/generate.py">ydk-gen/generate.py</a> script.</p>
174+
<p>To check out this version of ydk-gen use the below commands:</p>
175+
<div class="highlight-sh"><div class="highlight"><pre><span></span>$ git clone https://github.com/ygorelik/ydk-gen.git
176+
$ git checkout fbe17423d1e71f189a22fd6bd11f969474dfde6a
162177
</pre></div>
163-
</td></tr></table></div>
164178
</div>
165-
<div class="section" id="changelog">
166-
<h2>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline"></a></h2>
179+
</div>
180+
<div class="section" id="release-changes">
181+
<h2>Release Changes<a class="headerlink" href="#release-changes" title="Permalink to this headline"></a></h2>
167182
<blockquote>
168183
<div><ul class="simple">
169-
<li><a class="reference external" href="https://github.com/CiscoDevNet/ydk-py/blob/master/CHANGES.md">Changelog</a></li>
184+
<li><a class="reference external" href="https://github.com/ygorelik/ydk-gen/blob/master/CHANGES.md">Changelog</a></li>
170185
</ul>
171186
</div></blockquote>
172187
</div>

‎docs/api/class_hierarchy.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@
104104
</ul>
105105
</li>
106106
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Questions and Answers</a></li>
107-
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ydktest.html">ydktest bundle API</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.openconfig.html">openconfig bundle API</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ietf.html">ietf bundle API</a></li>
108109
</ul>
109110

110111

‎docs/api/errors.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@
104104
</ul>
105105
</li>
106106
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Questions and Answers</a></li>
107-
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ydktest.html">ydktest bundle API</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.openconfig.html">openconfig bundle API</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ietf.html">ietf bundle API</a></li>
108109
</ul>
109110

110111

‎docs/api/filters.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,8 @@
104104
</ul>
105105
</li>
106106
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Questions and Answers</a></li>
107-
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ydktest.html">ydktest bundle API</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.openconfig.html">openconfig bundle API</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="../ydk.models.ietf.html">ietf bundle API</a></li>
108109
</ul>
109110

110111

‎docs/api/path/annotation.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/capability.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/codec.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/data_node.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/gnmi_session.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/netconf_session.html

+13-11
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

@@ -162,7 +163,7 @@
162163
<span id="netconfsession"></span><h1>NetconfSession<a class="headerlink" href="#module-ydk.path" title="Permalink to this headline"></a></h1>
163164
<dl class="class">
164165
<dt id="ydk.path.NetconfSession">
165-
<em class="property">class </em><code class="descclassname">ydk.path.</code><code class="descname">NetconfSession</code><span class="sig-paren">(</span><em>address</em>, <em>username</em>, <em>password</em>, <em>port=830</em>, <em>protocol=&quot;ssh&quot;</em>, <em>on_demand=True</em>, <em>common_cache=False</em>, <em>int timeout=None</em>, <em>repo=None</em>, <em>private_key_path=&quot;&quot;</em>, <em>public_key_path=&quot;&quot;</em><span class="sig-paren">)</span><a class="headerlink" href="#ydk.path.NetconfSession" title="Permalink to this definition"></a></dt>
166+
<em class="property">class </em><code class="descclassname">ydk.path.</code><code class="descname">NetconfSession</code><span class="sig-paren">(</span><em>repo</em>, <em>address</em>, <em>username</em>, <em>password</em>, <em>port=830</em>, <em>protocol=&quot;ssh&quot;</em>, <em>on_demand=True</em>, <em>common_cache=False</em>, <em>int timeout=None</em>, <em>repo=None</em>, <em>private_key_path=&quot;&quot;</em>, <em>public_key_path=&quot;&quot;</em><span class="sig-paren">)</span><a class="headerlink" href="#ydk.path.NetconfSession" title="Permalink to this definition"></a></dt>
166167
<dd><p>Constructs an instance of the <cite>NetconfSession</cite> class and connects to Netconf server, which <strong>must</strong> support model download.</p>
167168
<table class="docutils field-list" frame="void" rules="none">
168169
<col class="field-name" />
@@ -171,15 +172,16 @@
171172
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
172173
<li><strong>address</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) IP address or DNS name of device, which supports Netconf server; required parameter.</li>
173174
<li><strong>username</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Username to log in to the device; required parameter.</li>
174-
<li><strong>password</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Password to log in to the device.</li>
175-
<li><strong>port</strong> &#8211; (<code class="docutils literal"><span class="pre">int</span></code>) Device port used to access the Netconf interface. Default value is 830.</li>
176-
<li><strong>protocol</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Currently supported <cite>ssh</cite> for secure connection and <cite>tcp</cite> for insecure connection; default - <cite>ssh</cite>.</li>
175+
<li><strong>password</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Password to log in to the device; not required, if <cite>public_key_path</cite> specified.</li>
176+
<li><strong>port</strong> &#8211; (<code class="docutils literal"><span class="pre">int</span></code>) Device port number, which is used to access the Netconf interface; default value is 830.</li>
177+
<li><strong>protocol</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Currently supported &#8220;ssh&#8221; for secure connection and &#8220;tcp&#8221; for insecure connection; default - &#8220;ssh&#8221;.</li>
177178
<li><strong>on_demand</strong> &#8211; (<code class="docutils literal"><span class="pre">bool</span></code>) On demand model downloading by default.</li>
178179
<li><strong>common_cache</strong> &#8211; (<code class="docutils literal"><span class="pre">bool</span></code>) Use common cache directory, if enabled.</li>
179-
<li><strong>timeout</strong> &#8211; (<code class="docutils literal"><span class="pre">int</span></code>) The timeout in microseconds: None or -1 for infinite timeout, 0 - for non-blocking</li>
180-
<li><strong>repo</strong> &#8211; (<a class="reference internal" href="repository.html#ydk.path.Repository" title="ydk.path.Repository"><code class="xref py py-class docutils literal"><span class="pre">Repository</span></code></a>) User provided repository - directory, which stores cached Yang models.</li>
181-
<li><strong>private_key_path</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Path to private key file. Requires public_key_path field.</li>
182-
<li><strong>public_key_path</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Path to public key file. Does not allow <cite>password</cite> field, if specified.</li>
180+
<li><strong>timeout</strong> &#8211; (<code class="docutils literal"><span class="pre">int</span></code>) The timeout in microseconds: None or -1 for infinite timeout, 0 - for non-blocking.</li>
181+
<li><strong>repo</strong> &#8211; (<a class="reference internal" href="repository.html#ydk.path.Repository" title="ydk.path.Repository"><code class="xref py py-class docutils literal"><span class="pre">Repository</span></code></a>) User provided repository - directory, which stores cached YANG models.
182+
If not specified, the temporary repository at &#8220;~/.ydk/&lt;address&gt;&#8221; is created.</li>
183+
<li><strong>private_key_path</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Path to private key file. This is optional parameter, which requires <cite>public_key_path</cite> field.</li>
184+
<li><strong>public_key_path</strong> &#8211; (<code class="docutils literal"><span class="pre">str</span></code>) Path to public key file. This is optional parameter.</li>
183185
</ul>
184186
</td>
185187
</tr>
@@ -250,12 +252,12 @@
250252
<dl class="method">
251253
<dt id="ydk.path.NetconfSession.get_capabilities">
252254
<code class="descname">get_capabilities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ydk.path.NetconfSession.get_capabilities" title="Permalink to this definition"></a></dt>
253-
<dd><p>Returns a list of capabilities of the client</p>
255+
<dd><p>Returns a list of capabilities for the Netconf server.</p>
254256
<table class="docutils field-list" frame="void" rules="none">
255257
<col class="field-name" />
256258
<col class="field-body" />
257259
<tbody valign="top">
258-
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list of <code class="docutils literal"><span class="pre">str</span></code> representing the client&#8217;s/server&#8217;s capabilities</td>
260+
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A list of <code class="docutils literal"><span class="pre">str</span></code> representing the Netconf server capabilities.</td>
259261
</tr>
260262
</tbody>
261263
</table>

‎docs/api/path/path.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

‎docs/api/path/repository.html

+2-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,8 @@
111111
</ul>
112112
</li>
113113
<li class="toctree-l1"><a class="reference internal" href="../../faq.html">Questions and Answers</a></li>
114-
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ydktest.html">ydktest bundle API</a></li>
114+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.openconfig.html">openconfig bundle API</a></li>
115+
<li class="toctree-l1"><a class="reference internal" href="../../ydk.models.ietf.html">ietf bundle API</a></li>
115116
</ul>
116117

117118

0 commit comments

Comments
 (0)