Port details on branch 2022Q4 |
- netbox IP address management tool
- 3.3.10 net-mgmt
=1 4.2.8Version of this port present on the latest quarterly branch. - Maintainer: kai@FreeBSD.org
 - Port Added: 2022-10-09 11:51:20
- Last Update: 2022-12-18 16:26:00
- Commit Hash: f2fbeea
- People watching this port, also watch:: gitlab-ce, netbox
- Also Listed In: python
- License: APACHE20
- WWW:
- https://github.com/netbox-community/netbox
- Description:
- NetBox is an open source web application designed to help manage and document
computer networks. Initially conceived by the network engineering team at
DigitalOcean, NetBox was developed specifically to address the needs of network
and infrastructure engineers. It encompasses the following aspects of network
management:
- IP address management (IPAM) - IP networks and addresses, VRFs, and VLANs
- Equipment racks - Organized by group and site
- Devices - Types of devices and where they are installed
- Connections - Network, console, and power connections among devices
- Virtualization - Virtual machines and clusters
- Data circuits - Long-haul communications circuits and providers
¦ ¦ ¦ ¦ 
- Manual pages:
- FreshPorts has no man page information for this port.
- pkg-plist: as obtained via:
make generate-plist - Dependency lines:
-
- To install the port:
- cd /usr/ports/net-mgmt/netbox/ && make install clean
- To add the package, run one of these commands:
- pkg install net-mgmt/netbox
- pkg install netbox
NOTE: If this package has multiple flavors (see below), then use one of them instead of the name specified above.- PKGNAME: netbox
- Flavors: there is no flavor information for this port.
- distinfo:
- TIMESTAMP = 1670965894
SHA256 (netbox-community-netbox-v3.3.10_GH0.tar.gz) = 18d59234db6ffbe08dc9b8eaea8cc8e022fc08f92e0714a01223ae8d7333b62b
SIZE (netbox-community-netbox-v3.3.10_GH0.tar.gz) = 7316933
No package information for this port in our database- Sometimes this happens. Not all ports have packages. Perhaps there is a build error. Check the fallout link:

