netbox-kea 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- netbox_kea-0.1.0/LICENSE +202 -0
- netbox_kea-0.1.0/PKG-INFO +94 -0
- netbox_kea-0.1.0/README.md +78 -0
- netbox_kea-0.1.0/netbox_kea/__init__.py +13 -0
- netbox_kea-0.1.0/netbox_kea/api/__init__.py +0 -0
- netbox_kea-0.1.0/netbox_kea/api/serializers.py +30 -0
- netbox_kea-0.1.0/netbox_kea/api/urls.py +10 -0
- netbox_kea-0.1.0/netbox_kea/api/views.py +10 -0
- netbox_kea-0.1.0/netbox_kea/constants.py +16 -0
- netbox_kea-0.1.0/netbox_kea/filtersets.py +9 -0
- netbox_kea-0.1.0/netbox_kea/forms.py +192 -0
- netbox_kea-0.1.0/netbox_kea/graphql.py +19 -0
- netbox_kea-0.1.0/netbox_kea/kea.py +81 -0
- netbox_kea-0.1.0/netbox_kea/migrations/0001_initial.py +38 -0
- netbox_kea-0.1.0/netbox_kea/migrations/0002_alter_server_options_server_dhcp4_server_dhcp6.py +27 -0
- netbox_kea-0.1.0/netbox_kea/migrations/__init__.py +0 -0
- netbox_kea-0.1.0/netbox_kea/models.py +113 -0
- netbox_kea-0.1.0/netbox_kea/navigation.py +20 -0
- netbox_kea-0.1.0/netbox_kea/tables.py +219 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/exception_htmx.html +12 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/inc/configure_table.html +17 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server.html +36 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_base.html +2 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_dhcp_leases.html +22 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_dhcp_leases_htmx.html +108 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_dhcp_subnets.html +32 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_leases_delete.html +34 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/server_status.html +19 -0
- netbox_kea-0.1.0/netbox_kea/templates/netbox_kea/service_disabled.html +14 -0
- netbox_kea-0.1.0/netbox_kea/urls.py +25 -0
- netbox_kea-0.1.0/netbox_kea/utilities.py +91 -0
- netbox_kea-0.1.0/netbox_kea/views.py +507 -0
- netbox_kea-0.1.0/pyproject.toml +33 -0
netbox_kea-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: netbox-kea
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary:
|
|
5
|
+
Author: Devon Mar
|
|
6
|
+
Author-email: devonm@mdmm.ca
|
|
7
|
+
Requires-Python: >=3.8.1,<4.0.0
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Requires-Dist: netaddr (>=0.8.0,<0.9.0)
|
|
13
|
+
Requires-Dist: requests (>=2,<3)
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
# NetBox plugin for the Kea DHCP server
|
|
17
|
+
|
|
18
|
+
This plugin allows you to view Kea status, leases and subnets in NetBox. Go directly from a NetBox device/VM to a DHCP lease and back!
|
|
19
|
+
|
|
20
|
+
## Features
|
|
21
|
+
|
|
22
|
+
- Uses the Kea management API
|
|
23
|
+
- View Kea daemon statuses.
|
|
24
|
+
- Supports Kea's DHCPv4 and DHCPv6 servers.
|
|
25
|
+
- View, delete, export and search for DHCP leases.
|
|
26
|
+
- Search for NetBox devices/VMs directly from DHCP leases.
|
|
27
|
+
- View DHCP subnets from Kea's configuration.
|
|
28
|
+
- REST API and GraphQL support for managing Server objects.
|
|
29
|
+
|
|
30
|
+

