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
|
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>Network interfaces — 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="IP addresses management" href="ndb_addresses.html" />
<link rel="prev" title="Record list filters" href="ndb_reports.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_addresses.html" title="IP addresses management"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="ndb_reports.html" title="Record list filters"
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.interface">
<span id="network-interfaces"></span><span id="ndbinterfaces"></span><h1>Network interfaces<a class="headerlink" href="#module-pyroute2.ndb.objects.interface" title="Permalink to this headline">¶</a></h1>
<div class="section" id="list-interfaces">
<h2>List interfaces<a class="headerlink" href="#list-interfaces" title="Permalink to this headline">¶</a></h2>
<p>List interface keys:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></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="s1">'on'</span><span class="p">)</span> <span class="k">as</span> <span class="n">ndb</span><span class="p">:</span>
<span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">:</span>
<span class="nb">print</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
</pre></div>
</div>
<p>NDB views support some dict methods: <cite>items()</cite>, <cite>values()</cite>, <cite>keys()</cite>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></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="s1">'on'</span><span class="p">)</span> <span class="k">as</span> <span class="n">ndb</span><span class="p">:</span>
<span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">nic</span> <span class="ow">in</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
<span class="n">nic</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="n">nic</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="get-interface-objects">
<h2>Get interface objects<a class="headerlink" href="#get-interface-objects" title="Permalink to this headline">¶</a></h2>
<p>The keys may be used as selectors to get interface objects:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">:</span>
<span class="nb">print</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="n">key</span><span class="p">])</span>
</pre></div>
</div>
<p>Also possible selector formats are <cite>dict()</cite> and simple string. The latter
means the interface name:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">eth0</span> <span class="o">=</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s1">'eth0'</span><span class="p">]</span>
</pre></div>
</div>
<p>Dict selectors are necessary to get interfaces by other properties:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wrk1_eth0</span> <span class="o">=</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[{</span><span class="s1">'target'</span><span class="p">:</span> <span class="s1">'worker1.sample.com'</span><span class="p">,</span>
<span class="s1">'ifname'</span><span class="p">:</span> <span class="s1">'eth0'</span><span class="p">}]</span>
<span class="n">wrk2_eth0</span> <span class="o">=</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[{</span><span class="s1">'target'</span><span class="p">:</span> <span class="s1">'worker2.sample.com'</span><span class="p">,</span>
<span class="s1">'address'</span><span class="p">:</span> <span class="s1">'52:54:00:22:a1:b7'</span><span class="p">}]</span>
</pre></div>
</div>
</div>
<div class="section" id="change-nic-properties">
<h2>Change nic properties<a class="headerlink" href="#change-nic-properties" title="Permalink to this headline">¶</a></h2>
<p>Changing MTU and MAC address:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s1">'eth0'</span><span class="p">]</span> <span class="k">as</span> <span class="n">eth0</span><span class="p">:</span>
<span class="n">eth0</span><span class="p">[</span><span class="s1">'mtu'</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1248</span>
<span class="n">eth0</span><span class="p">[</span><span class="s1">'address'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'00:11:22:33:44:55'</span>
<span class="c1"># --> <-- eth0.commit() is called by the context manager</span>
</pre></div>
</div>
<p>One can change a property either using the assignment statement, or
using the <cite>.set()</cite> routine:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># same code</span>
<span class="k">with</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s1">'eth0'</span><span class="p">]</span> <span class="k">as</span> <span class="n">eth0</span><span class="p">:</span>
<span class="n">eth0</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">1248</span><span class="p">)</span>
<span class="n">eth0</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>
</pre></div>
</div>
<p>The <cite>.set()</cite> routine returns the object itself, that makes possible
chain calls:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># same as above</span>
<span class="k">with</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s1">'eth0'</span><span class="p">]</span> <span class="k">as</span> <span class="n">eth0</span><span class="p">:</span>
<span class="n">eth0</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">1248</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="c1"># or</span>
<span class="k">with</span> <span class="n">ndb</span><span class="o">.</span><span class="n">interfaces</span><span class="p">[</span><span class="s1">'eth0'</span><span class="p">]</span> <span class="k">as</span> <span class="n">eth0</span><span class="p">:</span>
<span class="p">(</span><span class="n">eth0</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">1248</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="c1"># or without the context manager, call commit() explicitly</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="s1">'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">1248</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>
</div>
<div class="section" id="create-virtual-interfaces">
<h2>Create virtual interfaces<a class="headerlink" href="#create-virtual-interfaces" title="Permalink to this headline">¶</a></h2>
<p>Create a bridge and add a port, <cite>eth0</cite>:</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="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">ifname</span><span class="o">=</span><span class="s1">'br0'</span><span class="p">,</span> <span class="n">kind</span><span class="o">=</span><span class="s1">'bridge'</span><span class="p">)</span>
<span class="o">.</span><span class="n">commit</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="p">[</span><span class="s1">'eth0'</span><span class="p">]</span>
<span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s1">'master'</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="s1">'br0'</span><span class="p">][</span><span class="s1">'index'</span><span class="p">])</span>
<span class="o">.</span><span class="n">commit</span><span class="p">())</span>
</pre></div>
</div>
</div>
</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="#">Network interfaces</a><ul>
<li><a class="reference internal" href="#list-interfaces">List interfaces</a></li>
<li><a class="reference internal" href="#get-interface-objects">Get interface objects</a></li>
<li><a class="reference internal" href="#change-nic-properties">Change nic properties</a></li>
<li><a class="reference internal" href="#create-virtual-interfaces">Create virtual interfaces</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="ndb_reports.html"
title="previous chapter">Record list filters</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="ndb_addresses.html"
title="next chapter">IP addresses management</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/ndb_interfaces.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_addresses.html" title="IP addresses management"
>next</a> |</li>
<li class="right" >
<a href="ndb_reports.html" title="Record list filters"
>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>
|