- Dependencies
- NOTE: FreshPorts displays only information on required and default dependencies. Optional dependencies are not covered.
- Build dependencies:
-
- python3.9 : lang/python39
- Runtime dependencies:
-
- py39-django40>=4.0.8<4.1 : www/py-django40@py39
- py39-dj40-django-cors-headers>=3.13.0<4 : www/py-dj40-django-cors-headers@py39
- py39-dj40-django-debug-toolbar>=3.6.0<4 : www/py-dj40-django-debug-toolbar@py39
- py39-dj40-django-filter>=22.1<23 : www/py-dj40-django-filter@py39
- py39-dj40-django-graphiql-debug-toolbar>=0.2.0<1 : www/py-dj40-django-graphiql-debug-toolbar@py39
- py39-dj40-django-mptt>=0.14.0<0.15 : www/py-dj40-django-mptt@py39
- py39-dj40-django-prometheus>=2.2.0<2.3 : www/py-dj40-django-prometheus@py39
- py39-dj40-django-redis>=5.2.0<6 : www/py-dj40-django-redis@py39
- py39-dj40-django-rich>=1.4.0<2 : www/py-dj40-django-rich@py39
- py39-dj40-django-rq>=2.5.1<2.7 : devel/py-dj40-django-rq@py39
- py39-dj40-django-tables2>=2.4.1<2.5 : www/py-dj40-django-tables2@py39
- py39-dj40-django-taggit>=3.1.0<4 : www/py-dj40-django-taggit@py39
- py39-dj40-django-timezone-field>=5.0<6 : www/py-dj40-django-timezone-field@py39
- py39-dj40-djangorestframework>=3.14.0<3.15.0 : www/py-dj40-djangorestframework@py39
- py39-dj40-drf-yasg>=1.21.4<1.22 : www/py-dj40-drf-yasg@py39
- py39-dj40-graphene-django>=2.15.0<3 : devel/py-dj40-graphene-django@py39
- py39-django-pglocks>=1.0.4<1.1 : www/py-django-pglocks@py39
- py39-bleach>=5.0.1<6 : www/py-bleach@py39
- py39-Jinja2>=3.0.1<4 : devel/py-Jinja2@py39
- py39-markdown>=3.3.7<3.4 : textproc/py-markdown@py39
- py39-markdown-include>=0.7.0<1 : textproc/py-markdown-include@py39
- py39-mkdocs-material>=8.2.11<9 : textproc/py-mkdocs-material@py39
- py39-mkdocstrings>=0.17.0<1 : textproc/py-mkdocstrings@py39
- py39-netaddr>=0.8.0<1 : net/py-netaddr@py39
- py39-pillow>=9.2.0 : graphics/py-pillow@py39
- py39-psycopg2>=2.9.3<3 : databases/py-psycopg2@py39
- py39-sentry-sdk>=1.5.12<2 : devel/py-sentry-sdk@py39
- py39-social-auth-app-django>=5.0.0<6 : www/py-social-auth-app-django@py39
- py39-social-auth-core>=4.3.0<5 : security/py-social-auth-core@py39
- py39-svgwrite>=1.4.3<2 : graphics/py-svgwrite@py39
- py39-tablib>=3.2.1<4 : textproc/py-tablib@py39
- py39-tzdata>=2022.7 : devel/py-tzdata@py39
- py39-yaml>=5.4.1<7 : devel/py-yaml@py39
- py39-gunicorn>=20.1.0<21 : www/py-gunicorn@py39
- python3.9 : lang/python39
- Library dependencies:
-
- libpq.so.5 : databases/postgresql13-client
- There are no ports dependent upon this port
Configuration Options:
- ===> The following configuration options are available for netbox-3.3.10:
EXAMPLES=on: Build and/or install examples
===> Use 'make config' to modify these settings
- Options name:
- net-mgmt_netbox
- USES:
- cpe pgsql:10+ python:3.8+
- pkg-message:
- For install:
- Please note that NetBox requires a PostgreSQL database server, which uses its
built-in network address datatypes. Thus NetBox won't work with other RDBMS's,
e.g. MySQL, MariaDB, etc.
For installation instructions please refer to the related wiki page:
- https://wiki.freebsd.org/Ports/net-mgmt/netbox
- If upgrading
- As always it is strongly encouraged to make a backup of the database before the
database migrations will be executed.
The following steps are required to finish the upgrade:
1. Run database migrations, trace any missing cable paths, build the embedded
documentation, collect static files, remove stale content files, delete any
expired user sessions and clear the cache.
# cd /usr/local/share/netbox
# python3.9 manage.py migrate
# python3.9 manage.py trace_paths --no-input
# mkdocs build
# python3.9 manage.py collectstatic --no-input
# python3.9 manage.py remove_stale_contenttypes --no-input
# python3.9 manage.py clearsessions
# python3.9 manage.py clearcache
2. Restart WSGI/httpd environment (supervisord/apache/nginx/etc.)
- If upgrading from < 3.0.4:
- /!\ WARNING /!\
The NetBox 3.0 release contains major changes, so at least items 1.), 2.) and
3.) must be checked before proceeding with the upgrade!
/!\ WARNING /!\
1. Please ensure that your local installation of net-mgmt/netbox is at
the 2.11 release before attemping to upgrade to NetBox 3.0 or later.
2. Please also note that the previously deprecated secrets functionality has
been removed with NetBox 3.0. This means, all of the secrets still remain
in the database once upgraded, only the secrets functionality on the part of
NetBox is no longer given.
In order to continue to be able to access the stored secrets as usual (and
then possibly migrate them to another solution, e.g. security/vault), please
install the security/py-netbox-secretstore port once NetBox has been
upgraded to 3.x and follow its installation instructions how to enable the
plugin.
3. If plugins are used, they should be temporarily deactivated to avoid
disruptions during the upgrade process.
4. Following items should be checked as well:
* The default CSV export format for all objects now includes all available
data from the object list. Additionally, the CSV headers now use human-
friendly titles rather than raw field names. If backward compatibility
with the old format is desired, export templates can be written to
reproduce it.
* The "invalidate" management command (which clears cached database queries)
is no longer needed and has been removed.
* Support for queryset caching configuration (caching_config) has been
removed from the plugins API.
* The cacheops_* metrics have been removed from the Prometheus exporter.
* The "display_field" keyword argument has been removed from custom script
"ObjectVar" and "MultiObjectVar" fields. These widgets will use the
display value provided by the REST API.
* The deprecated "display_name" field has been removed from all REST API
serializers. (API clients should reference the display field instead.)
* The redundant REST API endpoints for console, power, and interface
connections have been removed. The same data can be retrieved by querying
the respective model endpoints with the ?connected=True filter applied.
* Several changes to the REST API were made as well. Please check the
changelogs for further details.
5. There's a new sample script for NetBox housekeeping tasks, which should run
once a day. If the EXAMPLES option is enabled (which is the default) it can
be found in the following directory:
/usr/local/share/examples/netbox/850.netbox-housekeeping.sample
Please run following commands to enable the new script:
# cp /usr/local/share/examples/netbox/850.netbox-housekeeping.sample /usr/local/etc/periodic/daily/850.netbox-housekeeping
# chmod 555 /usr/local/etc/periodic/daily/850.netbox-housekeeping
# sysrc -f /etc/periodic.conf daily_netbox_housekeeping_enable="YES"
- If upgrading from < 3.0.12_1:
- Please run the following command to make the online help available that was
previously missing:
# cd /usr/local/share/netbox
# python3.9 manage.py collectstatic --no-input
- If upgrading from < 3.1.6:
-
1. Please make sure that the PostgreSQL server for the NetBox instance is
running version 10 or higher. This is because PostgreSQL 9.6 is End-of-Life
since November 2021 and NetBox 3.1 makes use of the "macaddr8" field which
was introduced with PostgreSQL 10.
2. Following items should be checked as well:
* The tenant and tenant_id filters for the Cable model now filter on the
tenant assigned directly to each cable, rather than on the parent object
of either termination.
* The cable_peer and cable_peer_type attributes of cable termination models
have been renamed to link_peer and link_peer_type, respectively, to
accommodate wireless links between interfaces.
* Exported webhooks and custom fields now reference associated content
types by raw string value (e.g. "dcim.site") rather than by
human-friendly name.
* The 128GFC interface type has been corrected from 128gfc-sfp28 to
128gfc-qsfp28.
* Several changes to the REST API were made as well. Please check the
changelogs for further details.
- If upgrading from < 3.2.4:
- /!\ WARNING /!\
The NetBox 3.2 release contains major changes, so at least items 1.), 2.) and
3.) must be checked before proceeding with the upgrade!
/!\ WARNING /!\
1. This release includes a database migration that will remove the "asn",
"contact_name", "contact_phone", and "contact_email" fields from the site
model. (These fields have been superseded by the ASN and contact models
introduced in NetBox v3.1.)
To protect against the accidental destruction of data, the upgrade process
will fail if any sites still have data in any of these fields. To bypass
this safeguard, set the NETBOX_DELETE_LEGACY_DATA environment variable when
running the upgrade script, which will permit the destruction of legacy
data.
A set of migration scripts is available to assist with the migration of
legacy site data:
https://github.com/netbox-community/migration-scripts
2. NetBox v3.2 requires Python 3.8 or later.
3. If the NetBox Plugin "net-mgmt/py-netbox-plugin-extension" is used, please
disable it before the migrations are applied. This can be done by removing
the entry "netbox_plugin_extensions" from the "PLUGINS" section in the
NetBox configuration.
Once the upgrade is done, this port/package can be safely removed as it's no
longer required.
4. Following items should be checked as well:
* The embedded documentation now needs to be built locally as the procedure
requires a running instance of NetBox:
# cd /usr/local/share/netbox
# mkdocs build
Please also refer to the general updating instructions as this needs to
be done with every future update of NetBox.
* Automatic redirection of legacy slug-based URL paths has been removed.
URL-based slugs were changed to use numeric IDs in v2.11.0.
* The "asn" query filter for sites now matches against the AS number of
assigned ASN objects.
* The "created" field of all change-logged models now conveys a full
datetime object, rather than only a date. (Previous date-only values
will receive a timestamp of 00:00.) While this change is largely
unconcerning, strictly-typed API consumers may need to be updated.
* A "pre_run()" method has been added to the base Report class. Although
unlikely to affect most installations, you may need to alter any reports
which already use this name for a method.
* Webhook URLs now support Jinja2 templating. Although this is unlikely to
introduce any issues, it's possible that an unusual URL might trigger a
Jinja2 rendering error, in which case the URL would need to be properly
escaped.
* Several changes to the REST API were made as well. Please check the
changelogs for further details.
- If upgrading from < 3.2.5:
- Please note that the general update instructions got another command that needs
to be issued after each update:
# python3.9 manage.py clearcache
- If upgrading from < 3.3.4:
- The NetBox 3.3 release contains some breaking API changes, so please check the
following items before running the database migrations:
* Device position, device type height, and rack unit values are now reported
as decimals (e.g. 1.0 or 1.5) to support modeling half-height rack units.
* The "nat_outside" relation on the IP address model now returns a list of zero
or more related IP addresses, rather than a single instance (or None).
* Several fields on the cable API serializers have been altered or removed to
support multiple-object cable terminations:
+------------------------------+------+-------------------------------+------+
| Old Name | Type | New Name | Type |
+------------------------------+------+-------------------------------+------+
| termination_a_type | str | Removed | - |
| termination_b_type | str | Removed | - |
| termination_a_id | int | Removed | - |
| termination_b_id | int | Removed | - |
| termination_a | obj | a_terminations | list |
| termination_b | obj | b_terminations | list |
+------------------------------+------+-------------------------------+------+
* As with the cable model, several API fields on all objects to which cables
can be connected (interfaces, circuit terminations, etc.) have been changed:
+------------------------------+------+-------------------------------+------+
| Old Name | Type | New Name | Type |
+------------------------------+------+-------------------------------+------+
| link_peer | obj | link_peers | list |
| link_peer_type | str | link_peers_type | str |
| connected_endpoint | obj | connected_endpoints | list |
| connected_endpoint_type | str | connected_endpoints_type | str |
| connected_endpoint_reachable | bool | connected_endpoints_reachable | bool |
+------------------------------+------+-------------------------------+------+
* The cable path serialization returned by the "/paths/" endpoint for
pass-through ports has been simplified, and the following fields removed:
"origin_type", "origin", "destination_type", "destination". (Additionally,
"is_complete" has been added.)
* Several changes to the REST API were made as well. Please check the
changelogs for further details.
* The netbox sample rc script got a new "upgrade" directive that also
simplifies the upgrade process (database migrations, building the embedded
documentation, etc.).
- Master Sites:
|
Number of commits found: 6
Commit History - (may be incomplete: for full details, see links to repositories near top of page) |
Commit | Credits | Log message |
3.3.10 18 Dec 2022 16:26:00
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.10
Changelog:
Enhancements:
* Add replication controls for module bulk import
* Introduce LOGOUT_REDIRECT_URL config parameter to control
redirection of user after logout
* Enable reassigning an inventory item from one device to another
* Add vertical frame & cabinet rack types
* Add provider selection field for provider networks to circuit
termination edit view
* Permit whitespace in MAC addresses
* Enable filtering L2VPNs by slug
(Only the first 15 lines of the commit message are shown above ) |
3.3.9 01 Dec 2022 16:37:13
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.9
Changelog:
Enhancements:
* Ensure logging of failed login attempts
Bug Fixes:
* Call snapshot() on object when processing deletions
* Fix serialization of array field values in change log
* Fix spurious error message when rendering REST API docs
* Fix TypeError exception when viewing PDU configured for
three-phase power
* Support referencing custom field related objects by attribute in
addition to PK (Only the first 15 lines of the commit message are shown above ) |
3.3.8 18 Nov 2022 06:47:56
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.8
Changelog:
Enhancements:
* Add backplane Ethernet interface types
* Add location selector to power feed form
* Use front/rear port colors in cable trace SVG
* Include "add module type" button on manufacturer view
* Add count of L2VPNs to tenant view
* Include device location under cable view
* Include request cookies when queuing a custom script
Bug Fixes:
* Ensure thread safety of change logging functions (Only the first 15 lines of the commit message are shown above ) |
3.3.7 05 Nov 2022 22:25:46
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.7
Changelog:
Bug Fixes:
* Enforce advisory locks when allocating available IP addresses to
prevent race conditions
* Fix social authentication for new users
* Permit nullifying VLAN group scope_type via REST API
* Fix exception when ordering contacts by number of assignments
* Permit nullifying site time_zone via REST API
https://github.com/netbox-community/netbox/releases/tag/v3.3.7
MFH: 2022Q4
(cherry picked from commit 89d241404cc1fe0d2d28700ae5f090c8d783782e) |
3.3.6 27 Oct 2022 15:31:26
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.6
Changelog:
Enhancements:
* Enable filtering devices by device type slug
* Add LDAP configuration parameters to specify certificates
* Link "assigned" checkbox in IP address table to assigned interface
* Set cookie paths according to configured BASE_PATH
* Position A/Z termination cards above the fold under circuit view
Bug Fixes:
* Strip colons from usernames when using remote authentication
* Include OIDC dependencies for python-social-auth
* Fix service clone link (Only the first 15 lines of the commit message are shown above ) |
3.3.5 09 Oct 2022 11:48:24
    |
Kai Knoblich (kai)  |
net-mgmt/netbox: Update to 3.3.5
Changelog:
Enhancements:
* Include rack elevation under device view
* Omit extraneous URL query attributes during search
* Improve formatting of device heights and rack positions
Bug Fixes:
* Adjust non-racked device filter on site and location detailed view
* Fix validation when attempting to add redundant contact assignments
* Enforce object type validation when creating journal entries
* Fix exception when filtering VLANs by virtual machine
with no cluster assigned (Only the first 15 lines of the commit message are shown above ) |
Number of commits found: 6
|