|
|
31
|
+
|
|
32
|
+
## Limitations
|
|
33
|
+
|
|
34
|
+
- Due to limitations in the Kea management API, pagination is only supported when searching for leases by subnet.
|
|
35
|
+
Additionally, you can only go forwards, not backwards.
|
|
36
|
+
|
|
37
|
+
- Searching for leases by subnet ID does not support pagination. This may be an expensive operation depending on the subnet size.
|
|
38
|
+
|
|
39
|
+
- Kea doesn't provide a way to get a list of subnets without an additional hook library.
|
|
40
|
+
Thus, this plugin lists subnets using the `config-get` command. This means that the entire config will be fetched just to get the configured subnets!
|
|
41
|
+
This may be an expensive operation.
|
|
42
|
+
|
|
43
|
+
## Requirements
|
|
44
|
+
|
|
45
|
+
- NetBox > v3.5
|
|
46
|
+
- [Kea Control Agent](https://kea.readthedocs.io/en/latest/arm/agent.html)
|
|
47
|
+
- [`lease_cmds`](https://kea.readthedocs.io/en/latest/arm/hooks.html#lease-cmds-lease-commands-for-easier-lease-management) hook library
|
|
48
|
+
|
|
49
|
+
## Compatibility
|
|
50
|
+
|
|
51
|
+
- This plugin was tested with Kea v2.2.0 with the `memfile` lease database.
|
|
52
|
+
Other versions and lease databases may also work.
|
|
53
|
+
|
|
54
|
+
## Installation
|
|
55
|
+
|
|
56
|
+
1. Add `netbox-kea` to `local_requirements.txt`.
|
|
57
|
+
|
|
58
|
+
2. Enable the plugin in `configuration.py`
|
|
59
|
+
```python
|
|
60
|
+
PLUGINS = ["netbox_kea"]
|
|
61
|
+
```
|
|
62
|
+
3. Run `./migrate.py migrate`
|
|
63
|
+
|
|
64
|
+
## Custom Links
|
|
65
|
+
|
|
66
|
+
You can add custom links to NetBox models to easily search for leases.
|
|
67
|
+
|
|
68
|
+
Make sure to replace `<Kea Server ID>` in the link URL with the object ID of your Kea server. To find a server's ID, open the page for the server
|
|
69
|
+
and look at the top right corner for `netbox_kea.server:<Server ID Here>`.
|
|
70
|
+
|
|
71
|
+
### Show DHCP leases for a prefix
|
|
72
|
+
|
|
73
|
+
**Content types**: `IPAM > Prefix`
|
|
74
|
+
|
|
75
|
+
**Link URL**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases{{ object.prefix.version }}/?q={{ object.prefix }}&by=subnet`
|
|
76
|
+
|
|
77
|
+
### Show DHCP leases for a device/VM interface (by MAC):
|
|
78
|
+
|
|
79
|
+
**Content types**: `DCIM > Interface`, `Virtualization > Interface`
|
|
80
|
+
|
|
81
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.mac_address }}&by=hw`
|
|
82
|
+
|
|
83
|
+
**Link URL (DHCPv6)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.mac_address }}&by=hw`
|
|
84
|
+
|
|
85
|
+
### Show DHCP leases for a device/VM (by name):
|
|
86
|
+
|
|
87
|
+
**Content types**: `DCIM > Device`, `Virtualization > Virtual Machine`
|
|
88
|
+
|
|
89
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.name|lower }}&by=hostname`
|
|
90
|
+
|
|
91
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.name|lower }}&by=hostname`
|
|
92
|
+
|
|
93
|
+
You may also use a custom field by replacing `{{ object.name|lower }}` with `{{ object.cf.<your custom field>|lower }}`.
|
|
94
|
+
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# NetBox plugin for the Kea DHCP server
|
|
2
|
+
|
|
3
|
+
This plugin allows you to view Kea status, leases and subnets in NetBox. Go directly from a NetBox device/VM to a DHCP lease and back!
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Uses the Kea management API
|
|
8
|
+
- View Kea daemon statuses.
|
|
9
|
+
- Supports Kea's DHCPv4 and DHCPv6 servers.
|
|
10
|
+
- View, delete, export and search for DHCP leases.
|
|
11
|
+
- Search for NetBox devices/VMs directly from DHCP leases.
|
|
12
|
+
- View DHCP subnets from Kea's configuration.
|
|
13
|
+
- REST API and GraphQL support for managing Server objects.
|
|
14
|
+
|
|
15
|
+

|
|
16
|
+
|
|
17
|
+
## Limitations
|
|
18
|
+
|
|
19
|
+
- Due to limitations in the Kea management API, pagination is only supported when searching for leases by subnet.
|
|
20
|
+
Additionally, you can only go forwards, not backwards.
|
|
21
|
+
|
|
22
|
+
- Searching for leases by subnet ID does not support pagination. This may be an expensive operation depending on the subnet size.
|
|
23
|
+
|
|
24
|
+
- Kea doesn't provide a way to get a list of subnets without an additional hook library.
|
|
25
|
+
Thus, this plugin lists subnets using the `config-get` command. This means that the entire config will be fetched just to get the configured subnets!
|
|
26
|
+
This may be an expensive operation.
|
|
27
|
+
|
|
28
|
+
## Requirements
|
|
29
|
+
|
|
30
|
+
- NetBox > v3.5
|
|
31
|
+
- [Kea Control Agent](https://kea.readthedocs.io/en/latest/arm/agent.html)
|
|
32
|
+
- [`lease_cmds`](https://kea.readthedocs.io/en/latest/arm/hooks.html#lease-cmds-lease-commands-for-easier-lease-management) hook library
|
|
33
|
+
|
|
34
|
+
## Compatibility
|
|
35
|
+
|
|
36
|
+
- This plugin was tested with Kea v2.2.0 with the `memfile` lease database.
|
|
37
|
+
Other versions and lease databases may also work.
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
1. Add `netbox-kea` to `local_requirements.txt`.
|
|
42
|
+
|
|
43
|
+
2. Enable the plugin in `configuration.py`
|
|
44
|
+
```python
|
|
45
|
+
PLUGINS = ["netbox_kea"]
|
|
46
|
+
```
|
|
47
|
+
3. Run `./migrate.py migrate`
|
|
48
|
+
|
|
49
|
+
## Custom Links
|
|
50
|
+
|
|
51
|
+
You can add custom links to NetBox models to easily search for leases.
|
|
52
|
+
|
|
53
|
+
Make sure to replace `<Kea Server ID>` in the link URL with the object ID of your Kea server. To find a server's ID, open the page for the server
|
|
54
|
+
and look at the top right corner for `netbox_kea.server:<Server ID Here>`.
|
|
55
|
+
|
|
56
|
+
### Show DHCP leases for a prefix
|
|
57
|
+
|
|
58
|
+
**Content types**: `IPAM > Prefix`
|
|
59
|
+
|
|
60
|
+
**Link URL**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases{{ object.prefix.version }}/?q={{ object.prefix }}&by=subnet`
|
|
61
|
+
|
|
62
|
+
### Show DHCP leases for a device/VM interface (by MAC):
|
|
63
|
+
|
|
64
|
+
**Content types**: `DCIM > Interface`, `Virtualization > Interface`
|
|
65
|
+
|
|
66
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.mac_address }}&by=hw`
|
|
67
|
+
|
|
68
|
+
**Link URL (DHCPv6)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.mac_address }}&by=hw`
|
|
69
|
+
|
|
70
|
+
### Show DHCP leases for a device/VM (by name):
|
|
71
|
+
|
|
72
|
+
**Content types**: `DCIM > Device`, `Virtualization > Virtual Machine`
|
|
73
|
+
|
|
74
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases4/?q={{ object.name|lower }}&by=hostname`
|
|
75
|
+
|
|
76
|
+
**Link URL (DHCPv4)**: `https://netbox.example.com/plugins/kea/servers/<Kea Server ID>/leases6/?q={{ object.name|lower }}&by=hostname`
|
|
77
|
+
|
|
78
|
+
You may also use a custom field by replacing `{{ object.name|lower }}` with `{{ object.cf.<your custom field>|lower }}`.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
from extras.plugins import PluginConfig
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class NetBoxKeaConfig(PluginConfig):
|
|
5
|
+
name = "netbox_kea"
|
|
6
|
+
verbose_name = "Kea"
|
|
7
|
+
description = "Kea integration for NetBox"
|
|
8
|
+
version = "0.1.0"
|
|
9
|
+
base_url = "kea"
|
|
10
|
+
default_settings = {"kea_timeout": 30}
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
config = NetBoxKeaConfig
|
|
File without changes
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
from netbox.api.serializers import NetBoxModelSerializer
|
|
2
|
+
from rest_framework import serializers
|
|
3
|
+
|
|
4
|
+
from ..models import Server
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
class ServerSerializer(NetBoxModelSerializer):
|
|
8
|
+
url = serializers.HyperlinkedIdentityField(
|
|
9
|
+
view_name="plugins-api:netbox_kea-api:server-detail"
|
|
10
|
+
)
|
|
11
|
+
|
|
12
|
+
class Meta:
|
|
13
|
+
model = Server
|
|
14
|
+
fields = (
|
|
15
|
+
"id",
|
|
16
|
+
"name",
|
|
17
|
+
"server_url",
|
|
18
|
+
"username",
|
|
19
|
+
"password",
|
|
20
|
+
"ssl_verify",
|
|
21
|
+
"client_cert_path",
|
|
22
|
+
"client_key_path",
|
|
23
|
+
"ca_file_path",
|
|
24
|
+
"dhcp6",
|
|
25
|
+
"dhcp4",
|
|
26
|
+
"url",
|
|
27
|
+
"display",
|
|
28
|
+
"tags",
|
|
29
|
+
"last_updated",
|
|
30
|
+
)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
from netbox.api.viewsets import NetBoxModelViewSet
|
|
2
|
+
|
|
3
|
+
from .. import filtersets, models
|
|
4
|
+
from .serializers import ServerSerializer
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
class ServerViewSet(NetBoxModelViewSet):
|
|
8
|
+
queryset = models.Server.objects.prefetch_related("tags")
|
|
9
|
+
filterset_class = filtersets.ServerFilterSet
|
|
10
|
+
serializer_class = ServerSerializer
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
BY_IP = "ip"
|
|
2
|
+
BY_HOSTNAME = "hostname"
|
|
3
|
+
BY_DUID = "duid"
|
|
4
|
+
BY_SUBNET = "subnet"
|
|
5
|
+
BY_SUBNET_ID = "subnet_id"
|
|
6
|
+
BY_HW_ADDRESS = "hw"
|
|
7
|
+
BY_CLIENT_ID = "client_id"
|
|
8
|
+
|
|
9
|
+
HEX_STRING_REGEX = r"^([0-9A-Fa-f]{2}[:-]?)*([0-9A-Fa-f]{2})$"
|
|
10
|
+
|
|
11
|
+
# kea/src/lib/dhcp
|
|
12
|
+
# RFC8415 section 11.1
|
|
13
|
+
DUID_MAX_OCTETS = 128
|
|
14
|
+
DUID_MIN_OCTETS = 1
|
|
15
|
+
CLIENT_ID_MAX_OCTETS = DUID_MAX_OCTETS
|
|
16
|
+
CLIENT_ID_MIN_OCTETS = 2
|
|
@@ -0,0 +1,192 @@
|
|
|
1
|
+
from typing import Any, Dict, Literal, Optional
|
|
2
|
+
|
|
3
|
+
from django import forms
|
|
4
|
+
from django.core.exceptions import ValidationError
|
|
5
|
+
from netaddr import EUI, AddrFormatError, IPAddress, IPNetwork, mac_unix_expanded
|
|
6
|
+
from netbox.forms import NetBoxModelFilterSetForm, NetBoxModelForm
|
|
7
|
+
from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES, BootstrapMixin
|
|
8
|
+
from utilities.forms.fields import TagFilterField
|
|
9
|
+
|
|
10
|
+
from . import constants
|
|
11
|
+
from .models import Server
|
|
12
|
+
from .utilities import is_hex_string
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class ServerForm(NetBoxModelForm):
|
|
16
|
+
class Meta:
|
|
17
|
+
model = Server
|
|
18
|
+
fields = (
|
|
19
|
+
"name",
|
|
20
|
+
"server_url",
|
|
21
|
+
"username",
|
|
22
|
+
"password",
|
|
23
|
+
"ssl_verify",
|
|
24
|
+
"client_cert_path",
|
|
25
|
+
"client_key_path",
|
|
26
|
+
"ca_file_path",
|
|
27
|
+
"dhcp6",
|
|
28
|
+
"dhcp4",
|
|
29
|
+
"tags",
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class VeryHiddenInput(forms.HiddenInput):
|
|
34
|
+
"""Returns an empty string on render."""
|
|
35
|
+
|
|
36
|
+
input_type = "hidden"
|
|
37
|
+
template_name = ""
|
|
38
|
+
|
|
39
|
+
def render(self, name: str, value: Any, attrs: Any, renderer: Any) -> str:
|
|
40
|
+
return ""
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
class ServerFilterForm(NetBoxModelFilterSetForm):
|
|
44
|
+
model = Server
|
|
45
|
+
tag = TagFilterField(model)
|
|
46
|
+
dhcp4 = forms.NullBooleanField(
|
|
47
|
+
label="DHCPv4",
|
|
48
|
+
required=False,
|
|
49
|
+
widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES),
|
|
50
|
+
)
|
|
51
|
+
dhcp6 = forms.NullBooleanField(
|
|
52
|
+
label="DHCPv6",
|
|
53
|
+
required=False,
|
|
54
|
+
widget=forms.Select(choices=BOOLEAN_WITH_BLANK_CHOICES),
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
class BaseLeasesSarchForm(BootstrapMixin, forms.Form):
|
|
59
|
+
q = forms.CharField(label="Search")
|
|
60
|
+
page = forms.CharField(required=False, widget=VeryHiddenInput)
|
|
61
|
+
|
|
62
|
+
def clean(self) -> Optional[Dict[str, Any]]:
|
|
63
|
+
ip_version = self.Meta.ip_version
|
|
64
|
+
cleaned_data = super().clean()
|
|
65
|
+
q = cleaned_data.get("q")
|
|
66
|
+
by = cleaned_data.get("by")
|
|
67
|
+
|
|
68
|
+
if q and not by:
|
|
69
|
+
raise ValidationError({"by": "Search attribute is empty."})
|
|
70
|
+
elif by and not q:
|
|
71
|
+
raise ValidationError({"q": "Search value is empty."})
|
|
72
|
+
|
|
73
|
+
if by == constants.BY_SUBNET:
|
|
74
|
+
try:
|
|
75
|
+
if "/" not in q:
|
|
76
|
+
raise ValidationError({"q": "CIDR mask is required"})
|
|
77
|
+
net = IPNetwork(q, version=ip_version)
|
|
78
|
+
if net.ip != net.cidr.ip:
|
|
79
|
+
raise ValidationError(
|
|
80
|
+
{"q": f"{net} is not a valid prefix. Did you mean {net.cidr}?"}
|
|
81
|
+
)
|
|
82
|
+
cleaned_data["q"] = net
|
|
83
|
+
except (AddrFormatError, TypeError, ValueError) as e:
|
|
84
|
+
raise ValidationError(
|
|
85
|
+
{"q": f"Invalid IPv{ip_version} subnet: {cleaned_data['q']}"}
|
|
86
|
+
) from e
|
|
87
|
+
elif by == constants.BY_SUBNET_ID:
|
|
88
|
+
try:
|
|
89
|
+
i = int(q)
|
|
90
|
+
if i <= 0:
|
|
91
|
+
raise ValidationError({"q": f"Invalid subnet ID: {q}"})
|
|
92
|
+
cleaned_data["q"] = i
|
|
93
|
+
except ValueError as e:
|
|
94
|
+
raise ValidationError(
|
|
95
|
+
{"q": f"Subnet ID must be an integer: {q}"}
|
|
96
|
+
) from e
|
|
97
|
+
elif by == constants.BY_IP:
|
|
98
|
+
try:
|
|
99
|
+
# use IPAddress to normalize values
|
|
100
|
+
cleaned_data["q"] = str(IPAddress(q, version=ip_version))
|
|
101
|
+
except (AddrFormatError, TypeError, ValueError) as e:
|
|
102
|
+
raise ValidationError(
|
|
103
|
+
{"q": f"Invalid IPv{ip_version} address: {q}"}
|
|
104
|
+
) from e
|
|
105
|
+
elif by in (constants.BY_HW_ADDRESS):
|
|
106
|
+
try:
|
|
107
|
+
cleaned_data["q"] = str(EUI(q, version=48, dialect=mac_unix_expanded))
|
|
108
|
+
except (AddrFormatError, TypeError, ValueError) as e:
|
|
109
|
+
raise ValidationError({"q": f"Invalid hardware address: {q}"}) from e
|
|
110
|
+
elif by in constants.BY_DUID:
|
|
111
|
+
if not is_hex_string(
|
|
112
|
+
q, constants.DUID_MIN_OCTETS, constants.DUID_MAX_OCTETS
|
|
113
|
+
):
|
|
114
|
+
raise ValidationError({"q": f"Invalid DUID: {q}"})
|
|
115
|
+
cleaned_data["q"] = q.replace("-", "")
|
|
116
|
+
elif by in constants.BY_CLIENT_ID:
|
|
117
|
+
if not is_hex_string(
|
|
118
|
+
q, constants.CLIENT_ID_MIN_OCTETS, constants.DUID_MAX_OCTETS
|
|
119
|
+
):
|
|
120
|
+
raise ValidationError({"q": f"Invalid client ID: {q}"})
|
|
121
|
+
cleaned_data["q"] = q.replace("-", "")
|
|
122
|
+
|
|
123
|
+
page = cleaned_data["page"]
|
|
124
|
+
if page:
|
|
125
|
+
if by != constants.BY_SUBNET:
|
|
126
|
+
raise ValidationError({"page": "page is only supported with subnet."})
|
|
127
|
+
try:
|
|
128
|
+
page_ip = IPAddress(page, version=ip_version)
|
|
129
|
+
if page_ip not in cleaned_data["q"]:
|
|
130
|
+
raise ValidationError({"page": "page is not in the given subnet"})
|
|
131
|
+
|
|
132
|
+
cleaned_data["page"] = str(page_ip)
|
|
133
|
+
except AddrFormatError as e:
|
|
134
|
+
raise ValidationError({"page": f"Invalid IP: {page}"}) from e
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
class Leases4SearchForm(BaseLeasesSarchForm):
|
|
138
|
+
by = forms.ChoiceField(
|
|
139
|
+
label="Attribute",
|
|
140
|
+
choices=(
|
|
141
|
+
(constants.BY_IP, "IP Address"),
|
|
142
|
+
(constants.BY_HOSTNAME, "Hostname"),
|
|
143
|
+
(constants.BY_HW_ADDRESS, "Hardware Address"),
|
|
144
|
+
(constants.BY_CLIENT_ID, "Client ID"),
|
|
145
|
+
(constants.BY_SUBNET, "Subnet"),
|
|
146
|
+
(constants.BY_SUBNET_ID, "Subnet ID"),
|
|
147
|
+
),
|
|
148
|
+
required=True,
|
|
149
|
+
)
|
|
150
|
+
|
|
151
|
+
class Meta:
|
|
152
|
+
ip_version = 4
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
class Leases6SearchForm(BaseLeasesSarchForm):
|
|
156
|
+
by = forms.ChoiceField(
|
|
157
|
+
label="Attribute",
|
|
158
|
+
choices=(
|
|
159
|
+
(constants.BY_IP, "IP Address"),
|
|
160
|
+
(constants.BY_HOSTNAME, "Hostname"),
|
|
161
|
+
(constants.BY_DUID, "DUID"),
|
|
162
|
+
(constants.BY_SUBNET, "Subnet"),
|
|
163
|
+
(constants.BY_SUBNET_ID, "Subnet ID"),
|
|
164
|
+
),
|
|
165
|
+
required=True,
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
class Meta:
|
|
169
|
+
ip_version = 6
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
class MultipleIPField(forms.MultipleChoiceField):
|
|
173
|
+
def __init__(self, version: Literal[6, 4], *args, **kwargs) -> None:
|
|
174
|
+
self._version = version
|
|
175
|
+
super().__init__(*args, widget=forms.MultipleHiddenInput, **kwargs)
|
|
176
|
+
|
|
177
|
+
def clean(self, value: Any) -> Any:
|
|
178
|
+
if not isinstance(value, list):
|
|
179
|
+
raise forms.ValidationError(f"Expected a list, got {type(value)}.")
|
|
180
|
+
|
|
181
|
+
try:
|
|
182
|
+
return [str(IPAddress(ip, version=self._version)) for ip in value]
|
|
183
|
+
except (AddrFormatError, ValueError) as e:
|
|
184
|
+
raise forms.ValidationError("Invalid IP address.") from e
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
class Lease6DeleteForm(forms.Form):
|
|
188
|
+
pk = MultipleIPField(6)
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
class Lease4DeleteForm(forms.Form):
|
|
192
|
+
pk = MultipleIPField(4)
|