Installation v2.7-beta1 Release Notes
Release Date: 2019-12-12 // over 4 years ago-
WARNING: This is a beta release of NetBox intended for development use only. Do not rely on it for production use. A migration path forward to a stable release will not be provided. Expect to ultimately lose any data input into this instance.
Note: NetBox v2.7 is the last major release that will support Python 3.5. Beginning with NetBox v2.8, Python 3.6 or
higher will be required.๐ New Features
โจ Enhanced Device Type Import (#451)
๐ NetBox now supports the import of device types and related component templates using a definition written in YAML or
JSON. For example, the following will create a new device type with four network interfaces, two power ports, and a
console port:manufacturer: Acmemodel: Packet Shooter 9000slug: packet-shooter-9000u\_height: 1interfaces: - name: ge-0/0/0type: 1000base-t - name: ge-0/0/1type: 1000base-t - name: ge-0/0/2type: 1000base-t - name: ge-0/0/3type: 1000base-tpower-ports: - name: PSU0 - name: PSU1console-ports: - name: Console
This new functionality replaces the existing CSV-based import form, which did not allow for component template import.
Bulk Import of Device Components (#822)
๐ NetBox now supports the bulk import of device components such as console ports, power ports, and interfaces across
multiple devices. Device components can be imported in CSV-format.Here's an example bulk import of interfaces to several devices:
device,name,type Switch1,Vlan100,Virtual Switch1,Vlan200,Virtual Switch2,Vlan100,Virtual Switch2,Vlan200,Virtual
External File Storage (#1814)
๐ In prior releases, the only option for storing uploaded files (e.g. image attachments) was to save them to the local
๐ filesystem on the NetBox server. This release introduces support for several remote storage backends provided by the
django-storages
library. These include:- Amazon S3
- ApacheLibcloud
- Azure Storage
- DigitalOcean Spaces
- โฌ๏ธ Dropbox
- FTP
- Google Cloud Storage
- SFTP
To enable remote file storage, first install
django-storages
:pip install django-storages
๐ง Then, set the appropriate storage backend and its configuration in
configuration.py
. Here's an example using Amazon
S3:STORAGE\_BACKEND = 'storages.backends.s3boto3.S3Boto3Storage'STORAGE\_CONFIG = { 'AWS\_ACCESS\_KEY\_ID': '\<Key\>', 'AWS\_SECRET\_ACCESS\_KEY': '\<Secret\>', 'AWS\_STORAGE\_BUCKET\_NAME': 'netbox', 'AWS\_S3\_REGION\_NAME': 'eu-west-1', }
Thanks to @steffann for contributing this work!
๐ Changes
Rack Elevations Rendered via SVG (#2248)
NetBox v2.7 introduces a new method of rendering rack elevations as an
SVG via a REST API endpoint. This replaces the prior method of
rendering elevations using pure HTML which was cumbersome and had several shortcomings. Allowing elevations to be
rendered as an SVG image in the API allows users to retrieve and make use of the drawings in their own tooling. This
also opens the door to other feature requests related to rack elevations in the NetBox backlog.This feature implements a new REST API endpoint:
/api/dcim/racks/<id>/elevation/
0๏ธโฃ By default, this endpoint returns a paginated JSON response representing each rack unit in the given elevation. This is
the same response returned by the rack units detail endpoint and for this reason the rack units endpoint has been
๐ deprecated and will be removed in v2.8 (see #3753):/api/dcim/racks/<id>/units/
In order to render the elevation as an SVG, include the
render=svg
query parameter in the request. You may also
control the width of the elevation drawing in pixels withunit_width=<width in pixels>
and the height of each rack
unit withunit_height=<height in pixels>
. Theunit_width
defaults to230
and theunit_height
default to20
๐ป which produces elevations the same size as those that appear in the NetBox Web UI. The query parameterface
is used to
0๏ธโฃ request either thefront
orrear
of the elevation and defaults tofront
.0๏ธโฃ Here is an example of the request url for an SVG rendering using the default parameters to render the front of the
elevation:/api/dcim/racks/<id>/elevation/?render=svg
Here is an example of the request url for an SVG rendering of the rear of the elevation having a width of 300 pixels and
per unit height of 35 pixels:/api/dcim/racks/<id>/elevation/?render=svg&face=rear&unit_width=300&unit_height=35
Thanks to @hellerve for doing the heavy lifting on this!
๐ Topology Maps Removed (#2745)
๐ The topology maps feature has been removed to help focus NetBox development efforts.
๐ง Redis Configuration (#3282)
๐ง v2.6.0 introduced caching and added the
CACHE_DATABASE
option to the existingREDIS
database configuration section.
This did not however, allow for using two different Redis connections for the seperate caching and webhooks features.
๐ง This change separates the Redis connection configurations in theREDIS
section into distinctwebhooks
andcaching
๐ง subsections. This requires modification of theREDIS
section of theconfiguration.py
file as follows:๐ง Old Redis configuration:
REDIS = { 'HOST': 'localhost', 'PORT': 6379, 'PASSWORD': '', 'DATABASE': 0, 'CACHE\_DATABASE': 1, 'DEFAULT\_TIMEOUT': 300, 'SSL': False, }
๐ New Redis configuration:
REDIS = { 'webhooks': { 'HOST': 'redis.example.com', 'PORT': 1234, 'PASSWORD': 'foobar', 'DATABASE': 0, 'DEFAULT\_TIMEOUT': 300, 'SSL': False, }, 'caching': { 'HOST': 'localhost', 'PORT': 6379, 'PASSWORD': '', 'DATABASE': 1, 'DEFAULT\_TIMEOUT': 300, 'SSL': False, } }
๐ Note that
CACHE_DATABASE
has been removed and the connection settings have been duplicated for bothwebhooks
and
caching
. This allows the user to make use of separate Redis instances and/or databases if desired. Full connection
details are required in both sections, even if they are the same.๐ง WEBHOOKS_ENABLED Configuration Setting Removed (#3408)
๐ท As
django-rq
is now a required library, NetBox assumes that the RQ worker process is running. The installation and
๐ upgrade documentation has been updated to reflect this, and theWEBHOOKS_ENABLED
configuration parameter is no longer
๐ท used. Please ensure that both the NetBox WSGI service and the RQ worker process are running on all production
installations.API Choice Fields Now Use String Values (#3569)
NetBox's REST API presents fields which reference a particular choice as a dictionary with two keys:
value
and
label
. In previous versions,value
was an integer which represented the particular choice in the database. This has
๐โโ been changed to a more human-friendly "slug" string, which is essentially a simplified version of the choice'slabel
.For example, The site status field was previously represented as:
"status": { "value": 1, "label": "Active"},
Beginning with v2.7.0, it now looks like this:
"status": { "value": "active", "label": "Active"},
This change allows for much more intuitive representation of values, and obviates the need for API consumers to maintain
a mapping of static integer values.๐ Note that that all v2.7 releases will continue to accept the legacy integer values in write requests (POST, PUT, and
PATCH) to maintain backward compatibility. This behavior will be discontinued beginning in v2.8.0.โจ Enhancements
- ๐ฏ #33 - Add ability to clone objects (pre-populate form fields)
- #648 - Pre-populate forms when selecting "create and add another"
- #792 - Add power port and power outlet types
- #1865 - Add console port and console server port types
- #2669 - Relax uniqueness constraint on device and VM names
- #2902 - Replace
supervisord
withsystemd
- #3455 - Add tenant assignment to cluster
- #3564 - Add list views for device components
- #3538 - Introduce a REST API endpoint for executing custom
scripts - #3655 - Add
description
field to organizational models - ๐ง #3664 - Enable applying configuration contexts by tags
- #3706 - Increase
available_power
maximum value on PowerFeed - #3731 - Change Graph.type to a ContentType foreign key field
API Changes
- ๐ Choice fields now use human-friendly strings for their values instead of integers (see
#3569). - Introduced
/api/extras/scripts/
endpoint for retrieving and executing custom scripts - circuits.CircuitType: Added field
description
- dcim.ConsolePort: Added field
type
- dcim.ConsolePortTemplate: Added field
type
- dcim.ConsoleServerPort: Added field
type
- dcim.ConsoleServerPortTemplate: Added field
type
- dcim.DeviceRole: Added field
description
- dcim.PowerPort: Added field
type
- dcim.PowerPortTemplate: Added field
type
- dcim.PowerOutlet: Added field
type
- dcim.PowerOutletTemplate: Added field
type
- dcim.RackRole: Added field
description
- extras.Graph: The
type
field has been changed to a content type foreign key. Models are specified as
<app>.<model>
; e.g.dcim.site
. - ipam.Role: Added field
description
- secrets.SecretRole: Added field
description
- virtualization.Cluster: Added field
tenant