1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Views and objects — pyroute2 0.5.14 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Record list filters" href="ndb_reports.html" />
<link rel="prev" title="NDB objects" href="ndb_init.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ndb_reports.html" title="Record list filters"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ndb_init.html" title="NDB objects"
accesskey="P">previous</a> |</li>
<li class="nav-item"><a href="http://pyroute2.org">Project home</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">pyroute2 0.5.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="ndb.html" accesskey="U">NDB module</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-pyroute2.ndb.objects">
<span id="views-and-objects"></span><h1>Views and objects<a class="headerlink" href="#module-pyroute2.ndb.objects" title="Permalink to this headline">¶</a></h1>
<div class="section" id="structure">
<h2>Structure<a class="headerlink" href="#structure" title="Permalink to this headline">¶</a></h2>
<p>The NDB objects are dictionary-like structures that represent network
objects – interfaces, routes, addresses etc. In addition to the
usual dictionary API they have some NDB-specific methods, see the
<cite>RTNL_Object</cite> class description below.</p>
<p>The dictionary fields represent RTNL messages fields and NLA names,
and the objects are used as argument dictionaries to normal <cite>IPRoute</cite>
methods like <cite>link()</cite> or <cite>route()</cite>. Thus everything described for
the <cite>IPRoute</cite> methods is valid here as well.</p>
<p>See also: <a class="reference internal" href="iproute.html#iproute"><span class="std std-ref">IPRoute module</span></a></p>
<p>E.g.:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># create a vlan interface with IPRoute</span>
<span class="k">with</span> <span class="n">IPRoute</span><span class="p">()</span> <span class="k">as</span> <span class="n">ipr</span><span class="p">:</span>
<span class="n">ipr</span><span class="o">.</span><span class="n">link</span><span class="p">(</span><span class="s2">"add"</span><span class="p">,</span>
<span class="n">ifname</span><span class="o">=</span><span class="s2">"vlan1108"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="n">ipr</span><span class="o">.</span><span class="n">link_lookup</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">),</span>
<span class="n">vlan_id</span><span class="o">=</span><span class="mi">1108</span><span class="p">)</span>
<span class="c1"># same with NDB:</span>
<span class="k">with</span> <span class="n">NDB</span><span class="p">(</span><span class="n">log</span><span class="o">=</span><span class="s2">"stderr"</span><span class="p">)</span> <span class="k">as</span> <span class="n">ndb</span><span class="p">:</span>
<span class="p">(</span><span class="n">ndb</span>
<span class="o">.</span><span class="n">interfaces</span>
<span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s2">"vlan1108"</span><span class="p">,</span>
<span class="n">kind</span><span class="o">=</span><span class="s2">"vlan"</span><span class="p">,</span>
<span class="n">link</span><span class="o">=</span><span class="s2">"eth0"</span><span class="p">,</span>
<span class="n">vlan_id</span><span class="o">=</span><span class="mi">1108</span><span class="p">)</span>
<span class="o">.</span><span class="n">commit</span><span class="p">())</span>
</pre></div>
</div>
<p>Slightly simplifying, if a network object doesn’t exist, NDB will run
an RTNL method with “add” argument, if exists – “set”, and to remove
an object NDB will call the method with “del” argument.</p>
</div>
<div class="section" id="accessing-objects">
<h2>Accessing objects<a class="headerlink" href="#accessing-objects" title="Permalink to this headline">¶</a></h2>
<p>NDB objects are grouped into “views”:</p>
<blockquote>
<div><ul class="simple">
<li><p>interfaces</p></li>
<li><p>addresses</p></li>
<li><p>routes</p></li>
<li><p>neighbours</p></li>
<li><p>rules</p></li>
<li><p>netns</p></li>
<li><p>…</p></li>
</ul>
</div></blockquote>
<p>Views are dictionary-like objects that accept strings or dict selectors:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># access eth0</span>
<span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s2">"eth0"</span><span class="p">]</span>
<span class="c1"># access eth0 in the netns test01</span>
<span class="n">ndb</span><span class="o">.</span><span class="n">sources</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">netns</span><span class="o">=</span><span class="s2">"test01"</span><span class="p">)</span>
<span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[{</span><span class="s2">"target"</span><span class="p">:</span> <span class="s2">"test01"</span><span class="p">,</span> <span class="s2">"ifname"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">}]</span>
<span class="c1"># access a route to 10.4.0.0/24</span>
<span class="n">ndb</span><span class="o">.</span><span class="n">routes</span><span class="p">[</span><span class="s2">"10.4.0.0/24"</span><span class="p">]</span>
<span class="c1"># same with a dict selector</span>
<span class="n">ndb</span><span class="o">.</span><span class="n">routes</span><span class="p">[{</span><span class="s2">"dst"</span><span class="p">:</span> <span class="s2">"10.4.0.0"</span><span class="p">,</span> <span class="s2">"dst_len"</span><span class="p">:</span> <span class="mi">24</span><span class="p">}]</span>
</pre></div>
</div>
</div>
<div class="section" id="objects-cache">
<h2>Objects cache<a class="headerlink" href="#objects-cache" title="Permalink to this headline">¶</a></h2>
<p>NDB create objects on demand, it doesn’t create thousands of route objects
for thousands of routes by default. The object is being created only when
accessed for the first time, and stays in the cache as long as it has any
not committed changes. To inspect cached objects, use views’ <cite>.cache</cite>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="o">.</span><span class="n">cache</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="go">[(('target', u'localhost'), ('tflags', 0), ('index', 1)), # lo</span>
<span class="go"> (('target', u'localhost'), ('tflags', 0), ('index', 5))] # eth3</span>
</pre></div>
</div>
<p>There is no asynchronous cache invalidation, the cache is being cleaned up
every time when an object is accessed.</p>
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
</div>
<dl class="class">
<dt id="pyroute2.ndb.objects.RTNL_Object">
<em class="property">class </em><code class="sig-prename descclassname">pyroute2.ndb.objects.</code><code class="sig-name descname">RTNL_Object</code><span class="sig-paren">(</span><em class="sig-param">view</em>, <em class="sig-param">key</em>, <em class="sig-param">iclass</em>, <em class="sig-param">ctxid=None</em>, <em class="sig-param">load=True</em>, <em class="sig-param">master=None</em>, <em class="sig-param">auth_managers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.ndb.objects.RTNL_Object" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="pyroute2.ndb.objects.RTNL_Object.set">
<code class="sig-name descname">set</code><span class="sig-paren">(</span><em class="sig-param">*argv</em>, <em class="sig-param">**kwarg</em><span class="sig-paren">)</span><a class="headerlink" href="#pyroute2.ndb.objects.RTNL_Object.set" title="Permalink to this definition">¶</a></dt>
<dd><p>Set a field specified by <cite>key</cite> to <cite>value</cite>, and return self. The
method is useful to write call chains like that:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">ndb</span>
<span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s2">"eth0"</span><span class="p">]</span>
<span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'mtu'</span><span class="p">,</span> <span class="mi">1200</span><span class="p">)</span>
<span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'state'</span><span class="p">,</span> <span class="s1">'up'</span><span class="p">)</span>
<span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'address'</span><span class="p">,</span> <span class="s1">'00:11:22:33:44:55'</span><span class="p">)</span>
<span class="o">.</span><span class="n">commit</span><span class="p">())</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Views and objects</a><ul>
<li><a class="reference internal" href="#structure">Structure</a></li>
<li><a class="reference internal" href="#accessing-objects">Accessing objects</a></li>
<li><a class="reference internal" href="#objects-cache">Objects cache</a></li>
<li><a class="reference internal" href="#api">API</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ndb_init.html"
title="previous chapter">NDB objects</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ndb_reports.html"
title="next chapter">Record list filters</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ndb_objects.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="ndb_reports.html" title="Record list filters"
>next</a> |</li>
<li class="right" >
<a href="ndb_init.html" title="NDB objects"
>previous</a> |</li>
<li class="nav-item"><a href="http://pyroute2.org">Project home</a> »</li>
<li class="nav-item nav-item-0"><a href="index.html">pyroute2 0.5.14 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="ndb.html" >NDB module</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013, Peter V. Saveliev.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.1.2.
</div>
</body>
</html>
|
