netbox-ipam-treeview-plugin 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_ipam_treeview_plugin-0.1.0/.gitignore +13 -0
- netbox_ipam_treeview_plugin-0.1.0/CHANGELOG.md +15 -0
- netbox_ipam_treeview_plugin-0.1.0/LICENSE +202 -0
- netbox_ipam_treeview_plugin-0.1.0/PKG-INFO +135 -0
- netbox_ipam_treeview_plugin-0.1.0/README.md +111 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/__init__.py +23 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/columns.py +32 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/conf.py +23 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/navigation.py +37 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/static/netbox_ipam_treeview/tree.css +21 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/static/netbox_ipam_treeview/tree.js +289 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/template_content.py +22 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/inc/list_button.html +1 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/inc/rows.html +33 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/inc/table.html +27 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/inc/toolbar.html +32 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/tab.html +17 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templates/netbox_ipam_treeview/tree.html +57 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templatetags/__init__.py +0 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/templatetags/ipam_tree.py +64 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/__init__.py +0 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/builder.py +447 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/gaps.py +39 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/nesting.py +89 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/nodes.py +58 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/tree/usage.py +46 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/urls.py +11 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/utilization.py +100 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/version.py +1 -0
- netbox_ipam_treeview_plugin-0.1.0/netbox_ipam_treeview/views.py +236 -0
- netbox_ipam_treeview_plugin-0.1.0/pyproject.toml +57 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project are documented here. Format: [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
|
4
|
+
versioning: [SemVer](https://semver.org/).
|
|
5
|
+
|
|
6
|
+
## [0.1.0] - 2026-10-08
|
|
7
|
+
|
|
8
|
+
### Added
|
|
9
|
+
|
|
10
|
+
- Collapsible IPAM tree (VRF → Aggregate → Prefix) with lazy loading, Expand all / Collapse all and restored
|
|
11
|
+
expansion state.
|
|
12
|
+
- Free-space rows with one-click prefix creation, bulk-computed utilization bars, permission-aware row actions.
|
|
13
|
+
- Native prefix filters with ancestor context, per-user column picker, keyboard navigation.
|
|
14
|
+
- Tree tabs on Prefix, Aggregate and VRF pages and a *Tree view* button on the prefix list, each toggleable in
|
|
15
|
+
`PLUGINS_CONFIG`.
|
|
@@ -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,135 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: netbox-ipam-treeview-plugin
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: DDI-style collapsible tree view for NetBox IPAM prefixes.
|
|
5
|
+
Project-URL: Homepage, https://github.com/thomaschristory/netbox-ipam-treeview-plugin
|
|
6
|
+
Project-URL: Repository, https://github.com/thomaschristory/netbox-ipam-treeview-plugin
|
|
7
|
+
Project-URL: Changelog, https://github.com/thomaschristory/netbox-ipam-treeview-plugin/blob/main/CHANGELOG.md
|
|
8
|
+
Project-URL: Issues, https://github.com/thomaschristory/netbox-ipam-treeview-plugin/issues
|
|
9
|
+
Author: Thomas Christory
|
|
10
|
+
License-Expression: Apache-2.0
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Keywords: ddi,ipam,netbox,netbox-plugin,prefix,tree
|
|
13
|
+
Classifier: Development Status :: 3 - Alpha
|
|
14
|
+
Classifier: Framework :: Django
|
|
15
|
+
Classifier: Intended Audience :: System Administrators
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
19
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
21
|
+
Classifier: Topic :: System :: Networking
|
|
22
|
+
Requires-Python: >=3.12
|
|
23
|
+
Description-Content-Type: text/markdown
|
|
24
|
+
|
|
25
|
+
# netbox-ipam-treeview-plugin
|
|
26
|
+
|
|
27
|
+
[](https://github.com/thomaschristory/netbox-ipam-treeview-plugin/actions/workflows/ci.yml)
|
|
28
|
+
[](https://pypi.org/project/netbox-ipam-treeview-plugin/)
|
|
29
|
+
[](https://pypi.org/project/netbox-ipam-treeview-plugin/)
|
|
30
|
+
|
|
31
|
+
A DDI-style, collapsible tree view of NetBox IPAM. Instead of a flat, paginated list of prefixes, you start
|
|
32
|
+
from the top-level supernets and drill down: **VRF → Aggregate → Prefix → child prefix**, with free space shown
|
|
33
|
+
in place, one-click **Expand all** / **Collapse all**, and the tree remembering what you had open.
|
|
34
|
+
|
|
35
|
+

|
|
36
|
+
|
|
37
|
+
## Features
|
|
38
|
+
|
|
39
|
+
- **Collapsible tree**: roots are VRFs (Global first) and the aggregates holding their prefixes; children load
|
|
40
|
+
lazily as you expand, so it stays fast on large IPAMs.
|
|
41
|
+
- **Expand all / Collapse all** for the whole tree or any subtree (Alt+click a caret, or `*` on a focused row),
|
|
42
|
+
capped by `expand_all_limit` so a click can never render an unbounded page.
|
|
43
|
+
- **Free space** between children, shown as greyed rows with a one-click *Create* that pre-fills the prefix and VRF.
|
|
44
|
+
- **Utilization bars** with the same numbers as NetBox's own prefix views, computed in bulk.
|
|
45
|
+
- **Row actions** (add child, edit, delete), shown only when you have the permission.
|
|
46
|
+
- **NetBox filters**: the native prefix filter form; matches are shown with their ancestors as greyed context.
|
|
47
|
+
- **Column picker**, saved per user.
|
|
48
|
+
- **Remembers state**: expanded nodes are restored when you come back.
|
|
49
|
+
- **Keyboard navigation** (treegrid pattern): ↑ ↓ move, → expand / first child, ← collapse / parent, `*` expand
|
|
50
|
+
subtree, Enter opens the prefix.
|
|
51
|
+
- **Everywhere it is useful**: a *Prefix Tree* page, a *Tree view* button on the native prefix list (carrying
|
|
52
|
+
your filters), and *Tree* tabs on Prefix, Aggregate and VRF pages. Each can be switched off.
|
|
53
|
+
- Light and dark themes.
|
|
54
|
+
|
|
55
|
+
## Compatibility
|
|
56
|
+
|
|
57
|
+
| Plugin | NetBox | Python |
|
|
58
|
+
|--------|-------------|-------------|
|
|
59
|
+
| 0.1.x | 4.7 | 3.12 – 3.14 |
|
|
60
|
+
|
|
61
|
+
## Installation
|
|
62
|
+
|
|
63
|
+
```shell
|
|
64
|
+
source /opt/netbox/venv/bin/activate
|
|
65
|
+
pip install netbox-ipam-treeview-plugin
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Add it to `configuration.py` (or `local_requirements.txt` + `plugins.py` with netbox-docker):
|
|
69
|
+
|
|
70
|
+
```python
|
|
71
|
+
PLUGINS = ["netbox_ipam_treeview"]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
Then collect the static files and restart NetBox:
|
|
75
|
+
|
|
76
|
+
```shell
|
|
77
|
+
python /opt/netbox/netbox/manage.py collectstatic --no-input
|
|
78
|
+
sudo systemctl restart netbox
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
The tree lives at `/plugins/ipam-tree/` (menu: *IPAM → Prefixes → Prefix Tree*, right below *Prefixes*).
|
|
82
|
+
|
|
83
|
+
## Configuration
|
|
84
|
+
|
|
85
|
+
All settings are optional:
|
|
86
|
+
|
|
87
|
+
```python
|
|
88
|
+
PLUGINS_CONFIG = {
|
|
89
|
+
"netbox_ipam_treeview": {
|
|
90
|
+
"expand_all_limit": 5000,
|
|
91
|
+
},
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
| Setting | Default | Meaning |
|
|
96
|
+
|---|---|---|
|
|
97
|
+
| `show_menu_item` | `True` | Show the *Prefix Tree* menu entry |
|
|
98
|
+
| `menu_location` | `"ipam"` | `"ipam"`: IPAM menu, right below *Prefixes*; `"plugins"`: the Plugins menu |
|
|
99
|
+
| `show_list_toggle` | `True` | *Tree view* button on the native prefix list |
|
|
100
|
+
| `show_prefix_tab` | `True` | *Tree* tab on prefix pages |
|
|
101
|
+
| `show_aggregate_tab` | `True` | *Tree* tab on aggregate pages |
|
|
102
|
+
| `show_vrf_tab` | `True` | *Tree* tab on VRF pages |
|
|
103
|
+
| `group_by_vrf` | `True` | Top level is one node per VRF; `False` mixes all VRFs under the aggregates (add the VRF column) |
|
|
104
|
+
| `show_aggregates` | `True` | Aggregates as a tree level |
|
|
105
|
+
| `show_free_space` | `True` | Default for free-space rows (each user can toggle it) |
|
|
106
|
+
| `gaps_respect_mark_utilized` | `True` | No free-space rows under pools and *mark utilized* prefixes |
|
|
107
|
+
| `max_gap_rows` | `64` | Free-space rows per node; the rest are summarised in one row |
|
|
108
|
+
| `expand_all_limit` | `5000` | Row cap for *Expand all* and filtered trees |
|
|
109
|
+
| `default_columns` | status, utilization, scope, VLAN, tenant, role, description, actions | Columns before a user picks their own |
|
|
110
|
+
|
|
111
|
+
## Permissions
|
|
112
|
+
|
|
113
|
+
- The page requires `ipam.view_prefix`; every row is restricted to what the user may view.
|
|
114
|
+
- Aggregates appear only for users with `ipam.view_aggregate`; VRF groups only for VRFs the user may view.
|
|
115
|
+
- With constrained (object-level) permissions, prefixes hang under their **nearest visible ancestor**, and free-space
|
|
116
|
+
rows are not shown, because space taken by prefixes the user cannot see would look free.
|
|
117
|
+
- *Delete* links go to NetBox's own confirmation page.
|
|
118
|
+
|
|
119
|
+
## Development
|
|
120
|
+
|
|
121
|
+
The dev stack is netbox-docker with the plugin mounted live, seeded with ~8,000 RFC 1918 / ULA prefixes across
|
|
122
|
+
VRFs, aggregates, sites and VLANs.
|
|
123
|
+
|
|
124
|
+
```shell
|
|
125
|
+
make dev # build and start NetBox on http://localhost:8000 (admin / admin)
|
|
126
|
+
make seed # load the demo dataset (make reseed to wipe and reload, make seed-big for ~5x)
|
|
127
|
+
make test # pure unit tests (no NetBox needed)
|
|
128
|
+
make test-netbox # integration tests inside the NetBox container
|
|
129
|
+
make lint # ruff
|
|
130
|
+
make dist # build and check the wheel and sdist
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Apache-2.0
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# netbox-ipam-treeview-plugin
|
|
2
|
+
|
|
3
|
+
[](https://github.com/thomaschristory/netbox-ipam-treeview-plugin/actions/workflows/ci.yml)
|
|
4
|
+
[](https://pypi.org/project/netbox-ipam-treeview-plugin/)
|
|
5
|
+
[](https://pypi.org/project/netbox-ipam-treeview-plugin/)
|
|
6
|
+
|
|
7
|
+
A DDI-style, collapsible tree view of NetBox IPAM. Instead of a flat, paginated list of prefixes, you start
|
|
8
|
+
from the top-level supernets and drill down: **VRF → Aggregate → Prefix → child prefix**, with free space shown
|
|
9
|
+
in place, one-click **Expand all** / **Collapse all**, and the tree remembering what you had open.
|
|
10
|
+
|
|
11
|
+

|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- **Collapsible tree**: roots are VRFs (Global first) and the aggregates holding their prefixes; children load
|
|
16
|
+
lazily as you expand, so it stays fast on large IPAMs.
|
|
17
|
+
- **Expand all / Collapse all** for the whole tree or any subtree (Alt+click a caret, or `*` on a focused row),
|
|
18
|
+
capped by `expand_all_limit` so a click can never render an unbounded page.
|
|
19
|
+
- **Free space** between children, shown as greyed rows with a one-click *Create* that pre-fills the prefix and VRF.
|
|
20
|
+
- **Utilization bars** with the same numbers as NetBox's own prefix views, computed in bulk.
|
|
21
|
+
- **Row actions** (add child, edit, delete), shown only when you have the permission.
|
|
22
|
+
- **NetBox filters**: the native prefix filter form; matches are shown with their ancestors as greyed context.
|
|
23
|
+
- **Column picker**, saved per user.
|
|
24
|
+
- **Remembers state**: expanded nodes are restored when you come back.
|
|
25
|
+
- **Keyboard navigation** (treegrid pattern): ↑ ↓ move, → expand / first child, ← collapse / parent, `*` expand
|
|
26
|
+
subtree, Enter opens the prefix.
|
|
27
|
+
- **Everywhere it is useful**: a *Prefix Tree* page, a *Tree view* button on the native prefix list (carrying
|
|
28
|
+
your filters), and *Tree* tabs on Prefix, Aggregate and VRF pages. Each can be switched off.
|
|
29
|
+
- Light and dark themes.
|
|
30
|
+
|
|
31
|
+
## Compatibility
|
|
32
|
+
|
|
33
|
+
| Plugin | NetBox | Python |
|
|
34
|
+
|--------|-------------|-------------|
|
|
35
|
+
| 0.1.x | 4.7 | 3.12 – 3.14 |
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
```shell
|
|
40
|
+
source /opt/netbox/venv/bin/activate
|
|
41
|
+
pip install netbox-ipam-treeview-plugin
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Add it to `configuration.py` (or `local_requirements.txt` + `plugins.py` with netbox-docker):
|
|
45
|
+
|
|
46
|
+
```python
|
|
47
|
+
PLUGINS = ["netbox_ipam_treeview"]
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Then collect the static files and restart NetBox:
|
|
51
|
+
|
|
52
|
+
```shell
|
|
53
|
+
python /opt/netbox/netbox/manage.py collectstatic --no-input
|
|
54
|
+
sudo systemctl restart netbox
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The tree lives at `/plugins/ipam-tree/` (menu: *IPAM → Prefixes → Prefix Tree*, right below *Prefixes*).
|
|
58
|
+
|
|
59
|
+
## Configuration
|
|
60
|
+
|
|
61
|
+
All settings are optional:
|
|
62
|
+
|
|
63
|
+
```python
|
|
64
|
+
PLUGINS_CONFIG = {
|
|
65
|
+
"netbox_ipam_treeview": {
|
|
66
|
+
"expand_all_limit": 5000,
|
|
67
|
+
},
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
| Setting | Default | Meaning |
|
|
72
|
+
|---|---|---|
|
|
73
|
+
| `show_menu_item` | `True` | Show the *Prefix Tree* menu entry |
|
|
74
|
+
| `menu_location` | `"ipam"` | `"ipam"`: IPAM menu, right below *Prefixes*; `"plugins"`: the Plugins menu |
|
|
75
|
+
| `show_list_toggle` | `True` | *Tree view* button on the native prefix list |
|
|
76
|
+
| `show_prefix_tab` | `True` | *Tree* tab on prefix pages |
|
|
77
|
+
| `show_aggregate_tab` | `True` | *Tree* tab on aggregate pages |
|
|
78
|
+
| `show_vrf_tab` | `True` | *Tree* tab on VRF pages |
|
|
79
|
+
| `group_by_vrf` | `True` | Top level is one node per VRF; `False` mixes all VRFs under the aggregates (add the VRF column) |
|
|
80
|
+
| `show_aggregates` | `True` | Aggregates as a tree level |
|
|
81
|
+
| `show_free_space` | `True` | Default for free-space rows (each user can toggle it) |
|
|
82
|
+
| `gaps_respect_mark_utilized` | `True` | No free-space rows under pools and *mark utilized* prefixes |
|
|
83
|
+
| `max_gap_rows` | `64` | Free-space rows per node; the rest are summarised in one row |
|
|
84
|
+
| `expand_all_limit` | `5000` | Row cap for *Expand all* and filtered trees |
|
|
85
|
+
| `default_columns` | status, utilization, scope, VLAN, tenant, role, description, actions | Columns before a user picks their own |
|
|
86
|
+
|
|
87
|
+
## Permissions
|
|
88
|
+
|
|
89
|
+
- The page requires `ipam.view_prefix`; every row is restricted to what the user may view.
|
|
90
|
+
- Aggregates appear only for users with `ipam.view_aggregate`; VRF groups only for VRFs the user may view.
|
|
91
|
+
- With constrained (object-level) permissions, prefixes hang under their **nearest visible ancestor**, and free-space
|
|
92
|
+
rows are not shown, because space taken by prefixes the user cannot see would look free.
|
|
93
|
+
- *Delete* links go to NetBox's own confirmation page.
|
|
94
|
+
|
|
95
|
+
## Development
|
|
96
|
+
|
|
97
|
+
The dev stack is netbox-docker with the plugin mounted live, seeded with ~8,000 RFC 1918 / ULA prefixes across
|
|
98
|
+
VRFs, aggregates, sites and VLANs.
|
|
99
|
+
|
|
100
|
+
```shell
|
|
101
|
+
make dev # build and start NetBox on http://localhost:8000 (admin / admin)
|
|
102
|
+
make seed # load the demo dataset (make reseed to wipe and reload, make seed-big for ~5x)
|
|
103
|
+
make test # pure unit tests (no NetBox needed)
|
|
104
|
+
make test-netbox # integration tests inside the NetBox container
|
|
105
|
+
make lint # ruff
|
|
106
|
+
make dist # build and check the wheel and sdist
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
## License
|
|
110
|
+
|
|
111
|
+
Apache-2.0
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
from .conf import DEFAULTS
|
|
2
|
+
from .version import __version__
|
|
3
|
+
|
|
4
|
+
try:
|
|
5
|
+
from netbox.plugins import PluginConfig
|
|
6
|
+
except ImportError: # imported outside NetBox (pure unit tests, build tools)
|
|
7
|
+
PluginConfig = None
|
|
8
|
+
|
|
9
|
+
if PluginConfig is not None:
|
|
10
|
+
|
|
11
|
+
class IPAMAltViewConfig(PluginConfig):
|
|
12
|
+
name = "netbox_ipam_treeview"
|
|
13
|
+
verbose_name = "IPAM Tree"
|
|
14
|
+
description = "DDI-style collapsible tree view for NetBox IPAM prefixes"
|
|
15
|
+
version = __version__
|
|
16
|
+
author = "Thomas Christory"
|
|
17
|
+
author_email = "9317624+thomaschristory@users.noreply.github.com"
|
|
18
|
+
base_url = "ipam-tree"
|
|
19
|
+
min_version = "4.7.0"
|
|
20
|
+
max_version = "4.7.99"
|
|
21
|
+
default_settings = DEFAULTS
|
|
22
|
+
|
|
23
|
+
config = IPAMAltViewConfig
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
from django.utils.translation import gettext_lazy as _
|
|
2
|
+
|
|
3
|
+
from .conf import get_setting
|
|
4
|
+
|
|
5
|
+
USER_CONFIG_PATH = "plugins.netbox_ipam_treeview.columns"
|
|
6
|
+
|
|
7
|
+
COLUMNS = {
|
|
8
|
+
"status": _("Status"),
|
|
9
|
+
"utilization": _("Utilization"),
|
|
10
|
+
"vrf": _("VRF"),
|
|
11
|
+
"scope": _("Scope"),
|
|
12
|
+
"vlan": _("VLAN"),
|
|
13
|
+
"tenant": _("Tenant"),
|
|
14
|
+
"role": _("Role"),
|
|
15
|
+
"children": _("Children"),
|
|
16
|
+
"is_pool": _("Pool"),
|
|
17
|
+
"mark_utilized": _("Marked utilized"),
|
|
18
|
+
"tags": _("Tags"),
|
|
19
|
+
"description": _("Description"),
|
|
20
|
+
"created": _("Created"),
|
|
21
|
+
"last_updated": _("Last updated"),
|
|
22
|
+
"actions": "",
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
def resolve_columns(user):
|
|
27
|
+
"""The user's saved column choice, else the configured default, limited to known columns."""
|
|
28
|
+
chosen = None
|
|
29
|
+
if getattr(user, "is_authenticated", False) and hasattr(user, "config"):
|
|
30
|
+
chosen = user.config.get(USER_CONFIG_PATH)
|
|
31
|
+
chosen = chosen or get_setting("default_columns")
|
|
32
|
+
return [c for c in chosen if c in COLUMNS]
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
PLUGIN_NAME = "netbox_ipam_treeview"
|
|
2
|
+
|
|
3
|
+
DEFAULTS = {
|
|
4
|
+
"show_menu_item": True,
|
|
5
|
+
"menu_location": "ipam", # "ipam": IPAM menu, below "Prefixes"; "plugins": the Plugins menu
|
|
6
|
+
"show_list_toggle": True,
|
|
7
|
+
"show_prefix_tab": True,
|
|
8
|
+
"show_aggregate_tab": True,
|
|
9
|
+
"show_vrf_tab": True,
|
|
10
|
+
"group_by_vrf": True,
|
|
11
|
+
"show_aggregates": True,
|
|
12
|
+
"show_free_space": True,
|
|
13
|
+
"gaps_respect_mark_utilized": True,
|
|
14
|
+
"max_gap_rows": 64,
|
|
15
|
+
"expand_all_limit": 5000,
|
|
16
|
+
"default_columns": ["status", "utilization", "scope", "vlan", "tenant", "role", "description", "actions"],
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
def get_setting(key):
|
|
21
|
+
from netbox.plugins.utils import get_plugin_config
|
|
22
|
+
|
|
23
|
+
return get_plugin_config(PLUGIN_NAME, key, DEFAULTS[key])
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
from netbox.plugins import PluginMenuItem
|
|
2
|
+
|
|
3
|
+
from .conf import get_setting
|
|
4
|
+
|
|
5
|
+
LINK = "plugins:netbox_ipam_treeview:tree"
|
|
6
|
+
LABEL = "Prefix Tree"
|
|
7
|
+
PERMISSIONS = ["ipam.view_prefix"]
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def _add_to_ipam_menu():
|
|
11
|
+
"""Insert the tree right after "Prefixes" in NetBox's IPAM menu.
|
|
12
|
+
|
|
13
|
+
Plugins have no API for core menus, so this edits IPAM_MENU (plain dataclasses in NetBox 4.7).
|
|
14
|
+
Returns False when the menu looks different, and the caller falls back to the Plugins menu.
|
|
15
|
+
"""
|
|
16
|
+
try:
|
|
17
|
+
from netbox.navigation import MenuItem
|
|
18
|
+
from netbox.navigation.menu import IPAM_MENU
|
|
19
|
+
except ImportError:
|
|
20
|
+
return False
|
|
21
|
+
groups = getattr(IPAM_MENU, "groups", ())
|
|
22
|
+
if any(item.link == LINK for group in groups for item in group.items):
|
|
23
|
+
return True
|
|
24
|
+
for group in groups:
|
|
25
|
+
links = [item.link for item in group.items]
|
|
26
|
+
if "ipam:prefix_list" in links:
|
|
27
|
+
at = links.index("ipam:prefix_list") + 1
|
|
28
|
+
entry = MenuItem(link=LINK, link_text=LABEL, permissions=PERMISSIONS)
|
|
29
|
+
group.items = (*group.items[:at], entry, *group.items[at:])
|
|
30
|
+
return True
|
|
31
|
+
return False
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
_show = get_setting("show_menu_item")
|
|
35
|
+
_in_ipam = _show and get_setting("menu_location") == "ipam" and _add_to_ipam_menu()
|
|
36
|
+
|
|
37
|
+
menu_items = (PluginMenuItem(link=LINK, link_text=LABEL, permissions=PERMISSIONS),) if _show and not _in_ipam else ()
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
.ipt-tree td.ipt-name { padding-left: calc(0.5rem + var(--ipt-level, 0) * 1.4rem); white-space: nowrap; }
|
|
2
|
+
.ipt-tree .ipt-toggle, .ipt-tree .ipt-spacer { display: inline-block; width: 1.4rem; text-align: center; line-height: 1; }
|
|
3
|
+
.ipt-tree .ipt-toggle { color: inherit; text-decoration: none; }
|
|
4
|
+
.ipt-tree .ipt-toggle i { display: inline-block; transition: transform 0.12s ease; }
|
|
5
|
+
.ipt-tree tr[aria-expanded="true"] > td .ipt-toggle i { transform: rotate(90deg); }
|
|
6
|
+
.ipt-tree tr.ipt-hidden { display: none; }
|
|
7
|
+
.ipt-tree tr.ipt-vrf > td { background: var(--tblr-bg-surface-secondary); font-weight: 600; }
|
|
8
|
+
.ipt-tree tr.ipt-aggregate > td.ipt-name { font-weight: 600; }
|
|
9
|
+
.ipt-tree tr.ipt-gap > td, .ipt-tree tr.ipt-more > td { color: var(--tblr-secondary); font-style: italic; }
|
|
10
|
+
.ipt-tree tr.ipt-gap > td.ipt-name { box-shadow: inset 3px 0 0 var(--tblr-success); }
|
|
11
|
+
.ipt-tree tr.ipt-context > td { opacity: 0.55; }
|
|
12
|
+
.ipt-tree tr.ipt-loading .ipt-toggle i { animation: ipt-spin 0.8s linear infinite; }
|
|
13
|
+
.ipt-tree tr.ipt-failed .ipt-toggle { color: var(--tblr-danger); }
|
|
14
|
+
.ipt-tree tr:focus-visible { outline: 2px solid var(--tblr-primary); outline-offset: -2px; }
|
|
15
|
+
.ipt-tree.ipt-busy { opacity: 0.6; pointer-events: none; }
|
|
16
|
+
.ipt-columns { min-width: 14rem; }
|
|
17
|
+
@keyframes ipt-spin { to { transform: rotate(360deg); } }
|
|
18
|
+
.ipt-tree td { vertical-align: middle; }
|
|
19
|
+
.ipt-tree td.ipt-col-scope, .ipt-tree td.ipt-col-vlan, .ipt-tree td.ipt-col-tenant, .ipt-tree td.ipt-col-role,
|
|
20
|
+
.ipt-tree td.ipt-col-status, .ipt-tree td.ipt-col-vrf { white-space: nowrap; }
|
|
21
|
+
.ipt-tree td.ipt-col-utilization { min-width: 7rem; }
|