blob: d2fd54dfaa5818ec2488358b3a853e65b074fbb5 (
plain)
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
=============
API Reference
=============
This page documents netaddr's public API. Only things explicitly mentioned in this documentation
are supported and considered part of the public API.
Any of the following is considered private and unsupported:
* Anything within any of the ``netaddr`` submodules (``from netaddr.X import Y``)
* Anything with a name started with a single underscore (``_X``)
* Anything not explicitly documented as part of the public API
------------------
IP Class Hierarchy
------------------
Here the class hierarchy for IP related classes ::
+---------+ +---------+
| ipv4(M) | | ipv6(M) |
+---------+ +---------+
| |
(HAS A) (HAS A)
| |
+-----+----------------+-----------------+ |
| +--------|-------+---------|--------+--------+
| | | | | |
| | | | | |
v v v v | |
+-----------+ +-----------+ | |
| IPAddress | | IPNetwork | | |
+-----------+ +-----------+ | |
| | | |
(HAS A) (HAS A) | |
| | v v
+-------+--------+ +------------+
| | IPRange |
| +------------+
v |
+-------+ |
| IPSet | v
+-------+ +--------+
| IPGlob |
+--------+
---------
Constants
---------
The following constants are used by the various *flags* arguments on netaddr class constructors.
.. data:: netaddr.P
netaddr.INET_PTON
Use inet_pton() semantics instead of inet_aton() when parsing IPv4.
See the :meth:`IPAddress.__init__` documentation for details.
.. versionchanged:: 0.10.0
This parsing mode will become stricter in the future and it will reject leading zeros.
.. data:: netaddr.INET_ATON
Use ``inet_aton()`` semantics when parsing IPv4.
See the :meth:`IPAddress.__init__` documentation for details.
.. versionadded:: 0.10.0
.. data:: netaddr.Z
netaddr.ZEROFILL
Remove any preceding zeros from IPv4 address octets before parsing.
See the :meth:`IPAddress.__init__` documentation for details.
.. data:: netaddr.N
netaddr.NOHOST
Remove any host bits found to the right of an applied CIDR prefix.
See the :meth:`IPNetwork.__init__` documentation for details.
-----------------
Custom Exceptions
-----------------
.. autoexception:: netaddr.AddrConversionError
:exclude-members: __init__
.. autoexception:: netaddr.AddrFormatError
:exclude-members: __init__
.. autoexception:: netaddr.NotRegisteredError
:exclude-members: __init__
------------
IP addresses
------------
An IP address is a virtual address used to identify the source and destination of (layer 3) packets being transferred between hosts in a switched network. This library fully supports both IPv4 and the new IPv6 standards.
The `IPAddress` class is used to identify individual IP addresses.
.. autoclass:: netaddr.IPAddress
:members:
:inherited-members:
.. _ipv6_formatting_dialects:
^^^^^^^^^^^^^^^^^^^^^^^^
IPv6 formatting dialects
^^^^^^^^^^^^^^^^^^^^^^^^
The following dialect classes can be used with the IPAddress.format method.
.. autoclass:: netaddr.ipv6_compact
:members:
.. autoclass:: netaddr.ipv6_full
:members:
.. autoclass:: netaddr.ipv6_verbose
:members:
-----------------------
IP networks and subnets
-----------------------
The `IPNetwork` class is used to represent a group of IP addresses that comprise a network/subnet/VLAN containing hosts.
Nowadays, IP networks are usually specified using the CIDR format with a prefix indicating the size of the netmask. In the real world, there are a number of ways to express a "network"" and so the flexibility of the `IPNetwork` class constructor reflects this.
.. autoclass:: netaddr.IPNetwork
:members:
---------------------------
Arbitrary IP address ranges
---------------------------
netaddr was designed to accommodate the many different ways in which groups of IP addresses and IP networks are specified, not only in router configurations but also less standard but more human-readable forms found in, for instance, configuration files.
Here are the options currently available.
^^^^^^^^^^^^^^
bounded ranges
^^^^^^^^^^^^^^
A bounded range is a group of IP addresses specified using a start and end address forming a contiguous block. No bit boundaries are assumed but the end address must be numerically greater than or equal to the start address.
.. autoclass:: netaddr.IPRange
:members:
^^^^^^^^^^^^^^
IP glob ranges
^^^^^^^^^^^^^^
A very useful way to represent IP network in configuration files and on the command line for those who do not speak CIDR.
The `IPGlob` class is used to represent individual glob ranges.
.. autoclass:: netaddr.IPGlob
:members:
^^^^^^^^^^^^^^^^^^
globbing functions
^^^^^^^^^^^^^^^^^^
It is also very useful to be able to convert between glob ranges and CIDR and IP ranges. The following function enable these various conversions.
.. autofunction:: netaddr.cidr_to_glob
.. autofunction:: netaddr.glob_to_cidrs
.. autofunction:: netaddr.glob_to_iprange
.. autofunction:: netaddr.glob_to_iptuple
.. autofunction:: netaddr.iprange_to_globs
^^^^^^^^^^^^^^^
``nmap`` ranges
^^^^^^^^^^^^^^^
``nmap`` is a well known network security tool. It has a particularly flexible way of specifying IP address groupings.
Functions are provided that allow the verification and enumeration of IP address specified in this format.
.. autofunction:: netaddr.valid_nmap_range
.. autofunction:: netaddr.iter_nmap_range
-------
IP sets
-------
When dealing with large numbers of IP addresses and ranges it is often useful to manipulate them as sets so you can calculate intersections, unions and differences between various groups of them.
The `IPSet` class was built specifically for this purpose.
.. autoclass:: netaddr.IPSet
:members:
---------------------------
IP functions and generators
---------------------------
The following are a set of useful helper functions related to the various format supported in this library.
.. autofunction:: netaddr.all_matching_cidrs
.. autofunction:: netaddr.cidr_abbrev_to_verbose
.. autofunction:: netaddr.cidr_exclude
.. autofunction:: netaddr.cidr_merge
.. autofunction:: netaddr.iprange_to_cidrs
.. autofunction:: netaddr.iter_iprange
.. autofunction:: netaddr.iter_unique_ips
.. autofunction:: netaddr.largest_matching_cidr
.. autofunction:: netaddr.smallest_matching_cidr
.. autofunction:: netaddr.spanning_cidr
---------------------------------------
MAC addresses and the IEEE EUI standard
---------------------------------------
A MAC address is the 48-bit hardware address associated with a particular physical interface on a networked host. They are found in all networked devices and serve to identify (layer 2) frames in the networking stack.
The `EUI` class is used to represents MACs (as well as their larger and less common 64-bit cousins).
.. autoclass:: netaddr.EUI
:members:
.. autoclass:: netaddr.OUI
:members:
.. autoclass:: netaddr.IAB
:members:
.. _mac_formatting_dialects:
^^^^^^^^^^^^^^^^^^^^^^^
MAC formatting dialects
^^^^^^^^^^^^^^^^^^^^^^^
The following dialects are used to specify the formatting of MAC addresses.
.. autoclass:: netaddr.mac_bare
:members:
.. autoclass:: netaddr.mac_cisco
:members:
.. autoclass:: netaddr.mac_eui48
:members:
.. autoclass:: netaddr.mac_pgsql
:members:
.. autoclass:: netaddr.mac_unix
:members:
--------------------
Validation functions
--------------------
.. autofunction:: netaddr.valid_ipv4
.. autofunction:: netaddr.valid_ipv6
.. autofunction:: netaddr.valid_glob
.. autofunction:: netaddr.valid_mac
------------
A bit of fun
------------
Who said networking was all about being serious? It's always good to lighten up and have a bit of fun.
Let's face it, no networking library worth its salt would be complete without support for RFC 1924 - http://www.ietf.org/rfc/rfc1924 ``:-)``
.. autofunction:: netaddr.base85_to_ipv6
.. autofunction:: netaddr.ipv6_to_base85
|
