Merge pull request #2660 from digitalocean/develop

Release v2.5.0

.github/ISSUE_TEMPLATE.md

@@ -1,28 +0,0 @@
-<!--
-    Please note: GitHub issues are to be used only for feature requests
-    and bug reports. For installation assistance or general discussion,
-    please join us on the mailing list:
-
-        https://groups.google.com/forum/#!forum/netbox-discuss
-
-    Please indicate "bug report" or "feature request" below. Be sure to
-    search the existing set of issues (both open and closed) to see if
-    a similar issue has already been raised.
--->
-### Issue type:
-
-<!--
-    If filing a bug, please indicate the version of Python and NetBox
-    you are running. (This is not necessary for feature requests.)
--->
-**Python version:**
-**NetBox version:**
-
-<!--
-    If filing a bug, please record the exact steps taken to reproduce
-    the bug and any errors messages that are generated.
-
-    If filing a feature request, please precisely describe the data
-    model or workflow you would like to see implemented, and provide a
-    use case.
--->

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: 🐛 Bug Report
+about: Report a reproducible bug in the current release of NetBox
+
+---
+
+<!--
+    NOTE: This form is only for reproducible bugs. If you need assistance with
+    NetBox installation, or if you have a general question, DO NOT open an
+    issue. Instead, post to our mailing list:
+
+        https://groups.google.com/forum/#!forum/netbox-discuss
+
+    Please describe the environment in which you are running NetBox. Be sure
+    that you are running an unmodified instance of the latest stable release
+    before submitting a bug report.
+-->
+### Environment
+* Python version:  <!-- Example: 3.5.4 -->
+* NetBox version:  <!-- Example: 2.3.6 -->
+
+<!--
+    Describe in detail the steps that someone else can take to reproduce this
+    bug using the current stable release of NetBox (or the current beta release
+    where applicable).
+-->
+### Steps to Reproduce
+
+
+<!-- What did you expect to happen? -->
+### Expected Behavior
+
+
+<!-- What happened instead? -->
+### Observed Behavior

.github/ISSUE_TEMPLATE/documentation_change.md

@@ -0,0 +1,18 @@
+---
+name: 📖 Documentation Change
+about: Suggest an addition or modification to the NetBox documentation
+
+---
+
+<!--
+    Please indicate the nature of the change by placing an X in one of the
+    boxes below.
+-->
+### Change Type
+[ ] Addition
+[ ] Correction
+[ ] Deprecation
+[ ] Cleanup (formatting, typos, etc.)
+
+<!-- Describe the proposed change(s). -->
+### Proposed Changes

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,54 @@
+---
+name: ✨ Feature Request
+about: Propose a new NetBox feature or enhancement
+
+---
+
+<!--
+    NOTE: This form is only for proposing specific new features or enhancements.
+    If you have a general idea or question, please post to our mailing list
+    instead of opening an issue:
+
+        https://groups.google.com/forum/#!forum/netbox-discuss
+
+    NOTE: Due to an excessive backlog of feature requests, we are not currently
+    accepting any proposals which significantly extend NetBox's feature scope.
+
+    Please describe the environment in which you are running NetBox. Be sure
+    that you are running an unmodified instance of the latest stable release
+    before submitting a bug report.
+-->
+### Environment
+* Python version:  <!-- Example: 3.5.4 -->
+* NetBox version:  <!-- Example: 2.3.6 -->
+
+<!--
+    Describe in detail the new functionality you are proposing. Include any
+    specific changes to work flows, data models, or the user interface.
+-->
+### Proposed Functionality
+
+
+<!--
+    Convey an example use case for your proposed feature. Write from the
+    perspective of a NetBox user who would benefit from the proposed
+    functionality and describe how.
+--->
+### Use Case
+
+
+<!--
+    Note any changes to the database schema necessary to support the new
+    feature. For example, does the proposal require adding a new model or
+    field? (Not all new features require database changes.)
+--->
+### Database Changes
+
+
+<!--
+    List any new dependencies on external libraries or services that this new
+    feature would introduce. For example, does the proposal require the
+    installation of a new Python package? (Not all new features introduce new
+    dependencies.)
+-->
+### External Dependencies

.github/ISSUE_TEMPLATE/housekeeping.md

@@ -0,0 +1,17 @@
+---
+name: 🏡 Housekeeping
+about: A change pertaining to the codebase itself
+
+---
+
+<!--
+    NOTE: This type of issue should be opened only by those reasonably familiar
+    with NetBox's code base and interested in contributing to its development.
+
+    Describe the proposed change(s) in detail.
+-->
+### Proposed Changes
+
+
+<!-- Provide justification for the proposed change(s). -->
+### Justification

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,6 +6,8 @@
     be able to accept.
 
     Please indicate the relevant feature request or bug report below.
+    IF YOUR PULL REQUEST DOES NOT REFERENCE AN ACCEPTED BUG REPORT OR
+    FEATURE REQUEST, IT WILL BE MARKED AS INVALID AND CLOSED.
 -->
 ### Fixes:
 

.gitignore

@@ -1,6 +1,8 @@
 *.pyc
 /netbox/netbox/configuration.py
 /netbox/netbox/ldap_config.py
+/netbox/reports/*
+!/netbox/reports/__init__.py
 /netbox/static
 .idea
 /*.sh

.travis.yml

@@ -1,21 +1,16 @@
 sudo: required
-
 services:
-  - docker
-
-env:
-  - DOCKER_TAG=$TRAVIS_TAG
-
+  - postgresql
+addons:
+  postgresql: "9.4"
 language: python
 python:
-  - "2.7"
   - "3.5"
 install:
   - pip install -r requirements.txt
-  - pip install pep8
+  - pip install pycodestyle
+before_script:
+  - psql --version
+  - psql -U postgres -c 'SELECT version();'
 script:
   - ./scripts/cibuild.sh
-after_success:
-  - if [ ! -z "$TRAVIS_TAG" ] && [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
-    ./scripts/docker-build.sh;
-    fi

CONTRIBUTING.md

@@ -1,8 +1,8 @@
 ## Getting Help
 
 If you encounter any issues installing or using NetBox, try one of the
-following resources to get assistance. Please **do not** open a GitHub
-issue except to report bugs or request features.
+following resources to get assistance. Please **do not** open a GitHub issue
+except to report bugs or request features.
 
 ### Mailing List
 
@@ -10,104 +10,110 @@ We have established a Google Groups Mailing List for issues and general
 discussion. This is the best forum for obtaining assistance with NetBox
 installation. You can find us [here](https://groups.google.com/forum/#!forum/netbox-discuss).
 
-### Freenode IRC
+### Slack
 
-For real-time discussion, you can join the #netbox channel on [Freenode](https://freenode.net/).
-You can connect to Freenode at irc.freenode.net using an IRC client, or
-you can use their [webchat client](https://webchat.freenode.net/).
+For real-time discussion, you can join the #netbox Slack channel on [NetworkToCode](https://slack.networktocode.com/).
 
 ## Reporting Bugs
 
-* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases) of
-NetBox. If you're running an older version, it's possible that the bug
-has already been fixed.
+* First, ensure that you've installed the [latest stable version](https://github.com/digitalocean/netbox/releases)
+of NetBox. If you're running an older version, it's possible that the bug has
+already been fixed.
 
-* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the bug you've found has
-already been reported. If you think you may be experiencing a reported
-issue that hasn't already been resolved, please click "add a reaction"
-in the top right corner of the issue and add a thumbs up (+1). You might
-also want to add a comment describing how it's affecting your
-installation. This will allow us to prioritize bugs based on how many
-users are affected.
+* Next, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues)
+to see if the bug you've found has already been reported. If you think you may
+be experiencing a reported issue that hasn't already been resolved, please
+click "add a reaction" in the top right corner of the issue and add a thumbs
+up (+1). You mightalso want to add a comment describing how it's affecting your
+installation. This will allow us to prioritize bugs based on how many users are
+affected.
 
-* If you haven't found an existing issue that describes your suspected
-bug, please inquire about it on the mailing list. **Do not** file an
-issue until you have received confirmation that it is in fact a bug.
-Invalid issues are very distracting and slow the pace at which NetBox is
-developed.
+* If you haven't found an existing issue that describes your suspected bug,
+please inquire about it on the mailing list. **Do not** file an issue until you
+have received confirmation that it is in fact a bug. Invalid issues are very
+distracting and slow the pace at which NetBox is developed.
 
-* When submitting an issue, please be as descriptive as possible. Be
-sure to include:
+* When submitting an issue, please be as descriptive as possible. Be sure to
+include:
 
     * The environment in which NetBox is running
-    * The exact steps that can be taken to reproduce the issue (if
-      applicable)
+    * The exact steps that can be taken to reproduce the issue (if applicable)
     * Any error messages generated
     * Screenshots (if applicable)
 
-* Keep in mind that we prioritize bugs based on their severity and how
-much work is required to resolve them. It may take some time for someone
-to address your issue.
+* Please avoid prepending any sort of tag (e.g. "[Bug]") to the issue title.
+The issue will be reviewed by a moderator after submission and the appropriate
+labels will be applied for categorization.
+
+* Keep in mind that we prioritize bugs based on their severity and how much
+work is required to resolve them. It may take some time for someone to address
+your issue.
 
 ## Feature Requests
 
-* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues) to see if the feature you're
-requesting is already listed. (Be sure to search closed issues as well,
-since some feature requests are rejected.) If the feature you'd like to
-see has already been requested, click "add a reaction" in the top right
-corner of the issue and add a thumbs up (+1). This ensures that the
-issue has a better chance of making it onto the roadmap. Also feel free
-to add a comment with any additional justification for the feature.
+* First, check the GitHub [issues list](https://github.com/digitalocean/netbox/issues)
+to see if the feature you're requesting is already listed. (Be sure to search
+closed issues as well, since some feature requests have been rejected.) If the
+feature you'd like to see has already been requested and is open, click "add a
+reaction" in the top right corner of the issue and add a thumbs up (+1). This
+ensures that the issue has a better chance of receiving attention. Also feel
+free to add a comment with any additional justification for the feature.
 (However, note that comments with no substance other than a "+1" will be
-deleted. Please use GitHub's reactions feature to indicate your
-support.)
+deleted. Please use GitHub's reactions feature to indicate your support.)
 
-* While suggestions for new features are welcome, it's important to
-limit the scope of NetBox's feature set to avoid feature creep. For
-example, the following features would be firmly out of scope for NetBox:
-
-    * Ticket management
-    * Network state monitoring
-    * Acting as a DNS server
-    * Acting as an authentication server
+* Due to an excessive backlog of feature requests, we are not currently
+accepting any proposals which substantially extend NetBox's functionality
+beyond its current feature set. This includes the introduction of any new views
+or models which have not already been proposed in an existing feature request.
 
 * Before filing a new feature request, consider raising your idea on the
-mailing list first. Feedback you receive there will help validate and
-shape the proposed feature before filing a formal issue.
+mailing list first. Feedback you receive there will help validate and shape the
+proposed feature before filing a formal issue.
 
-* Good feature requests are very narrowly defined. Be sure to enumerate
-specific functionality and data schema. The more effort you put into
-writing a feature request, the better its chance is of being
+* Good feature requests are very narrowly defined. Be sure to thoroughly
+describe the functionality and data model(s) being proposed. The more effort
+you put into writing a feature request, the better its chance is of being
 implemented. Overly broad feature requests will be closed.
 
 * When submitting a feature request on GitHub, be sure to include the
 following:
 
     * A detailed description of the proposed functionality
-    * A use case for the feature; who would use it and what value it
-      would add to NetBox
-    * A rough description of changes necessary to the database schema
-      (if applicable)
-    * Any third-party libraries or other resources which would be
-      involved
+    * A use case for the feature; who would use it and what value it would add
+      to NetBox
+    * A rough description of changes necessary to the database schema (if
+      applicable)
+    * Any third-party libraries or other resources which would be involved
+
+* Please avoid prepending any sort of tag (e.g. "[Feature]") to the issue
+title. The issue will be reviewed by a moderator after submission and the
+appropriate labels will be applied for categorization.
 
 ## Submitting Pull Requests
 
-* Be sure to open an issue before starting work on a pull request, and
-discuss your idea with the NetBox maintainers before beginning work​.
-This will help prevent wasting time on something that might we might not
-be able to implement. When suggesting a new feature, also make sure it
-won't conflict with any work that's already in progress.
+* Be sure to open an issue **before** starting work on a pull request, and
+discuss your idea with the NetBox maintainers before beginning work. This will
+help prevent wasting time on something that might we might not be able to
+implement. When suggesting a new feature, also make sure it won't conflict with
+any work that's already in progress.
 
-* When submitting a pull request, please be sure to work off of the
-`develop` branch, rather than `master`. In NetBox, the `develop` branch
-is used for ongoing development, while `master` is used for tagging new
-stable releases.
+* Any pull request which does _not_ relate to an accepted issue will be closed.
 
-* All code submissions should meet the following criteria (CI will
-enforce these checks):
+* When submitting a pull request, please be sure to work off of the `develop`
+branch, rather than `master`. The `develop` branch is used for ongoing
+development, while `master` is used for tagging new stable releases.
+
+* All code submissions should meet the following criteria (CI will enforce
+these checks):
 
     * Python syntax is valid
     * All tests pass when run with `./manage.py test`
     * PEP 8 compliance is enforced, with the exception that lines may be
       greater than 80 characters in length
+
+## Commenting
+
+Only comment on an issue if you are sharing a relevant idea or constructive
+feedback. **Do not** comment on an issue just to show your support (give the
+top post a :+1: instead) or ask for an ETA. These comments will be deleted to
+reduce noise in the discussion.

README.md

@@ -1,17 +1,21 @@
 ![NetBox](docs/netbox_logo.png "NetBox logo")
 
-NetBox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically to address the needs of network and infrastructure engineers.
+NetBox is an IP address management (IPAM) and data center infrastructure
+management (DCIM) tool. Initially conceived by the network engineering team at
+[DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically
+to address the needs of network and infrastructure engineers.
 
-NetBox runs as a web application atop the [Django](https://www.djangoproject.com/) Python framework with a [PostgreSQL](http://www.postgresql.org/) database. For a complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/digitalocean/netbox).
+NetBox runs as a web application atop the [Django](https://www.djangoproject.com/)
+Python framework with a [PostgreSQL](http://www.postgresql.org/) database. For a
+complete list of requirements, see `requirements.txt`. The code is available [on GitHub](https://github.com/digitalocean/netbox).
 
 The complete documentation for NetBox can be found at [Read the Docs](http://netbox.readthedocs.io/en/stable/).
 
-Questions? Comments? Please subscribe to [the netbox-discuss mailing list](https://groups.google.com/forum/#!forum/netbox-discuss), or join us on IRC in **#netbox** on **irc.freenode.net**!
+Questions? Comments? Please subscribe to [the netbox-discuss mailing list](https://groups.google.com/forum/#!forum/netbox-discuss),
+or join us in the #netbox Slack channel on [NetworkToCode](https://networktocode.slack.com/)!
 
 ### Build Status
 
-NetBox is built against both Python 2.7 and 3.5.  Python 3.5 is recommended.
-
 |             | status |
 |-------------|------------|
 | **master** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=master)](https://travis-ci.org/digitalocean/netbox) |
@@ -27,9 +31,27 @@ NetBox is built against both Python 2.7 and 3.5.  Python 3.5 is recommended.
 
 # Installation
 
-Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/digitalocean/netbox/releases) and run `upgrade.sh`.
+Please see [the documentation](http://netbox.readthedocs.io/en/stable/) for
+instructions on installing NetBox. To upgrade NetBox, please download the [latest release](https://github.com/digitalocean/netbox/releases)
+and run `upgrade.sh`.
 
 ## Alternative Installations
 
-* [Docker container](https://github.com/digitalocean/netbox-docker)
-* [Heroku deployment](https://heroku.com/deploy?template=https://github.com/BILDQUADRAT/netbox/tree/heroku) (via [@mraerino](https://github.com/BILDQUADRAT/netbox/tree/heroku))
+* [Docker container](https://github.com/ninech/netbox-docker) (via [@cimnine](https://github.com/cimnine))
+* [Vagrant deployment](https://github.com/ryanmerolle/netbox-vagrant) (via [@ryanmerolle](https://github.com/ryanmerolle))
+* [Ansible deployment](https://github.com/lae/ansible-role-netbox) (via [@lae](https://github.com/lae))
+
+# Related projects
+
+## Supported SDK
+
+- [pynetbox](https://github.com/digitalocean/pynetbox) Python API client library for Netbox.
+
+## Community SDK
+
+- [netbox-client-ruby](https://github.com/ninech/netbox-client-ruby) A ruby client library for Netbox v2.
+
+## Ansible Inventory
+
+- [netbox-as-ansible-inventory](https://github.com/AAbouZaid/netbox-as-ansible-inventory) Ansible dynamic inventory script for Netbox.
+

base_requirements.txt

@@ -0,0 +1,72 @@
+# The Python web framework on which NetBox is built
+# https://github.com/django/django
+Django
+
+# Django middleware which permits cross-domain API requests
+# https://github.com/OttoYiu/django-cors-headers
+django-cors-headers
+
+# Runtime UI tool for debugging Django
+# https://github.com/jazzband/django-debug-toolbar
+django-debug-toolbar
+
+# Library for writing reusable URL query filters
+# https://github.com/carltongibson/django-filter
+django-filter
+
+# Modified Preorder Tree Traversal (recursive nesting of objects)
+# https://github.com/django-mptt/django-mptt
+django-mptt
+
+# Abstraction models for rendering and paginating HTML tables
+# https://github.com/jieter/django-tables2
+django-tables2
+
+# User-defined tags for objects
+# https://github.com/alex/django-taggit
+django-taggit
+
+# A Django REST Framework serializer which represents tags
+# https://github.com/glemmaPaul/django-taggit-serializer
+django-taggit-serializer
+
+# A Django field for representing time zones
+# https://github.com/mfogel/django-timezone-field/
+django-timezone-field
+
+# A REST API framework for Django projects
+# https://github.com/encode/django-rest-framework
+djangorestframework
+
+# Swagger/OpenAPI schema generation for REST APIs
+# https://github.com/axnsan12/drf-yasg
+drf-yasg[validation]
+
+# Python interface to the graphviz graph rendering utility
+# https://github.com/xflr6/graphviz
+graphviz
+
+# Simple markup language for rendering HTML
+# https://github.com/Python-Markdown/markdown
+# py-gfm requires Markdown<3.0
+Markdown<3.0
+
+# Library for manipulating IP prefixes and addresses
+# https://github.com/drkjam/netaddr
+netaddr
+
+# Fork of PIL (Python Imaging Library) for image processing
+# https://github.com/python-pillow/Pillow
+Pillow
+
+# PostgreSQL database adapter for Python
+# https://github.com/psycopg/psycopg2
+psycopg2-binary
+
+# GitHub-flavored Markdown extensions
+# https://github.com/zopieux/py-gfm
+py-gfm
+
+# Extensive cryptographic library (fork of pycrypto)
+# https://github.com/Legrandin/pycryptodome
+pycryptodome

docs/additional-features/change-logging.md

@@ -0,0 +1,9 @@
+# Change Logging
+
+Every time an object in NetBox is created, updated, or deleted, a serialized copy of that object is saved to the database, along with meta data including the current time and the user associated with the change. These records form a running changelog both for each individual object as well as NetBox as a whole (Organization > Changelog).
+
+A serialized representation is included for each object in JSON format. This is similar to how objects are conveyed within the REST API, but does not include any nested representations. For instance, the `tenant` field of a site will record only the tenant's ID, not a representation of the tenant.
+
+When a request is made, a random request ID is generated and attached to any change records resulting from the request. For example, editing multiple objects in bulk will create a change record for each object, and each of those objects will be assigned the same request ID. This makes it easy to identify all the change records associated with a particular request.
+
+Change records are exposed in the API via the read-only endpoint `/api/extras/object-changes/`. They may also be exported in CSV format.

docs/additional-features/context-data.md

@@ -0,0 +1,5 @@
+# Contextual Configuration Data
+
+Sometimes it is desirable to associate arbitrary data with a group of devices to aid in their configuration. For example, you might want to associate a set of syslog servers for all devices at a particular site. Context data enables the association of arbitrary data to devices and virtual machines grouped by region, site, role, platform, and/or tenant. Context data is arranged hierarchically, so that data with a higher weight can be entered to override more general lower-weight data. Multiple instances of data are automatically merged by NetBox to present a single dictionary for each object.
+
+Devices and Virtual Machines may also have a local config context defined. This local context will always overwrite the rendered config context objects for the Device/VM. This is useful in situations were the device requires a one-off value different from the rest of the environment.

docs/additional-features/custom-fields.md

@@ -0,0 +1,26 @@
+# Custom Fields
+
+Each object in NetBox is represented in the database as a discrete table, and each attribute of an object exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows.
+
+However, some users might want to associate with objects attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number pointing to the support ticket that was opened to have it installed. This is certainly a legitimate use for NetBox, but it's perhaps not a common enough need to warrant expanding the internal data schema. Instead, you can create a custom field to hold this data.
+
+Custom fields must be created through the admin UI under Extras > Custom Fields. To create a new custom field, select the object(s) to which you want it to apply, and the type of field it will be. NetBox supports six field types:
+
+* Free-form text (up to 255 characters)
+* Integer
+* Boolean (true/false)
+* Date
+* URL
+* Selection
+
+Assign the field a name. This should be a simple database-friendly string, e.g. `tps_report`. You may optionally assign the field a human-friendly label (e.g. "TPS report") as well; the label will be displayed on forms. If a description is provided, it will appear beneath the field in a form.
+
+Marking the field as required will require the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields. (The default value has no effect for selection fields.)
+
+When creating a selection field, you should create at least two choices. These choices will be arranged first by weight, with lower weights appearing higher in the list, and then alphabetically.
+
+## Using Custom Fields
+
+When a single object is edited, the form will include any custom fields which have been defined for the object type. These fields are included in the "Custom Fields" panel. On the backend, each custom field value is saved separately from the core object as an independent database call, so it's best to avoid adding too many custom fields per object.
+
+When editing multiple objects, custom field values are saved in bulk. There is no significant difference in overhead when saving a custom field value for 100 objects versus one object. However, the bulk operation must be performed separately for each custom field.

docs/additional-features/export-templates.md

@@ -0,0 +1,52 @@
+# Export Templates
+
+NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Extras > Export Templates under the admin interface.
+
+Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list.
+
+Export templates are written in [Django's template language](https://docs.djangoproject.com/en/1.9/ref/templates/language/), which is very similar to Jinja2. The list of objects returned from the database is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example:
+
+```
+{% for rack in queryset %}
+Rack: {{ rack.name }}
+Site: {{ rack.site.name }}
+Height: {{ rack.u_height }}U
+{% endfor %}
+```
+
+To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`.
+
+A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`.
+
+## Example
+
+Here's an example device export template that will generate a simple Nagios configuration from a list of devices.
+
+```
+{% for device in queryset %}{% if device.status and device.primary_ip %}define host{
+        use                     generic-switch
+        host_name               {{ device.name }}
+        address                 {{ device.primary_ip.address.ip }}
+}
+{% endif %}{% endfor %}
+```
+
+The generated output will look something like this:
+
+```
+define host{
+        use                     generic-switch
+        host_name               switch1
+        address                 192.0.2.1
+}
+define host{
+        use                     generic-switch
+        host_name               switch2
+        address                 192.0.2.2
+}
+define host{
+        use                     generic-switch
+        host_name               switch3
+        address                 192.0.2.3
+}
+```

docs/additional-features/graphs.md

@@ -0,0 +1,25 @@
+# Graphs
+
+NetBox does not have the ability to generate graphs natively, but this feature allows you to embed contextual graphs from an external resources (such as a monitoring system) inside the site, provider, and interface views. Each embedded graph must be defined with the following parameters:
+
+* **Type:** Site, provider, or interface. This determines in which view the graph will be displayed.
+* **Weight:** Determines the order in which graphs are displayed (lower weights are displayed first). Graphs with equal weights will be ordered alphabetically by name.
+* **Name:** The title to display above the graph.
+* **Source URL:** The source of the image to be embedded. The associated object will be available as a template variable named `obj`.
+* **Link URL (optional):** A URL to which the graph will be linked. The associated object will be available as a template variable named `obj`.
+
+## Examples
+
+You only need to define one graph object for each graph you want to include when viewing an object. For example, if you want to include a graph of traffic through an interface over the past five minutes, your graph source might looks like this:
+
+```
+https://my.nms.local/graphs/?node={{ obj.device.name }}&interface={{ obj.name }}&duration=5m
+```
+
+You can define several graphs to provide multiple contexts when viewing an object. For example:
+
+```
+https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
+https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=24h
+https://my.nms.local/graphs/?type=errors&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
+```

docs/additional-features/reports.md

@@ -0,0 +1,131 @@
+# NetBox Reports
+
+A NetBox report is a mechanism for validating the integrity of data within NetBox. Running a report allows the user to verify that the objects defined within NetBox meet certain arbitrary conditions. For example, you can write reports to check that:
+
+* All top-of-rack switches have a console connection
+* Every router has a loopback interface with an IP address assigned
+* Each interface description conforms to a standard format
+* Every site has a minimum set of VLANs defined
+* All IP addresses have a parent prefix
+
+...and so on. Reports are completely customizable, so there's practically no limit to what you can test for.
+
+## Writing Reports
+
+Reports must be saved as files in the [`REPORTS_ROOT`](../configuration/optional-settings/#reports_root) path (which defaults to `netbox/reports/`). Each file created within this path is considered a separate module. Each module holds one or more reports (Python classes), each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test.
+
+!!! warning
+    The reports path includes a file named `__init__.py`, which registers the path as a Python module. Do not delete this file.
+
+For example, we can create a module named `devices.py` to hold all of our reports which pertain to devices in NetBox. Within that module, we might define several reports. Each report is defined as a Python class inheriting from `extras.reports.Report`.
+
+```
+from extras.reports import Report
+
+class DeviceConnectionsReport(Report):
+    description = "Validate the minimum physical connections for each device"
+
+class DeviceIPsReport(Report):
+    description = "Check that every device has a primary IP address assigned"
+```
+
+Within each report class, we'll create a number of test methods to execute our report's logic. In DeviceConnectionsReport, for instance, we want to ensure that every live device has a console connection, an out-of-band management connection, and two power connections.
+
+```
+from dcim.constants import CONNECTION_STATUS_PLANNED, DEVICE_STATUS_ACTIVE
+from dcim.models import ConsolePort, Device, PowerPort
+from extras.reports import Report
+
+
+class DeviceConnectionsReport(Report):
+    description = "Validate the minimum physical connections for each device"
+
+    def test_console_connection(self):
+
+        # Check that every console port for every active device has a connection defined.
+        for console_port in ConsolePort.objects.select_related('device').filter(device__status=DEVICE_STATUS_ACTIVE):
+            if console_port.cs_port is None:
+                self.log_failure(
+                    console_port.device,
+                    "No console connection defined for {}".format(console_port.name)
+                )
+            elif console_port.connection_status == CONNECTION_STATUS_PLANNED:
+                self.log_warning(
+                    console_port.device,
+                    "Console connection for {} marked as planned".format(console_port.name)
+                )
+            else:
+                self.log_success(console_port.device)
+
+    def test_power_connections(self):
+
+        # Check that every active device has at least two connected power supplies.
+        for device in Device.objects.filter(status=DEVICE_STATUS_ACTIVE):
+            connected_ports = 0
+            for power_port in PowerPort.objects.filter(device=device):
+                if power_port.power_outlet is not None:
+                    connected_ports += 1
+                    if power_port.connection_status == CONNECTION_STATUS_PLANNED:
+                        self.log_warning(
+                            device,
+                            "Power connection for {} marked as planned".format(power_port.name)
+                        )
+            if connected_ports < 2:
+                self.log_failure(
+                    device,
+                    "{} connected power supplies found (2 needed)".format(connected_ports)
+                )
+            else:
+                self.log_success(device)
+```
+
+As you can see, reports are completely customizable. Validation logic can be as simple or as complex as needed.
+
+!!! warning
+    Reports should never alter data: If you find yourself using the `create()`, `save()`, `update()`, or `delete()` methods on objects within reports, stop and re-evaluate what you're trying to accomplish. Note that there are no safeguards against the accidental alteration or destruction of data.
+
+The following methods are available to log results within a report:
+
+* log(message)
+* log_success(object, message=None)
+* log_info(object, message)
+* log_warning(object, message)
+* log_failure(object, message)
+
+The recording of one or more failure messages will automatically flag a report as failed. It is advised to log a success for each object that is evaluated so that the results will reflect how many objects are being reported on. (The inclusion of a log message is optional for successes.) Messages recorded with `log()` will appear in a report's results but are not associated with a particular object or status.
+
+To perform additional tasks, such as sending an email or calling a webhook, after a report has been run, extend the `post_run()` method. The status of the report is available as `self.failed` and the results object is `self.result`.
+
+Once you have created a report, it will appear in the reports list. Initially, reports will have no results associated with them. To generate results, run the report.
+
+## Running Reports
+
+### Via the Web UI
+
+Reports can be run via the web UI by navigating to the report and clicking the "run report" button at top right. Note that a user must have permission to create ReportResults in order to run reports. (Permissions can be assigned through the admin UI.)
+
+Once a report has been run, its associated results will be included in the report view.
+
+### Via the API
+
+To run a report via the API, simply issue a POST request to its `run` endpoint. Reports are identified by their module and class name.
+
+```
+    POST /api/extras/reports/<module>.<name>/run/
+```
+
+Our example report above would be called as:
+
+```
+    POST /api/extras/reports/devices.DeviceConnectionsReport/run/
+```
+
+### Via the CLI
+
+Reports can be run on the CLI by invoking the management command:
+
+```
+python3 manage.py runreport <module>
+```
+
+One or more report modules may be specified.

docs/additional-features/tags.md

@@ -0,0 +1,24 @@
+# Tags
+
+Tags are free-form text labels which can be applied to a variety of objects within NetBox. Tags are created on-demand as they are assigned to objects. Use commas to separate tags when adding multiple tags to an object 9for example: `Inventoried, Monitored`). Use double quotes around a multi-word tag when adding only one tag, e.g. `"Core Switch"`.
+
+Each tag has a label and a URL-friendly slug. For example, the slug for a tag named "Dunder Mifflin, Inc." would be `dunder-mifflin-inc`. The slug is generated automatically and makes tags easier to work with as URL parameters.
+
+Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored":
+
+```
+GET /api/dcim/devices/?tag=monitored
+```
+
+Tags are included in the API representation of an object as a list of plain strings:
+
+```
+{
+    ...
+    "tags": [
+        "Core Switch",
+        "Monitored"
+    ],
+    ...
+}
+```

docs/additional-features/topology-maps.md

@@ -0,0 +1,17 @@
+# Topology Maps
+
+NetBox can generate simple topology maps from the physical network connections recorded in its database. First, you'll need to create a topology map definition under the admin UI at Extras > Topology Maps.
+
+Each topology map is associated with a site. A site can have multiple topology maps, which might each illustrate a different aspect of its infrastructure (for example, production versus backend infrastructure).
+
+To define the scope of a topology map, decide which devices you want to include. The map will only include interface connections with both points terminated on an included device. Specify the devices to include in the **device patterns** field by entering a list of [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) matching device names. For example, if you wanted to include "mgmt-switch1" through "mgmt-switch99", you might use the regex `mgmt-switch\d+`.
+
+Each line of the **device patterns** field represents a hierarchical layer within the topology map. For example, you might map a traditional network with core, distribution, and access tiers like this:
+
+```
+core-switch-[abcd]
+dist-switch\d
+access-switch\d+;oob-switch\d+
+```
+
+Note that you can combine multiple regexes onto one line using semicolons. The order in which regexes are listed on a line is significant: devices matching the first regex will be rendered first, and subsequent groups will be rendered to the right of those.

docs/additional-features/webhooks.md

@@ -0,0 +1,65 @@
+# Webhooks
+
+A webhook defines an HTTP request that is sent to an external application when certain types of objects are created, updated, and/or deleted in NetBox. When a webhook is triggered, a POST request is sent to its configured URL. This request will include a full representation of the object being modified for consumption by the receiver. Webhooks are configured via the admin UI under Extras > Webhooks.
+
+An optional secret key can be configured for each webhook. This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. This digest can be used by the receiver to authenticate the request's content.
+
+## Installation
+
+If you are upgrading from a previous version of Netbox and want to enable the webhook feature, please follow the directions listed in the sections below.
+
+* [Install Redis server and djano-rq package](../installation/2-netbox/#install-python-packages)
+* [Modify configuration to enable webhooks](../installation/2-netbox/#webhooks-configuration)
+* [Create supervisord program to run the rqworker process](../installation/3-http-daemon/#supervisord-installation)
+
+## Requests
+
+The webhook POST request is structured as so (assuming `application/json` as the Content-Type):
+
+```no-highlight
+{
+    "event": "created",
+    "signal_received_timestamp": 1508769597,
+    "model": "Site"
+    "data": {
+        ...
+    }
+}
+```
+
+`data` is the serialized representation of the model instance(s) from the event. The same serializers from the NetBox API are used. So an example of the payload for a Site delete event would be:
+
+```no-highlight
+{
+    "event": "deleted",
+    "signal_received_timestamp": 1508781858.544069,
+    "model": "Site",
+    "data": {
+        "asn": None,
+        "comments": "",
+        "contact_email": "",
+        "contact_name": "",
+        "contact_phone": "",
+        "count_circuits": 0,
+        "count_devices": 0,
+        "count_prefixes": 0,
+        "count_racks": 0,
+        "count_vlans": 0,
+        "custom_fields": {},
+        "facility": "",
+        "id": 54,
+        "name": "test",
+        "physical_address": "",
+        "region": None,
+        "shipping_address": "",
+        "slug": "test",
+        "tenant": None
+    }
+}
+```
+
+A request is considered successful if the response status code is any one of a list of "good" statuses defined in the [requests library](https://github.com/requests/requests/blob/205755834d34a8a6ecf2b0b5b2e9c3e6a7f4e4b6/requests/models.py#L688), otherwise the request is marked as having failed. The user may manually retry a failed request.
+
+## Backend Status
+
+Django-rq includes a status page in the admin site which can be used to view the result of processed webhooks and manually retry any failed webhooks. Access it from http://netbox.local/admin/webhook-backend-status/.

docs/administration/netbox-shell.md

@@ -0,0 +1,194 @@
+NetBox includes a Python shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following command:
+
+```
+./manage.py nbshell
+```
+
+This will launch a customized version of [the built-in Django shell](https://docs.djangoproject.com/en/dev/ref/django-admin/#shell) with all relevant NetBox models pre-loaded. (If desired, the stock Django shell is also available by executing `./manage.py shell`.)
+
+```
+$ ./manage.py nbshell
+### NetBox interactive shell (jstretch-laptop)
+### Python 3.5.2 | Django 2.0.8 | NetBox 2.4.3
+### lsmodels() will show available models. Use help(<model>) for more info.
+```
+
+The function `lsmodels()` will print a list of all available NetBox models:
+
+```
+>>> lsmodels()
+DCIM:
+  ConsolePort
+  ConsolePortTemplate
+  ConsoleServerPort
+  ConsoleServerPortTemplate
+  Device
+  ...
+```
+
+## Querying Objects
+
+Objects are retrieved by forming a [Django queryset](https://docs.djangoproject.com/en/dev/topics/db/queries/#retrieving-objects). The base queryset for an object takes the form `<model>.objects.all()`, which will return a (truncated) list of all objects of that type.
+
+```
+>>> Device.objects.all()
+<QuerySet [<Device: TestDevice1>, <Device: TestDevice2>, <Device: TestDevice3>, <Device: TestDevice4>, <Device: TestDevice5>, '...(remaining elements truncated)...']>
+```
+
+Use a `for` loop to cycle through all objects in the list:
+
+```
+>>> for device in Device.objects.all():
+...   print(device.name, device.device_type)
+...
+(u'TestDevice1', <DeviceType: PacketThingy 9000>)
+(u'TestDevice2', <DeviceType: PacketThingy 9000>)
+(u'TestDevice3', <DeviceType: PacketThingy 9000>)
+(u'TestDevice4', <DeviceType: PacketThingy 9000>)
+(u'TestDevice5', <DeviceType: PacketThingy 9000>)
+...
+```
+
+To count all objects matching the query, replace `all()` with `count()`:
+
+```
+>>> Device.objects.count()
+1274
+```
+
+To retrieve a particular object (typically by its primary key or other unique field), use `get()`:
+
+```
+>>> Site.objects.get(pk=7)
+<Site: Test Lab>
+```
+
+### Filtering Querysets
+
+In most cases, you want to retrieve only a specific subset of objects. To filter a queryset, replace `all()` with `filter()` and pass one or more keyword arguments. For example:
+
+```
+>>> Device.objects.filter(status=STATUS_ACTIVE)
+<QuerySet [<Device: TestDevice1>, <Device: TestDevice2>, <Device: TestDevice3>, <Device: TestDevice8>, <Device: TestDevice9>, '...(remaining elements truncated)...']>
+```
+
+Querysets support slicing to return a specific range of objects.
+
+```
+>>> Device.objects.filter(status=STATUS_ACTIVE)[:3]
+<QuerySet [<Device: TestDevice1>, <Device: TestDevice2>, <Device: TestDevice3>]>
+```
+
+The `count()` method can be appended to the queryset to return a count of objects rather than the full list.
+
+```
+>>> Device.objects.filter(status=STATUS_ACTIVE).count()
+982
+```
+
+Relationships with other models can be traversed by concatenating field names with a double-underscore. For example, the following will return all devices assigned to the tenant named "Pied Piper."
+
+```
+>>> Device.objects.filter(tenant__name='Pied Piper')
+```
+
+This approach can span multiple levels of relations. For example, the following will return all IP addresses assigned to a device in North America:
+
+```
+>>> IPAddress.objects.filter(interface__device__site__region__slug='north-america')
+```
+
+!!! note
+    While the above query is functional, it is very inefficient. There are ways to optimize such requests, however they are out of the scope of this document. For more information, see the [Django queryset method reference](https://docs.djangoproject.com/en/dev/ref/models/querysets/) documentation.
+
+Reverse relationships can be traversed as well. For example, the following will find all devices with an interface named "em0":
+
+```
+>>> Device.objects.filter(interfaces__name='em0')
+```
+
+Character fields can be filtered against partial matches using the `contains` or `icontains` field lookup (the later of which is case-insensitive).
+
+```
+>>> Device.objects.filter(name__icontains='testdevice')
+```
+
+Similarly, numeric fields can be filtered by values less than, greater than, and/or equal to a given value.
+
+```
+>>> VLAN.objects.filter(vid__gt=2000)
+```
+
+Multiple filters can be combined to further refine a queryset.
+
+```
+>>> VLAN.objects.filter(vid__gt=2000, name__icontains='engineering')
+```
+
+To return the inverse of a filtered queryset, use `exclude()` instead of `filter()`.
+
+```
+>>> Device.objects.count()
+4479
+>>> Device.objects.filter(status=STATUS_ACTIVE).count()
+4133
+>>> Device.objects.exclude(status=STATUS_ACTIVE).count()
+346
+```
+
+!!! info
+    The examples above are intended only to provide a cursory introduction to queryset filtering. For an exhaustive list of the available filters, please consult the [Django queryset API docs](https://docs.djangoproject.com/en/dev/ref/models/querysets/).
+
+## Creating and Updating Objects
+
+New objects can be created by instantiating the desired model, defining values for all required attributes, and calling `save()` on the instance.
+
+```
+>>> lab1 = Site.objects.get(pk=7)
+>>> myvlan = VLAN(vid=123, name='MyNewVLAN', site=lab1)
+>>> myvlan.save()
+```
+
+Alternatively, the above can be performed as a single operation:
+
+```
+>>> VLAN(vid=123, name='MyNewVLAN', site=Site.objects.get(pk=7)).save()
+```
+
+To modify an object, retrieve it, update the desired field(s), and call `save()` again.
+
+```
+>>> vlan = VLAN.objects.get(pk=1280)
+>>> vlan.name
+u'MyNewVLAN'
+>>> vlan.name = 'BetterName'
+>>> vlan.save()
+>>> VLAN.objects.get(pk=1280).name
+u'BetterName'
+```
+
+!!! warning
+    The Django ORM provides methods to create/edit many objects at once, namely `bulk_create()` and `update()`. These are best avoided in most cases as they bypass a model's built-in validation and can easily lead to database corruption if not used carefully.
+
+## Deleting Objects
+
+To delete an object, simply call `delete()` on its instance. This will return a dictionary of all objects (including related objects) which have been deleted as a result of this operation.
+
+```
+>>> vlan
+<VLAN: 123 (BetterName)>
+>>> vlan.delete()
+(1, {u'extras.CustomFieldValue': 0, u'ipam.VLAN': 1})
+```
+
+To delete multiple objects at once, call `delete()` on a filtered queryset. It's a good idea to always sanity-check the count of selected objects _before_ deleting them.
+
+```
+>>> Device.objects.filter(name__icontains='test').count()
+27
+>>> Device.objects.filter(name__icontains='test').delete()
+(35, {u'extras.CustomFieldValue': 0, u'dcim.DeviceBay': 0, u'secrets.Secret': 0, u'dcim.InterfaceConnection': 4, u'extras.ImageAttachment': 0, u'dcim.Device': 27, u'dcim.Interface': 4, u'dcim.ConsolePort': 0, u'dcim.PowerPort': 0})
+```
+
+!!! warning
+    Deletions are immediate and irreversible. Always think very carefully before calling `delete()` on an instance or queryset.

docs/administration/replicating-netbox.md

@@ -0,0 +1,63 @@
+# Replicating the Database
+
+NetBox uses [PostgreSQL](https://www.postgresql.org/) for its database, so general PostgreSQL best practices will apply to NetBox. You can dump and restore the database using the `pg_dump` and `psql` utilities, respectively.
+
+!!! note
+    The examples below assume that your database is named `netbox`.
+
+## Export the Database
+
+Use the `pg_dump` utility to export the entire database to a file:
+
+```no-highlight
+pg_dump netbox > netbox.sql
+```
+
+When replicating a production database for development purposes, you may find it convenient to exclude changelog data, which can easily account for the bulk of a database's size. To do this, exclude the `extras_objectchange` table data from the export. The table will still be included in the output file, but will not be populated with any data.
+
+```no-highlight
+pg_dump --exclude-table-data=extras_objectchange netbox > netbox.sql
+```
+
+## Load an Exported Database
+
+!!! warning
+    This will destroy and replace any existing instance of the database.
+
+```no-highlight
+psql -c 'drop database netbox'
+psql -c 'create database netbox'
+psql netbox < netbox.sql
+```
+
+Keep in mind that PostgreSQL user accounts and permissions are not included with the dump: You will need to create those manually if you want to fully replicate the original database (see the [installation docs](installation/1-postgresql.md)). When setting up a development instance of NetBox, it's strongly recommended to use different credentials anyway.
+
+## Export the Database Schema
+
+If you want to export only the database schema, and not the data itself (e.g. for development reference), do the following:
+
+```no-highlight
+pg_dump -s netbox > netbox_schema.sql
+```
+
+---
+
+# Replicating Media
+
+NetBox stored uploaded files (such as image attachments) in its media directory. To fully replicate an instance of NetBox, you'll need to copy both the database and the media files.
+
+## Archive the Media Directory
+
+Execute the following command from the root of the NetBox installation path (typically `/opt/netbox`):
+
+```no-highlight
+tar -czf netbox_media.tar.gz netbox/media/
+```
+
+## Restore the Media Directory
+
+To extract the saved archive into a new installation, run the following from the installation root:
+
+```no-highlight
+tar -xf netbox_media.tar.gz
+```

docs/api/authentication.md

@@ -4,6 +4,9 @@ The NetBox API employs token-based authentication. For convenience, cookie authe
 
 A token is a unique identifier that identifies a user to the API. Each user in NetBox may have one or more tokens which he or she can use to authenticate to the API. To create a token, navigate to the API tokens page at `/user/api-tokens/`.
 
+!!! note
+    The creation and modification of API tokens can be restricted per user by an administrator. If you don't see an option to create an API token, ask an administrator to grant you access.
+
 Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation.
 
 By default, a token can be used for all operations available via the API. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only.

docs/api/examples.md

@@ -4,7 +4,8 @@ Supported HTTP methods:
 
 * `GET`: Retrieve an object or list of objects
 * `POST`: Create a new object
-* `PUT`: Update an existing object
+* `PUT`: Update an existing object, all mandatory fields must be specified
+* `PATCH`: Updates an existing object, only specifying the field to be changed
 * `DELETE`: Delete an existing object
 
 To authenticate a request, attach your token in an `Authorization` header:
@@ -81,15 +82,15 @@ $ curl -H "Accept: application/json; indent=4" http://localhost/api/dcim/sites/6
 
 ### Creating a new site
 
-Send a `POST` request to the site list endpoint with token authentication and JSON-formatted data. Only mandatory fields are required.
+Send a `POST` request to the site list endpoint with token authentication and JSON-formatted data. Only mandatory fields are required. This example includes one non required field, "region."
 
 ```
-$ curl -X POST -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/ --data '{"name": "My New Site", "slug": "my-new-site"}'
+$ curl -X POST -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/ --data '{"name": "My New Site", "slug": "my-new-site", "region": 5}'
 {
     "id": 16,
     "name": "My New Site",
     "slug": "my-new-site",
-    "region": null,
+    "region": 5,
     "tenant": null,
     "facility": "",
     "asn": null,
@@ -101,21 +102,29 @@ $ curl -X POST -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0
     "comments": ""
 }
 ```
+Note that in this example we are creating a site bound to a region with the ID of 5. For write API actions (`POST`, `PUT`, and `PATCH`) the integer ID value is used for `ForeignKey` (related model) relationships, instead of the nested representation that is used in the `GET` (list) action.
 
 ### Modify an existing site
 
-Make an authenticated `PUT` request to the site detail endpoint. As with a create (POST) request, all mandatory fields must be included.
+Make an authenticated `PUT` request to the site detail endpoint. As with a create (`POST`) request, all mandatory fields must be included.
 
 ```
 $ curl -X PUT -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/16/ --data '{"name": "Renamed Site", "slug": "renamed-site"}'
 ```
 
+### Modify an object by changing a field
+
+Make an authenticated `PATCH` request to the device endpoint. With `PATCH`, unlike `POST` and `PUT`, we only specify the field that is being changed. In this example, we add a serial number to a device.
+```
+$ curl -X PATCH -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/devices/2549/ --data '{"serial": "FTX1123A090"}'
+```
+
 ### Delete an existing site
 
 Send an authenticated `DELETE` request to the site detail endpoint.
 
 ```
-$ curl -v X DELETE -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/16/
+$ curl -v -X DELETE -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9cdc0" -H "Content-Type: application/json" -H "Accept: application/json; indent=4" http://localhost:8000/api/dcim/sites/16/
 * Connected to localhost (127.0.0.1) port 8000 (#0)
 > DELETE /api/dcim/sites/16/ HTTP/1.1
 > User-Agent: curl/7.35.0
@@ -135,4 +144,4 @@ $ curl -v X DELETE -H "Authorization: Token d2f763479f703d80de0ec15254237bc651f9
 * Closing connection 0
 ```
 
-The response to a successfull `DELETE` request will have code 204 (No Content); the body of the response will be empty.
+The response to a successful `DELETE` request will have code 204 (No Content); the body of the response will be empty.

docs/api/overview.md

@@ -1,8 +1,42 @@
 NetBox v2.0 and later includes a full-featured REST API that allows its data model to be read and manipulated externally.
 
+# What is a REST API?
+
+REST stands for [representational state transfer](https://en.wikipedia.org/wiki/Representational_state_transfer). It's a particular type of API which employs HTTP to create, retrieve, update, and delete objects from a database. (This set of operations is commonly referred to as CRUD.) Each type of operation is associated with a particular HTTP verb:
+
+* `GET`: Retrieve an object or list of objects
+* `POST`: Create an object
+* `PUT` / `PATCH`: Modify an existing object. `PUT` requires all mandatory fields to be specified, while `PATCH` only expects the field that is being modified to be specified.
+* `DELETE`: Delete an existing object
+
+The NetBox API represents all objects in [JavaScript Object Notation (JSON)](http://www.json.org/). This makes it very easy to interact with NetBox data on the command line with common tools. For example, we can request an IP address from NetBox and output the JSON using `curl` and `jq`. (Piping the output through `jq` isn't strictly required but makes it much easier to read.)
+
+```
+$ curl -s http://localhost:8000/api/ipam/ip-addresses/2954/ | jq '.'
+{
+  "custom_fields": {},
+  "nat_outside": null,
+  "nat_inside": null,
+  "description": "An example IP address",
+  "id": 2954,
+  "family": 4,
+  "address": "5.101.108.132/26",
+  "vrf": null,
+  "tenant": null,
+  "status": {
+    "label": "Active",
+    "value": 1
+  },
+  "role": null,
+  "interface": null
+}
+```
+
+Each attribute of the NetBox object is expressed as a field in the dictionary. Fields may include their own nested objects, as in the case of the `status` field above. Every object includes a primary key named `id` which uniquely identifies it in the database.
+
 # URL Hierarchy
 
-NetBox's entire REST API is housed under the API root, `/api/`. The API's URL structure is divided at the root level by application: circuits, DCIM, extras, IPAM, secrets, and tenancy. Within each application, each model has its own path. For example, the provider and circuit objects are located under the "circuits" application:
+NetBox's entire API is housed under the API root at `https://<hostname>/api/`. The URL structure is divided at the root level by application: circuits, DCIM, extras, IPAM, secrets, and tenancy. Within each application, each model has its own path. For example, the provider and circuit objects are located under the "circuits" application:
 
 * /api/circuits/providers/
 * /api/circuits/circuits/
@@ -13,9 +47,9 @@ Likewise, the site, rack, and device objects are located under the "DCIM" applic
 * /api/dcim/racks/
 * /api/dcim/devices/
 
-The full hierarchy of available endpoints can be viewed by navigating to the API root (e.g. /api/) in a web browser.
+The full hierarchy of available endpoints can be viewed by navigating to the API root in a web browser.
 
-Each model generally has two URLs associated with it: a list URL and a detail URL. The list URL is used to request a list of multiple objects or to create a new object. The detail URL is used to retrieve, update, or delete an existing object. All objects are referenced by their numeric primary key (ID).
+Each model generally has two views associated with it: a list view and a detail view. The list view is used to request a list of multiple objects or to create a new object. The detail view is used to retrieve, update, or delete an existing object. All objects are referenced by their numeric primary key (`id`).
 
 * /api/dcim/devices/ - List devices or create a new device
 * /api/dcim/devices/123/ - Retrieve, update, or delete the device with ID 123
@@ -54,10 +88,10 @@ The base serializer is used to represent the default view of a model. This inclu
     "vid": 101,
     "name": "Users-Floor1",
     "tenant": null,
-    "status": [
-        1,
-        "Active"
-    ],
+    "status": {
+        "value": 1,
+        "label": "Active"
+    },
     "role": {
         "id": 9,
         "url": "http://localhost:8000/api/ipam/roles/9/",
@@ -70,7 +104,7 @@ The base serializer is used to represent the default view of a model. This inclu
 }
 ```
 
-Related objects (e.g. `ForeignKey` fields) are represented using a nested serializer. A nested serializer provides a minimal representation of an object, including only its URL and enough information to construct its name.
+Related objects (e.g. `ForeignKey` fields) are represented using a nested serializer. A nested serializer provides a minimal representation of an object, including only its URL and enough information to construct its name. When performing write api actions (`POST`, `PUT`, and `PATCH`), any `ForeignKey` relationships do not use the nested serializer, instead you will pass just the integer ID of the related model.  
 
 When a base serializer includes one or more nested serializers, the hierarchical structure precludes it from being used for write operations. Thus, a flat representation of an object may be provided using a writable serializer. This serializer includes only raw database values and is not typically used for retrieval, except as part of the response to the creation or updating of an object.
 
@@ -88,6 +122,37 @@ When a base serializer includes one or more nested serializers, the hierarchical
 }
 ```
 
+## Static Choice Fields
+
+Some model fields, such as the `status` field in the above example, utilize static integers corresponding to static choices. The available choices can be retrieved from the read-only `_choices` endpoint within each app. A specific `model:field` tuple may optionally be specified in the URL.
+
+Each choice includes a human-friendly label and its corresponding numeric value. For example, `GET /api/ipam/_choices/prefix:status/` will return:
+
+```
+[
+    {
+        "value": 0,
+        "label": "Container"
+    },
+    {
+        "value": 1,
+        "label": "Active"
+    },
+    {
+        "value": 2,
+        "label": "Reserved"
+    },
+    {
+        "value": 3,
+        "label": "Deprecated"
+    }
+]
+```
+
+Thus, to set a prefix's status to "Reserved," it would be assigned the integer `2`.
+
+A request for `GET /api/ipam/_choices/` will return choices for _all_ fields belonging to models within the IPAM app.
+
 # Pagination
 
 API responses which contain a list of objects (for example, a request to `/api/dcim/devices/`) will be paginated to avoid unnecessary overhead. The root JSON object will contain the following attributes:
@@ -136,3 +201,33 @@ The response will return devices 1 through 100. The URL provided in the `next` a
     "results": [...]
 }
 ```
+
+The maximum number of objects that can be returned is limited by the [`MAX_PAGE_SIZE`](../configuration/optional-settings/#max_page_size) setting, which is 1000 by default. Setting this to `0` or `None` will remove the maximum limit. An API consumer can then pass `?limit=0` to retrieve _all_ matching objects with a single request.
+
+!!! warning
+    Disabling the page size limit introduces a potential for very resource-intensive requests, since one API request can effectively retrieve an entire table from the database.
+
+# Filtering
+
+A list of objects retrieved via the API can be filtered by passing one or more query parameters. The same parameters used by the web UI work for the API as well. For example, to return only prefixes with a status of "Active" (`1`):
+
+```
+GET /api/ipam/prefixes/?status=1
+```
+
+The same filter can be incldued multiple times. These will effect a logical OR and return objects matching any of the given values. For example, the following will return all active and reserved prefixes:
+
+```
+GET /api/ipam/prefixes/?status=1&status=2
+```
+
+## Custom Fields
+
+To filter on a custom field, prepend `cf_` to the field name. For example, the following query will return only sites where a custom field named `foo` is equal to 123:
+
+```
+GET /api/dcim/sites/?cf_foo=123
+```
+
+!!! note
+    Full versus partial matching when filtering is configurable per custom field. Filtering can be toggled (or disabled) for a custom field in the admin UI.

docs/configuration/index.md

@@ -0,0 +1,16 @@
+# NetBox Configuration
+
+NetBox's local configuration is stored in `netbox/netbox/configuration.py`. An example configuration is provided at `netbox/netbox/configuration.example.py`. You may copy or rename the example configuration and make changes as appropriate. NetBox will not run without a configuration file.
+
+While NetBox has many configuration settings, only a few of them must be defined at the time of installation.
+
+* [Required settings](required-settings.md)
+* [Optional settings](optional-settings.md)
+
+## Changing the Configuration
+
+Configuration settings may be changed at any time. However, the NetBox service must be restarted before the changes will take effect:
+
+```no-highlight
+# sudo supervisorctl restart netbox
+```

docs/configuration/optional-settings.md

@@ -1,4 +1,4 @@
-The following are optional settings which may be declared in `netbox/netbox/configuration.py`.
+# Optional Configuration Settings
 
 ## ADMINS
 
@@ -17,7 +17,7 @@ ADMINS = [
 
 ## BANNER_BOTTOM
 
-Setting these variables will display content in a banner at the top and/or bottom of the page, respectively. To replicate the content of the top banner in the bottom banner, set:
+Setting these variables will display content in a banner at the top and/or bottom of the page, respectively. HTML is allowed. To replicate the content of the top banner in the bottom banner, set:
 
 ```
 BANNER_TOP = 'Your banner text'
@@ -26,6 +26,12 @@ BANNER_BOTTOM = BANNER_TOP
 
 ---
 
+## BANNER_LOGIN
+
+The value of this variable will be displayed on the login page above the login form. HTML is allowed.
+
+---
+
 ## BASE_PATH
 
 Default: None
@@ -38,6 +44,14 @@ BASE_PATH = 'netbox/'
 
 ---
 
+## CHANGELOG_RETENTION
+
+Default: 90
+
+The number of days to retain logged changes (object creations, updates, and deletions). Set this to `0` to retain changes in the database indefinitely. (Warning: This will greatly increase database size over time.)
+
+---
+
 ## CORS_ORIGIN_ALLOW_ALL
 
 Default: False
@@ -83,6 +97,34 @@ Enforcement of unique IP space can be toggled on a per-VRF basis. To enforce uni
 
 ---
 
+## LOGGING
+
+By default, all messages of INFO severity or higher will be logged to the console. Additionally, if `DEBUG` is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in `ADMINS`.
+
+The Django framework on which NetBox runs allows for the customization of logging, e.g. to write logs to file. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/1.11/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a file:
+
+```
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'file': {
+            'level': 'INFO',
+            'class': 'logging.FileHandler',
+            'filename': '/var/log/netbox.log',
+        },
+    },
+    'loggers': {
+        'django': {
+            'handlers': ['file'],
+            'level': 'INFO',
+        },
+    },
+}
+```
+
+---
+
 ## LOGIN_REQUIRED
 
 Default: False
@@ -91,6 +133,14 @@ Setting this to True will permit only authenticated users to access any part of
 
 ---
 
+## LOGIN_TIMEOUT
+
+Default: 1209600 seconds (14 days)
+
+The liftetime (in seconds) of the authentication cookie issued to a NetBox user upon login.
+
+---
+
 ## MAINTENANCE_MODE
 
 Default: False
@@ -99,11 +149,61 @@ Setting this to True will display a "maintenance mode" banner at the top of ever
 
 ---
 
-## NETBOX_USERNAME
+## MAX_PAGE_SIZE
 
-## NETBOX_PASSWORD
+Default: 1000
 
-If provided, NetBox will use these credentials to authenticate against devices when collecting data.
+An API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This setting defines the maximum limit. Setting it to `0` or `None` will allow an API consumer to request all objects by specifying `?limit=0`.
+
+---
+
+## MEDIA_ROOT
+
+Default: $BASE_DIR/netbox/media/
+
+The file path to the location where media files (such as image attachments) are stored. By default, this is the `netbox/media/` directory within the base NetBox installation path.
+
+---
+
+## NAPALM_USERNAME
+
+## NAPALM_PASSWORD
+
+NetBox will use these credentials when authenticating to remote devices via the [NAPALM library](https://napalm-automation.net/), if installed. Both parameters are optional.
+
+Note: If SSH public key authentication has been set up for the system account under which NetBox runs, these parameters are not needed.
+
+---
+
+## NAPALM_ARGS
+
+A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](http://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example:
+
+```
+NAPALM_ARGS = {
+    'api_key': '472071a93b60a1bd1fafb401d9f8ef41',
+    'port': 2222,
+}
+```
+
+Note: Some platforms (e.g. Cisco IOS) require an argument named `secret` to be passed in addition to the normal password. If desired, you can use the configured `NAPALM_PASSWORD` as the value for this argument:
+
+```
+NAPALM_USERNAME = 'username'
+NAPALM_PASSWORD = 'MySecretPassword'
+NAPALM_ARGS = {
+    'secret': NAPALM_PASSWORD,
+    # Include any additional args here
+}
+```
+
+---
+
+## NAPALM_TIMEOUT
+
+Default: 30 seconds
+
+The amount of time (in seconds) to wait for NAPALM to connect to a device.
 
 ---
 
@@ -123,6 +223,22 @@ When determining the primary IP address for a device, IPv6 is preferred over IPv
 
 ---
 
+## REPORTS_ROOT
+
+Default: $BASE_DIR/netbox/reports/
+
+The file path to the location where custom reports will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path.
+
+---
+
+## SESSION_FILE_PATH
+
+Default: None
+
+Session data is used to track authenticated users when they access NetBox. By default, NetBox stores session data in the PostgreSQL database. However, this inhibits authentication to a standby instance of NetBox without write access to the database. Alternatively, a local file path may be specified here and NetBox will store session data as files instead of using the database. Note that the user as which NetBox runs must have read and write permissions to this path.
+
+---
+
 ## TIME_ZONE
 
 Default: UTC
@@ -131,6 +247,14 @@ The time zone NetBox will use when dealing with dates and times. It is recommend
 
 ---
 
+## WEBHOOKS_ENABLED
+
+Default: False
+
+Enable this option to run the webhook backend. See the docs section on the webhook backend [here](../miscellaneous/webhooks/) for more information on setup and use.
+
+---
+
 ## Date and Time Formatting
 
 You may define custom formatting for date and times. For detailed instructions on writing format strings, please see [the Django documentation](https://docs.djangoproject.com/en/dev/ref/templates/builtins/#date).
@@ -145,3 +269,49 @@ SHORT_TIME_FORMAT = 'H:i:s'          # 13:23:00
 DATETIME_FORMAT = 'N j, Y g:i a'     # June 26, 2016 1:23 p.m.
 SHORT_DATETIME_FORMAT = 'Y-m-d H:i'  # 2016-06-27 13:23
 ```
+
+---
+
+## Redis Connection Settings
+
+[Redis](https://redis.io/) is a key-value store which functions as a very lightweight database. It is required when enabling NetBox [webhooks](../miscellaneous/webhooks/). A Redis connection is configured using a dictionary similar to the following:
+
+```
+REDIS = {
+    'HOST': 'localhost',
+    'PORT': 6379,
+    'PASSWORD': '',
+    'DATABASE': 0,
+    'DEFAULT_TIMEOUT': 300,
+}
+```
+
+### DATABASE
+
+Default: 0
+
+The Redis database ID.
+
+### DEFAULT_TIMEOUT
+
+Default: 300
+
+The timeout value to use when connecting to the Redis server (in seconds).
+
+### HOST
+
+Default: localhost
+
+The hostname or IP address of the Redis server.
+
+### PORT
+
+Default: 6379
+
+The TCP port to use when connecting to the Redis server.
+
+### PASSWORD
+
+Default: None
+
+The password to use when authenticating to the Redis server (optional).

docs/configuration/required-settings.md

@@ -1,4 +1,4 @@
-NetBox's local configuration is held in `netbox/netbox/configuration.py`. An example configuration is provided at `netbox/netbox/configuration.example.py`. You may copy or rename the example configuration and make changes as appropriate. NetBox will not run without a configuration file.
+# Required Configuration Settings
 
 ## ALLOWED_HOSTS
 

docs/core-functionality/circuits.md

@@ -1,18 +1,16 @@
-The circuits component of NetBox deals with the management of long-haul Internet and private transit links and providers.
-
 # Providers
 
 A provider is any entity which provides some form of connectivity. While this obviously includes carriers which offer Internet and private transit service, it might also include Internet exchange (IX) points and even organizations with whom you peer directly.
 
-Each provider may be assigned an autonomous system number (ASN), an account number, and contact information.
+Each provider may be assigned an autonomous system number (ASN), an account number, and relevant contact information.
 
 ---
 
 # Circuits
 
-A circuit represents a single physical data link connecting two endpoints. Each circuit belongs to a provider and must be assigned a circuit ID which is unique to that provider.
+A circuit represents a single _physical_ link connecting exactly two endpoints. (A circuit with more than two endpoints is a virtual circuit, which is not currently supported by NetBox.) Each circuit belongs to a provider and must be assigned a circuit ID which is unique to that provider.
 
-### Circuit Types
+## Circuit Types
 
 Circuits are classified by type. For example, you might define circuit types for:
 
@@ -23,11 +21,14 @@ Circuits are classified by type. For example, you might define circuit types for
 
 Circuit types are fully customizable.
 
-### Circuit Terminations
+## Circuit Terminations
 
 A circuit may have one or two terminations, annotated as the "A" and "Z" sides of the circuit. A single-termination circuit can be used when you don't know (or care) about the far end of a circuit (for example, an Internet access circuit which connects to a transit provider). A dual-termination circuit is useful for tracking circuits which connect two sites.
 
-Each circuit termination is tied to a site, and optionally to a specific device and interface within that site. Each termination can be assigned a separate downstream and upstream speed independent from one another. Fields are also available to track cross-connect and patch panel details.
+Each circuit termination is tied to a site, and may optionally be connected via a cable to a specific device interface or pass-through port. Each termination can be assigned a separate downstream and upstream speed independent from one another. Fields are also available to track cross-connect and patch panel details.
 
 !!! note
     A circuit represents a physical link, and cannot have more than two endpoints. When modeling a multi-point topology, each leg of the topology must be defined as a discrete circuit.
+
+!!! note
+    A circuit may terminate only to a physical interface. Circuits may not terminate to LAG interfaces, which are virtual interfaces: You must define each physical circuit within a service bundle separately and terminate it to its actual physical interface.

docs/core-functionality/devices.md

@@ -0,0 +1,144 @@
+# Device Types
+
+A device type represents a particular make and model of hardware that exists in the real world. Device types define the physical attributes of a device (rack height and depth) and its individual components (console, power, and network interfaces).
+
+Device types are instantiated as devices installed within racks. For example, you might define a device type to represent a Juniper EX4300-48T network switch with 48 Ethernet interfaces. You can then create multiple devices of this type named "switch1," "switch2," and so on. Each device will inherit the components (such as interfaces) of its device type at the time of creation. (However, changes made to a device type will **not** apply to instances of that device type retroactively.)
+
+Some devices house child devices which share physical resources, like space and power, but which functional independently from one another. A common example of this is blade server chassis. Each device type is designated as one of the following:
+
+* A parent device (which has device bays)
+* A child device (which must be installed in a device bay)
+* Neither
+
+!!! note
+    This parent/child relationship is **not** suitable for modeling chassis-based devices, wherein child members share a common control plane.
+
+## Manufacturers
+
+Each device type must be assigned to a manufacturer. The model number of a device type must be unique to its manufacturer.
+
+## Component Templates
+
+Each device type is assigned a number of component templates which define the physical components within a device. These are:
+
+* Console ports
+* Console server ports
+* Power ports
+* Power outlets
+* Network interfaces
+* Front ports
+* Rear ports
+* Device bays (which house child devices)
+
+Whenever a new device is created, its components are automatically created per the templates assigned to its device type. For example, a Juniper EX4300-48T device type might have the following component templates defined:
+
+* One template for a console port ("Console")
+* Two templates for power ports ("PSU0" and "PSU1")
+* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47")
+* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3")
+
+Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above.
+
+!!! note
+    Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components on existing devices.
+
+---
+
+# Devices
+
+Every piece of hardware which is installed within a rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth or full depth. A device may have a height of 0U: These devices do not consume vertical rack space and cannot be assigned to a particular rack unit. A common example of a 0U device is a vertically-mounted PDU.
+
+When assigning a multi-U device to a rack, it is considered to be mounted in the lowest-numbered rack unit which it occupies. For example, a 3U device which occupies U8 through U10 is said to be mounted in U8. This logic applies to racks with both ascending and descending unit numbering.
+
+A device is said to be full depth if its installation on one rack face prevents the installation of any other device on the opposite face within the same rack unit(s). This could be either because the device is physically too deep to allow a device behind it, or because the installation of an opposing device would impede airflow.
+
+## Device Components
+
+There are eight types of device components which comprise all of the interconnection logic with NetBox:
+
+* Console ports
+* Console server ports
+* Power ports
+* Power outlets
+* Network interfaces
+* Front ports
+* Rear ports
+* Device bays
+
+### Console
+
+Console ports connect only to console server ports. Console connections can be marked as either *planned* or *connected*.
+
+### Power
+
+Power ports connect only to power outlets. Power connections can be marked as either *planned* or *connected*.
+
+### Interfaces
+
+Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. Each type of connection can be classified as either *planned* or *connected*.
+
+Each interface is a assigned a form factor denoting its physical properties. Two special form factors exist: the "virtual" form factor can be used to designate logical interfaces (such as SVIs), and the "LAG" form factor can be used to desinate link aggregation groups to which physical interfaces can be assigned.
+
+Each interface can also be enabled or disabled, and optionally designated as management-only (for out-of-band management). Fields are also provided to store an interface's MTU and MAC address.
+
+VLANs can be assigned to each interface as either tagged or untagged. (An interface may have only one untagged VLAN.)
+
+### Pass-through Ports
+
+Pass-through ports are used to model physical terminations which comprise part of a longer path, such as a cable terminated to a patch panel. Each front port maps to a position on a rear port. A 24-port UTP patch panel, for instance, would have 24 front ports and 24 rear ports. Although this relationship is typically one-to-one, a rear port may have multiple front ports mapped to it. This can be useful for modeling instances where multiple paths share a common cable (for example, six different fiber connections sharing a 12-strand MPO cable).
+
+Pass-through ports can also be used to model "bump in the wire" devices, such as a media convertor or passive tap.
+
+### Device Bays
+
+Device bays represent the ability of a device to house child devices. For example, you might install four blade servers into a 2U chassis. The chassis would appear in the rack elevation as a 2U device with four device bays. Each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear within rack elevations, but they are included in the "Non-Racked Devices" list within the rack view.
+
+## Device Roles
+
+Devices can be organized by functional roles. These roles are fully customizable. For example, you might create roles for core switches, distribution switches, and access switches.
+
+---
+
+# Platforms
+
+A platform defines the type of software running on a device or virtual machine. This can be helpful when it is necessary to distinguish between, for instance, different feature sets. Note that two devices of the same type may be assigned different platforms: for example, one Juniper MX240 running Junos 14 and another running Junos 15.
+
+The platform model is also used to indicate which [NAPALM](https://napalm-automation.net/) driver NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform.
+
+The assignment of platforms to devices is an optional feature, and may be disregarded if not desired.
+
+---
+
+# Inventory Items
+
+Inventory items represent hardware components installed within a device, such as a power supply or CPU. Currently, these are used merely for inventory tracking, although future development might see their functionality expand. Like device types, each item can optionally be assigned a manufacturer.
+
+---
+
+# Virtual Chassis
+
+A virtual chassis represents a set of devices which share a single control plane: a stack of switches which are managed as a single device, for example. Each device in the virtual chassis is assigned a position and (optionally) a priority. Exactly one device is designated the virtual chassis master: This device will typically be assigned a name, secrets, services, and other attributes related to its management.
+
+It's important to recognize the distinction between a virtual chassis and a chassis-based device. For instance, a virtual chassis is not used to model a chassis switch with removable line cards such as the Juniper EX9208, as its line cards are _not_ physically separate devices capable of operating independently.
+
+---
+
+# Cables
+
+A cable represents a physical connection between two termination points, such as between a console port and a patch panel port, or between two network interfaces. Cables can be traced through pass-through ports to form a complete path between two endpoints. In the example below, three individual cables comprise a path between the two connected endpoints.
+
+```
+|<------------------------------------------ Cable Path ------------------------------------------->|
+
+  Device A                   Patch Panel A                 Patch Panel B                  Device B
++-----------+               +-------------+               +-------------+               +-----------+
+| Interface | --- Cable --- | Front Port  |               | Front Port  | --- Cable --- | Interface |
++-----------+               +-------------+               +-------------+               +-----------+
+                            +-------------+               +-------------+
+                            |  Rear Port  | --- Cable --- |  Rear Port  |
+                            +-------------+               +-------------+
+```
+
+All connections between device components in NetBox are represented using cables. However, defining the actual cable plant is optional: Components can be be directly connected using cables with no type or other attributes assigned.
+
+Cables are also used to associated ports and interfaces with circuit terminations. To do this, first create the circuit termination, then navigate the desired component and connect a cable between the two.

docs/core-functionality/ipam.md

@@ -0,0 +1,93 @@
+# Aggregates
+
+The first step to documenting your IP space is to define its scope by creating aggregates. Aggregates establish the root of your IP address hierarchy by defining the top-level allocations that you're interested in managing. Most organizations will want to track some commonly-used private IP spaces, such as:
+
+* 10.0.0.0/8 (RFC 1918)
+* 100.64.0.0/10 (RFC 6598)
+* 172.16.0.0/12 (RFC 1918)
+* 192.168.0.0/16 (RFC 1918)
+* One or more /48s within fd00::/8 (IPv6 unique local addressing)
+
+In addition to one or more of these, you'll want to create an aggregate for each globally-routable space your organization has been allocated. These aggregates should match the allocations recorded in public WHOIS databases.
+
+Each IP prefix will be automatically arranged under its parent aggregate if one exists. Note that it's advised to create aggregates only for IP ranges actually allocated to your organization (or marked for private use): There is no need to define aggregates for provider-assigned space which is only used on Internet circuits, for example.
+
+Aggregates cannot overlap with one another: They can only exist side-by-side. For instance, you cannot define both 10.0.0.0/8 and 10.16.0.0/16 as aggregates, because they overlap. 10.16.0.0/16 in this example would be created as a prefix and automatically grouped under 10.0.0.0/8. Remember, the purpose of aggregates is to establish the root of your IP addressing hierarchy.
+
+## Regional Internet Registries (RIRs)
+
+[Regional Internet registries](https://en.wikipedia.org/wiki/Regional_Internet_registry) are responsible for the allocation of globally-routable address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for internal use, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which "owns" certain address space. There also exist lower-tier registries which serve a particular geographic area.
+
+Each aggregate must be assigned to one RIR. You are free to define whichever RIRs you choose (or create your own). The RIR model includes a boolean flag which indicates whether the RIR allocates only private IP space.
+
+For example, suppose your organization has been allocated 104.131.0.0/16 by ARIN. It also makes use of RFC 1918 addressing internally. You would first create RIRs named ARIN and RFC 1918, then create an aggregate for each of these top-level prefixes, assigning it to its respective RIR.
+
+---
+
+# Prefixes
+
+A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address: All bits in the address not covered by the mask must be zero. (In other words, a prefix cannot be a specific IP address.)
+
+Prefixes are automatically arranged by their parent aggregates. Additionally, each prefix can be assigned to a particular site and VRF (routing table). All prefixes not assigned to a VRF will appear in the "global" table.
+
+Each prefix can be assigned a status and a role. These terms are often used interchangeably so it's important to recognize the difference between them. The **status** defines a prefix's operational state. Statuses are hard-coded in NetBox and can be one of the following:
+
+* Container - A summary of child prefixes
+* Active - Provisioned and in use
+* Reserved - Designated for future use
+* Deprecated - No longer in use
+
+On the other hand, a prefix's **role** defines its function. Role assignment is optional and roles are fully customizable. For example, you might create roles to differentiate between production and development infrastructure.
+
+A prefix may also be assigned to a VLAN. This association is helpful for identifying which prefixes are included when reviewing a list of VLANs.
+
+The prefix model include a "pool" flag. If enabled, NetBox will treat this prefix as a range (such as a NAT pool) wherein every IP address is valid and assignable. This logic is used for identifying available IP addresses within a prefix. If this flag is disabled, NetBox will assume that the first and last (broadcast) address within the prefix are unusable.
+
+---
+
+# IP Addresses
+
+An IP address comprises a single host address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world.
+
+Like prefixes, an IP address can optionally be assigned to a VRF (otherwise, it will appear in the "global" table). IP addresses are automatically organized under parent prefixes within their respective VRFs.
+
+Also like prefixes, each IP address can be assigned a status and a role. Statuses are hard-coded in NetBox and include the following:
+
+* Active
+* Reserved
+* Deprecated
+* DHCP
+
+Each IP address can optionally be assigned a special role. Roles are used to indicate some special attribute of an IP address: for example, it is used as a loopback, or is a virtual IP maintained using VRRP. (Note that this differs in purpose from a _functional_ role, and thus cannot be customized.) Available roles include:
+
+* Loopback
+* Secondary
+* Anycast
+* VIP
+* VRRP
+* HSRP
+* GLBP
+
+An IP address can be assigned to a device or virtual machine interface, and an interface may have multiple IP addresses assigned to it. Further, each device and virtual machine may have one of its interface IPs designated as its primary IP address (one for IPv4 and one for IPv6).
+
+## Network Address Translation (NAT)
+
+An IP address can be designated as the network address translation (NAT) inside IP address for exactly one other IP address. This is useful primarily to denote a translation between public and private IP addresses. This relationship is followed in both directions: For example, if 10.0.0.1 is assigned as the inside IP for 192.0.2.1, 192.0.2.1 will be displayed as the outside IP for 10.0.0.1.
+
+!!! note
+    NetBox does not support tracking one-to-many NAT relationships (also called port address translation). This type of policy requires additional logic to model and cannot be fully represented by IP address alone.
+
+---
+
+# Virtual Routing and Forwarding (VRF)
+
+A VRF object in NetBox represents a virtual routing and forwarding (VRF) domain. Each VRF is essentially a separate routing table. VRFs are commonly used to isolate customers or organizations from one another within a network, or to route overlapping address space (e.g. multiple instances of the 10.0.0.0/8 space).
+
+Each VRF is assigned a unique name and route distinguisher (RD). The RD is expected to take one of the forms prescribed in [RFC 4364](https://tools.ietf.org/html/rfc4364#section-4.2), however its formatting is not strictly enforced.
+
+Each prefix and IP address may be assigned to one (and only one) VRF. If you have a prefix or IP address which exists in multiple VRFs, you will need to create a separate instance of it in NetBox for each VRF. Any IP prefix or address not assigned to a VRF is said to belong to the "global" table.
+
+By default, NetBox will allow duplicate prefixes to be assigned to a VRF. This behavior can be disabled by setting the "enforce unique" flag on the VRF model.
+
+!!! note
+    Enforcement of unique IP space can be toggled for global table (non-VRF prefixes) using the `ENFORCE_GLOBAL_UNIQUE` configuration setting.

docs/core-functionality/secrets.md

@@ -1,14 +1,12 @@
-"Secrets" are small amounts of data that must be kept confidential; for example, passwords and SNMP community strings. NetBox provides encrypted storage of secret data.
-
 # Secrets
 
-A secret represents a single credential or other string which must be stored securely. Each secret is assigned to a device within NetBox. The plaintext value of a secret is encrypted to a ciphertext immediately prior to storage within the database using a 256-bit AES master key. A SHA256 hash of the plaintext is also stored along with each ciphertext to validate the decrypted plaintext.
+A secret represents a single credential or other sensitive string of characters which must be stored securely. Each secret is assigned to a device within NetBox. The plaintext value of a secret is encrypted to a ciphertext immediately prior to storage within the database using a 256-bit AES master key. A SHA256 hash of the plaintext is also stored along with each ciphertext to validate the decrypted plaintext.
 
 Each secret can also store an optional name parameter, which is not encrypted. This may be useful for storing user names.
 
-### Roles
+## Roles
 
-Each secret is assigned a functional role which indicates what it is used for. Typical roles might include:
+Each secret is assigned a functional role which indicates what it is used for. Secret roles are customizable. Typical roles might include:
 
 * Login credentials
 * SNMP community strings

docs/core-functionality/services.md

@@ -0,0 +1,5 @@
+# Services
+
+A service represents a layer four TCP or UDP service available on a device or virtual machine. For example, you might want to document that an HTTP service is running on a device. Each service includes a name, protocol, and port number; for example, "SSH (TCP/22)" or "DNS (UDP/53)."
+
+A service may optionally be bound to one or more specific IP addresses belonging to its parent device or VM. (If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.)

docs/core-functionality/sites-and-racks.md

@@ -0,0 +1,49 @@
+# Sites
+
+How you choose to use sites will depend on the nature of your organization, but typically a site will equate to a building or campus. For example, a chain of banks might create a site to represent each of its branches, a site for its corporate headquarters, and two additional sites for its presence in two colocation facilities.
+
+Each site must be assigned one of the following operational statuses:
+
+* Active
+* Planned
+* Retired
+
+The site model provides a facility ID field which can be used to annotate a facility ID (such as a datacenter name) associated with the site. Each site may also have an autonomous system (AS) number and time zone associated with it. (Time zones are provided by the [pytz](https://pypi.org/project/pytz/) package.)
+
+The site model also includes several fields for storing contact and address information.
+
+## Regions
+
+Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
+
+---
+
+# Racks
+
+The rack model represents a physical two- or four-post equipment rack in which equipment is mounted. Each rack must be assigned to a site. Rack height is measured in *rack units* (U); racks are commonly between 42U and 48U tall, but NetBox allows you to define racks of arbitrary height. A toggle is provided to indicate whether rack units are in ascending or descending order.
+
+Each rack is assigned a name and (optionally) a separate facility ID. This is helpful when leasing space in a data center your organization does not own: The facility will often assign a seemingly arbitrary ID to a rack (for example, "M204.313") whereas internally you refer to is simply as "R113." A unique serial number may also be associated with each rack.
+
+A rack must be designated as one of the following types:
+
+* 2-post frame
+* 4-post frame
+* 4-post cabinet
+* Wall-mounted frame
+* Wall-mounted cabinet
+
+Each rack has two faces (front and rear) on which devices can be mounted. Rail-to-rail width may be 19 or 23 inches.
+
+## Rack Groups
+
+Racks can be arranged into groups. As with sites, how you choose to designate rack groups will depend on the nature of your organization. For example, if each site represents a campus, each group might represent a building within a campus. If each site represents a building, each rack group might equate to a floor or room.
+
+Each rack group must be assigned to a parent site. Hierarchical recursion of rack groups is not currently supported.
+
+## Rack Roles
+
+Each rack can optionally be assigned a functional role. For example, you might designate a rack for compute or storage resources, or to house colocated customer devices. Rack roles are fully customizable.
+
+## Rack Space Reservations
+
+Users can reserve units within a rack for future use. Multiple non-contiguous rack units can be associated with a single reservation (but reservations cannot span multiple racks). A rack reservation may optionally designate a specific tenant.

docs/core-functionality/tenancy.md

@@ -0,0 +1,20 @@
+# Tenants
+
+A tenant represents a discrete entity for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. The following objects can be assigned to tenants:
+
+* Sites
+* Racks
+* Rack reservations
+* Devices
+* VRFs
+* Prefixes
+* IP addresses
+* VLANs
+* Circuits
+* Virtual machines
+
+Tenant assignment is used to signify ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate.
+
+### Tenant Groups
+
+Tenants can be organized by custom groups. For instance, you might create one group called "Customers" and one called "Acquisitions." The assignment of tenants to groups is optional.

docs/core-functionality/virtual-machines.md

@@ -0,0 +1,27 @@
+# Clusters
+
+A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type, and may optionally be assigned to a group and/or site.
+
+Physical devices may be associated with clusters as hosts. This allows users to track on which host(s) a particular VM may reside. However, NetBox does not support pinning a specific VM within a cluster to a particular host device.
+
+## Cluster Types
+
+A cluster type represents a technology or mechanism by which a cluster is formed. For example, you might create a cluster type named "VMware vSphere" for a locally hosted cluster or "DigitalOcean NYC3" for one hosted by a cloud provider.
+
+## Cluster Groups
+
+Cluster groups may be created for the purpose of organizing clusters. The assignment of clusters to groups is optional.
+
+---
+
+# Virtual Machines
+
+A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be associated with exactly one cluster.
+
+Like devices, each VM can be assigned a platform and have interfaces created on it. VM interfaces behave similarly to device interfaces, and can be assigned IP addresses, VLANs, and services. However, given their virtual nature, they cannot be connected to other interfaces. Unlike physical devices, VMs cannot be assigned console or power ports, device bays, or inventory items.
+
+The following resources can be defined for each VM:
+
+* vCPU count
+* Memory (MB)
+* Disk space (GB)

docs/core-functionality/vlans.md

@@ -0,0 +1,15 @@
+# VLANs
+
+A VLAN represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in [IEEE 802.1Q](https://en.wikipedia.org/wiki/IEEE_802.1Q). Each VLAN may be assigned to a site and/or VLAN group.
+
+Each VLAN must be assigned one of the following operational statuses:
+
+* Active
+* Reserved
+* Deprecated
+
+Each VLAN may also be assigned a functional role. Prefixes and VLANs share the same set of customizable roles.
+
+## VLAN Groups
+
+VLAN groups can be used to organize VLANs within NetBox. Groups can also be used to enforce uniqueness: Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs (including VLANs which belong to a common site). For example, you can create two VLANs with ID 123, but they cannot both be assigned to the same group.

docs/data-model/dcim.md

@@ -1,114 +0,0 @@
-Data center infrastructure management (DCIM) entails all physical assets: sites, racks, devices, cabling, etc.
-
-# Sites
-
-How you choose to use sites will depend on the nature of your organization, but typically a site will equate to a building or campus. For example, a chain of banks might create a site to represent each of its branches, a site for its corporate headquarters, and two additional sites for its presence in two colocation facilities.
-
-Sites can be assigned an optional facility ID to identify the actual facility housing colocated equipment, and an Autonomous System (AS) number.
-
-### Regions
-
-Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
-
----
-
-# Racks
-
-The rack model represents a physical two- or four-post equipment rack in which equipment is mounted. Each rack is assigned to a site. Rack height is measured in *rack units* (U); racks are commonly between 42U and 48U, but NetBox allows you to define racks of arbitrary height. Each rack has two faces (front and rear) on which devices can be mounted.
-
-Each rack is assigned a name and (optionally) a separate facility ID. This is helpful when leasing space in a data center your organization does not own: The facility will often assign a seemingly arbitrary ID to a rack (for example, "M204.313") whereas internally you refer to is simply as "R113." The facility ID can alternatively be used to store a rack's serial number.
-
-The available rack types include 2- and 4-post frames, 4-post cabinet, and wall-mounted frame and cabinet. Rail-to-rail width may be 19 or 23 inches.
-
-### Rack Groups
-
-Racks can be arranged into groups. As with sites, how you choose to designate rack groups will depend on the nature of your organization. For example, if each site represents a campus, each group might represent a building within a campus. If each site represents a building, each rack group might equate to a floor or room.
-
-Each group is assigned to a parent site for easy navigation. Hierarchical recursion of rack groups is not supported.
-
-### Rack Roles
-
-Each rack can optionally be assigned a functional role. For example, you might designate a rack for compute or storage resources, or to house colocated customer devices. Rack roles are fully customizable.
-
-### Rack Space Reservations
-
-Users can reserve units within a rack for future use. Multiple non-contiguous rack units can be associated with a single reservation (but reservations cannot span multiple racks).
-
----
-
-# Device Types
-
-A device type represents a particular hardware model that exists in the real world. Device types describe the physical attributes of a device (rack height and depth), its class (e.g. console server, PDU, etc.), and its individual components (console, power, and data).
-
-Device types are instantiated as devices installed within racks. For example, you might define a device type to represent a Juniper EX4300-48T network switch with 48 Ethernet interfaces. You can then create multiple devices of this type named "switch1," "switch2," and so on. Each device will inherit the components (such as interfaces) of its device type.
-
-### Manufacturers
-
-Each device type belongs to one manufacturer; e.g. Cisco, Opengear, or APC. The model number of a device type must be unique to its manufacturer.
-
-### Component Templates
-
-Each device type is assigned a number of component templates which define the physical interfaces a device has. These are:
-
-* Console ports
-* Console server ports
-* Power ports
-* Power outlets
-* Interfaces
-* Device bays
-
-Whenever a new device is created, it is automatically assigned components per the templates assigned to its device type. For example, a Juniper EX4300-48T device type might have the following component templates:
-
-* One template for a console port ("Console")
-* Two templates for power ports ("PSU0" and "PSU1")
-* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47")
-* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3")
-
-Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above.
-
-!!! note
-    Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components of existing devices individually.
-
----
-
-# Devices
-
-Every piece of hardware which is installed within a rack exists in NetBox as a device. Devices are measured in rack units (U) and depth. 0U devices which can be installed in a rack but don't consume vertical rack space (such as a vertically-mounted power distribution unit) can also be defined.
-
-When assigning a multi-U device to a rack, it is considered to be mounted in the lowest-numbered rack unit which it occupies. For example, a 3U device which occupies U8 through U10 shows as being mounted in U8. This logic applies to racks with both ascending and descending unit numbering.
-
-A device is said to be "full depth" if its installation on one rack face prevents the installation of any other device on the opposite face within the same rack unit(s). This could be either because the device is physically too deep to allow a device behind it, or because the installation of an opposing device would impede air flow.
-
-### Roles
-
-NetBox allows for the definition of arbitrary device roles by which devices can be organized. For example, you might create roles for core switches, distribution switches, and access switches. In the interest of simplicity, a device can belong to only one role.
-
-### Platforms
-
-A device's platform is used to denote the type of software running on it. This can be helpful when it is necessary to distinguish between, for instance, different feature sets. Note that two devices of same type may be assigned different platforms: for example, one Juniper MX240 running Junos 14 and another running Junos 15.
-
-The assignment of platforms to devices is an optional feature, and may be disregarded if not desired.
-
-### Inventory Items
-
-Inventory items represent hardware components installed within a device, such as a power supply or CPU. Currently, these are used merely for inventory tracking, although future development might see their functionality expand. Each item can optionally be assigned a manufacturer.
-
-!!! note
-    Prior to version 2.0, inventory items were called modules.
-
-### Components
-
-There are six types of device components which comprise all of the interconnection logic with NetBox:
-
-* Console ports
-* Console server ports
-* Power ports
-* Power outlets
-* Interfaces
-* Device bays
-
-Console ports connect only to console server ports, and power ports connect only to power outlets. Interfaces connect to one another in a symmetric manner: If interface A connects to interface B, interface B therefore connects to interface A. (The relationship between two interfaces is actually represented in the database by an InterfaceConnection object, but this is transparent to the user.) Each type of connection can be classified as either *planned* or *connected*. This allows for easily denoting connections which have not yet been installed.
-
-Each interface is a assigned a form factor denoting its physical properties. Two special form factors exist: the "virtual" form factor can be used to designate logical interfaces (such as SVIs), and the "LAG" form factor can be used to desinate link aggregation groups to which physical interfaces can be assigned. Each interface can also be designated as management-only (for out-of-band management) and assigned a short description.
-
-Device bays represent the ability of a device to house child devices. For example, you might install four blade servers into a 2U chassis. The chassis would appear in the rack elevation as a 2U device with four device bays. Each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear on rack elevations, but they are included in the "Non-Racked Devices" list within the rack view.

docs/data-model/extras.md

@@ -1,132 +0,0 @@
-This section entails features of NetBox which are not crucial to its primary functions, but provide additional value.
-
-# Custom Fields
-
-Each object in NetBox is represented in the database as a discrete table, and each attribute of an object exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows.
-
-However, some users might want to associate with objects attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number pointing to the support ticket that was opened to have it installed. This is certainly a legitimate use for NetBox, but it's perhaps not a common enough need to warrant expanding the internal data schema. Instead, you can create a custom field to hold this data.
-
-Custom fields must be created through the admin UI under Extras > Custom Fields. To create a new custom field, select the object(s) to which you want it to apply, and the type of field it will be. NetBox supports six field types:
-
-* Free-form text (up to 255 characters)
-* Integer
-* Boolean (true/false)
-* Date
-* URL
-* Selection
-
-Assign the field a name. This should be a simple database-friendly string, e.g. `tps_report`. You may optionally assign the field a human-friendly label (e.g. "TPS report") as well; the label will be displayed on forms. If a description is provided, it will appear beneath the field in a form.
-
-Marking the field as required will require the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields. (The default value has no effect for selection fields.)
-
-When creating a selection field, you should create at least two choices. These choices will be arranged first by weight, with lower weights appearing higher in the list, and then alphabetically.
-
-## Using Custom Fields
-
-When a single object is edited, the form will include any custom fields which have been defined for the object type. These fields are included in the "Custom Fields" panel. On the backend, each custom field value is saved separately from the core object as an independent database call, so it's best to avoid adding too many custom fields per object.
-
-When editing multiple objects, custom field values are saved in bulk. There is no significant difference in overhead when saving a custom field value for 100 objects versus one object. However, the bulk operation must be performed separately for each custom field.
-
-# Export Templates
-
-NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Extras > Export Templates under the admin interface.
-
-Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list.
-
-Export templates are written in [Django's template language](https://docs.djangoproject.com/en/1.9/ref/templates/language/), which is very similar to Jinja2. The list of objects returned from the database is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example:
-
-```
-{% for rack in queryset %}
-Rack: {{ rack.name }}
-Site: {{ rack.site.name }}
-Height: {{ rack.u_height }}U
-{% endfor %}
-```
-
-To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`.
-
-A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`.
-
-## Example
-
-Here's an example device export template that will generate a simple Nagios configuration from a list of devices.
-
-```
-{% for device in queryset %}{% if device.status and device.primary_ip %}define host{
-        use                     generic-switch
-        host_name               {{ device.name }}
-        address                 {{ device.primary_ip.address.ip }}
-}
-{% endif %}{% endfor %}
-```
-
-The generated output will look something like this:
-
-```
-define host{
-        use                     generic-switch
-        host_name               switch1
-        address                 192.0.2.1
-}
-define host{
-        use                     generic-switch
-        host_name               switch2
-        address                 192.0.2.2
-}
-define host{
-        use                     generic-switch
-        host_name               switch3
-        address                 192.0.2.3
-}
-```
-
-# Graphs
-
-NetBox does not have the ability to generate graphs natively, but this feature allows you to embed contextual graphs from an external resources (such as a monitoring system) inside the site, provider, and interface views. Each embedded graph must be defined with the following parameters:
-
-* **Type:** Site, provider, or interface. This determines in which view the graph will be displayed.
-* **Weight:** Determines the order in which graphs are displayed (lower weights are displayed first). Graphs with equal weights will be ordered alphabetically by name.
-* **Name:** The title to display above the graph.
-* **Source URL:** The source of the image to be embedded. The associated object will be available as a template variable named `obj`.
-* **Link URL (optional):** A URL to which the graph will be linked. The associated object will be available as a template variable named `obj`.
-
-## Examples
-
-You only need to define one graph object for each graph you want to include when viewing an object. For example, if you want to include a graph of traffic through an interface over the past five minutes, your graph source might looks like this:
-
-```
-https://my.nms.local/graphs/?node={{ obj.device.name }}&interface={{ obj.name }}&duration=5m
-```
-
-You can define several graphs to provide multiple contexts when viewing an object. For example:
-
-```
-https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
-https://my.nms.local/graphs/?type=throughput&node={{ obj.device.name }}&interface={{ obj.name }}&duration=24h
-https://my.nms.local/graphs/?type=errors&node={{ obj.device.name }}&interface={{ obj.name }}&duration=60m
-```
-
-# Topology Maps
-
-NetBox can generate simple topology maps from the physical network connections recorded in its database. First, you'll need to create a topology map definition under the admin UI at Extras > Topology Maps.
-
-Each topology map is associated with a site. A site can have multiple topology maps, which might each illustrate a different aspect of its infrastructure (for example, production versus backend infrastructure).
-
-To define the scope of a topology map, decide which devices you want to include. The map will only include interface connections with both points terminated on an included device. Specify the devices to include in the **device patterns** field by entering a list of [regular expressions](https://en.wikipedia.org/wiki/Regular_expression) matching device names. For example, if you wanted to include "mgmt-switch1" through "mgmt-switch99", you might use the regex `mgmt-switch\d+`.
-
-Each line of the **device patterns** field represents a hierarchical layer within the topology map. For example, you might map a traditional network with core, distribution, and access tiers like this:
-
-```
-core-switch-[abcd]
-dist-switch\d
-access-switch\d+,oob-switch\d+
-```
-
-Note that you can combine multiple regexes onto one line using semicolons. The order in which regexes are listed on a line is significant: devices matching the first regex will be rendered first, and subsequent groups will be rendered to the right of those.
-
-# Image Attachments
-
-Certain objects within NetBox (namely sites, racks, and devices) can have photos or other images attached to them. (Note that _only_ image files are supported.) Each attachment may optionally be assigned a name; if omitted, the attachment will be represented by its file name.
-
-!!! note
-    If you experience a server error while attempting to upload an image attachment, verify that the system user NetBox runs as has write permission to the media root directory (`netbox/media/`).

docs/data-model/ipam.md

@@ -1,99 +0,0 @@
-IP address management (IPAM) entails the allocation of IP networks, addresses, and related numeric resources.
-
-# VRFs
-
-A VRF object in NetBox represents a virtual routing and forwarding (VRF) domain within a network. Each VRF is essentially a separate routing table: the same IP prefix or address can exist in multiple VRFs. VRFs are commonly used to isolate customers or organizations from one another within a network.
-
-Each VRF is assigned a name and a unique route distinguisher (RD). VRFs are an optional feature of NetBox: Any IP prefix or address not assigned to a VRF is said to belong to the "global" table.
-
-!!! note
-    By default, NetBox allows for overlapping IP space both in the global table and within each VRF. Unique space enforcement can be toggled per-VRF as well as in the global table using the `ENFORCE_GLOBAL_UNIQUE` configuration setting.
-
----
-
-# Aggregates
-
-IP address space is organized as a hierarchy, with more-specific (smaller) prefixes arranged as child nodes under less-specific (larger) prefixes. For example:
-
-* 10.0.0.0/8
-    * 10.1.0.0/16
-        * 10.1.2.0/24
-
-The root of the IPv4 hierarchy is 0.0.0.0/0, which encompasses all possible IPv4 addresses (and similarly, ::/0 for IPv6). However, even the largest organizations use only a small fraction of the global address space. Therefore, it makes sense to track in NetBox only the address space which is of interest to your organization.
-
-Aggregates serve as arbitrary top-level nodes in the IP space hierarchy. They allow you to easily construct your IP scheme without any clutter of unused address space. For instance, most organizations utilize some portion of the private IPv4 space set aside in RFC 1918. So, you might define three aggregates for this space:
-
-* 10.0.0.0/8
-* 172.16.0.0/12
-* 192.168.0.0/16
-
-Additionally, you might define an aggregate for each large swath of public IPv4 space your organization uses. You'd also create aggregates for both globally routable and unique local IPv6 space. (Most organizations will not have a need to track IPv6 link local space.)
-
-Prefixes you create in NetBox (discussed below) will be automatically organized under their respective aggregates. Any space within an aggregate which is not covered by an existing prefix will be annotated as available for allocation. Total utilization for each aggregate is displayed in the aggregates list.
-
-Aggregates cannot overlap with one another; they can only exist in parallel. For instance, you cannot define both 10.0.0.0/8 and 10.16.0.0/16 as aggregates, because they overlap. 10.16.0.0/16 in this example would be created as a prefix and automatically grouped under 10.0.0.0/8.
-
-### RIRs
-
-Regional Internet Registries (RIRs) are responsible for the allocation of global address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for private or internal use only, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which "owns" certain address space.
-
-Each aggregate must be assigned to one RIR. You are free to define whichever RIRs you choose (or create your own). Each RIR can be annotated as representing only private space.
-
----
-
-# Prefixes
-
-A prefix is an IPv4 or IPv6 network and mask expressed in CIDR notation (e.g. 192.0.2.0/24). A prefix entails only the "network portion" of an IP address; all bits in the address not covered by the mask must be zero.
-
-Each prefix may be assigned to one VRF; prefixes not assigned to a VRF are assigned to the "global" table. Prefixes are also organized under their respective aggregates, irrespective of VRF assignment.
-
-A prefix may optionally be assigned to one VLAN; a VLAN may have multiple prefixes assigned to it. Each prefix may also be assigned a short description.
-
-### Statuses
-
-Each prefix is assigned an operational status. This is one of the following:
-
-* Container - A summary of child prefixes
-* Active - Provisioned and in use
-* Reserved - Designated for future use
-* Deprecated - No longer in use
-
-### Roles
-
-Whereas a status describes a prefix's operational state, a role describes its function. For example, roles might include:
-
-* Access segment
-* Infrastructure
-* NAT
-* Lab
-* Out-of-band
-
-Role assignment is optional and roles are fully customizable.
-
----
-
-# IP Addresses
-
-An IP address comprises a single address (either IPv4 or IPv6) and its subnet mask. Its mask should match exactly how the IP address is configured on an interface in the real world.
-
-Like prefixes, an IP address can optionally be assigned to a VRF (or it will appear in the "global" table). IP addresses are automatically organized under parent prefixes within their respective VRFs. Each IP address can also be assigned a short description.
-
-An IP address can be assigned to a device's interface; an interface may have multiple IP addresses assigned to it. Further, each device may have one of its interface IPs designated as its primary IP address (for both IPv4 and IPv6).
-
-One IP address can be designated as the network address translation (NAT) IP address for exactly one other IP address. This is useful primarily to denote the public address for a private internal IP. Tracking one-to-many NAT (or PAT) assignments is not supported.
-
----
-
-# VLANs
-
-A VLAN represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in [IEEE 802.1Q](https://en.wikipedia.org/wiki/IEEE_802.1Q). Each VLAN may be assigned to a site and/or VLAN group. Like prefixes, each VLAN is assigned an operational status and (optionally) a functional role, and may include a short description.
-
-### VLAN Groups
-
-VLAN groups can be employed for administrative organization within NetBox. Each VLAN within a group must have a unique ID and name. VLANs which are not assigned to a group may have overlapping names and IDs, including within a site.
-
----
-
-# Services
-
-A service represents a TCP or UDP service available on a device. Each service must be defined with a name, protocol, and port number; for example, "SSH (TCP/22)." A service may optionally be bound to one or more specific IP addresses belonging to a device. (If no IP addresses are bound, the service is assumed to be reachable via any assigned IP address.)

docs/data-model/tenancy.md

@@ -1,20 +0,0 @@
-NetBox supports the assignment of resources to tenant organizations. Typically, these are used to represent individual customers of or internal departments within the organization using NetBox.
-
-# Tenants
-
-A tenant represents a discrete organization. The following objects can be assigned to tenants:
-
-* Sites
-* Racks
-* Devices
-* VRFs
-* Prefixes
-* IP addresses
-* VLANs
-* Circuits
-
-If a prefix or IP address is not assigned to a tenant, it will appear to inherit the tenant to which its parent VRF is assigned, if any.
-
-### Tenant Groups
-
-Tenants can be grouped by type. For instance, you might create one group called "Customers" and one called "Acquisitions." The assignment of tenants to groups is optional.

docs/development/extending-models.md

@@ -0,0 +1,74 @@
+# Extending Models
+
+Below is a list of items to consider when adding a new field to a model:
+
+### 1. Generate and run database migration
+
+Django migrations are used to express changes to the database schema. In most cases, Django can generate these automatically, however very complex changes may require manual intervention. Always remember to specify a short but descriptive name when generating a new migration.
+
+```
+./manage.py makemigrations <app> -n <name>
+./manage.py migrate
+```
+
+Where possible, try to merge related changes into a single migration. For example, if three new fields are being added to different models within an app, these can be expressed in the same migration. You can merge a new migration with an existing one by combining their `operations` lists.
+
+!!! note
+    Migrations can only be merged within a release. Once a new release has been published, its migrations cannot be altered.
+
+### 2. Add validation logic to `clean()`
+
+If the new field introduces additional validation requirements (beyond what's included with the field itself), implement them in the model's `clean()` method. Remember to call the model's original method using `super()` before or agter your custom validation as appropriate:
+
+```
+class Foo(models.Model):
+
+    def clean(self):
+
+        super(DeviceCSVForm, self).clean()
+
+        # Custom validation goes here
+        if self.bar is None:
+            raise ValidationError()
+```
+
+### 3. Add CSV helpers
+
+Add the name of the new field to `csv_headers` and included a CSV-friendly representation of its data in the model's `to_csv()` method. These will be used when exporting objects in CSV format.
+
+### 4. Update relevant querysets
+
+If you're adding a relational field (e.g. `ForeignKey`) and intend to include the data when retreiving a list of objects, be sure to include the field using `select_related()` or `prefetch_related()` as appropriate. This will optimize the view and avoid excessive database lookups.
+
+### 5. Update API serializer
+
+Extend the model's API serializer in `<app>.api.serializers` to include the new field. In most cases, it will not be necessary to also extend the nested serializer, which produces a minimal represenation of the model.
+
+### 6. Add choices to API view
+
+If the new field has static choices, add it to the `FieldChoicesViewSet` for the app.
+
+### 7. Add field to forms
+
+Extend any forms to include the new field as appropriate. Common forms include:
+
+* **Credit/edit** - Manipulating a single object
+* **Bulk edit** - Performing a change on mnay objects at once
+* **CSV import** - The form used when bulk importing objects in CSV format
+* **Filter** - Displays the options available for filtering a list of objects (both UI and API)
+
+### 8. Extend object filter set
+
+If the new field should be filterable, add it to the `FilterSet` for the model. If the field should be searchable, remember to reference it in the FilterSet's `search()` method.
+
+### 9. Add column to object table
+
+If the new field will be included in the object list view, add a column to the model's table. For simple fields, adding the field name to `Meta.fields` will be sufficient. More complex fields may require explicitly declaring a new column.
+
+### 10. Update the UI templates
+
+Edit the object's view template to display the new field. There may also be a custom add/edit form template that needs to be updated.
+
+### 11. Adjust API and model tests
+
+Extend the model and/or API tests to verify that the new field and any accompanying validation logic perform as expected. This is especially important for relational fields.

docs/development/index.md

@@ -0,0 +1,30 @@
+# NetBox Development
+
+NetBox is maintained as a [GitHub project](https://github.com/digitalocean/netbox) under the Apache 2 license. Users are encouraged to submit GitHub issues for feature requests and bug reports, however we are very selective about pull requests. Please see the `CONTRIBUTING` guide for more direction on contributing to NetBox.
+
+## Communication
+
+Communication among developers should always occur via public channels:
+
+* [GitHub issues](https://github.com/digitalocean/netbox/issues) - All feature requests, bug reports, and other substantial changes to the code base **must** be documented in an issue.
+* [The mailing list](https://groups.google.com/forum/#!forum/netbox-discuss) - The preferred forum for general discussion and support issues. Ideal for shaping a feature request prior to submitting an issue.
+* [#netbox on NetworkToCode](http://slack.networktocode.com/) - Good for quick chats. Avoid any discussion that might need to be referenced later on, as the chat history is not retained long.
+
+## Governance
+
+NetBox follows the [benevolent dictator](http://oss-watch.ac.uk/resources/benevolentdictatorgovernancemodel) model of governance, with [Jeremy Stretch](https://github.com/jeremystretch) ultimately responsible for all changes to the code base. While community contributions are welcomed and encouraged, the lead maintainer's primary role is to ensure the project's long-term maintainability and continued focus on its primary functions (in other words, avoid scope creep).
+
+## Project Structure
+
+All development of the current NetBox release occurs in the `develop` branch; releases are packaged from the `master` branch. The `master` branch should _always_ represent the current stable release in its entirety, such that installing NetBox by either downloading a packaged release or cloning the `master` branch provides the same code base.
+
+NetBox components are arranged into functional subsections called _apps_ (a carryover from Django verancular). Each app holds the models, views, and templates relevant to a particular function:
+
+* `circuits`: Communications circuits and providers (not to be confused with power circuits)
+* `dcim`: Datacenter infrastructure management (sites, racks, and devices)
+* `extras`: Additional features not considered part of the core data model
+* `ipam`: IP address management (VRFs, prefixes, IP addresses, and VLANs)
+* `secrets`: Encrypted storage of sensitive data (e.g. login credentials)
+* `tenancy`: Tenants (such as customers) to which NetBox objects may be assigned
+* `utilities`: Resources which are not user-facing (extendable classes, etc.)
+* `virtualization`: Virtual machines and clusters

docs/development/release-checklist.md

@@ -0,0 +1,81 @@
+# Minor Version Bumps
+
+## Update Requirements
+
+Required Python packages are maintained in two files. `base_requirements.txt` contains a list of all the packages required by NetBox. Some of them may be pinned to a specific version of the package due to a known issue. For example:
+
+```
+# https://github.com/encode/django-rest-framework/issues/6053
+djangorestframework==3.8.1
+```
+
+The other file is `requirements.txt`, which lists each of the required packages pinned to its current stable version. When NetBox is installed, the Python environment is configured to match this file. This helps ensure that a new release of a dependency doesn't break NetBox.
+
+Every minor version release should refresh `requirements.txt` so that it lists the most recent stable release of each package. To do this:
+
+1. Create a new virtual environment.
+2. Install the latest version of all required packages via pip:
+
+```
+pip install -U -r base_requirements.txt
+```
+
+3. Run all tests and check that the UI and API function as expected.
+4. Update the package versions in `requirements.txt` as appropriate.
+
+## Update Static Libraries
+
+Update the following static libraries to their most recent stable release:
+
+* Bootstrap 3
+* Font Awesome 4
+* jQuery
+* jQuery UI
+
+## Manually Perform a New Install
+
+Create a new installation of NetBox by following [the current documentation](http://netbox.readthedocs.io/en/latest/). This should be a manual process, so that issues with the documentation can be identified and corrected.
+
+## Close the Release Milestone
+
+Close the release milestone on GitHub. Ensure that there are no remaining open issues associated with it.
+
+---
+
+# All Releases
+
+## Verify CI Build Status
+
+Ensure that continuous integration testing on the `develop` branch is completing successfully.
+
+## Update Version and Changelog
+
+Update the `VERSION` constant in `settings.py` to the new release version and add the current date to the release notes in `CHANGELOG.md`.
+
+## Submit a Pull Request
+
+Submit a pull request title **"Release vX.Y.X"** to merge the `develop` branch into `master`. Include a brief change log listing the features, improvements, and/or bugs addressed in the release.
+
+Once CI has completed on the PR, merge it.
+
+## Create a New Release
+
+Draft a [new release](https://github.com/digitalocean/netbox/releases/new) with the following parameters.
+
+* **Tag:** Current version (e.g. `v2.3.4`)
+* **Target:** `master`
+* **Title:** Version and date (e.g. `v2.3.4 - 2018-08-02`)
+
+Copy the description from the pull request into the release notes.
+
+## Update the Development Version
+
+On the `develop` branch, update `VERSION` in `settings.py` to point to the next release. For example, if you just released v2.3.4, set:
+
+```
+VERSION = 'v2.3.5-dev'
+```
+
+## Announce the Release
+
+Announce the release on the [mailing list](https://groups.google.com/forum/#!forum/netbox-discuss). Include a link to the release and the (HTML-formatted) release notes.

docs/development/style-guide.md

@@ -0,0 +1,54 @@
+# Style Guide
+
+NetBox generally follows the [Django style guide](https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/coding-style/), which is itself based on [PEP 8](https://www.python.org/dev/peps/pep-0008/). [Pycodestyle](https://github.com/pycqa/pycodestyle) is used to validate code formatting, ignoring certain violations. See `scripts/cibuild.sh`.
+
+## PEP 8 Exceptions
+
+* Wildcard imports (for example, `from .constants import *`) are acceptable under any of the following conditions:
+    * The library being import contains only constant declarations (`constants.py`)
+    * The library being imported explicitly defines `__all__` (e.g. `<app>.api.nested_serializers`)
+
+* Maximum line length is 120 characters (E501)
+    * This does not apply to HTML templates or to automatically generated code (e.g. database migrations).
+
+* Line breaks are permitted following binary operators (W504)
+
+## Enforcing Code Style
+
+The `pycodestyle` utility (previously `pep8`) is used by the CI process to enforce code style. It is strongly recommended to include as part of your commit process. A git commit hook is provided in the source at `scripts/git-hooks/pre-commit`. Linking to this script from `.git/hooks/` will invoke `pycodestyle` prior to every commit attempt and abort if the validation fails.
+
+```
+$ cd .git/hooks/
+$ ln -s ../../scripts/git-hooks/pre-commit
+```
+
+To invoke `pycodestyle` manually, run:
+
+```
+pycodestyle --ignore=W504,E501 netbox/
+```
+
+## Introducing New Dependencies
+
+The introduction of a new dependency is best avoided unless it is absolutely necessary. For small features, it's generally preferable to replicate functionality within the NetBox code base rather than to introduce reliance on an external project. This reduces both the burden of tracking new releases and our exposure to outside bugs and attacks.
+
+If there's a strong case for introducing a new depdency, it must meet the following criteria:
+
+* Its complete source code must be published and freely accessible without registration.
+* Its license must be conducive to inclusion in an open source project.
+* It must be actively maintained, with no longer than one year between releases.
+* It must be available via the [Python Package Index](https://pypi.org/) (PyPI).
+
+When adding a new dependency, a short description of the package and the URL of its code repository must be added to `base_requirements.txt`. Additionally, a line specifying the package name pinned to the current stable release must be added to `requirements.txt`. This ensures that NetBox will install only the known-good release and simplify support efforts.
+
+## General Guidance
+
+* When in doubt, remain consistent: It is better to be consistently incorrect than inconsistently correct. If you notice in the course of unrelated work a pattern that should be corrected, continue to follow the pattern for now and open a bug so that the entire code base can be evaluated at a later point.
+
+* No easter eggs. While they can be fun, NetBox must be considered as a business-critical tool. The potential, however minor, for introducing a bug caused by unnecessary logic is best avoided entirely.
+
+* Constants (variables which generally do not change) should be declared in `constants.py` within each app. Wildcard imports from the file are acceptable.
+
+* Every model should have a docstring. Every custom method should include an expalantion of its function.
+
+* Nested API serializers generate minimal representations of an object. These are stored separately from the primary serializers to avoid circular dependencies. Always import nested serializers from other apps directly. For example, from within the DCIM app you would write `from ipam.api.nested_serializers import NestedIPAddressSerializer`.

docs/development/utility-views.md

@@ -0,0 +1,53 @@
+# Utility Views
+
+Utility views are reusable views that handle common CRUD tasks, such as listing and updating objects. Some views operate on individual objects, whereas others (referred to as "bulk" views) operate on multiple objects at once.
+
+## Individual Views
+
+### ObjectListView
+
+Generates a paginated table of objects from a given queryset, which may optionally be filtered.
+
+### ObjectEditView
+
+Updates an object identified by a primary key (PK) or slug. If no existing object is specified, a new object will be created.
+
+### ObjectDeleteView
+
+Deletes an object. The user is redirected to a confirmation page before the deletion is executed.
+
+## Bulk Views
+
+### BulkCreateView
+
+Creates multiple objects at once based on a given pattern. Currently used only for IP addresses.
+
+### BulkImportView
+
+Accepts CSV-formatted data and creates a new object for each line. Creation is all-or-none.
+
+### BulkEditView
+
+Applies changes to multiple objects at once in a two-step operation. First, the list of PKs for selected objects is POSTed and an edit form is presented to the user. On submission of that form, the specified changes are made to all selected objects.
+
+### BulkDeleteView
+
+Deletes multiple objects. The user selects the objects to be deleted and confirms the deletion.
+
+## Component Views
+
+### ComponentCreateView
+
+Create one or more component objects beloning to a parent object (e.g. interfaces attached to a device).
+
+### ComponentEditView
+
+A subclass of `ObjectEditView`: Updates an individual component object.
+
+### ComponentDeleteView
+
+A subclass of `ObjectDeleteView`: Deletes an individual component object.
+
+### BulkComponentCreateView
+
+Create a set of components objects for each of a selected set of parent objects. This view can be used e.g. to create multiple interfaces on multiple devices at once.

docs/index.md

@@ -1,3 +1,5 @@
+![NetBox](netbox_logo.png "NetBox logo")
+
 # What is NetBox?
 
 NetBox is an open source web application designed to help manage and document computer networks. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically to address the needs of network and infrastructure engineers. It encompasses the following aspects of network management:
@@ -6,10 +8,11 @@ NetBox is an open source web application designed to help manage and document co
 * **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
 * **Secrets** - Encrypted storage of sensitive credentials
 
-# What NetBox Isn't
+# What NetBox Is Not
 
 While NetBox strives to cover many areas of network management, the scope of its feature set is necessarily limited. This ensures that development focuses on core functionality and that scope creep is reasonably contained. To that end, it might help to provide some examples of functionality that NetBox **does not** provide:
 
@@ -41,13 +44,15 @@ When given a choice between a relatively simple [80% solution](https://en.wikipe
 
 NetBox is built on the [Django](https://djangoproject.com/) Python framework and utilizes a [PostgreSQL](https://www.postgresql.org/) database. It runs as a WSGI service behind your choice of HTTP server.
 
-| Function     | Component         |
-|--------------|-------------------|
-| HTTP Service | nginx or Apache   |
-| WSGI Service | gunicorn or uWSGI |
-| Application  | Django/Python     |
-| Database     | PostgreSQL        |
+| Function           | Component         |
+|--------------------|-------------------|
+| HTTP service       | nginx or Apache   |
+| WSGI service       | gunicorn or uWSGI |
+| Application        | Django/Python     |
+| Database           | PostgreSQL 9.4+   |
+| Task queuing       | Redis/django-rq   |
+| Live device access | NAPALM            |
 
 # Getting Started
 
-See the [installation guide](installation/postgresql.md) for help getting NetBox up and running quickly.
+See the [installation guide](installation/index.md) for help getting NetBox up and running quickly.

docs/installation/1-postgresql.md

@@ -0,0 +1,71 @@
+NetBox requires a PostgreSQL database to store data. This can be hosted locally or on a remote server. (Please note that MySQL is not supported, as NetBox leverages PostgreSQL's built-in [network address types](https://www.postgresql.org/docs/current/static/datatype-net-types.html).)
+
+!!! note
+    The installation instructions provided here have been tested to work on Ubuntu 18.04 and CentOS 7.5. The particular commands needed to install dependencies on other distributions may vary significantly. Unfortunately, this is outside the control of the NetBox maintainers. Please consult your distribution's documentation for assistance with any errors.
+
+!!! warning
+    NetBox v2.2 and later requires PostgreSQL 9.4 or higher.
+
+# Installation
+
+**Ubuntu**
+
+If a recent enough version of PostgreSQL is not available through your distribution's package manager, you'll need to install it from an official [PostgreSQL repository](https://wiki.postgresql.org/wiki/Apt).
+
+```no-highlight
+# apt-get update
+# apt-get install -y postgresql libpq-dev
+```
+
+**CentOS**
+
+CentOS 7.5 does not ship with a recent enough version of PostgreSQL, so it will need to be installed from an external repository. The instructions below show the installation of PostgreSQL 9.6.
+
+```no-highlight
+# yum install https://download.postgresql.org/pub/repos/yum/9.6/redhat/rhel-7-x86_64/pgdg-centos96-9.6-3.noarch.rpm
+# yum install postgresql96 postgresql96-server postgresql96-devel
+# /usr/pgsql-9.6/bin/postgresql96-setup initdb
+```
+
+CentOS users should modify the PostgreSQL configuration to accept password-based authentication by replacing `ident` with `md5` for all host entries within `/var/lib/pgsql/9.6/data/pg_hba.conf`. For example:
+
+```no-highlight
+host    all             all             127.0.0.1/32            md5
+host    all             all             ::1/128                 md5
+```
+
+Then, start the service and enable it to run at boot:
+
+```no-highlight
+# systemctl start postgresql-9.6
+# systemctl enable postgresql-9.6
+```
+
+# Database Creation
+
+At a minimum, we need to create a database for NetBox and assign it a username and password for authentication. This is done with the following commands.
+
+!!! danger
+    DO NOT USE THE PASSWORD FROM THE EXAMPLE.
+
+```no-highlight
+# sudo -u postgres psql
+psql (9.4.5)
+Type "help" for help.
+
+postgres=# CREATE DATABASE netbox;
+CREATE DATABASE
+postgres=# CREATE USER netbox WITH PASSWORD 'J5brHrAXFLQSif0K';
+CREATE ROLE
+postgres=# GRANT ALL PRIVILEGES ON DATABASE netbox TO netbox;
+GRANT
+postgres=# \q
+```
+
+You can verify that authentication works issuing the following command and providing the configured password. (Replace `localhost` with your database server if using a remote database.)
+
+```no-highlight
+# psql -U netbox -W -h localhost netbox
+```
+
+If successful, you will enter a `netbox` prompt. Type `\q` to exit.

docs/installation/2-netbox.md

@@ -1,36 +1,20 @@
 # Installation
 
-**Debian/Ubuntu**
+This section of the documentation discusses installing and configuring the NetBox application.
 
-Python 3:
+**Ubuntu**
 
 ```no-highlight
-# apt-get install -y python3 python3-dev python3-pip libxml2-dev libxslt1-dev libffi-dev graphviz libpq-dev libssl-dev
-# update-alternatives --install /usr/bin/python python /usr/bin/python3 1
+# apt-get install -y python3 python3-pip python3-dev build-essential libxml2-dev libxslt1-dev libffi-dev graphviz libpq-dev libssl-dev zlib1g-dev
 ```
 
-Python 2:
-
-```no-highlight
-# apt-get install -y python2.7 python-dev python-pip libxml2-dev libxslt1-dev libffi-dev graphviz libpq-dev libssl-dev
-```
-
-**CentOS/RHEL**
-
-Python 3:
+**CentOS**
 
 ```no-highlight
 # yum install -y epel-release
-# yum install -y gcc python34 python34-devel python34-setuptools libxml2-devel libxslt-devel libffi-devel graphviz openssl-devel
-# easy_install-3.4 pip
-# ln -s -f python3.4 /usr/bin/python
-```
-
-Python 2:
-
-```no-highlight
-# yum install -y epel-release
-# yum install -y gcc python2 python-devel python-pip libxml2-devel libxslt-devel libffi-devel graphviz openssl-devel
+# yum install -y gcc python36 python36-devel python36-setuptools libxml2-devel libxslt-devel libffi-devel graphviz openssl-devel redhat-rpm-config
+# easy_install-3.6 pip
+# ln -s /usr/bin/python36 /usr/bin/python3
 ```
 
 You may opt to install NetBox either from a numbered release or by cloning the master branch of its repository on GitHub.
@@ -57,13 +41,13 @@ Create the base directory for the NetBox installation. For this guide, we'll use
 
 If `git` is not already installed, install it:
 
-**Debian/Ubuntu**
+**Ubuntu**
 
 ```no-highlight
 # apt-get install -y git
 ```
 
-**CentOS/RHEL**
+**CentOS**
 
 ```no-highlight
 # yum install -y git
@@ -82,20 +66,50 @@ Resolving deltas: 100% (1495/1495), done.
 Checking connectivity... done.
 ```
 
-## Install Python Packages
+!!! warning
+    Ensure that the media directory (`/opt/netbox/netbox/media/` in this example) and all its subdirectories are writable by the user account as which NetBox runs. If the NetBox process does not have permission to write to this directory, attempts to upload files (e.g. image attachments) will fail. (The appropriate user account will vary by platform.)
+
+    `# chown -R netbox:netbox /opt/netbox/netbox/media/`
+
+# Install Python Packages
 
 Install the required Python packages using pip. (If you encounter any compilation errors during this step, ensure that you've installed all of the system dependencies listed above.)
 
-Python 3:
-
 ```no-highlight
 # pip3 install -r requirements.txt
 ```
 
-Python 2:
+!!! note
+    If you encounter errors while installing the required packages, check that you're running a recent version of pip (v9.0.1 or higher) with the command `pip3 -V`.
+
+## NAPALM Automation (Optional)
+
+NetBox supports integration with the [NAPALM automation](https://napalm-automation.net/) library. NAPALM allows NetBox to fetch live data from devices and return it to a requester via its REST API. Installation of NAPALM is optional. To enable it, install the `napalm` package using pip or pip3:
 
 ```no-highlight
-# pip install -r requirements.txt
+# pip3 install napalm
+```
+
+## Webhooks (Optional)
+
+[Webhooks](../data-model/extras/#webhooks) allow NetBox to integrate with external services by pushing out a notification each time a relevant object is created, updated, or deleted. Enabling the webhooks feature requires [Redis](https://redis.io/), a lightweight in-memory database. You may opt to install a Redis sevice locally (see below) or connect to an external one.
+
+**Ubuntu**
+
+```no-highlight
+# apt-get install -y redis-server
+```
+
+**CentOS**
+
+```no-highlight
+# yum install -y redis
+```
+
+Enabling webhooks also requires installing the [`django-rq`](https://github.com/ui/django-rq) package. This allows NetBox to use the Redis database as a queue for outgoing webhooks.
+
+```no-highlight
+# pip3 install django-rq
 ```
 
 # Configuration
@@ -148,13 +162,28 @@ You may use the script located at `netbox/generate_secret_key.py` to generate a
 !!! note
     In the case of a highly available installation with multiple web servers, `SECRET_KEY` must be identical among all servers in order to maintain a persistent user session state.
 
+## Webhooks Configuration
+
+If you have opted to enable the webhooks, set `WEBHOOKS_ENABLED = True` and define the relevant `REDIS` database parameters. Below is an example:
+
+```python
+WEBHOOKS_ENABLED = True
+REDIS = {
+    'HOST': 'localhost',
+    'PORT': 6379,
+    'PASSWORD': '',
+    'DATABASE': 0,
+    'DEFAULT_TIMEOUT': 300,
+}
+```
+
 # Run Database Migrations
 
-Before NetBox can run, we need to install the database schema. This is done by running `./manage.py migrate` from the `netbox` directory (`/opt/netbox/netbox/` in our example):
+Before NetBox can run, we need to install the database schema. This is done by running `python3 manage.py migrate` from the `netbox` directory (`/opt/netbox/netbox/` in our example):
 
 ```no-highlight
 # cd /opt/netbox/netbox/
-# ./manage.py migrate
+# python3 manage.py migrate
 Operations to perform:
   Apply all migrations: dcim, sessions, admin, ipam, utilities, auth, circuits, contenttypes, extras, secrets, users
 Running migrations:
@@ -172,7 +201,7 @@ If this step results in a PostgreSQL authentication error, ensure that the usern
 NetBox does not come with any predefined user accounts. You'll need to create a super user to be able to log into NetBox:
 
 ```no-highlight
-# ./manage.py createsuperuser
+# python3 manage.py createsuperuser
 Username: admin
 Email address: admin@example.com
 Password:
@@ -183,7 +212,7 @@ Superuser created successfully.
 # Collect Static Files
 
 ```no-highlight
-# ./manage.py collectstatic --no-input
+# python3 manage.py collectstatic --no-input
 
 You have requested to collect static files at the destination
 location as specified in your settings:
@@ -204,7 +233,7 @@ NetBox ships with some initial data to help you get started: RIR definitions, co
     This step is optional. It's perfectly fine to start using NetBox without using this initial data if you'd rather create everything from scratch.
 
 ```no-highlight
-# ./manage.py loaddata initial_data
+# python3 manage.py loaddata initial_data
 Installed 43 object(s) from 4 fixture(s)
 ```
 
@@ -213,17 +242,17 @@ Installed 43 object(s) from 4 fixture(s)
 At this point, NetBox should be able to run. We can verify this by starting a development instance:
 
 ```no-highlight
-# ./manage.py runserver 0.0.0.0:8000 --insecure
+# python3 manage.py runserver 0.0.0.0:8000 --insecure
 Performing system checks...
 
 System check identified no issues (0 silenced).
-June 17, 2016 - 16:17:36
-Django version 1.9.7, using settings 'netbox.settings'
+November 28, 2018 - 09:33:45
+Django version 2.0.9, using settings 'netbox.settings'
 Starting development server at http://0.0.0.0:8000/
 Quit the server with CONTROL-C.
 ```
 
-Now if we navigate to the name or IP of the server (as defined in `ALLOWED_HOSTS`) we should be greeted with the NetBox home page. Note that this built-in web service is for development and testing purposes only. **It is not suited for production use.**
+Next, connect to the name or IP of the server (as defined in `ALLOWED_HOSTS`) on port 8000; for example, <http://127.0.0.1:8000/>. You should be greeted with the NetBox home page. Note that this built-in web service is for development and testing purposes only. **It is not suited for production use.**
 
 !!! warning
     If the test service does not run, or you cannot reach the NetBox home page, something has gone wrong. Do not proceed with the rest of this guide until the installation has been corrected.

docs/installation/3-http-daemon.md

@@ -1,13 +1,9 @@
-# Web Server Installation
-
 We'll set up a simple WSGI front end using [gunicorn](http://gunicorn.org/) for the purposes of this guide. For web servers, we provide example configurations for both [nginx](https://www.nginx.com/resources/wiki/) and [Apache](http://httpd.apache.org/docs/2.4). (You are of course free to use whichever combination of HTTP and WSGI services you'd like.) We'll also use [supervisord](http://supervisord.org/) to enable service persistence.
 
 !!! info
-    Only Debian/Ubuntu instructions are provided here, but the installation process for CentOS/RHEL does not differ much. Please consult the documentation for those distributions for details.
+    For the sake of brevity, only Ubuntu 18.04 instructions are provided here, but this sort of web server and WSGI configuration is not unique to NetBox. Please consult your distribution's documentation for assistance if needed.
 
-```no-highlight
-# apt-get install -y gunicorn supervisor
-```
+# Web Server Installation
 
 ## Option A: nginx
 
@@ -25,7 +21,7 @@ server {
 
     server_name netbox.example.com;
 
-    access_log off;
+    client_max_body_size 25m;
 
     location /static/ {
         alias /opt/netbox/netbox/static/;
@@ -55,12 +51,12 @@ Restart the nginx service to use the new configuration.
 # service nginx restart
 ```
 
-To enable SSL, consider this guide on [securing nginx with Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-14-04).
+To enable SSL, consider this guide on [securing nginx with Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-16-04).
 
 ## Option B: Apache
 
 ```no-highlight
-# apt-get install -y apache2
+# apt-get install -y apache2 libapache2-mod-wsgi-py3
 ```
 
 Once Apache is installed, proceed with the following configuration (Be sure to modify the `ServerName` appropriately):
@@ -73,6 +69,9 @@ Once Apache is installed, proceed with the following configuration (Be sure to m
 
     Alias /static /opt/netbox/netbox/static
 
+    # Needed to allow token-based API authentication
+    WSGIPassAuthorization on
+
     <Directory /opt/netbox/netbox/static>
         Options Indexes FollowSymLinks MultiViews
         AllowOverride None
@@ -83,6 +82,7 @@ Once Apache is installed, proceed with the following configuration (Be sure to m
         ProxyPass !
     </Location>
 
+    RequestHeader set "X-Forwarded-Proto" expr=%{REQUEST_SCHEME}
     ProxyPass / http://127.0.0.1:8001/
     ProxyPassReverse / http://127.0.0.1:8001/
 </VirtualHost>
@@ -93,14 +93,21 @@ Save the contents of the above example in `/etc/apache2/sites-available/netbox.c
 ```no-highlight
 # a2enmod proxy
 # a2enmod proxy_http
+# a2enmod headers
 # a2ensite netbox
 # service apache2 restart
 ```
 
-To enable SSL, consider this guide on [securing Apache with Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-14-04).
+To enable SSL, consider this guide on [securing Apache with Let's Encrypt](https://www.digitalocean.com/community/tutorials/how-to-secure-apache-with-let-s-encrypt-on-ubuntu-16-04).
 
 # gunicorn Installation
 
+Install gunicorn:
+
+```no-highlight
+# pip3 install gunicorn
+```
+
 Save the following configuration in the root netbox installation path as `gunicorn_config.py` (e.g. `/opt/netbox/gunicorn_config.py` per our example installation). Be sure to verify the location of the gunicorn executable on your server (e.g. `which gunicorn`) and to update the `pythonpath` variable if needed. If using CentOS/RHEL, change the username from `www-data` to `nginx` or `apache`.
 
 ```no-highlight
@@ -113,6 +120,12 @@ user = 'www-data'
 
 # supervisord Installation
 
+Install supervisor:
+
+```no-highlight
+# apt-get install -y supervisor
+```
+
 Save the following as `/etc/supervisor/conf.d/netbox.conf`. Update the `command` and `directory` paths as needed. If using CentOS/RHEL, change the username from `www-data` to `nginx` or `apache`.
 
 ```no-highlight
@@ -120,6 +133,11 @@ Save the following as `/etc/supervisor/conf.d/netbox.conf`. Update the `command`
 command = gunicorn -c /opt/netbox/gunicorn_config.py netbox.wsgi
 directory = /opt/netbox/netbox/
 user = www-data
+
+[program:netbox-rqworker]
+command = python3 /opt/netbox/netbox/manage.py rqworker
+directory = /opt/netbox/netbox/
+user = www-data
 ```
 
 Then, restart the supervisor service to detect and run the gunicorn service:

docs/installation/4-ldap.md

@@ -1,5 +1,4 @@
-This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to
-built-in Django users in the event of a failure.
+This guide explains how to implement LDAP authentication using an external server. User authentication will fall back to built-in Django users in the event of a failure.
 
 # Requirements
 
@@ -8,27 +7,30 @@ built-in Django users in the event of a failure.
 On Ubuntu:
 
 ```no-highlight
-sudo apt-get install -y python-dev libldap2-dev libsasl2-dev libssl-dev
+sudo apt-get install -y libldap2-dev libsasl2-dev libssl-dev
 ```
 
 On CentOS:
 
 ```no-highlight
-sudo yum install -y python-devel openldap-devel
+sudo yum install -y openldap-devel
 ```
 
 ## Install django-auth-ldap
 
 ```no-highlight
-sudo pip install django-auth-ldap
+pip3 install django-auth-ldap
 ```
 
 # Configuration
 
-Create a file in the same directory as `configuration.py` (typically `netbox/netbox/`) named `ldap_config.py`. Define all of the parameters required below in `ldap_config.py`.
+Create a file in the same directory as `configuration.py` (typically `netbox/netbox/`) named `ldap_config.py`. Define all of the parameters required below in `ldap_config.py`. Complete documentation of all `django-auth-ldap` configuration options is included in the project's [official documentation](http://django-auth-ldap.readthedocs.io/).
 
 ## General Server Configuration
 
+!!! info
+    When using Windows Server 2012 you may need to specify a port on `AUTH_LDAP_SERVER_URI`. Use `3269` for secure, or `3268` for non-secure.
+
 ```python
 import ldap
 
@@ -50,8 +52,13 @@ AUTH_LDAP_BIND_PASSWORD = "demo"
 LDAP_IGNORE_CERT_ERRORS = True
 ```
 
+STARTTLS can be configured by setting `AUTH_LDAP_START_TLS = True` and using the `ldap://` URI scheme.
+
 ## User Authentication
 
+!!! info
+    When using Windows Server 2012, `AUTH_LDAP_USER_DN_TEMPLATE` should be set to None.
+
 ```python
 from django_auth_ldap.config import LDAPSearch
 
@@ -67,17 +74,20 @@ AUTH_LDAP_USER_DN_TEMPLATE = "uid=%(user)s,ou=users,dc=example,dc=com"
 # You can map user attributes to Django attributes as so.
 AUTH_LDAP_USER_ATTR_MAP = {
     "first_name": "givenName",
-    "last_name": "sn"
+    "last_name": "sn",
+    "email": "mail"
 }
 ```
 
 # User Groups for Permissions
+!!! info
+    When using Microsoft Active Directory, support for nested groups can be activated by using `NestedGroupOfNamesType()` instead of `GroupOfNamesType()` for `AUTH_LDAP_GROUP_TYPE`. You will also need to modify the import line to use `NestedGroupOfNamesType` instead of `GroupOfNamesType` .
 
 ```python
 from django_auth_ldap.config import LDAPSearch, GroupOfNamesType
 
 # This search ought to return all groups to which the user belongs. django_auth_ldap uses this to determine group
-# heirarchy.
+# hierarchy.
 AUTH_LDAP_GROUP_SEARCH = LDAPSearch("dc=example,dc=com", ldap.SCOPE_SUBTREE,
                                     "(objectClass=group)")
 AUTH_LDAP_GROUP_TYPE = GroupOfNamesType()
@@ -99,3 +109,7 @@ AUTH_LDAP_FIND_GROUP_PERMS = True
 AUTH_LDAP_CACHE_GROUPS = True
 AUTH_LDAP_GROUP_CACHE_TIMEOUT = 3600
 ```
+
+* `is_active` - All users must be mapped to at least this group to enable authentication. Without this, users cannot log in.
+* `is_staff` - Users mapped to this group are enabled for access to the administration tools; this is the equivalent of checking the "staff status" box on a manually created user. This doesn't grant any specific permissions.
+* `is_superuser` - Users mapped to this group will be granted superuser status. Superusers are implicitly granted all permissions.

docs/installation/index.md

@@ -0,0 +1,14 @@
+# Installation
+
+The following sections detail how to set up a new instance of NetBox:
+
+1. [PostgreSQL database](1-postgresql.md)
+2. [NetBox components](2-netbox.md)
+3. [HTTP dameon](3-http-daemon.md)
+4. [LDAP authentication](4-ldap.md) (optional)
+
+# Upgrading
+
+If you are upgrading from an existing installation, please consult the [upgrading guide](upgrading.md).
+
+NetBox v2.5 and later requires Python 3.5 or higher. Please see the instructions for [migrating to Python 3](migrating-to-python3.md) if you are still using Python 2.

docs/installation/migrating-to-python3.md

@@ -0,0 +1,44 @@
+# Migration
+
+!!! warning
+    Beginning with v2.5, NetBox will no longer support Python 2. It is strongly recommended that you upgrade to Python 3 as soon as possible.
+
+## Ubuntu
+
+Remove the Python2 version of gunicorn:
+
+```no-highlight
+# pip uninstall -y gunicorn
+```
+
+Install Python3 and pip3, Python's package management tool:
+
+```no-highlight
+# apt-get update
+# apt-get install -y python3 python3-dev python3-setuptools
+# easy_install3 pip
+```
+
+Install the Python3 packages required by NetBox:
+
+```no-highlight
+# pip3 install -r requirements.txt
+```
+
+Replace gunicorn with the Python3 version:
+
+```no-highlight
+# pip3 install gunicorn
+```
+
+If using LDAP authentication, install the `django-auth-ldap` package:
+
+```no-highlight
+# pip3 install django-auth-ldap
+```
+
+If using Webhooks, install the `django-rq` package:
+
+```no-highlight
+# pip3 install django-rq
+```

docs/installation/postgresql.md

@@ -1,59 +0,0 @@
-NetBox requires a PostgreSQL database to store data. (Please note that MySQL is not supported, as NetBox leverages PostgreSQL's built-in [network address types](https://www.postgresql.org/docs/9.1/static/datatype-net-types.html).)
-
-# Installation
-
-**Debian/Ubuntu**
-
-```no-highlight
-# apt-get update
-# apt-get install -y postgresql libpq-dev
-```
-
-**CentOS/RHEL**
-
-```no-highlight
-# yum install -y postgresql postgresql-server postgresql-devel
-# postgresql-setup initdb
-```
-
-CentOS users should modify the PostgreSQL configuration to accept password-based authentication by replacing `ident` with `md5` for all host entries within `/var/lib/pgsql/data/pg_hba.conf`. For example:
-
-```no-highlight
-host    all             all             127.0.0.1/32            md5
-host    all             all             ::1/128                 md5
-```
-
-Then, start the service:
-
-```no-highlight
-# systemctl start postgresql
-```
-
-# Database Creation
-
-At a minimum, we need to create a database for NetBox and assign it a username and password for authentication. This is done with the following commands.
-
-!!! danger
-    DO NOT USE THE PASSWORD FROM THE EXAMPLE.
-
-```no-highlight
-# sudo -u postgres psql
-psql (9.3.13)
-Type "help" for help.
-
-postgres=# CREATE DATABASE netbox;
-CREATE DATABASE
-postgres=# CREATE USER netbox WITH PASSWORD 'J5brHrAXFLQSif0K';
-CREATE ROLE
-postgres=# GRANT ALL PRIVILEGES ON DATABASE netbox TO netbox;
-GRANT
-postgres=# \q
-```
-
-You can verify that authentication works issuing the following command and providing the configured password:
-
-```no-highlight
-# psql -U netbox -h localhost -W
-```
-
-If successful, you will enter a `postgres` prompt. Type `\q` to exit.

docs/installation/upgrading.md

@@ -12,25 +12,37 @@ Download and extract the latest version:
 # wget https://github.com/digitalocean/netbox/archive/vX.Y.Z.tar.gz
 # tar -xzf vX.Y.Z.tar.gz -C /opt
 # cd /opt/
-# ln -sf netbox-X.Y.Z/ netbox
+# ln -sfn netbox-X.Y.Z/ netbox
 ```
 
 Copy the 'configuration.py' you created when first installing to the new version:
 
 ```no-highlight
-# cp /opt/netbox-X.Y.Z/netbox/netbox/configuration.py /opt/netbox/netbox/netbox/configuration.py
+# cp netbox-X.Y.Z/netbox/netbox/configuration.py netbox/netbox/netbox/configuration.py
+```
+
+Be sure to replicate your uploaded media as well. (The exact action necessary will depend on where you choose to store your media, but in general moving or copying the media directory will suffice.)
+
+```no-highlight
+# cp -pr netbox-X.Y.Z/netbox/media/ netbox/netbox/
+```
+
+Also make sure to copy over any reports that you've made. Note that if you made them in a separate directory (`/opt/netbox-reports` for example), then you will not need to copy them - the config file that you copied earlier will point to the correct location.
+
+```no-highlight
+# cp -r /opt/netbox-X.Y.X/netbox/reports /opt/netbox/netbox/reports/
 ```
 
 If you followed the original installation guide to set up gunicorn, be sure to copy its configuration as well:
 
 ```no-highlight
-# cp /opt/netbox-X.Y.Z/gunicorn_config.py /opt/netbox/gunicorn_config.py
+# cp netbox-X.Y.Z/gunicorn_config.py netbox/gunicorn_config.py
 ```
 
 Copy the LDAP configuration if using LDAP:
 
 ```no-highlight
-# cp /opt/netbox-X.Y.Z/netbox/netbox/ldap_config.py /opt/netbox/netbox/netbox/ldap_config.py
+# cp netbox-X.Y.Z/netbox/netbox/ldap_config.py netbox/netbox/netbox/ldap_config.py
 ```
 
 ## Option B: Clone the Git Repository (latest master release)
@@ -58,6 +70,14 @@ This script:
 * Applies any database migrations that were included in the release
 * Collects all static files to be served by the HTTP service
 
+!!! note
+    It's possible that the upgrade script will display a notice warning of unreflected database migrations:
+
+        Your models have changes that are not yet reflected in a migration, and so won't be applied.
+        Run 'manage.py makemigrations' to make new migrations, and then re-run 'manage.py migrate' to apply them.
+
+    This may occur due to semantic differences in environment, and can be safely ignored. Never attempt to create new migrations unless you are intentionally modifying the database schema.
+
 # Restart the WSGI Service
 
 Finally, restart the WSGI service to run the new code. If you followed this guide for the initial installation, this is done using `supervisorctl`:
@@ -65,3 +85,9 @@ Finally, restart the WSGI service to run the new code. If you followed this guid
 ```no-highlight
 # sudo supervisorctl restart netbox
 ```
+
+If using webhooks, also restart the Redis worker:
+
+```no-highlight
+# sudo supervisorctl restart netbox-rqworker
+```

mkdocs.yml

@@ -1,28 +1,55 @@
 site_name: NetBox
+theme: readthedocs
+repo_url: https://github.com/digitalocean/netbox
 
 pages:
-    - 'Introduction': 'index.md'
-    - 'Installation':
-        - 'PostgreSQL': 'installation/postgresql.md'
-        - 'NetBox': 'installation/netbox.md'
-        - 'Web Server': 'installation/web-server.md'
-        - 'LDAP (Optional)': 'installation/ldap.md'
-        - 'Upgrading': 'installation/upgrading.md'
-    - 'Configuration':
-        - 'Mandatory Settings': 'configuration/mandatory-settings.md'
-        - 'Optional Settings': 'configuration/optional-settings.md'
-    - 'Data Model':
-        - 'Circuits': 'data-model/circuits.md'
-        - 'DCIM': 'data-model/dcim.md'
-        - 'IPAM': 'data-model/ipam.md'
-        - 'Secrets': 'data-model/secrets.md'
-        - 'Tenancy': 'data-model/tenancy.md'
-        - 'Extras': 'data-model/extras.md'
-    - 'API':
-        - 'Overview': 'api/overview.md'
-        - 'Authentication': 'api/authentication.md'
-        - 'Working with Secrets': 'api/working-with-secrets.md'
-        - 'Examples': 'api/examples.md'
+    - Introduction: 'index.md'
+    - Installation:
+        - Installing NetBox: 'installation/index.md'
+        - 1. PostgreSQL: 'installation/1-postgresql.md'
+        - 2. NetBox: 'installation/2-netbox.md'
+        - 3. HTTP Daemon: 'installation/3-http-daemon.md'
+        - 4. LDAP (Optional): 'installation/4-ldap.md'
+        - Upgrading NetBox: 'installation/upgrading.md'
+        - Migrating to Python3: 'installation/migrating-to-python3.md'
+    - Configuration:
+        - Configuring NetBox: 'configuration/index.md'
+        - Required Settings: 'configuration/required-settings.md'
+        - Optional Settings: 'configuration/optional-settings.md'
+    - Core Functionality:
+        - IP Address Management: 'core-functionality/ipam.md'
+        - VLANs: 'core-functionality/vlans.md'
+        - Sites and Racks: 'core-functionality/sites-and-racks.md'
+        - Devices: 'core-functionality/devices.md'
+        - Virtual Machines: 'core-functionality/virtual-machines.md'
+        - Services: 'core-functionality/services.md'
+        - Circuits: 'core-functionality/circuits.md'
+        - Secrets: 'core-functionality/secrets.md'
+        - Tenancy: 'core-functionality/tenancy.md'
+    - Additional Features:
+        - Tags: 'additional-features/tags.md'
+        - Custom Fields: 'additional-features/custom-fields.md'
+        - Context Data: 'additional-features/context-data.md'
+        - Export Templates: 'additional-features/export-templates.md'
+        - Graphs: 'additional-features/graphs.md'
+        - Topology Maps: 'additional-features/topology-maps.md'
+        - Reports: 'additional-features/reports.md'
+        - Webhooks: 'additional-features/webhooks.md'
+        - Change Logging: 'additional-features/change-logging.md'
+    - Administration:
+        - Replicating NetBox: 'administration/replicating-netbox.md'
+        - NetBox Shell: 'administration/netbox-shell.md'
+    - API:
+        - Overview: 'api/overview.md'
+        - Authentication: 'api/authentication.md'
+        - Working with Secrets: 'api/working-with-secrets.md'
+        - Examples: 'api/examples.md'
+    - Development:
+        - Introduction: 'development/index.md'
+        - Style Guide: 'development/style-guide.md'
+        - Utility Views: 'development/utility-views.md'
+        - Extending Models: 'development/extending-models.md'
+        - Release Checklist: 'development/release-checklist.md'
 
 markdown_extensions:
     - admonition:

netbox/circuits/api/nested_serializers.py

@@ -0,0 +1,52 @@
+from rest_framework import serializers
+
+from circuits.models import Circuit, CircuitTermination, CircuitType, Provider
+from utilities.api import WritableNestedSerializer
+
+__all__ = [
+    'NestedCircuitSerializer',
+    'NestedCircuitTerminationSerializer',
+    'NestedCircuitTypeSerializer',
+    'NestedProviderSerializer',
+]
+
+
+#
+# Providers
+#
+
+class NestedProviderSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:provider-detail')
+
+    class Meta:
+        model = Provider
+        fields = ['id', 'url', 'name', 'slug']
+
+
+#
+# Circuits
+#
+
+class NestedCircuitTypeSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittype-detail')
+
+    class Meta:
+        model = CircuitType
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedCircuitSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuit-detail')
+
+    class Meta:
+        model = Circuit
+        fields = ['id', 'url', 'cid']
+
+
+class NestedCircuitTerminationSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittermination-detail')
+    circuit = NestedCircuitSerializer()
+
+    class Meta:
+        model = CircuitTermination
+        fields = ['id', 'url', 'circuit', 'term_side']

netbox/circuits/api/serializers.py

@@ -1,117 +1,64 @@
-from rest_framework import serializers
+from taggit_serializer.serializers import TaggitSerializer, TagListSerializerField
 
+from circuits.constants import CIRCUIT_STATUS_CHOICES
 from circuits.models import Provider, Circuit, CircuitTermination, CircuitType
-from dcim.api.serializers import NestedSiteSerializer, InterfaceSerializer
+from dcim.api.nested_serializers import NestedCableSerializer, NestedSiteSerializer
+from dcim.api.serializers import ConnectedEndpointSerializer
 from extras.api.customfields import CustomFieldModelSerializer
-from tenancy.api.serializers import NestedTenantSerializer
+from tenancy.api.nested_serializers import NestedTenantSerializer
+from utilities.api import ChoiceField, ValidatedModelSerializer
+from .nested_serializers import *
 
 
 #
 # Providers
 #
 
-class ProviderSerializer(CustomFieldModelSerializer):
+class ProviderSerializer(TaggitSerializer, CustomFieldModelSerializer):
+    tags = TagListSerializerField(required=False)
 
     class Meta:
         model = Provider
         fields = [
-            'id', 'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments',
-            'custom_fields',
+            'id', 'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments', 'tags',
+            'custom_fields', 'created', 'last_updated',
         ]
 
 
-class NestedProviderSerializer(serializers.ModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:provider-detail')
-
-    class Meta:
-        model = Provider
-        fields = ['id', 'url', 'name', 'slug']
-
-
-class WritableProviderSerializer(CustomFieldModelSerializer):
-
-    class Meta:
-        model = Provider
-        fields = [
-            'id', 'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments',
-            'custom_fields',
-        ]
-
-
-#
-# Circuit types
-#
-
-class CircuitTypeSerializer(serializers.ModelSerializer):
-
-    class Meta:
-        model = CircuitType
-        fields = ['id', 'name', 'slug']
-
-
-class NestedCircuitTypeSerializer(serializers.ModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittype-detail')
-
-    class Meta:
-        model = CircuitType
-        fields = ['id', 'url', 'name', 'slug']
-
-
 #
 # Circuits
 #
 
-class CircuitSerializer(CustomFieldModelSerializer):
+class CircuitTypeSerializer(ValidatedModelSerializer):
+
+    class Meta:
+        model = CircuitType
+        fields = ['id', 'name', 'slug']
+
+
+class CircuitSerializer(TaggitSerializer, CustomFieldModelSerializer):
     provider = NestedProviderSerializer()
+    status = ChoiceField(choices=CIRCUIT_STATUS_CHOICES, required=False)
     type = NestedCircuitTypeSerializer()
-    tenant = NestedTenantSerializer()
+    tenant = NestedTenantSerializer(required=False, allow_null=True)
+    tags = TagListSerializerField(required=False)
 
     class Meta:
         model = Circuit
         fields = [
-            'id', 'cid', 'provider', 'type', 'tenant', 'install_date', 'commit_rate', 'description', 'comments',
-            'custom_fields',
+            'id', 'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', 'description',
+            'comments', 'tags', 'custom_fields', 'created', 'last_updated',
         ]
 
 
-class NestedCircuitSerializer(serializers.ModelSerializer):
-    url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuit-detail')
-
-    class Meta:
-        model = Circuit
-        fields = ['id', 'url', 'cid']
-
-
-class WritableCircuitSerializer(CustomFieldModelSerializer):
-
-    class Meta:
-        model = Circuit
-        fields = [
-            'id', 'cid', 'provider', 'type', 'tenant', 'install_date', 'commit_rate', 'description', 'comments',
-            'custom_fields',
-        ]
-
-
-#
-# Circuit Terminations
-#
-
-class CircuitTerminationSerializer(serializers.ModelSerializer):
+class CircuitTerminationSerializer(ConnectedEndpointSerializer):
     circuit = NestedCircuitSerializer()
     site = NestedSiteSerializer()
-    interface = InterfaceSerializer()
+    cable = NestedCableSerializer(read_only=True)
 
     class Meta:
         model = CircuitTermination
         fields = [
-            'id', 'circuit', 'term_side', 'site', 'interface', 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info',
-        ]
-
-
-class WritableCircuitTerminationSerializer(serializers.ModelSerializer):
-
-    class Meta:
-        model = CircuitTermination
-        fields = [
-            'id', 'circuit', 'term_side', 'site', 'interface', 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info',
+            'id', 'circuit', 'term_side', 'site', 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info',
+            'description', 'connected_endpoint_type', 'connected_endpoint', 'connection_status', 'cable',
         ]

netbox/circuits/api/urls.py

@@ -14,6 +14,9 @@ class CircuitsRootView(routers.APIRootView):
 router = routers.DefaultRouter()
 router.APIRootView = CircuitsRootView
 
+# Field choices
+router.register(r'_choices', views.CircuitsFieldChoicesViewSet, basename='field-choice')
+
 # Providers
 router.register(r'providers', views.ProviderViewSet)
 

netbox/circuits/api/views.py

@@ -1,29 +1,37 @@
 from django.shortcuts import get_object_or_404
-
-from rest_framework.decorators import detail_route
+from rest_framework.decorators import action
 from rest_framework.response import Response
-from rest_framework.viewsets import ModelViewSet
 
 from circuits import filters
 from circuits.models import Provider, CircuitTermination, CircuitType, Circuit
-from extras.models import Graph, GRAPH_TYPE_PROVIDER
 from extras.api.serializers import RenderedGraphSerializer
 from extras.api.views import CustomFieldModelViewSet
-from utilities.api import WritableSerializerMixin
+from extras.models import Graph, GRAPH_TYPE_PROVIDER
+from utilities.api import FieldChoicesViewSet, ModelViewSet
 from . import serializers
 
 
+#
+# Field choices
+#
+
+class CircuitsFieldChoicesViewSet(FieldChoicesViewSet):
+    fields = (
+        (Circuit, ['status']),
+        (CircuitTermination, ['term_side']),
+    )
+
+
 #
 # Providers
 #
 
-class ProviderViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
-    queryset = Provider.objects.all()
+class ProviderViewSet(CustomFieldModelViewSet):
+    queryset = Provider.objects.prefetch_related('tags')
     serializer_class = serializers.ProviderSerializer
-    write_serializer_class = serializers.WritableProviderSerializer
-    filter_class = filters.ProviderFilter
+    filterset_class = filters.ProviderFilter
 
-    @detail_route()
+    @action(detail=True)
     def graphs(self, request, pk=None):
         """
         A convenience method for rendering graphs for a particular provider.
@@ -41,25 +49,26 @@ class ProviderViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
 class CircuitTypeViewSet(ModelViewSet):
     queryset = CircuitType.objects.all()
     serializer_class = serializers.CircuitTypeSerializer
+    filterset_class = filters.CircuitTypeFilter
 
 
 #
 # Circuits
 #
 
-class CircuitViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
-    queryset = Circuit.objects.select_related('type', 'tenant', 'provider')
+class CircuitViewSet(CustomFieldModelViewSet):
+    queryset = Circuit.objects.select_related('type', 'tenant', 'provider').prefetch_related('tags')
     serializer_class = serializers.CircuitSerializer
-    write_serializer_class = serializers.WritableCircuitSerializer
-    filter_class = filters.CircuitFilter
+    filterset_class = filters.CircuitFilter
 
 
 #
 # Circuit Terminations
 #
 
-class CircuitTerminationViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = CircuitTermination.objects.select_related('circuit', 'site', 'interface__device')
+class CircuitTerminationViewSet(ModelViewSet):
+    queryset = CircuitTermination.objects.select_related(
+        'circuit', 'site', 'connected_endpoint__device', 'cable'
+    )
     serializer_class = serializers.CircuitTerminationSerializer
-    write_serializer_class = serializers.WritableCircuitTerminationSerializer
-    filter_class = filters.CircuitTerminationFilter
+    filterset_class = filters.CircuitTerminationFilter

netbox/circuits/constants.py

@@ -0,0 +1,24 @@
+
+# Circuit statuses
+CIRCUIT_STATUS_DEPROVISIONING = 0
+CIRCUIT_STATUS_ACTIVE = 1
+CIRCUIT_STATUS_PLANNED = 2
+CIRCUIT_STATUS_PROVISIONING = 3
+CIRCUIT_STATUS_OFFLINE = 4
+CIRCUIT_STATUS_DECOMMISSIONED = 5
+CIRCUIT_STATUS_CHOICES = [
+    [CIRCUIT_STATUS_PLANNED, 'Planned'],
+    [CIRCUIT_STATUS_PROVISIONING, 'Provisioning'],
+    [CIRCUIT_STATUS_ACTIVE, 'Active'],
+    [CIRCUIT_STATUS_OFFLINE, 'Offline'],
+    [CIRCUIT_STATUS_DEPROVISIONING, 'Deprovisioning'],
+    [CIRCUIT_STATUS_DECOMMISSIONED, 'Decommissioned'],
+]
+
+# CircuitTermination sides
+TERM_SIDE_A = 'A'
+TERM_SIDE_Z = 'Z'
+TERM_SIDE_CHOICES = (
+    (TERM_SIDE_A, 'A'),
+    (TERM_SIDE_Z, 'Z'),
+)

netbox/circuits/filters.py

@@ -1,35 +1,39 @@
 import django_filters
-
 from django.db.models import Q
 
 from dcim.models import Site
 from extras.filters import CustomFieldFilterSet
 from tenancy.models import Tenant
-from utilities.filters import NullableModelMultipleChoiceFilter, NumericInFilter
+from utilities.filters import NumericInFilter, TagFilter
+from .constants import CIRCUIT_STATUS_CHOICES
 from .models import Provider, Circuit, CircuitTermination, CircuitType
 
 
 class ProviderFilter(CustomFieldFilterSet, django_filters.FilterSet):
-    id__in = NumericInFilter(name='id', lookup_expr='in')
+    id__in = NumericInFilter(
+        field_name='id',
+        lookup_expr='in'
+    )
     q = django_filters.CharFilter(
         method='search',
         label='Search',
     )
     site_id = django_filters.ModelMultipleChoiceFilter(
-        name='circuits__terminations__site',
+        field_name='circuits__terminations__site',
         queryset=Site.objects.all(),
         label='Site',
     )
     site = django_filters.ModelMultipleChoiceFilter(
-        name='circuits__terminations__site__slug',
+        field_name='circuits__terminations__site__slug',
         queryset=Site.objects.all(),
         to_field_name='slug',
         label='Site (slug)',
     )
+    tag = TagFilter()
 
     class Meta:
         model = Provider
-        fields = ['name', 'account', 'asn']
+        fields = ['name', 'slug', 'asn', 'account']
 
     def search(self, queryset, name, value):
         if not value.strip():
@@ -37,64 +41,78 @@ class ProviderFilter(CustomFieldFilterSet, django_filters.FilterSet):
         return queryset.filter(
             Q(name__icontains=value) |
             Q(account__icontains=value) |
+            Q(noc_contact__icontains=value) |
+            Q(admin_contact__icontains=value) |
             Q(comments__icontains=value)
         )
 
 
+class CircuitTypeFilter(django_filters.FilterSet):
+
+    class Meta:
+        model = CircuitType
+        fields = ['name', 'slug']
+
+
 class CircuitFilter(CustomFieldFilterSet, django_filters.FilterSet):
-    id__in = NumericInFilter(name='id', lookup_expr='in')
+    id__in = NumericInFilter(
+        field_name='id',
+        lookup_expr='in'
+    )
     q = django_filters.CharFilter(
         method='search',
         label='Search',
     )
     provider_id = django_filters.ModelMultipleChoiceFilter(
-        name='provider',
         queryset=Provider.objects.all(),
         label='Provider (ID)',
     )
     provider = django_filters.ModelMultipleChoiceFilter(
-        name='provider__slug',
+        field_name='provider__slug',
         queryset=Provider.objects.all(),
         to_field_name='slug',
         label='Provider (slug)',
     )
     type_id = django_filters.ModelMultipleChoiceFilter(
-        name='type',
         queryset=CircuitType.objects.all(),
         label='Circuit type (ID)',
     )
     type = django_filters.ModelMultipleChoiceFilter(
-        name='type__slug',
+        field_name='type__slug',
         queryset=CircuitType.objects.all(),
         to_field_name='slug',
         label='Circuit type (slug)',
     )
-    tenant_id = NullableModelMultipleChoiceFilter(
-        name='tenant',
+    status = django_filters.MultipleChoiceFilter(
+        choices=CIRCUIT_STATUS_CHOICES,
+        null_value=None
+    )
+    tenant_id = django_filters.ModelMultipleChoiceFilter(
         queryset=Tenant.objects.all(),
         label='Tenant (ID)',
     )
-    tenant = NullableModelMultipleChoiceFilter(
-        name='tenant',
+    tenant = django_filters.ModelMultipleChoiceFilter(
+        field_name='tenant__slug',
         queryset=Tenant.objects.all(),
         to_field_name='slug',
         label='Tenant (slug)',
     )
     site_id = django_filters.ModelMultipleChoiceFilter(
-        name='terminations__site',
+        field_name='terminations__site',
         queryset=Site.objects.all(),
         label='Site (ID)',
     )
     site = django_filters.ModelMultipleChoiceFilter(
-        name='terminations__site__slug',
+        field_name='terminations__site__slug',
         queryset=Site.objects.all(),
         to_field_name='slug',
         label='Site (slug)',
     )
+    tag = TagFilter()
 
     class Meta:
         model = Circuit
-        fields = ['install_date']
+        fields = ['cid', 'install_date', 'commit_rate']
 
     def search(self, queryset, name, value):
         if not value.strip():
@@ -103,18 +121,42 @@ class CircuitFilter(CustomFieldFilterSet, django_filters.FilterSet):
             Q(cid__icontains=value) |
             Q(terminations__xconnect_id__icontains=value) |
             Q(terminations__pp_info__icontains=value) |
+            Q(terminations__description__icontains=value) |
             Q(description__icontains=value) |
             Q(comments__icontains=value)
         ).distinct()
 
 
 class CircuitTerminationFilter(django_filters.FilterSet):
+    q = django_filters.CharFilter(
+        method='search',
+        label='Search',
+    )
     circuit_id = django_filters.ModelMultipleChoiceFilter(
-        name='circuit',
         queryset=Circuit.objects.all(),
         label='Circuit',
     )
+    site_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Site.objects.all(),
+        label='Site (ID)',
+    )
+    site = django_filters.ModelMultipleChoiceFilter(
+        field_name='site__slug',
+        queryset=Site.objects.all(),
+        to_field_name='slug',
+        label='Site (slug)',
+    )
 
     class Meta:
         model = CircuitTermination
-        fields = ['term_side', 'site']
+        fields = ['term_side', 'port_speed', 'upstream_speed', 'xconnect_id']
+
+    def search(self, queryset, name, value):
+        if not value.strip():
+            return queryset
+        return queryset.filter(
+            Q(circuit__cid__icontains=value) |
+            Q(xconnect_id__icontains=value) |
+            Q(pp_info__icontains=value) |
+            Q(description__icontains=value)
+        ).distinct()

netbox/circuits/forms.py

@@ -1,14 +1,16 @@
 from django import forms
 from django.db.models import Count
+from taggit.forms import TagField
 
-from dcim.models import Site, Device, Interface, Rack, VIRTUAL_IFACE_TYPES
-from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
+from dcim.models import Site
+from extras.forms import AddRemoveTagsForm, CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
+from tenancy.forms import TenancyForm
 from tenancy.models import Tenant
 from utilities.forms import (
-    APISelect, BootstrapMixin, BulkImportForm, CommentField, CSVDataField, FilterChoiceField, Livesearch, SmallTextarea,
-    SlugField,
+    AnnotatedMultipleChoiceField, add_blank_choice, BootstrapMixin, CommentField, CSVChoiceField, FilterChoiceField,
+    SmallTextarea, SlugField,
 )
-
+from .constants import CIRCUIT_STATUS_CHOICES
 from .models import Circuit, CircuitTermination, CircuitType, Provider
 
 
@@ -19,13 +21,22 @@ from .models import Circuit, CircuitTermination, CircuitType, Provider
 class ProviderForm(BootstrapMixin, CustomFieldForm):
     slug = SlugField()
     comments = CommentField()
+    tags = TagField(
+        required=False
+    )
 
     class Meta:
         model = Provider
-        fields = ['name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments']
+        fields = [
+            'name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments', 'tags',
+        ]
         widgets = {
-            'noc_contact': SmallTextarea(attrs={'rows': 5}),
-            'admin_contact': SmallTextarea(attrs={'rows': 5}),
+            'noc_contact': SmallTextarea(
+                attrs={'rows': 5}
+            ),
+            'admin_contact': SmallTextarea(
+                attrs={'rows': 5}
+            ),
         }
         help_texts = {
             'name': "Full name of the provider",
@@ -36,35 +47,72 @@ class ProviderForm(BootstrapMixin, CustomFieldForm):
         }
 
 
-class ProviderFromCSVForm(forms.ModelForm):
+class ProviderCSVForm(forms.ModelForm):
+    slug = SlugField()
 
     class Meta:
         model = Provider
-        fields = ['name', 'slug', 'asn', 'account', 'portal_url']
+        fields = Provider.csv_headers
+        help_texts = {
+            'name': 'Provider name',
+            'asn': '32-bit autonomous system number',
+            'portal_url': 'Portal URL',
+            'comments': 'Free-form comments',
+        }
 
 
-class ProviderImportForm(BootstrapMixin, BulkImportForm):
-    csv = CSVDataField(csv_form=ProviderFromCSVForm)
-
-
-class ProviderBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
-    pk = forms.ModelMultipleChoiceField(queryset=Provider.objects.all(), widget=forms.MultipleHiddenInput)
-    asn = forms.IntegerField(required=False, label='ASN')
-    account = forms.CharField(max_length=30, required=False, label='Account number')
-    portal_url = forms.URLField(required=False, label='Portal')
-    noc_contact = forms.CharField(required=False, widget=SmallTextarea, label='NOC contact')
-    admin_contact = forms.CharField(required=False, widget=SmallTextarea, label='Admin contact')
-    comments = CommentField(widget=SmallTextarea)
+class ProviderBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(
+        queryset=Provider.objects.all(),
+        widget=forms.MultipleHiddenInput
+    )
+    asn = forms.IntegerField(
+        required=False,
+        label='ASN'
+    )
+    account = forms.CharField(
+        max_length=30,
+        required=False,
+        label='Account number'
+    )
+    portal_url = forms.URLField(
+        required=False,
+        label='Portal'
+    )
+    noc_contact = forms.CharField(
+        required=False,
+        widget=SmallTextarea,
+        label='NOC contact'
+    )
+    admin_contact = forms.CharField(
+        required=False,
+        widget=SmallTextarea,
+        label='Admin contact'
+    )
+    comments = CommentField(
+        widget=SmallTextarea()
+    )
 
     class Meta:
-        nullable_fields = ['asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments']
+        nullable_fields = [
+            'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments',
+        ]
 
 
 class ProviderFilterForm(BootstrapMixin, CustomFieldFilterForm):
     model = Provider
-    q = forms.CharField(required=False, label='Search')
-    site = FilterChoiceField(queryset=Site.objects.all(), to_field_name='slug')
-    asn = forms.IntegerField(required=False, label='ASN')
+    q = forms.CharField(
+        required=False,
+        label='Search'
+    )
+    site = FilterChoiceField(
+        queryset=Site.objects.all(),
+        to_field_name='slug'
+    )
+    asn = forms.IntegerField(
+        required=False,
+        label='ASN'
+    )
 
 
 #
@@ -76,19 +124,38 @@ class CircuitTypeForm(BootstrapMixin, forms.ModelForm):
 
     class Meta:
         model = CircuitType
-        fields = ['name', 'slug']
+        fields = [
+            'name', 'slug',
+        ]
+
+
+class CircuitTypeCSVForm(forms.ModelForm):
+    slug = SlugField()
+
+    class Meta:
+        model = CircuitType
+        fields = CircuitType.csv_headers
+        help_texts = {
+            'name': 'Name of circuit type',
+        }
 
 
 #
 # Circuits
 #
 
-class CircuitForm(BootstrapMixin, CustomFieldForm):
+class CircuitForm(BootstrapMixin, TenancyForm, CustomFieldForm):
     comments = CommentField()
+    tags = TagField(
+        required=False
+    )
 
     class Meta:
         model = Circuit
-        fields = ['cid', 'type', 'provider', 'tenant', 'install_date', 'commit_rate', 'description', 'comments']
+        fields = [
+            'cid', 'type', 'provider', 'status', 'install_date', 'commit_rate', 'description', 'tenant_group', 'tenant',
+            'comments', 'tags',
+        ]
         help_texts = {
             'cid': "Unique circuit ID",
             'install_date': "Format: YYYY-MM-DD",
@@ -96,56 +163,127 @@ class CircuitForm(BootstrapMixin, CustomFieldForm):
         }
 
 
-class CircuitFromCSVForm(forms.ModelForm):
-    provider = forms.ModelChoiceField(Provider.objects.all(), to_field_name='name',
-                                      error_messages={'invalid_choice': 'Provider not found.'})
-    type = forms.ModelChoiceField(CircuitType.objects.all(), to_field_name='name',
-                                  error_messages={'invalid_choice': 'Invalid circuit type.'})
-    tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False,
-                                    error_messages={'invalid_choice': 'Tenant not found.'})
+class CircuitCSVForm(forms.ModelForm):
+    provider = forms.ModelChoiceField(
+        queryset=Provider.objects.all(),
+        to_field_name='name',
+        help_text='Name of parent provider',
+        error_messages={
+            'invalid_choice': 'Provider not found.'
+        }
+    )
+    type = forms.ModelChoiceField(
+        queryset=CircuitType.objects.all(),
+        to_field_name='name',
+        help_text='Type of circuit',
+        error_messages={
+            'invalid_choice': 'Invalid circuit type.'
+        }
+    )
+    status = CSVChoiceField(
+        choices=CIRCUIT_STATUS_CHOICES,
+        required=False,
+        help_text='Operational status'
+    )
+    tenant = forms.ModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False,
+        to_field_name='name',
+        help_text='Name of assigned tenant',
+        error_messages={
+            'invalid_choice': 'Tenant not found.'
+        }
+    )
 
     class Meta:
         model = Circuit
-        fields = ['cid', 'provider', 'type', 'tenant', 'install_date', 'commit_rate', 'description']
+        fields = [
+            'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', 'description', 'comments',
+        ]
 
 
-class CircuitImportForm(BootstrapMixin, BulkImportForm):
-    csv = CSVDataField(csv_form=CircuitFromCSVForm)
-
-
-class CircuitBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
-    pk = forms.ModelMultipleChoiceField(queryset=Circuit.objects.all(), widget=forms.MultipleHiddenInput)
-    type = forms.ModelChoiceField(queryset=CircuitType.objects.all(), required=False)
-    provider = forms.ModelChoiceField(queryset=Provider.objects.all(), required=False)
-    tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
-    commit_rate = forms.IntegerField(required=False, label='Commit rate (Kbps)')
-    description = forms.CharField(max_length=100, required=False)
-    comments = CommentField(widget=SmallTextarea)
+class CircuitBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
+    pk = forms.ModelMultipleChoiceField(
+        queryset=Circuit.objects.all(),
+        widget=forms.MultipleHiddenInput
+    )
+    type = forms.ModelChoiceField(
+        queryset=CircuitType.objects.all(),
+        required=False
+    )
+    provider = forms.ModelChoiceField(
+        queryset=Provider.objects.all(),
+        required=False
+    )
+    status = forms.ChoiceField(
+        choices=add_blank_choice(CIRCUIT_STATUS_CHOICES),
+        required=False,
+        initial=''
+    )
+    tenant = forms.ModelChoiceField(
+        queryset=Tenant.objects.all(),
+        required=False
+    )
+    commit_rate = forms.IntegerField(
+        required=False,
+        label='Commit rate (Kbps)'
+    )
+    description = forms.CharField(
+        max_length=100,
+        required=False
+    )
+    comments = CommentField(
+        widget=SmallTextarea
+    )
 
     class Meta:
-        nullable_fields = ['tenant', 'commit_rate', 'description', 'comments']
+        nullable_fields = [
+            'tenant', 'commit_rate', 'description', 'comments',
+        ]
 
 
 class CircuitFilterForm(BootstrapMixin, CustomFieldFilterForm):
     model = Circuit
-    q = forms.CharField(required=False, label='Search')
+    q = forms.CharField(
+        required=False,
+        label='Search'
+    )
     type = FilterChoiceField(
-        queryset=CircuitType.objects.annotate(filter_count=Count('circuits')),
+        queryset=CircuitType.objects.annotate(
+            filter_count=Count('circuits')
+        ),
         to_field_name='slug'
     )
     provider = FilterChoiceField(
-        queryset=Provider.objects.annotate(filter_count=Count('circuits')),
+        queryset=Provider.objects.annotate(
+            filter_count=Count('circuits')
+        ),
         to_field_name='slug'
     )
+    status = AnnotatedMultipleChoiceField(
+        choices=CIRCUIT_STATUS_CHOICES,
+        annotate=Circuit.objects.all(),
+        annotate_field='status',
+        required=False
+    )
     tenant = FilterChoiceField(
-        queryset=Tenant.objects.annotate(filter_count=Count('circuits')),
+        queryset=Tenant.objects.annotate(
+            filter_count=Count('circuits')
+        ),
         to_field_name='slug',
-        null_option=(0, 'None')
+        null_label='-- None --'
     )
     site = FilterChoiceField(
-        queryset=Site.objects.annotate(filter_count=Count('circuit_terminations')),
+        queryset=Site.objects.annotate(
+            filter_count=Count('circuit_terminations')
+        ),
         to_field_name='slug'
     )
+    commit_rate = forms.IntegerField(
+        required=False,
+        min_value=0,
+        label='Commit rate (Kbps)'
+    )
 
 
 #
@@ -153,54 +291,12 @@ class CircuitFilterForm(BootstrapMixin, CustomFieldFilterForm):
 #
 
 class CircuitTerminationForm(BootstrapMixin, forms.ModelForm):
-    site = forms.ModelChoiceField(
-        queryset=Site.objects.all(),
-        widget=forms.Select(
-            attrs={'filter-for': 'rack'}
-        )
-    )
-    rack = forms.ModelChoiceField(
-        queryset=Rack.objects.all(),
-        required=False,
-        label='Rack',
-        widget=APISelect(
-            api_url='/api/dcim/racks/?site_id={{site}}',
-            attrs={'filter-for': 'device', 'nullable': 'true'}
-        )
-    )
-    device = forms.ModelChoiceField(
-        queryset=Device.objects.all(),
-        required=False,
-        label='Device',
-        widget=APISelect(
-            api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}',
-            display_field='display_name',
-            attrs={'filter-for': 'interface'}
-        )
-    )
-    livesearch = forms.CharField(
-        required=False,
-        label='Device',
-        widget=Livesearch(
-            query_key='q',
-            query_url='dcim-api:device-list',
-            field_to_update='device'
-        )
-    )
-    interface = forms.ModelChoiceField(
-        queryset=Interface.objects.all(),
-        required=False,
-        label='Interface',
-        widget=APISelect(
-            api_url='/api/dcim/interfaces/?device_id={{device}}&type=physical',
-            disabled_indicator='is_connected'
-        )
-    )
 
     class Meta:
         model = CircuitTermination
-        fields = ['term_side', 'site', 'rack', 'device', 'livesearch', 'interface', 'port_speed', 'upstream_speed',
-                  'xconnect_id', 'pp_info']
+        fields = [
+            'term_side', 'site', 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info', 'description',
+        ]
         help_texts = {
             'port_speed': "Physical circuit speed",
             'xconnect_id': "ID of the local cross-connect",
@@ -209,52 +305,3 @@ class CircuitTerminationForm(BootstrapMixin, forms.ModelForm):
         widgets = {
             'term_side': forms.HiddenInput(),
         }
-
-    def __init__(self, *args, **kwargs):
-
-        super(CircuitTerminationForm, self).__init__(*args, **kwargs)
-
-        # If an interface has been assigned, initialize rack and device
-        if self.instance.interface:
-            self.initial['rack'] = self.instance.interface.device.rack
-            self.initial['device'] = self.instance.interface.device
-
-        # Limit rack choices
-        if self.is_bound:
-            self.fields['rack'].queryset = Rack.objects.filter(site__pk=self.data['site'])
-        elif self.initial.get('site'):
-            self.fields['rack'].queryset = Rack.objects.filter(site=self.initial['site'])
-        else:
-            self.fields['rack'].choices = []
-
-        # Limit device choices
-        if self.is_bound and self.data.get('rack'):
-            self.fields['device'].queryset = Device.objects.filter(rack=self.data['rack'])
-        elif self.initial.get('rack'):
-            self.fields['device'].queryset = Device.objects.filter(rack=self.initial['rack'])
-        else:
-            self.fields['device'].choices = []
-
-        # Limit interface choices
-        if self.is_bound and self.data.get('device'):
-            interfaces = Interface.objects.filter(device=self.data['device']).exclude(
-                form_factor__in=VIRTUAL_IFACE_TYPES
-            ).select_related(
-                'circuit_termination', 'connected_as_a', 'connected_as_b'
-            )
-            self.fields['interface'].widget.attrs['initial'] = self.data.get('interface')
-        elif self.initial.get('device'):
-            interfaces = Interface.objects.filter(device=self.initial['device']).exclude(
-                form_factor__in=VIRTUAL_IFACE_TYPES
-            ).select_related(
-                'circuit_termination', 'connected_as_a', 'connected_as_b'
-            )
-            self.fields['interface'].widget.attrs['initial'] = self.initial.get('interface')
-        else:
-            interfaces = []
-        self.fields['interface'].choices = [
-            (iface.id, {
-                'label': iface.name,
-                'disabled': iface.is_connected and iface.id != self.fields['interface'].widget.attrs.get('initial'),
-            }) for iface in interfaces
-        ]

netbox/circuits/migrations/0001_initial.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.7 on 2016-06-22 18:21
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 
 

netbox/circuits/migrations/0001_initial_squashed_0010_circuit_status.py

@@ -0,0 +1,94 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.14 on 2018-07-31 02:25
+import dcim.fields
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    replaces = [('circuits', '0001_initial'), ('circuits', '0002_auto_20160622_1821'), ('circuits', '0003_provider_32bit_asn_support'), ('circuits', '0004_circuit_add_tenant'), ('circuits', '0005_circuit_add_upstream_speed'), ('circuits', '0006_terminations'), ('circuits', '0007_circuit_add_description'), ('circuits', '0008_circuittermination_interface_protect_on_delete'), ('circuits', '0009_unicode_literals'), ('circuits', '0010_circuit_status')]
+
+    dependencies = [
+        ('dcim', '0001_initial'),
+        ('dcim', '0022_color_names_to_rgb'),
+        ('tenancy', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Provider',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateField(auto_now_add=True)),
+                ('last_updated', models.DateTimeField(auto_now=True)),
+                ('name', models.CharField(max_length=50, unique=True)),
+                ('slug', models.SlugField(unique=True)),
+                ('asn', dcim.fields.ASNField(blank=True, null=True, verbose_name='ASN')),
+                ('account', models.CharField(blank=True, max_length=30, verbose_name='Account number')),
+                ('portal_url', models.URLField(blank=True, verbose_name='Portal')),
+                ('noc_contact', models.TextField(blank=True, verbose_name='NOC contact')),
+                ('admin_contact', models.TextField(blank=True, verbose_name='Admin contact')),
+                ('comments', models.TextField(blank=True)),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='CircuitType',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=50, unique=True)),
+                ('slug', models.SlugField(unique=True)),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='Circuit',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created', models.DateField(auto_now_add=True)),
+                ('last_updated', models.DateTimeField(auto_now=True)),
+                ('cid', models.CharField(max_length=50, verbose_name='Circuit ID')),
+                ('install_date', models.DateField(blank=True, null=True, verbose_name='Date installed')),
+                ('commit_rate', models.PositiveIntegerField(blank=True, null=True, verbose_name='Commit rate (Kbps)')),
+                ('comments', models.TextField(blank=True)),
+                ('provider', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='circuits', to='circuits.Provider')),
+                ('type', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='circuits', to='circuits.CircuitType')),
+                ('tenant', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='circuits', to='tenancy.Tenant')),
+                ('description', models.CharField(blank=True, max_length=100)),
+                ('status', models.PositiveSmallIntegerField(choices=[[2, 'Planned'], [3, 'Provisioning'], [1, 'Active'], [4, 'Offline'], [0, 'Deprovisioning'], [5, 'Decommissioned']], default=1))
+            ],
+            options={
+                'ordering': ['provider', 'cid'],
+            },
+        ),
+        migrations.AlterUniqueTogether(
+            name='circuit',
+            unique_together=set([('provider', 'cid')]),
+        ),
+        migrations.CreateModel(
+            name='CircuitTermination',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('term_side', models.CharField(choices=[('A', 'A'), ('Z', 'Z')], max_length=1, verbose_name='Termination')),
+                ('port_speed', models.PositiveIntegerField(verbose_name='Port speed (Kbps)')),
+                ('upstream_speed', models.PositiveIntegerField(blank=True, help_text='Upstream speed, if different from port speed', null=True, verbose_name='Upstream speed (Kbps)')),
+                ('xconnect_id', models.CharField(blank=True, max_length=50, verbose_name='Cross-connect ID')),
+                ('pp_info', models.CharField(blank=True, max_length=100, verbose_name='Patch panel/port(s)')),
+                ('circuit', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='circuits.Circuit')),
+                ('interface', models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='circuit_termination', to='dcim.Interface')),
+                ('site', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='circuit_terminations', to='dcim.Site')),
+            ],
+            options={
+                'ordering': ['circuit', 'term_side'],
+            },
+        ),
+        migrations.AlterUniqueTogether(
+            name='circuittermination',
+            unique_together=set([('circuit', 'term_side')]),
+        ),
+    ]

netbox/circuits/migrations/0002_auto_20160622_1821.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.7 on 2016-06-22 18:21
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import django.db.models.deletion
 

netbox/circuits/migrations/0003_provider_32bit_asn_support.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.7 on 2016-07-13 19:24
-from __future__ import unicode_literals
-
 import dcim.fields
 from django.db import migrations
 

netbox/circuits/migrations/0004_circuit_add_tenant.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.8 on 2016-07-26 21:59
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import django.db.models.deletion
 

netbox/circuits/migrations/0005_circuit_add_upstream_speed.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.8 on 2016-08-08 20:24
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 
 

netbox/circuits/migrations/0006_terminations.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.10 on 2016-12-13 16:30
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import django.db.models.deletion
 

netbox/circuits/migrations/0007_circuit_add_description.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.10.4 on 2017-01-17 20:08
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 
 

netbox/circuits/migrations/0008_circuittermination_interface_protect_on_delete.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.11 on 2017-04-19 17:17
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import django.db.models.deletion
 

netbox/circuits/migrations/0009_unicode_literals.py

@@ -0,0 +1,79 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2017-05-24 15:34
+import dcim.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0008_circuittermination_interface_protect_on_delete'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='circuit',
+            name='cid',
+            field=models.CharField(max_length=50, verbose_name='Circuit ID'),
+        ),
+        migrations.AlterField(
+            model_name='circuit',
+            name='commit_rate',
+            field=models.PositiveIntegerField(blank=True, null=True, verbose_name='Commit rate (Kbps)'),
+        ),
+        migrations.AlterField(
+            model_name='circuit',
+            name='install_date',
+            field=models.DateField(blank=True, null=True, verbose_name='Date installed'),
+        ),
+        migrations.AlterField(
+            model_name='circuittermination',
+            name='port_speed',
+            field=models.PositiveIntegerField(verbose_name='Port speed (Kbps)'),
+        ),
+        migrations.AlterField(
+            model_name='circuittermination',
+            name='pp_info',
+            field=models.CharField(blank=True, max_length=100, verbose_name='Patch panel/port(s)'),
+        ),
+        migrations.AlterField(
+            model_name='circuittermination',
+            name='term_side',
+            field=models.CharField(choices=[('A', 'A'), ('Z', 'Z')], max_length=1, verbose_name='Termination'),
+        ),
+        migrations.AlterField(
+            model_name='circuittermination',
+            name='upstream_speed',
+            field=models.PositiveIntegerField(blank=True, help_text='Upstream speed, if different from port speed', null=True, verbose_name='Upstream speed (Kbps)'),
+        ),
+        migrations.AlterField(
+            model_name='circuittermination',
+            name='xconnect_id',
+            field=models.CharField(blank=True, max_length=50, verbose_name='Cross-connect ID'),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='account',
+            field=models.CharField(blank=True, max_length=30, verbose_name='Account number'),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='admin_contact',
+            field=models.TextField(blank=True, verbose_name='Admin contact'),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='asn',
+            field=dcim.fields.ASNField(blank=True, null=True, verbose_name='ASN'),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='noc_contact',
+            field=models.TextField(blank=True, verbose_name='NOC contact'),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='portal_url',
+            field=models.URLField(blank=True, verbose_name='Portal'),
+        ),
+    ]

netbox/circuits/migrations/0010_circuit_status.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.9 on 2018-02-06 18:48
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0009_unicode_literals'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='circuit',
+            name='status',
+            field=models.PositiveSmallIntegerField(choices=[[2, 'Planned'], [3, 'Provisioning'], [1, 'Active'], [4, 'Offline'], [0, 'Deprovisioning'], [5, 'Decommissioned']], default=1),
+        ),
+    ]

netbox/circuits/migrations/0011_tags.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.12 on 2018-05-22 19:04
+from django.db import migrations
+import taggit.managers
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('taggit', '0002_auto_20150616_2121'),
+        ('circuits', '0010_circuit_status'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='circuit',
+            name='tags',
+            field=taggit.managers.TaggableManager(help_text='A comma-separated list of tags.', through='taggit.TaggedItem', to='taggit.Tag', verbose_name='Tags'),
+        ),
+        migrations.AddField(
+            model_name='provider',
+            name='tags',
+            field=taggit.managers.TaggableManager(help_text='A comma-separated list of tags.', through='taggit.TaggedItem', to='taggit.Tag', verbose_name='Tags'),
+        ),
+    ]

netbox/circuits/migrations/0012_change_logging.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.12 on 2018-06-13 17:14
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0011_tags'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='circuittype',
+            name='created',
+            field=models.DateField(auto_now_add=True, null=True),
+        ),
+        migrations.AddField(
+            model_name='circuittype',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='circuit',
+            name='created',
+            field=models.DateField(auto_now_add=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='circuit',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='created',
+            field=models.DateField(auto_now_add=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name='provider',
+            name='last_updated',
+            field=models.DateTimeField(auto_now=True, null=True),
+        ),
+    ]

netbox/circuits/migrations/0013_cables.py

@@ -0,0 +1,89 @@
+import sys
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+from dcim.constants import CONNECTION_STATUS_CONNECTED
+
+
+def circuit_terminations_to_cables(apps, schema_editor):
+    """
+    Copy all existing CircuitTermination Interface associations as Cables
+    """
+    ContentType = apps.get_model('contenttypes', 'ContentType')
+    CircuitTermination = apps.get_model('circuits', 'CircuitTermination')
+    Interface = apps.get_model('dcim', 'Interface')
+    Cable = apps.get_model('dcim', 'Cable')
+
+    # Load content types
+    circuittermination_type = ContentType.objects.get_for_model(CircuitTermination)
+    interface_type = ContentType.objects.get_for_model(Interface)
+
+    # Create a new Cable instance from each console connection
+    if 'test' not in sys.argv:
+        print("\n    Adding circuit terminations... ", end='', flush=True)
+    for circuittermination in CircuitTermination.objects.filter(interface__isnull=False):
+
+        # Create the new Cable
+        cable = Cable.objects.create(
+            termination_a_type=circuittermination_type,
+            termination_a_id=circuittermination.id,
+            termination_b_type=interface_type,
+            termination_b_id=circuittermination.interface_id,
+            status=CONNECTION_STATUS_CONNECTED
+        )
+
+        # Cache the Cable on its two termination points
+        CircuitTermination.objects.filter(pk=circuittermination.pk).update(
+            cable=cable,
+            connected_endpoint=circuittermination.interface,
+            connection_status=CONNECTION_STATUS_CONNECTED
+        )
+        # Cache the connected Cable on the Interface
+        Interface.objects.filter(pk=circuittermination.interface_id).update(
+            cable=cable,
+            _connected_circuittermination=circuittermination,
+            connection_status=CONNECTION_STATUS_CONNECTED
+        )
+
+    cable_count = Cable.objects.filter(termination_a_type=circuittermination_type).count()
+    if 'test' not in sys.argv:
+        print("{} cables created".format(cable_count))
+
+
+class Migration(migrations.Migration):
+    atomic = False
+
+    dependencies = [
+        ('circuits', '0012_change_logging'),
+        ('dcim', '0066_cables'),
+    ]
+
+    operations = [
+
+        # Add new CircuitTermination fields
+        migrations.AddField(
+            model_name='circuittermination',
+            name='connected_endpoint',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='dcim.Interface'),
+        ),
+        migrations.AddField(
+            model_name='circuittermination',
+            name='connection_status',
+            field=models.NullBooleanField(),
+        ),
+        migrations.AddField(
+            model_name='circuittermination',
+            name='cable',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to='dcim.Cable'),
+        ),
+
+        # Copy CircuitTermination connections to Interfaces as Cables
+        migrations.RunPython(circuit_terminations_to_cables),
+
+        # Remove interface field from CircuitTermination
+        migrations.RemoveField(
+            model_name='circuittermination',
+            name='interface',
+        ),
+    ]

netbox/circuits/migrations/0014_circuittermination_description.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.1.3 on 2018-11-05 18:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('circuits', '0013_cables'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='circuittermination',
+            name='description',
+            field=models.CharField(blank=True, max_length=100),
+        ),
+    ]

netbox/circuits/models.py

@@ -1,54 +1,63 @@
 from django.contrib.contenttypes.fields import GenericRelation
 from django.db import models
 from django.urls import reverse
-from django.utils.encoding import python_2_unicode_compatible
+from taggit.managers import TaggableManager
 
+from dcim.constants import CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_CONNECTED, STATUS_CLASSES
 from dcim.fields import ASNField
-from extras.models import CustomFieldModel, CustomFieldValue
-from tenancy.models import Tenant
-from utilities.utils import csv_format
-from utilities.models import CreatedUpdatedModel
+from dcim.models import CableTermination
+from extras.models import CustomFieldModel, ObjectChange
+from utilities.models import ChangeLoggedModel
+from utilities.utils import serialize_object
+from .constants import CIRCUIT_STATUS_ACTIVE, CIRCUIT_STATUS_CHOICES, TERM_SIDE_CHOICES
 
 
-TERM_SIDE_A = 'A'
-TERM_SIDE_Z = 'Z'
-TERM_SIDE_CHOICES = (
-    (TERM_SIDE_A, 'A'),
-    (TERM_SIDE_Z, 'Z'),
-)
-
-
-def humanize_speed(speed):
-    """
-    Humanize speeds given in Kbps (e.g. 10000000 becomes '10 Gbps')
-    """
-    if speed >= 1000000000 and speed % 1000000000 == 0:
-        return '{} Tbps'.format(speed / 1000000000)
-    elif speed >= 1000000 and speed % 1000000 == 0:
-        return '{} Gbps'.format(speed / 1000000)
-    elif speed >= 1000 and speed % 1000 == 0:
-        return '{} Mbps'.format(speed / 1000)
-    elif speed >= 1000:
-        return '{} Mbps'.format(float(speed) / 1000)
-    else:
-        return '{} Kbps'.format(speed)
-
-
-@python_2_unicode_compatible
-class Provider(CreatedUpdatedModel, CustomFieldModel):
+class Provider(ChangeLoggedModel, CustomFieldModel):
     """
     Each Circuit belongs to a Provider. This is usually a telecommunications company or similar organization. This model
     stores information pertinent to the user's relationship with the Provider.
     """
-    name = models.CharField(max_length=50, unique=True)
-    slug = models.SlugField(unique=True)
-    asn = ASNField(blank=True, null=True, verbose_name='ASN')
-    account = models.CharField(max_length=30, blank=True, verbose_name='Account number')
-    portal_url = models.URLField(blank=True, verbose_name='Portal')
-    noc_contact = models.TextField(blank=True, verbose_name='NOC contact')
-    admin_contact = models.TextField(blank=True, verbose_name='Admin contact')
-    comments = models.TextField(blank=True)
-    custom_field_values = GenericRelation(CustomFieldValue, content_type_field='obj_type', object_id_field='obj_id')
+    name = models.CharField(
+        max_length=50,
+        unique=True
+    )
+    slug = models.SlugField(
+        unique=True
+    )
+    asn = ASNField(
+        blank=True,
+        null=True,
+        verbose_name='ASN'
+    )
+    account = models.CharField(
+        max_length=30,
+        blank=True,
+        verbose_name='Account number'
+    )
+    portal_url = models.URLField(
+        blank=True,
+        verbose_name='Portal'
+    )
+    noc_contact = models.TextField(
+        blank=True,
+        verbose_name='NOC contact'
+    )
+    admin_contact = models.TextField(
+        blank=True,
+        verbose_name='Admin contact'
+    )
+    comments = models.TextField(
+        blank=True
+    )
+    custom_field_values = GenericRelation(
+        to='extras.CustomFieldValue',
+        content_type_field='obj_type',
+        object_id_field='obj_id'
+    )
+
+    tags = TaggableManager()
+
+    csv_headers = ['name', 'slug', 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', 'comments']
 
     class Meta:
         ordering = ['name']
@@ -60,23 +69,32 @@ class Provider(CreatedUpdatedModel, CustomFieldModel):
         return reverse('circuits:provider', args=[self.slug])
 
     def to_csv(self):
-        return csv_format([
+        return (
             self.name,
             self.slug,
             self.asn,
             self.account,
             self.portal_url,
-        ])
+            self.noc_contact,
+            self.admin_contact,
+            self.comments,
+        )
 
 
-@python_2_unicode_compatible
-class CircuitType(models.Model):
+class CircuitType(ChangeLoggedModel):
     """
     Circuits can be organized by their functional role. For example, a user might wish to define CircuitTypes named
     "Long Haul," "Metro," or "Out-of-Band".
     """
-    name = models.CharField(max_length=50, unique=True)
-    slug = models.SlugField(unique=True)
+    name = models.CharField(
+        max_length=50,
+        unique=True
+    )
+    slug = models.SlugField(
+        unique=True
+    )
+
+    csv_headers = ['name', 'slug']
 
     class Meta:
         ordering = ['name']
@@ -87,44 +105,97 @@ class CircuitType(models.Model):
     def get_absolute_url(self):
         return "{}?type={}".format(reverse('circuits:circuit_list'), self.slug)
 
+    def to_csv(self):
+        return (
+            self.name,
+            self.slug,
+        )
 
-@python_2_unicode_compatible
-class Circuit(CreatedUpdatedModel, CustomFieldModel):
+
+class Circuit(ChangeLoggedModel, CustomFieldModel):
     """
     A communications circuit connects two points. Each Circuit belongs to a Provider; Providers may have multiple
-    circuits. Each circuit is also assigned a CircuitType and a Site. A Circuit may be terminated to a specific device
-    interface, but this is not required. Circuit port speed and commit rate are measured in Kbps.
+    circuits. Each circuit is also assigned a CircuitType and a Site.  Circuit port speed and commit rate are measured
+    in Kbps.
     """
-    cid = models.CharField(max_length=50, verbose_name='Circuit ID')
-    provider = models.ForeignKey('Provider', related_name='circuits', on_delete=models.PROTECT)
-    type = models.ForeignKey('CircuitType', related_name='circuits', on_delete=models.PROTECT)
-    tenant = models.ForeignKey(Tenant, related_name='circuits', blank=True, null=True, on_delete=models.PROTECT)
-    install_date = models.DateField(blank=True, null=True, verbose_name='Date installed')
-    commit_rate = models.PositiveIntegerField(blank=True, null=True, verbose_name='Commit rate (Kbps)')
-    description = models.CharField(max_length=100, blank=True)
-    comments = models.TextField(blank=True)
-    custom_field_values = GenericRelation(CustomFieldValue, content_type_field='obj_type', object_id_field='obj_id')
+    cid = models.CharField(
+        max_length=50,
+        verbose_name='Circuit ID'
+    )
+    provider = models.ForeignKey(
+        to='circuits.Provider',
+        on_delete=models.PROTECT,
+        related_name='circuits'
+    )
+    type = models.ForeignKey(
+        to='CircuitType',
+        on_delete=models.PROTECT,
+        related_name='circuits'
+    )
+    status = models.PositiveSmallIntegerField(
+        choices=CIRCUIT_STATUS_CHOICES,
+        default=CIRCUIT_STATUS_ACTIVE
+    )
+    tenant = models.ForeignKey(
+        to='tenancy.Tenant',
+        on_delete=models.PROTECT,
+        related_name='circuits',
+        blank=True,
+        null=True
+    )
+    install_date = models.DateField(
+        blank=True,
+        null=True,
+        verbose_name='Date installed'
+    )
+    commit_rate = models.PositiveIntegerField(
+        blank=True,
+        null=True,
+        verbose_name='Commit rate (Kbps)')
+    description = models.CharField(
+        max_length=100,
+        blank=True
+    )
+    comments = models.TextField(
+        blank=True
+    )
+    custom_field_values = GenericRelation(
+        to='extras.CustomFieldValue',
+        content_type_field='obj_type',
+        object_id_field='obj_id'
+    )
+
+    tags = TaggableManager()
+
+    csv_headers = [
+        'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', 'description', 'comments',
+    ]
 
     class Meta:
         ordering = ['provider', 'cid']
         unique_together = ['provider', 'cid']
 
     def __str__(self):
-        return u'{} {}'.format(self.provider, self.cid)
+        return '{} {}'.format(self.provider, self.cid)
 
     def get_absolute_url(self):
         return reverse('circuits:circuit', args=[self.pk])
 
     def to_csv(self):
-        return csv_format([
+        return (
             self.cid,
             self.provider.name,
             self.type.name,
+            self.get_status_display(),
             self.tenant.name if self.tenant else None,
-            self.install_date.isoformat() if self.install_date else None,
+            self.install_date,
             self.commit_rate,
             self.description,
-        ])
+            self.comments,
+        )
+
+    def get_status_class(self):
+        return STATUS_CLASSES[self.status]
 
     def _get_termination(self, side):
         for ct in self.terminations.all():
@@ -140,33 +211,77 @@ class Circuit(CreatedUpdatedModel, CustomFieldModel):
     def termination_z(self):
         return self._get_termination('Z')
 
-    def commit_rate_human(self):
-        return '' if not self.commit_rate else humanize_speed(self.commit_rate)
-    commit_rate_human.admin_order_field = 'commit_rate'
 
-
-@python_2_unicode_compatible
-class CircuitTermination(models.Model):
-    circuit = models.ForeignKey('Circuit', related_name='terminations', on_delete=models.CASCADE)
-    term_side = models.CharField(max_length=1, choices=TERM_SIDE_CHOICES, verbose_name='Termination')
-    site = models.ForeignKey('dcim.Site', related_name='circuit_terminations', on_delete=models.PROTECT)
-    interface = models.OneToOneField(
-        'dcim.Interface', related_name='circuit_termination', blank=True, null=True, on_delete=models.PROTECT
+class CircuitTermination(CableTermination):
+    circuit = models.ForeignKey(
+        to='circuits.Circuit',
+        on_delete=models.CASCADE,
+        related_name='terminations'
+    )
+    term_side = models.CharField(
+        max_length=1,
+        choices=TERM_SIDE_CHOICES,
+        verbose_name='Termination'
+    )
+    site = models.ForeignKey(
+        to='dcim.Site',
+        on_delete=models.PROTECT,
+        related_name='circuit_terminations'
+    )
+    connected_endpoint = models.OneToOneField(
+        to='dcim.Interface',
+        on_delete=models.SET_NULL,
+        related_name='+',
+        blank=True,
+        null=True
+    )
+    connection_status = models.NullBooleanField(
+        choices=CONNECTION_STATUS_CHOICES,
+        blank=True
+    )
+    port_speed = models.PositiveIntegerField(
+        verbose_name='Port speed (Kbps)'
     )
-    port_speed = models.PositiveIntegerField(verbose_name='Port speed (Kbps)')
     upstream_speed = models.PositiveIntegerField(
-        blank=True, null=True, verbose_name='Upstream speed (Kbps)',
+        blank=True,
+        null=True,
+        verbose_name='Upstream speed (Kbps)',
         help_text='Upstream speed, if different from port speed'
     )
-    xconnect_id = models.CharField(max_length=50, blank=True, verbose_name='Cross-connect ID')
-    pp_info = models.CharField(max_length=100, blank=True, verbose_name='Patch panel/port(s)')
+    xconnect_id = models.CharField(
+        max_length=50,
+        blank=True,
+        verbose_name='Cross-connect ID'
+    )
+    pp_info = models.CharField(
+        max_length=100,
+        blank=True,
+        verbose_name='Patch panel/port(s)'
+    )
+    description = models.CharField(
+        max_length=100,
+        blank=True
+    )
 
     class Meta:
         ordering = ['circuit', 'term_side']
         unique_together = ['circuit', 'term_side']
 
     def __str__(self):
-        return u'{} (Side {})'.format(self.circuit, self.get_term_side_display())
+        return 'Side {}'.format(self.get_term_side_display())
+
+    def log_change(self, user, request_id, action):
+        """
+        Reference the parent circuit when recording the change.
+        """
+        ObjectChange(
+            user=user,
+            request_id=request_id,
+            changed_object=self,
+            related_object=self.circuit,
+            action=action,
+            object_data=serialize_object(self)
+        ).save()
 
     def get_peer_termination(self):
         peer_side = 'Z' if self.term_side == 'A' else 'A'
@@ -174,11 +289,3 @@ class CircuitTermination(models.Model):
             return CircuitTermination.objects.select_related('site').get(circuit=self.circuit, term_side=peer_side)
         except CircuitTermination.DoesNotExist:
             return None
-
-    def port_speed_human(self):
-        return humanize_speed(self.port_speed)
-    port_speed_human.admin_order_field = 'port_speed'
-
-    def upstream_speed_human(self):
-        return '' if not self.upstream_speed else humanize_speed(self.upstream_speed)
-    upstream_speed_human.admin_order_field = 'upstream_speed'

netbox/circuits/tables.py

@@ -1,17 +1,33 @@
 import django_tables2 as tables
+from django.utils.safestring import mark_safe
 from django_tables2.utils import Accessor
 
-from utilities.tables import BaseTable, SearchTable, ToggleColumn
-
+from tenancy.tables import COL_TENANT
+from utilities.tables import BaseTable, ToggleColumn
 from .models import Circuit, CircuitType, Provider
 
-
 CIRCUITTYPE_ACTIONS = """
+<a href="{% url 'circuits:circuittype_changelog' slug=record.slug %}" class="btn btn-default btn-xs" title="Changelog">
+    <i class="fa fa-history"></i>
+</a>
 {% if perms.circuit.change_circuittype %}
     <a href="{% url 'circuits:circuittype_edit' slug=record.slug %}" class="btn btn-xs btn-warning"><i class="glyphicon glyphicon-pencil" aria-hidden="true"></i></a>
 {% endif %}
 """
 
+STATUS_LABEL = """
+<span class="label label-{{ record.get_status_class }}">{{ record.get_status_display }}</span>
+"""
+
+
+class CircuitTerminationColumn(tables.Column):
+
+    def render(self, value):
+        return mark_safe('<a href="{}">{}</a>'.format(
+            value.site.get_absolute_url(),
+            value.site
+        ))
+
 
 #
 # Providers
@@ -20,19 +36,18 @@ CIRCUITTYPE_ACTIONS = """
 class ProviderTable(BaseTable):
     pk = ToggleColumn()
     name = tables.LinkColumn()
-    circuit_count = tables.Column(accessor=Accessor('count_circuits'), verbose_name='Circuits')
 
     class Meta(BaseTable.Meta):
         model = Provider
-        fields = ('pk', 'name', 'asn', 'account', 'circuit_count')
+        fields = ('pk', 'name', 'asn', 'account',)
 
 
-class ProviderSearchTable(SearchTable):
-    name = tables.LinkColumn()
+class ProviderDetailTable(ProviderTable):
+    circuit_count = tables.Column(accessor=Accessor('count_circuits'), verbose_name='Circuits')
 
-    class Meta(SearchTable.Meta):
+    class Meta(ProviderTable.Meta):
         model = Provider
-        fields = ('name', 'asn', 'account')
+        fields = ('pk', 'name', 'asn', 'account', 'circuit_count')
 
 
 #
@@ -60,26 +75,11 @@ class CircuitTable(BaseTable):
     pk = ToggleColumn()
     cid = tables.LinkColumn(verbose_name='ID')
     provider = tables.LinkColumn('circuits:provider', args=[Accessor('provider.slug')])
-    tenant = tables.LinkColumn('tenancy:tenant', args=[Accessor('tenant.slug')])
-    a_side = tables.LinkColumn(
-        'dcim:site', accessor=Accessor('termination_a.site'), orderable=False,
-        args=[Accessor('termination_a.site.slug')]
-    )
-    z_side = tables.LinkColumn(
-        'dcim:site', accessor=Accessor('termination_z.site'), orderable=False,
-        args=[Accessor('termination_z.site.slug')]
-    )
+    status = tables.TemplateColumn(template_code=STATUS_LABEL, verbose_name='Status')
+    tenant = tables.TemplateColumn(template_code=COL_TENANT)
+    termination_a = CircuitTerminationColumn(orderable=False, verbose_name='A Side')
+    termination_z = CircuitTerminationColumn(orderable=False, verbose_name='Z Side')
 
     class Meta(BaseTable.Meta):
         model = Circuit
-        fields = ('pk', 'cid', 'type', 'provider', 'tenant', 'a_side', 'z_side', 'description')
-
-
-class CircuitSearchTable(SearchTable):
-    cid = tables.LinkColumn(verbose_name='ID')
-    provider = tables.LinkColumn('circuits:provider', args=[Accessor('provider.slug')])
-    tenant = tables.LinkColumn('tenancy:tenant', args=[Accessor('tenant.slug')])
-
-    class Meta(SearchTable.Meta):
-        model = Circuit
-        fields = ('cid', 'type', 'provider', 'tenant', 'description')
+        fields = ('pk', 'cid', 'status', 'type', 'provider', 'tenant', 'termination_a', 'termination_z', 'description')

netbox/circuits/tests/test_api.py

@@ -1,23 +1,19 @@
-from rest_framework import status
-from rest_framework.test import APITestCase
-
-from django.contrib.auth.models import User
 from django.urls import reverse
+from rest_framework import status
 
-from dcim.models import Site
-from extras.models import Graph, GRAPH_TYPE_PROVIDER
-from circuits.models import Circuit, CircuitTermination, CircuitType, Provider, TERM_SIDE_A, TERM_SIDE_Z
-from users.models import Token
-from utilities.tests import HttpStatusMixin
+from circuits.constants import CIRCUIT_STATUS_ACTIVE, TERM_SIDE_A, TERM_SIDE_Z
+from circuits.models import Circuit, CircuitTermination, CircuitType, Provider
+from dcim.models import Device, DeviceRole, DeviceType, Interface, Manufacturer, Site
+from extras.constants import GRAPH_TYPE_PROVIDER
+from extras.models import Graph
+from utilities.testing import APITestCase
 
 
-class ProviderTest(HttpStatusMixin, APITestCase):
+class ProviderTest(APITestCase):
 
     def setUp(self):
 
-        user = User.objects.create(username='testuser', is_superuser=True)
-        token = Token.objects.create(user=user)
-        self.header = {'HTTP_AUTHORIZATION': 'Token {}'.format(token.key)}
+        super().setUp()
 
         self.provider1 = Provider.objects.create(name='Test Provider 1', slug='test-provider-1')
         self.provider2 = Provider.objects.create(name='Test Provider 2', slug='test-provider-2')
@@ -58,6 +54,16 @@ class ProviderTest(HttpStatusMixin, APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_providers_brief(self):
+
+        url = reverse('circuits-api:provider-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'slug', 'url']
+        )
+
     def test_create_provider(self):
 
         data = {
@@ -66,7 +72,7 @@ class ProviderTest(HttpStatusMixin, APITestCase):
         }
 
         url = reverse('circuits-api:provider-list')
-        response = self.client.post(url, data, **self.header)
+        response = self.client.post(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(Provider.objects.count(), 4)
@@ -74,6 +80,32 @@ class ProviderTest(HttpStatusMixin, APITestCase):
         self.assertEqual(provider4.name, data['name'])
         self.assertEqual(provider4.slug, data['slug'])
 
+    def test_create_provider_bulk(self):
+
+        data = [
+            {
+                'name': 'Test Provider 4',
+                'slug': 'test-provider-4',
+            },
+            {
+                'name': 'Test Provider 5',
+                'slug': 'test-provider-5',
+            },
+            {
+                'name': 'Test Provider 6',
+                'slug': 'test-provider-6',
+            },
+        ]
+
+        url = reverse('circuits-api:provider-list')
+        response = self.client.post(url, data, format='json', **self.header)
+
+        self.assertHttpStatus(response, status.HTTP_201_CREATED)
+        self.assertEqual(Provider.objects.count(), 6)
+        self.assertEqual(response.data[0]['name'], data[0]['name'])
+        self.assertEqual(response.data[1]['name'], data[1]['name'])
+        self.assertEqual(response.data[2]['name'], data[2]['name'])
+
     def test_update_provider(self):
 
         data = {
@@ -82,7 +114,7 @@ class ProviderTest(HttpStatusMixin, APITestCase):
         }
 
         url = reverse('circuits-api:provider-detail', kwargs={'pk': self.provider1.pk})
-        response = self.client.put(url, data, **self.header)
+        response = self.client.put(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_200_OK)
         self.assertEqual(Provider.objects.count(), 3)
@@ -99,13 +131,11 @@ class ProviderTest(HttpStatusMixin, APITestCase):
         self.assertEqual(Provider.objects.count(), 2)
 
 
-class CircuitTypeTest(HttpStatusMixin, APITestCase):
+class CircuitTypeTest(APITestCase):
 
     def setUp(self):
 
-        user = User.objects.create(username='testuser', is_superuser=True)
-        token = Token.objects.create(user=user)
-        self.header = {'HTTP_AUTHORIZATION': 'Token {}'.format(token.key)}
+        super().setUp()
 
         self.circuittype1 = CircuitType.objects.create(name='Test Circuit Type 1', slug='test-circuit-type-1')
         self.circuittype2 = CircuitType.objects.create(name='Test Circuit Type 2', slug='test-circuit-type-2')
@@ -125,6 +155,16 @@ class CircuitTypeTest(HttpStatusMixin, APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_circuittypes_brief(self):
+
+        url = reverse('circuits-api:circuittype-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['id', 'name', 'slug', 'url']
+        )
+
     def test_create_circuittype(self):
 
         data = {
@@ -133,7 +173,7 @@ class CircuitTypeTest(HttpStatusMixin, APITestCase):
         }
 
         url = reverse('circuits-api:circuittype-list')
-        response = self.client.post(url, data, **self.header)
+        response = self.client.post(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(CircuitType.objects.count(), 4)
@@ -149,7 +189,7 @@ class CircuitTypeTest(HttpStatusMixin, APITestCase):
         }
 
         url = reverse('circuits-api:circuittype-detail', kwargs={'pk': self.circuittype1.pk})
-        response = self.client.put(url, data, **self.header)
+        response = self.client.put(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_200_OK)
         self.assertEqual(CircuitType.objects.count(), 3)
@@ -166,13 +206,11 @@ class CircuitTypeTest(HttpStatusMixin, APITestCase):
         self.assertEqual(CircuitType.objects.count(), 2)
 
 
-class CircuitTest(HttpStatusMixin, APITestCase):
+class CircuitTest(APITestCase):
 
     def setUp(self):
 
-        user = User.objects.create(username='testuser', is_superuser=True)
-        token = Token.objects.create(user=user)
-        self.header = {'HTTP_AUTHORIZATION': 'Token {}'.format(token.key)}
+        super().setUp()
 
         self.provider1 = Provider.objects.create(name='Test Provider 1', slug='test-provider-1')
         self.provider2 = Provider.objects.create(name='Test Provider 2', slug='test-provider-2')
@@ -196,16 +234,27 @@ class CircuitTest(HttpStatusMixin, APITestCase):
 
         self.assertEqual(response.data['count'], 3)
 
+    def test_list_circuits_brief(self):
+
+        url = reverse('circuits-api:circuit-list')
+        response = self.client.get('{}?brief=1'.format(url), **self.header)
+
+        self.assertEqual(
+            sorted(response.data['results'][0]),
+            ['cid', 'id', 'url']
+        )
+
     def test_create_circuit(self):
 
         data = {
             'cid': 'TEST0004',
             'provider': self.provider1.pk,
             'type': self.circuittype1.pk,
+            'status': CIRCUIT_STATUS_ACTIVE,
         }
 
         url = reverse('circuits-api:circuit-list')
-        response = self.client.post(url, data, **self.header)
+        response = self.client.post(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
         self.assertEqual(Circuit.objects.count(), 4)
@@ -214,6 +263,38 @@ class CircuitTest(HttpStatusMixin, APITestCase):
         self.assertEqual(circuit4.provider_id, data['provider'])
         self.assertEqual(circuit4.type_id, data['type'])
 
+    def test_create_circuit_bulk(self):
+
+        data = [
+            {
+                'cid': 'TEST0004',
+                'provider': self.provider1.pk,
+                'type': self.circuittype1.pk,
+                'status': CIRCUIT_STATUS_ACTIVE,
+            },
+            {
+                'cid': 'TEST0005',
+                'provider': self.provider1.pk,
+                'type': self.circuittype1.pk,
+                'status': CIRCUIT_STATUS_ACTIVE,
+            },
+            {
+                'cid': 'TEST0006',
+                'provider': self.provider1.pk,
+                'type': self.circuittype1.pk,
+                'status': CIRCUIT_STATUS_ACTIVE,
+            },
+        ]
+
+        url = reverse('circuits-api:circuit-list')
+        response = self.client.post(url, data, format='json', **self.header)
+
+        self.assertHttpStatus(response, status.HTTP_201_CREATED)
+        self.assertEqual(Circuit.objects.count(), 6)
+        self.assertEqual(response.data[0]['cid'], data[0]['cid'])
+        self.assertEqual(response.data[1]['cid'], data[1]['cid'])
+        self.assertEqual(response.data[2]['cid'], data[2]['cid'])
+
     def test_update_circuit(self):
 
         data = {
@@ -223,7 +304,7 @@ class CircuitTest(HttpStatusMixin, APITestCase):
         }
 
         url = reverse('circuits-api:circuit-detail', kwargs={'pk': self.circuit1.pk})
-        response = self.client.put(url, data, **self.header)
+        response = self.client.put(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_200_OK)
         self.assertEqual(Circuit.objects.count(), 3)
@@ -241,29 +322,30 @@ class CircuitTest(HttpStatusMixin, APITestCase):
         self.assertEqual(Circuit.objects.count(), 2)
 
 
-class CircuitTerminationTest(HttpStatusMixin, APITestCase):
+class CircuitTerminationTest(APITestCase):
 
     def setUp(self):
 
-        user = User.objects.create(username='testuser', is_superuser=True)
-        token = Token.objects.create(user=user)
-        self.header = {'HTTP_AUTHORIZATION': 'Token {}'.format(token.key)}
+        super().setUp()
 
+        self.site1 = Site.objects.create(name='Test Site 1', slug='test-site-1')
+        self.site2 = Site.objects.create(name='Test Site 2', slug='test-site-2')
         provider = Provider.objects.create(name='Test Provider', slug='test-provider')
         circuittype = CircuitType.objects.create(name='Test Circuit Type', slug='test-circuit-type')
         self.circuit1 = Circuit.objects.create(cid='TEST0001', provider=provider, type=circuittype)
         self.circuit2 = Circuit.objects.create(cid='TEST0002', provider=provider, type=circuittype)
         self.circuit3 = Circuit.objects.create(cid='TEST0003', provider=provider, type=circuittype)
-        self.site1 = Site.objects.create(name='Test Site 1', slug='test-site-1')
-        self.site2 = Site.objects.create(name='Test Site 2', slug='test-site-2')
         self.circuittermination1 = CircuitTermination.objects.create(
             circuit=self.circuit1, term_side=TERM_SIDE_A, site=self.site1, port_speed=1000000
         )
         self.circuittermination2 = CircuitTermination.objects.create(
-            circuit=self.circuit2, term_side=TERM_SIDE_A, site=self.site1, port_speed=1000000
+            circuit=self.circuit1, term_side=TERM_SIDE_Z, site=self.site2, port_speed=1000000
         )
         self.circuittermination3 = CircuitTermination.objects.create(
-            circuit=self.circuit3, term_side=TERM_SIDE_A, site=self.site1, port_speed=1000000
+            circuit=self.circuit2, term_side=TERM_SIDE_A, site=self.site1, port_speed=1000000
+        )
+        self.circuittermination4 = CircuitTermination.objects.create(
+            circuit=self.circuit2, term_side=TERM_SIDE_Z, site=self.site2, port_speed=1000000
         )
 
     def test_get_circuittermination(self):
@@ -278,22 +360,22 @@ class CircuitTerminationTest(HttpStatusMixin, APITestCase):
         url = reverse('circuits-api:circuittermination-list')
         response = self.client.get(url, **self.header)
 
-        self.assertEqual(response.data['count'], 3)
+        self.assertEqual(response.data['count'], 4)
 
     def test_create_circuittermination(self):
 
         data = {
-            'circuit': self.circuit1.pk,
-            'term_side': TERM_SIDE_Z,
-            'site': self.site2.pk,
+            'circuit': self.circuit3.pk,
+            'term_side': TERM_SIDE_A,
+            'site': self.site1.pk,
             'port_speed': 1000000,
         }
 
         url = reverse('circuits-api:circuittermination-list')
-        response = self.client.post(url, data, **self.header)
+        response = self.client.post(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_201_CREATED)
-        self.assertEqual(CircuitTermination.objects.count(), 4)
+        self.assertEqual(CircuitTermination.objects.count(), 5)
         circuittermination4 = CircuitTermination.objects.get(pk=response.data['id'])
         self.assertEqual(circuittermination4.circuit_id, data['circuit'])
         self.assertEqual(circuittermination4.term_side, data['term_side'])
@@ -302,20 +384,23 @@ class CircuitTerminationTest(HttpStatusMixin, APITestCase):
 
     def test_update_circuittermination(self):
 
+        circuittermination5 = CircuitTermination.objects.create(
+            circuit=self.circuit3, term_side=TERM_SIDE_A, site=self.site1, port_speed=1000000
+        )
+
         data = {
-            'circuit': self.circuit1.pk,
+            'circuit': self.circuit3.pk,
             'term_side': TERM_SIDE_Z,
             'site': self.site2.pk,
             'port_speed': 1000000,
         }
 
-        url = reverse('circuits-api:circuittermination-detail', kwargs={'pk': self.circuittermination1.pk})
-        response = self.client.put(url, data, **self.header)
+        url = reverse('circuits-api:circuittermination-detail', kwargs={'pk': circuittermination5.pk})
+        response = self.client.put(url, data, format='json', **self.header)
 
         self.assertHttpStatus(response, status.HTTP_200_OK)
-        self.assertEqual(CircuitTermination.objects.count(), 3)
+        self.assertEqual(CircuitTermination.objects.count(), 5)
         circuittermination1 = CircuitTermination.objects.get(pk=response.data['id'])
-        self.assertEqual(circuittermination1.circuit_id, data['circuit'])
         self.assertEqual(circuittermination1.term_side, data['term_side'])
         self.assertEqual(circuittermination1.site_id, data['site'])
         self.assertEqual(circuittermination1.port_speed, data['port_speed'])
@@ -326,4 +411,4 @@ class CircuitTerminationTest(HttpStatusMixin, APITestCase):
         response = self.client.delete(url, **self.header)
 
         self.assertHttpStatus(response, status.HTTP_204_NO_CONTENT)
-        self.assertEqual(CircuitTermination.objects.count(), 2)
+        self.assertEqual(CircuitTermination.objects.count(), 3)

netbox/circuits/urls.py

@@ -1,41 +1,49 @@
 from django.conf.urls import url
 
+from dcim.views import CableCreateView, CableTraceView
+from extras.views import ObjectChangeLogView
 from . import views
-
+from .models import Circuit, CircuitTermination, CircuitType, Provider
 
 app_name = 'circuits'
 urlpatterns = [
 
     # Providers
     url(r'^providers/$', views.ProviderListView.as_view(), name='provider_list'),
-    url(r'^providers/add/$', views.ProviderEditView.as_view(), name='provider_add'),
+    url(r'^providers/add/$', views.ProviderCreateView.as_view(), name='provider_add'),
     url(r'^providers/import/$', views.ProviderBulkImportView.as_view(), name='provider_import'),
     url(r'^providers/edit/$', views.ProviderBulkEditView.as_view(), name='provider_bulk_edit'),
     url(r'^providers/delete/$', views.ProviderBulkDeleteView.as_view(), name='provider_bulk_delete'),
-    url(r'^providers/(?P<slug>[\w-]+)/$', views.provider, name='provider'),
+    url(r'^providers/(?P<slug>[\w-]+)/$', views.ProviderView.as_view(), name='provider'),
     url(r'^providers/(?P<slug>[\w-]+)/edit/$', views.ProviderEditView.as_view(), name='provider_edit'),
     url(r'^providers/(?P<slug>[\w-]+)/delete/$', views.ProviderDeleteView.as_view(), name='provider_delete'),
+    url(r'^providers/(?P<slug>[\w-]+)/changelog/$', ObjectChangeLogView.as_view(), name='provider_changelog', kwargs={'model': Provider}),
 
     # Circuit types
     url(r'^circuit-types/$', views.CircuitTypeListView.as_view(), name='circuittype_list'),
-    url(r'^circuit-types/add/$', views.CircuitTypeEditView.as_view(), name='circuittype_add'),
+    url(r'^circuit-types/add/$', views.CircuitTypeCreateView.as_view(), name='circuittype_add'),
+    url(r'^circuit-types/import/$', views.CircuitTypeBulkImportView.as_view(), name='circuittype_import'),
     url(r'^circuit-types/delete/$', views.CircuitTypeBulkDeleteView.as_view(), name='circuittype_bulk_delete'),
     url(r'^circuit-types/(?P<slug>[\w-]+)/edit/$', views.CircuitTypeEditView.as_view(), name='circuittype_edit'),
+    url(r'^circuit-types/(?P<slug>[\w-]+)/changelog/$', ObjectChangeLogView.as_view(), name='circuittype_changelog', kwargs={'model': CircuitType}),
 
     # Circuits
     url(r'^circuits/$', views.CircuitListView.as_view(), name='circuit_list'),
-    url(r'^circuits/add/$', views.CircuitEditView.as_view(), name='circuit_add'),
+    url(r'^circuits/add/$', views.CircuitCreateView.as_view(), name='circuit_add'),
     url(r'^circuits/import/$', views.CircuitBulkImportView.as_view(), name='circuit_import'),
     url(r'^circuits/edit/$', views.CircuitBulkEditView.as_view(), name='circuit_bulk_edit'),
     url(r'^circuits/delete/$', views.CircuitBulkDeleteView.as_view(), name='circuit_bulk_delete'),
-    url(r'^circuits/(?P<pk>\d+)/$', views.circuit, name='circuit'),
+    url(r'^circuits/(?P<pk>\d+)/$', views.CircuitView.as_view(), name='circuit'),
     url(r'^circuits/(?P<pk>\d+)/edit/$', views.CircuitEditView.as_view(), name='circuit_edit'),
     url(r'^circuits/(?P<pk>\d+)/delete/$', views.CircuitDeleteView.as_view(), name='circuit_delete'),
+    url(r'^circuits/(?P<pk>\d+)/changelog/$', ObjectChangeLogView.as_view(), name='circuit_changelog', kwargs={'model': Circuit}),
     url(r'^circuits/(?P<pk>\d+)/terminations/swap/$', views.circuit_terminations_swap, name='circuit_terminations_swap'),
 
     # Circuit terminations
-    url(r'^circuits/(?P<circuit>\d+)/terminations/add/$', views.CircuitTerminationEditView.as_view(), name='circuittermination_add'),
+    url(r'^circuits/(?P<circuit>\d+)/terminations/add/$', views.CircuitTerminationCreateView.as_view(), name='circuittermination_add'),
     url(r'^circuit-terminations/(?P<pk>\d+)/edit/$', views.CircuitTerminationEditView.as_view(), name='circuittermination_edit'),
     url(r'^circuit-terminations/(?P<pk>\d+)/delete/$', views.CircuitTerminationDeleteView.as_view(), name='circuittermination_delete'),
+    url(r'^circuit-terminations/(?P<termination_a_id>\d+)/connect/$', CableCreateView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}),
+    url(r'^circuit-terminations/(?P<pk>\d+)/trace/$', CableTraceView.as_view(), name='circuittermination_trace', kwargs={'model': CircuitTermination}),
 
 ]

netbox/circuits/views.py

@@ -4,16 +4,16 @@ from django.contrib.auth.mixins import PermissionRequiredMixin
 from django.db import transaction
 from django.db.models import Count
 from django.shortcuts import get_object_or_404, redirect, render
-from django.urls import reverse
+from django.views.generic import View
 
 from extras.models import Graph, GRAPH_TYPE_PROVIDER
 from utilities.forms import ConfirmationForm
 from utilities.views import (
     BulkDeleteView, BulkEditView, BulkImportView, ObjectDeleteView, ObjectEditView, ObjectListView,
 )
-
 from . import filters, forms, tables
-from .models import Circuit, CircuitTermination, CircuitType, Provider, TERM_SIDE_A, TERM_SIDE_Z
+from .constants import TERM_SIDE_A, TERM_SIDE_Z
+from .models import Circuit, CircuitTermination, CircuitType, Provider
 
 
 #
@@ -24,32 +24,41 @@ class ProviderListView(ObjectListView):
     queryset = Provider.objects.annotate(count_circuits=Count('circuits'))
     filter = filters.ProviderFilter
     filter_form = forms.ProviderFilterForm
-    table = tables.ProviderTable
+    table = tables.ProviderDetailTable
     template_name = 'circuits/provider_list.html'
 
 
-def provider(request, slug):
+class ProviderView(View):
 
-    provider = get_object_or_404(Provider, slug=slug)
-    circuits = Circuit.objects.filter(provider=provider).select_related('type', 'tenant')\
-        .prefetch_related('terminations__site')
-    show_graphs = Graph.objects.filter(type=GRAPH_TYPE_PROVIDER).exists()
+    def get(self, request, slug):
 
-    return render(request, 'circuits/provider.html', {
-        'provider': provider,
-        'circuits': circuits,
-        'show_graphs': show_graphs,
-    })
+        provider = get_object_or_404(Provider, slug=slug)
+        circuits = Circuit.objects.filter(provider=provider).select_related(
+            'type', 'tenant'
+        ).prefetch_related(
+            'terminations__site'
+        )
+        show_graphs = Graph.objects.filter(type=GRAPH_TYPE_PROVIDER).exists()
+
+        return render(request, 'circuits/provider.html', {
+            'provider': provider,
+            'circuits': circuits,
+            'show_graphs': show_graphs,
+        })
 
 
-class ProviderEditView(PermissionRequiredMixin, ObjectEditView):
-    permission_required = 'circuits.change_provider'
+class ProviderCreateView(PermissionRequiredMixin, ObjectEditView):
+    permission_required = 'circuits.add_provider'
     model = Provider
-    form_class = forms.ProviderForm
+    model_form = forms.ProviderForm
     template_name = 'circuits/provider_edit.html'
     default_return_url = 'circuits:provider_list'
 
 
+class ProviderEditView(ProviderCreateView):
+    permission_required = 'circuits.change_provider'
+
+
 class ProviderDeleteView(PermissionRequiredMixin, ObjectDeleteView):
     permission_required = 'circuits.delete_provider'
     model = Provider
@@ -58,25 +67,25 @@ class ProviderDeleteView(PermissionRequiredMixin, ObjectDeleteView):
 
 class ProviderBulkImportView(PermissionRequiredMixin, BulkImportView):
     permission_required = 'circuits.add_provider'
-    form = forms.ProviderImportForm
+    model_form = forms.ProviderCSVForm
     table = tables.ProviderTable
-    template_name = 'circuits/provider_import.html'
     default_return_url = 'circuits:provider_list'
 
 
 class ProviderBulkEditView(PermissionRequiredMixin, BulkEditView):
     permission_required = 'circuits.change_provider'
-    cls = Provider
+    queryset = Provider.objects.all()
     filter = filters.ProviderFilter
+    table = tables.ProviderTable
     form = forms.ProviderBulkEditForm
-    template_name = 'circuits/provider_bulk_edit.html'
     default_return_url = 'circuits:provider_list'
 
 
 class ProviderBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_provider'
-    cls = Provider
+    queryset = Provider.objects.all()
     filter = filters.ProviderFilter
+    table = tables.ProviderTable
     default_return_url = 'circuits:provider_list'
 
 
@@ -90,18 +99,28 @@ class CircuitTypeListView(ObjectListView):
     template_name = 'circuits/circuittype_list.html'
 
 
-class CircuitTypeEditView(PermissionRequiredMixin, ObjectEditView):
-    permission_required = 'circuits.change_circuittype'
+class CircuitTypeCreateView(PermissionRequiredMixin, ObjectEditView):
+    permission_required = 'circuits.add_circuittype'
     model = CircuitType
-    form_class = forms.CircuitTypeForm
+    model_form = forms.CircuitTypeForm
+    default_return_url = 'circuits:circuittype_list'
 
-    def get_return_url(self, request, obj):
-        return reverse('circuits:circuittype_list')
+
+class CircuitTypeEditView(CircuitTypeCreateView):
+    permission_required = 'circuits.change_circuittype'
+
+
+class CircuitTypeBulkImportView(PermissionRequiredMixin, BulkImportView):
+    permission_required = 'circuits.add_circuittype'
+    model_form = forms.CircuitTypeCSVForm
+    table = tables.CircuitTypeTable
+    default_return_url = 'circuits:circuittype_list'
 
 
 class CircuitTypeBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_circuittype'
-    cls = CircuitType
+    queryset = CircuitType.objects.annotate(circuit_count=Count('circuits'))
+    table = tables.CircuitTypeTable
     default_return_url = 'circuits:circuittype_list'
 
 
@@ -110,42 +129,52 @@ class CircuitTypeBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
 #
 
 class CircuitListView(ObjectListView):
-    queryset = Circuit.objects.select_related('provider', 'type', 'tenant').prefetch_related('terminations__site')
+    queryset = Circuit.objects.select_related(
+        'provider', 'type', 'tenant'
+    ).prefetch_related(
+        'terminations__site'
+    )
     filter = filters.CircuitFilter
     filter_form = forms.CircuitFilterForm
     table = tables.CircuitTable
     template_name = 'circuits/circuit_list.html'
 
 
-def circuit(request, pk):
+class CircuitView(View):
 
-    circuit = get_object_or_404(Circuit.objects.select_related('provider', 'type', 'tenant__group'), pk=pk)
-    termination_a = CircuitTermination.objects.select_related(
-        'site__region', 'interface__device'
-    ).filter(
-        circuit=circuit, term_side=TERM_SIDE_A
-    ).first()
-    termination_z = CircuitTermination.objects.select_related(
-        'site__region', 'interface__device'
-    ).filter(
-        circuit=circuit, term_side=TERM_SIDE_Z
-    ).first()
+    def get(self, request, pk):
 
-    return render(request, 'circuits/circuit.html', {
-        'circuit': circuit,
-        'termination_a': termination_a,
-        'termination_z': termination_z,
-    })
+        circuit = get_object_or_404(Circuit.objects.select_related('provider', 'type', 'tenant__group'), pk=pk)
+        termination_a = CircuitTermination.objects.select_related(
+            'site__region', 'connected_endpoint__device'
+        ).filter(
+            circuit=circuit, term_side=TERM_SIDE_A
+        ).first()
+        termination_z = CircuitTermination.objects.select_related(
+            'site__region', 'connected_endpoint__device'
+        ).filter(
+            circuit=circuit, term_side=TERM_SIDE_Z
+        ).first()
+
+        return render(request, 'circuits/circuit.html', {
+            'circuit': circuit,
+            'termination_a': termination_a,
+            'termination_z': termination_z,
+        })
 
 
-class CircuitEditView(PermissionRequiredMixin, ObjectEditView):
-    permission_required = 'circuits.change_circuit'
+class CircuitCreateView(PermissionRequiredMixin, ObjectEditView):
+    permission_required = 'circuits.add_circuit'
     model = Circuit
-    form_class = forms.CircuitForm
+    model_form = forms.CircuitForm
     template_name = 'circuits/circuit_edit.html'
     default_return_url = 'circuits:circuit_list'
 
 
+class CircuitEditView(CircuitCreateView):
+    permission_required = 'circuits.change_circuit'
+
+
 class CircuitDeleteView(PermissionRequiredMixin, ObjectDeleteView):
     permission_required = 'circuits.delete_circuit'
     model = Circuit
@@ -154,25 +183,25 @@ class CircuitDeleteView(PermissionRequiredMixin, ObjectDeleteView):
 
 class CircuitBulkImportView(PermissionRequiredMixin, BulkImportView):
     permission_required = 'circuits.add_circuit'
-    form = forms.CircuitImportForm
+    model_form = forms.CircuitCSVForm
     table = tables.CircuitTable
-    template_name = 'circuits/circuit_import.html'
     default_return_url = 'circuits:circuit_list'
 
 
 class CircuitBulkEditView(PermissionRequiredMixin, BulkEditView):
     permission_required = 'circuits.change_circuit'
-    cls = Circuit
+    queryset = Circuit.objects.select_related('provider', 'type', 'tenant').prefetch_related('terminations__site')
     filter = filters.CircuitFilter
+    table = tables.CircuitTable
     form = forms.CircuitBulkEditForm
-    template_name = 'circuits/circuit_bulk_edit.html'
     default_return_url = 'circuits:circuit_list'
 
 
 class CircuitBulkDeleteView(PermissionRequiredMixin, BulkDeleteView):
     permission_required = 'circuits.delete_circuit'
-    cls = Circuit
+    queryset = Circuit.objects.select_related('provider', 'type', 'tenant').prefetch_related('terminations__site')
     filter = filters.CircuitFilter
+    table = tables.CircuitTable
     default_return_url = 'circuits:circuit_list'
 
 
@@ -225,10 +254,10 @@ def circuit_terminations_swap(request, pk):
 # Circuit terminations
 #
 
-class CircuitTerminationEditView(PermissionRequiredMixin, ObjectEditView):
-    permission_required = 'circuits.change_circuittermination'
+class CircuitTerminationCreateView(PermissionRequiredMixin, ObjectEditView):
+    permission_required = 'circuits.add_circuittermination'
     model = CircuitTermination
-    form_class = forms.CircuitTerminationForm
+    model_form = forms.CircuitTerminationForm
     template_name = 'circuits/circuittermination_edit.html'
 
     def alter_obj(self, obj, request, url_args, url_kwargs):
@@ -240,6 +269,10 @@ class CircuitTerminationEditView(PermissionRequiredMixin, ObjectEditView):
         return obj.circuit.get_absolute_url()
 
 
+class CircuitTerminationEditView(CircuitTerminationCreateView):
+    permission_required = 'circuits.change_circuittermination'
+
+
 class CircuitTerminationDeleteView(PermissionRequiredMixin, ObjectDeleteView):
     permission_required = 'circuits.delete_circuittermination'
     model = CircuitTermination

netbox/dcim/api/nested_serializers.py

@@ -0,0 +1,249 @@
+from rest_framework import serializers
+
+from dcim.constants import CONNECTION_STATUS_CHOICES
+from dcim.models import (
+    Cable, ConsolePort, ConsoleServerPort, Device, DeviceBay, DeviceType, DeviceRole, FrontPort, FrontPortTemplate,
+    Interface, Manufacturer, Platform, PowerOutlet, PowerPort, Rack, RackGroup, RackRole, RearPort, RearPortTemplate,
+    Region, Site, VirtualChassis,
+)
+from utilities.api import ChoiceField, WritableNestedSerializer
+
+__all__ = [
+    'NestedCableSerializer',
+    'NestedConsolePortSerializer',
+    'NestedConsoleServerPortSerializer',
+    'NestedDeviceBaySerializer',
+    'NestedDeviceRoleSerializer',
+    'NestedDeviceSerializer',
+    'NestedDeviceTypeSerializer',
+    'NestedFrontPortSerializer',
+    'NestedFrontPortTemplateSerializer',
+    'NestedInterfaceSerializer',
+    'NestedManufacturerSerializer',
+    'NestedPlatformSerializer',
+    'NestedPowerOutletSerializer',
+    'NestedPowerPortSerializer',
+    'NestedRackGroupSerializer',
+    'NestedRackRoleSerializer',
+    'NestedRackSerializer',
+    'NestedRearPortSerializer',
+    'NestedRearPortTemplateSerializer',
+    'NestedRegionSerializer',
+    'NestedSiteSerializer',
+    'NestedVirtualChassisSerializer',
+]
+
+
+#
+# Regions/sites
+#
+
+class NestedRegionSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:region-detail')
+
+    class Meta:
+        model = Region
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedSiteSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:site-detail')
+
+    class Meta:
+        model = Site
+        fields = ['id', 'url', 'name', 'slug']
+
+
+#
+# Racks
+#
+
+class NestedRackGroupSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackgroup-detail')
+
+    class Meta:
+        model = RackGroup
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedRackRoleSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rackrole-detail')
+
+    class Meta:
+        model = RackRole
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedRackSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rack-detail')
+
+    class Meta:
+        model = Rack
+        fields = ['id', 'url', 'name', 'display_name']
+
+
+#
+# Device types
+#
+
+class NestedManufacturerSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:manufacturer-detail')
+
+    class Meta:
+        model = Manufacturer
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedDeviceTypeSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:devicetype-detail')
+    manufacturer = NestedManufacturerSerializer(read_only=True)
+
+    class Meta:
+        model = DeviceType
+        fields = ['id', 'url', 'manufacturer', 'model', 'slug']
+
+
+class NestedRearPortTemplateSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearporttemplate-detail')
+
+    class Meta:
+        model = RearPortTemplate
+        fields = ['id', 'url', 'name']
+
+
+class NestedFrontPortTemplateSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:frontporttemplate-detail')
+
+    class Meta:
+        model = FrontPortTemplate
+        fields = ['id', 'url', 'name']
+
+
+#
+# Devices
+#
+
+class NestedDeviceRoleSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:devicerole-detail')
+
+    class Meta:
+        model = DeviceRole
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedPlatformSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:platform-detail')
+
+    class Meta:
+        model = Platform
+        fields = ['id', 'url', 'name', 'slug']
+
+
+class NestedDeviceSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:device-detail')
+
+    class Meta:
+        model = Device
+        fields = ['id', 'url', 'name', 'display_name']
+
+
+class NestedConsoleServerPortSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleserverport-detail')
+    device = NestedDeviceSerializer(read_only=True)
+    connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
+
+    class Meta:
+        model = ConsoleServerPort
+        fields = ['id', 'url', 'device', 'name', 'cable', 'connection_status']
+
+
+class NestedConsolePortSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleport-detail')
+    device = NestedDeviceSerializer(read_only=True)
+    connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
+
+    class Meta:
+        model = ConsolePort
+        fields = ['id', 'url', 'device', 'name', 'cable', 'connection_status']
+
+
+class NestedPowerOutletSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:poweroutlet-detail')
+    device = NestedDeviceSerializer(read_only=True)
+    connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
+
+    class Meta:
+        model = PowerOutlet
+        fields = ['id', 'url', 'device', 'name', 'cable', 'connection_status']
+
+
+class NestedPowerPortSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:powerport-detail')
+    device = NestedDeviceSerializer(read_only=True)
+    connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
+
+    class Meta:
+        model = PowerPort
+        fields = ['id', 'url', 'device', 'name', 'cable', 'connection_status']
+
+
+class NestedInterfaceSerializer(WritableNestedSerializer):
+    device = NestedDeviceSerializer(read_only=True)
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:interface-detail')
+    connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
+
+    class Meta:
+        model = Interface
+        fields = ['id', 'url', 'device', 'name', 'cable', 'connection_status']
+
+
+class NestedRearPortSerializer(WritableNestedSerializer):
+    device = NestedDeviceSerializer(read_only=True)
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearport-detail')
+
+    class Meta:
+        model = RearPort
+        fields = ['id', 'url', 'device', 'name', 'cable']
+
+
+class NestedFrontPortSerializer(WritableNestedSerializer):
+    device = NestedDeviceSerializer(read_only=True)
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:frontport-detail')
+
+    class Meta:
+        model = FrontPort
+        fields = ['id', 'url', 'device', 'name', 'cable']
+
+
+class NestedDeviceBaySerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearport-detail')
+    device = NestedDeviceSerializer(read_only=True)
+
+    class Meta:
+        model = DeviceBay
+        fields = ['id', 'url', 'device', 'name']
+
+
+#
+# Cables
+#
+
+class NestedCableSerializer(serializers.ModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail')
+
+    class Meta:
+        model = Cable
+        fields = ['id', 'url', 'label']
+
+
+#
+# Virtual chassis
+#
+
+class NestedVirtualChassisSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='dcim-api:virtualchassis-detail')
+    master = NestedDeviceSerializer()
+
+    class Meta:
+        model = VirtualChassis
+        fields = ['id', 'url', 'master']

netbox/dcim/api/urls.py

@@ -14,6 +14,9 @@ class DCIMRootView(routers.APIRootView):
 router = routers.DefaultRouter()
 router.APIRootView = DCIMRootView
 
+# Field choices
+router.register(r'_choices', views.DCIMFieldChoicesViewSet, basename='field-choice')
+
 # Sites
 router.register(r'regions', views.RegionViewSet)
 router.register(r'sites', views.SiteViewSet)
@@ -34,6 +37,8 @@ router.register(r'console-server-port-templates', views.ConsoleServerPortTemplat
 router.register(r'power-port-templates', views.PowerPortTemplateViewSet)
 router.register(r'power-outlet-templates', views.PowerOutletTemplateViewSet)
 router.register(r'interface-templates', views.InterfaceTemplateViewSet)
+router.register(r'front-port-templates', views.FrontPortTemplateViewSet)
+router.register(r'rear-port-templates', views.RearPortTemplateViewSet)
 router.register(r'device-bay-templates', views.DeviceBayTemplateViewSet)
 
 # Devices
@@ -47,16 +52,24 @@ router.register(r'console-server-ports', views.ConsoleServerPortViewSet)
 router.register(r'power-ports', views.PowerPortViewSet)
 router.register(r'power-outlets', views.PowerOutletViewSet)
 router.register(r'interfaces', views.InterfaceViewSet)
+router.register(r'front-ports', views.FrontPortViewSet)
+router.register(r'rear-ports', views.RearPortViewSet)
 router.register(r'device-bays', views.DeviceBayViewSet)
 router.register(r'inventory-items', views.InventoryItemViewSet)
 
 # Connections
-router.register(r'console-connections', views.ConsoleConnectionViewSet, base_name='consoleconnections')
-router.register(r'power-connections', views.PowerConnectionViewSet, base_name='powerconnections')
-router.register(r'interface-connections', views.InterfaceConnectionViewSet)
+router.register(r'console-connections', views.ConsoleConnectionViewSet, basename='consoleconnections')
+router.register(r'power-connections', views.PowerConnectionViewSet, basename='powerconnections')
+router.register(r'interface-connections', views.InterfaceConnectionViewSet, basename='interfaceconnections')
+
+# Cables
+router.register(r'cables', views.CableViewSet)
+
+# Virtual chassis
+router.register(r'virtual-chassis', views.VirtualChassisViewSet)
 
 # Miscellaneous
-router.register(r'connected-device', views.ConnectedDeviceViewSet, base_name='connected-device')
+router.register(r'connected-device', views.ConnectedDeviceViewSet, basename='connected-device')
 
 app_name = 'dcim-api'
 urlpatterns = router.urls

netbox/dcim/api/views.py

@@ -1,48 +1,105 @@
-from rest_framework.decorators import detail_route
-from rest_framework.mixins import ListModelMixin
-from rest_framework.permissions import IsAuthenticated
-from rest_framework.response import Response
-from rest_framework.viewsets import GenericViewSet, ModelViewSet, ViewSet
+from collections import OrderedDict
 
 from django.conf import settings
+from django.db.models import F, Q
+from django.http import HttpResponseForbidden
 from django.shortcuts import get_object_or_404
+from drf_yasg import openapi
+from drf_yasg.openapi import Parameter
+from drf_yasg.utils import swagger_auto_schema
+from rest_framework.decorators import action
+from rest_framework.mixins import ListModelMixin
+from rest_framework.response import Response
+from rest_framework.viewsets import GenericViewSet, ViewSet
 
-from dcim.models import (
-    ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceBay,
-    DeviceBayTemplate, DeviceRole, DeviceType, Interface, InterfaceConnection, InterfaceTemplate, Manufacturer,
-    InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, Rack, RackGroup,
-    RackReservation, RackRole, Region, Site,
-)
 from dcim import filters
+from dcim.models import (
+    Cable, ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceBay,
+    DeviceBayTemplate, DeviceRole, DeviceType, FrontPort, FrontPortTemplate, Interface, InterfaceTemplate,
+    Manufacturer, InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, Rack,
+    RackGroup, RackReservation, RackRole, RearPort, RearPortTemplate, Region, Site, VirtualChassis,
+)
 from extras.api.serializers import RenderedGraphSerializer
 from extras.api.views import CustomFieldModelViewSet
 from extras.models import Graph, GRAPH_TYPE_INTERFACE, GRAPH_TYPE_SITE
-from utilities.api import ServiceUnavailable, WritableSerializerMixin
-from .exceptions import MissingFilterException
+from utilities.api import (
+    get_serializer_for_model, IsAuthenticatedOrLoginNotRequired, FieldChoicesViewSet, ModelViewSet, ServiceUnavailable,
+)
 from . import serializers
+from .exceptions import MissingFilterException
+
+
+#
+# Field choices
+#
+
+class DCIMFieldChoicesViewSet(FieldChoicesViewSet):
+    fields = (
+        (Cable, ['length_unit']),
+        (Device, ['face', 'status']),
+        (ConsolePort, ['connection_status']),
+        (Interface, ['connection_status', 'form_factor', 'mode']),
+        (InterfaceTemplate, ['form_factor']),
+        (PowerPort, ['connection_status']),
+        (Rack, ['outer_unit', 'status', 'type', 'width']),
+        (Site, ['status']),
+    )
+
+
+# Mixins
+
+class CableTraceMixin(object):
+
+    @action(detail=True, url_path='trace')
+    def trace(self, request, pk):
+        """
+        Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
+        """
+        obj = get_object_or_404(self.queryset.model, pk=pk)
+
+        # Initialize the path array
+        path = []
+
+        for near_end, cable, far_end in obj.trace():
+
+            # Serialize each object
+            serializer_a = get_serializer_for_model(near_end, prefix='Nested')
+            x = serializer_a(near_end, context={'request': request}).data
+            if cable is not None:
+                y = serializers.TracedCableSerializer(cable, context={'request': request}).data
+            else:
+                y = None
+            if far_end is not None:
+                serializer_b = get_serializer_for_model(far_end, prefix='Nested')
+                z = serializer_b(far_end, context={'request': request}).data
+            else:
+                z = None
+
+            path.append((x, y, z))
+
+        return Response(path)
 
 
 #
 # Regions
 #
 
-class RegionViewSet(WritableSerializerMixin, ModelViewSet):
+class RegionViewSet(ModelViewSet):
     queryset = Region.objects.all()
     serializer_class = serializers.RegionSerializer
-    write_serializer_class = serializers.WritableRegionSerializer
+    filterset_class = filters.RegionFilter
 
 
 #
 # Sites
 #
 
-class SiteViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
-    queryset = Site.objects.select_related('region', 'tenant')
+class SiteViewSet(CustomFieldModelViewSet):
+    queryset = Site.objects.select_related('region', 'tenant').prefetch_related('tags')
     serializer_class = serializers.SiteSerializer
-    write_serializer_class = serializers.WritableSiteSerializer
-    filter_class = filters.SiteFilter
+    filterset_class = filters.SiteFilter
 
-    @detail_route()
+    @action(detail=True)
     def graphs(self, request, pk=None):
         """
         A convenience method for rendering graphs for a particular site.
@@ -57,11 +114,10 @@ class SiteViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
 # Rack groups
 #
 
-class RackGroupViewSet(WritableSerializerMixin, ModelViewSet):
+class RackGroupViewSet(ModelViewSet):
     queryset = RackGroup.objects.select_related('site')
     serializer_class = serializers.RackGroupSerializer
-    write_serializer_class = serializers.WritableRackGroupSerializer
-    filter_class = filters.RackGroupFilter
+    filterset_class = filters.RackGroupFilter
 
 
 #
@@ -71,19 +127,19 @@ class RackGroupViewSet(WritableSerializerMixin, ModelViewSet):
 class RackRoleViewSet(ModelViewSet):
     queryset = RackRole.objects.all()
     serializer_class = serializers.RackRoleSerializer
+    filterset_class = filters.RackRoleFilter
 
 
 #
 # Racks
 #
 
-class RackViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
-    queryset = Rack.objects.select_related('site', 'group__site', 'tenant')
+class RackViewSet(CustomFieldModelViewSet):
+    queryset = Rack.objects.select_related('site', 'group__site', 'tenant').prefetch_related('tags')
     serializer_class = serializers.RackSerializer
-    write_serializer_class = serializers.WritableRackSerializer
-    filter_class = filters.RackFilter
+    filterset_class = filters.RackFilter
 
-    @detail_route()
+    @action(detail=True)
     def units(self, request, pk=None):
         """
         List rack units (by rack)
@@ -108,11 +164,10 @@ class RackViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
 # Rack reservations
 #
 
-class RackReservationViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = RackReservation.objects.select_related('rack')
+class RackReservationViewSet(ModelViewSet):
+    queryset = RackReservation.objects.select_related('rack', 'user', 'tenant')
     serializer_class = serializers.RackReservationSerializer
-    write_serializer_class = serializers.WritableRackReservationSerializer
-    filter_class = filters.RackReservationFilter
+    filterset_class = filters.RackReservationFilter
 
     # Assign user from request
     def perform_create(self, serializer):
@@ -126,63 +181,69 @@ class RackReservationViewSet(WritableSerializerMixin, ModelViewSet):
 class ManufacturerViewSet(ModelViewSet):
     queryset = Manufacturer.objects.all()
     serializer_class = serializers.ManufacturerSerializer
+    filterset_class = filters.ManufacturerFilter
 
 
 #
 # Device types
 #
 
-class DeviceTypeViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
-    queryset = DeviceType.objects.select_related('manufacturer')
+class DeviceTypeViewSet(CustomFieldModelViewSet):
+    queryset = DeviceType.objects.select_related('manufacturer').prefetch_related('tags')
     serializer_class = serializers.DeviceTypeSerializer
-    write_serializer_class = serializers.WritableDeviceTypeSerializer
-    filter_class = filters.DeviceTypeFilter
+    filterset_class = filters.DeviceTypeFilter
 
 
 #
 # Device type components
 #
 
-class ConsolePortTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class ConsolePortTemplateViewSet(ModelViewSet):
     queryset = ConsolePortTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.ConsolePortTemplateSerializer
-    write_serializer_class = serializers.WritableConsolePortTemplateSerializer
-    filter_class = filters.ConsolePortTemplateFilter
+    filterset_class = filters.ConsolePortTemplateFilter
 
 
-class ConsoleServerPortTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class ConsoleServerPortTemplateViewSet(ModelViewSet):
     queryset = ConsoleServerPortTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.ConsoleServerPortTemplateSerializer
-    write_serializer_class = serializers.WritableConsoleServerPortTemplateSerializer
-    filter_class = filters.ConsoleServerPortTemplateFilter
+    filterset_class = filters.ConsoleServerPortTemplateFilter
 
 
-class PowerPortTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class PowerPortTemplateViewSet(ModelViewSet):
     queryset = PowerPortTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.PowerPortTemplateSerializer
-    write_serializer_class = serializers.WritablePowerPortTemplateSerializer
-    filter_class = filters.PowerPortTemplateFilter
+    filterset_class = filters.PowerPortTemplateFilter
 
 
-class PowerOutletTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class PowerOutletTemplateViewSet(ModelViewSet):
     queryset = PowerOutletTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.PowerOutletTemplateSerializer
-    write_serializer_class = serializers.WritablePowerOutletTemplateSerializer
-    filter_class = filters.PowerOutletTemplateFilter
+    filterset_class = filters.PowerOutletTemplateFilter
 
 
-class InterfaceTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class InterfaceTemplateViewSet(ModelViewSet):
     queryset = InterfaceTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.InterfaceTemplateSerializer
-    write_serializer_class = serializers.WritableInterfaceTemplateSerializer
-    filter_class = filters.InterfaceTemplateFilter
+    filterset_class = filters.InterfaceTemplateFilter
 
 
-class DeviceBayTemplateViewSet(WritableSerializerMixin, ModelViewSet):
+class FrontPortTemplateViewSet(ModelViewSet):
+    queryset = FrontPortTemplate.objects.select_related('device_type__manufacturer')
+    serializer_class = serializers.FrontPortTemplateSerializer
+    filterset_class = filters.FrontPortTemplateFilter
+
+
+class RearPortTemplateViewSet(ModelViewSet):
+    queryset = RearPortTemplate.objects.select_related('device_type__manufacturer')
+    serializer_class = serializers.RearPortTemplateSerializer
+    filterset_class = filters.RearPortTemplateFilter
+
+
+class DeviceBayTemplateViewSet(ModelViewSet):
     queryset = DeviceBayTemplate.objects.select_related('device_type__manufacturer')
     serializer_class = serializers.DeviceBayTemplateSerializer
-    write_serializer_class = serializers.WritableDeviceBayTemplateSerializer
-    filter_class = filters.DeviceBayTemplateFilter
+    filterset_class = filters.DeviceBayTemplateFilter
 
 
 #
@@ -192,6 +253,7 @@ class DeviceBayTemplateViewSet(WritableSerializerMixin, ModelViewSet):
 class DeviceRoleViewSet(ModelViewSet):
     queryset = DeviceRole.objects.all()
     serializer_class = serializers.DeviceRoleSerializer
+    filterset_class = filters.DeviceRoleFilter
 
 
 #
@@ -201,84 +263,161 @@ class DeviceRoleViewSet(ModelViewSet):
 class PlatformViewSet(ModelViewSet):
     queryset = Platform.objects.all()
     serializer_class = serializers.PlatformSerializer
+    filterset_class = filters.PlatformFilter
 
 
 #
 # Devices
 #
 
-class DeviceViewSet(WritableSerializerMixin, CustomFieldModelViewSet):
+class DeviceViewSet(CustomFieldModelViewSet):
     queryset = Device.objects.select_related(
         'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'rack', 'parent_bay',
+        'virtual_chassis__master',
     ).prefetch_related(
-        'primary_ip4__nat_outside', 'primary_ip6__nat_outside',
+        'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags',
     )
-    serializer_class = serializers.DeviceSerializer
-    write_serializer_class = serializers.WritableDeviceSerializer
-    filter_class = filters.DeviceFilter
+    filterset_class = filters.DeviceFilter
 
-    @detail_route(url_path='lldp-neighbors')
-    def lldp_neighbors(self, request, pk):
+    def get_serializer_class(self):
         """
-        Retrieve live LLDP neighbors of a device
+        Include rendered config context when retrieving a single Device.
+        """
+        if self.action == 'retrieve':
+            return serializers.DeviceWithConfigContextSerializer
+
+        request = self.get_serializer_context()['request']
+        if request.query_params.get('brief', False):
+            return serializers.NestedDeviceSerializer
+
+        return serializers.DeviceSerializer
+
+    @action(detail=True, url_path='napalm')
+    def napalm(self, request, pk):
+        """
+        Execute a NAPALM method on a Device
         """
         device = get_object_or_404(Device, pk=pk)
         if not device.primary_ip:
-            raise ServiceUnavailable("No IP configured for this device.")
+            raise ServiceUnavailable("This device does not have a primary IP address configured.")
+        if device.platform is None:
+            raise ServiceUnavailable("No platform is configured for this device.")
+        if not device.platform.napalm_driver:
+            raise ServiceUnavailable("No NAPALM driver is configured for this device's platform ().".format(
+                device.platform
+            ))
 
-        RPC = device.get_rpc_client()
-        if not RPC:
-            raise ServiceUnavailable("No RPC client available for this platform ({}).".format(device.platform))
-
-        # Connect to device and retrieve inventory info
+        # Check that NAPALM is installed
         try:
-            with RPC(device, username=settings.NETBOX_USERNAME, password=settings.NETBOX_PASSWORD) as rpc_client:
-                lldp_neighbors = rpc_client.get_lldp_neighbors()
-        except:
-            raise ServiceUnavailable("Error connecting to the remote device.")
+            import napalm
+            from napalm.base.exceptions import ModuleImportError
+        except ImportError:
+            raise ServiceUnavailable("NAPALM is not installed. Please see the documentation for instructions.")
 
-        return Response(lldp_neighbors)
+        # Validate the configured driver
+        try:
+            driver = napalm.get_network_driver(device.platform.napalm_driver)
+        except ModuleImportError:
+            raise ServiceUnavailable("NAPALM driver for platform {} not found: {}.".format(
+                device.platform, device.platform.napalm_driver
+            ))
+
+        # Verify user permission
+        if not request.user.has_perm('dcim.napalm_read'):
+            return HttpResponseForbidden()
+
+        # Connect to the device
+        napalm_methods = request.GET.getlist('method')
+        response = OrderedDict([(m, None) for m in napalm_methods])
+        ip_address = str(device.primary_ip.address.ip)
+        optional_args = settings.NAPALM_ARGS.copy()
+        if device.platform.napalm_args is not None:
+            optional_args.update(device.platform.napalm_args)
+        d = driver(
+            hostname=ip_address,
+            username=settings.NAPALM_USERNAME,
+            password=settings.NAPALM_PASSWORD,
+            timeout=settings.NAPALM_TIMEOUT,
+            optional_args=optional_args
+        )
+        try:
+            d.open()
+        except Exception as e:
+            raise ServiceUnavailable("Error connecting to the device at {}: {}".format(ip_address, e))
+
+        # Validate and execute each specified NAPALM method
+        for method in napalm_methods:
+            if not hasattr(driver, method):
+                response[method] = {'error': 'Unknown NAPALM method'}
+                continue
+            if not method.startswith('get_'):
+                response[method] = {'error': 'Only get_* NAPALM methods are supported'}
+                continue
+            try:
+                response[method] = getattr(d, method)()
+            except NotImplementedError:
+                response[method] = {'error': 'Method {} not implemented for NAPALM driver {}'.format(method, driver)}
+            except Exception as e:
+                response[method] = {'error': 'Method {} failed: {}'.format(method, e)}
+        d.close()
+
+        return Response(response)
 
 
 #
 # Device components
 #
 
-class ConsolePortViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = ConsolePort.objects.select_related('device', 'cs_port__device')
+class ConsolePortViewSet(CableTraceMixin, ModelViewSet):
+    queryset = ConsolePort.objects.select_related(
+        'device', 'connected_endpoint__device', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
     serializer_class = serializers.ConsolePortSerializer
-    write_serializer_class = serializers.WritableConsolePortSerializer
-    filter_class = filters.ConsolePortFilter
+    filterset_class = filters.ConsolePortFilter
 
 
-class ConsoleServerPortViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = ConsoleServerPort.objects.select_related('device', 'connected_console__device')
+class ConsoleServerPortViewSet(CableTraceMixin, ModelViewSet):
+    queryset = ConsoleServerPort.objects.select_related(
+        'device', 'connected_endpoint__device', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
     serializer_class = serializers.ConsoleServerPortSerializer
-    write_serializer_class = serializers.WritableConsoleServerPortSerializer
-    filter_class = filters.ConsoleServerPortFilter
+    filterset_class = filters.ConsoleServerPortFilter
 
 
-class PowerPortViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = PowerPort.objects.select_related('device', 'power_outlet__device')
+class PowerPortViewSet(CableTraceMixin, ModelViewSet):
+    queryset = PowerPort.objects.select_related(
+        'device', 'connected_endpoint__device', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
     serializer_class = serializers.PowerPortSerializer
-    write_serializer_class = serializers.WritablePowerPortSerializer
-    filter_class = filters.PowerPortFilter
+    filterset_class = filters.PowerPortFilter
 
 
-class PowerOutletViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = PowerOutlet.objects.select_related('device', 'connected_port__device')
+class PowerOutletViewSet(CableTraceMixin, ModelViewSet):
+    queryset = PowerOutlet.objects.select_related(
+        'device', 'connected_endpoint__device', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
     serializer_class = serializers.PowerOutletSerializer
-    write_serializer_class = serializers.WritablePowerOutletSerializer
-    filter_class = filters.PowerOutletFilter
+    filterset_class = filters.PowerOutletFilter
 
 
-class InterfaceViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = Interface.objects.select_related('device')
+class InterfaceViewSet(CableTraceMixin, ModelViewSet):
+    queryset = Interface.objects.select_related(
+        'device', '_connected_interface', '_connected_circuittermination', 'cable'
+    ).prefetch_related(
+        'ip_addresses', 'tags'
+    )
     serializer_class = serializers.InterfaceSerializer
-    write_serializer_class = serializers.WritableInterfaceSerializer
-    filter_class = filters.InterfaceFilter
+    filterset_class = filters.InterfaceFilter
 
-    @detail_route()
+    @action(detail=True)
     def graphs(self, request, pk=None):
         """
         A convenience method for rendering graphs for a particular interface.
@@ -289,18 +428,36 @@ class InterfaceViewSet(WritableSerializerMixin, ModelViewSet):
         return Response(serializer.data)
 
 
-class DeviceBayViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = DeviceBay.objects.select_related('installed_device')
+class FrontPortViewSet(ModelViewSet):
+    queryset = FrontPort.objects.select_related(
+        'device__device_type__manufacturer', 'rear_port', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
+    serializer_class = serializers.FrontPortSerializer
+    filterset_class = filters.FrontPortFilter
+
+
+class RearPortViewSet(ModelViewSet):
+    queryset = RearPort.objects.select_related(
+        'device__device_type__manufacturer', 'cable'
+    ).prefetch_related(
+        'tags'
+    )
+    serializer_class = serializers.RearPortSerializer
+    filterset_class = filters.RearPortFilter
+
+
+class DeviceBayViewSet(ModelViewSet):
+    queryset = DeviceBay.objects.select_related('installed_device').prefetch_related('tags')
     serializer_class = serializers.DeviceBaySerializer
-    write_serializer_class = serializers.WritableDeviceBaySerializer
-    filter_class = filters.DeviceBayFilter
+    filterset_class = filters.DeviceBayFilter
 
 
-class InventoryItemViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = InventoryItem.objects.select_related('device', 'manufacturer')
+class InventoryItemViewSet(ModelViewSet):
+    queryset = InventoryItem.objects.select_related('device', 'manufacturer').prefetch_related('tags')
     serializer_class = serializers.InventoryItemSerializer
-    write_serializer_class = serializers.WritableInventoryItemSerializer
-    filter_class = filters.InventoryItemFilter
+    filterset_class = filters.InventoryItemFilter
 
 
 #
@@ -308,22 +465,56 @@ class InventoryItemViewSet(WritableSerializerMixin, ModelViewSet):
 #
 
 class ConsoleConnectionViewSet(ListModelMixin, GenericViewSet):
-    queryset = ConsolePort.objects.select_related('device', 'cs_port__device').filter(cs_port__isnull=False)
+    queryset = ConsolePort.objects.select_related(
+        'device', 'connected_endpoint__device'
+    ).filter(
+        connected_endpoint__isnull=False
+    )
     serializer_class = serializers.ConsolePortSerializer
-    filter_class = filters.ConsoleConnectionFilter
+    filterset_class = filters.ConsoleConnectionFilter
 
 
 class PowerConnectionViewSet(ListModelMixin, GenericViewSet):
-    queryset = PowerPort.objects.select_related('device', 'power_outlet__device').filter(power_outlet__isnull=False)
+    queryset = PowerPort.objects.select_related(
+        'device', 'connected_endpoint__device'
+    ).filter(
+        connected_endpoint__isnull=False
+    )
     serializer_class = serializers.PowerPortSerializer
-    filter_class = filters.PowerConnectionFilter
+    filterset_class = filters.PowerConnectionFilter
 
 
-class InterfaceConnectionViewSet(WritableSerializerMixin, ModelViewSet):
-    queryset = InterfaceConnection.objects.select_related('interface_a__device', 'interface_b__device')
+class InterfaceConnectionViewSet(ModelViewSet):
+    queryset = Interface.objects.select_related(
+        'device', '_connected_interface', '_connected_circuittermination'
+    ).filter(
+        # Avoid duplicate connections by only selecting the lower PK in a connected pair
+        Q(_connected_interface__isnull=False, pk__lt=F('_connected_interface')) |
+        Q(_connected_circuittermination__isnull=False)
+    )
     serializer_class = serializers.InterfaceConnectionSerializer
-    write_serializer_class = serializers.WritableInterfaceConnectionSerializer
-    filter_class = filters.InterfaceConnectionFilter
+    filterset_class = filters.InterfaceConnectionFilter
+
+
+#
+# Cables
+#
+
+class CableViewSet(ModelViewSet):
+    queryset = Cable.objects.prefetch_related(
+        'termination_a', 'termination_b'
+    )
+    serializer_class = serializers.CableSerializer
+    filterset_class = filters.CableFilter
+
+
+#
+# Virtual chassis
+#
+
+class VirtualChassisViewSet(ModelViewSet):
+    queryset = VirtualChassis.objects.prefetch_related('tags')
+    serializer_class = serializers.VirtualChassisSerializer
 
 
 #
@@ -336,24 +527,43 @@ class ConnectedDeviceViewSet(ViewSet):
     interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors
     via a protocol such as LLDP. Two query parameters must be included in the request:
 
-    * `peer-device`: The name of the peer device
-    * `peer-interface`: The name of the peer interface
+    * `peer_device`: The name of the peer device
+    * `peer_interface`: The name of the peer interface
     """
-    permission_classes = [IsAuthenticated]
+    permission_classes = [IsAuthenticatedOrLoginNotRequired]
+    _device_param = Parameter(
+        name='peer_device',
+        in_='query',
+        description='The name of the peer device',
+        required=True,
+        type=openapi.TYPE_STRING
+    )
+    _interface_param = Parameter(
+        name='peer_interface',
+        in_='query',
+        description='The name of the peer interface',
+        required=True,
+        type=openapi.TYPE_STRING
+    )
 
     def get_view_name(self):
         return "Connected Device Locator"
 
+    @swagger_auto_schema(
+        manual_parameters=[_device_param, _interface_param],
+        responses={'200': serializers.DeviceSerializer}
+    )
     def list(self, request):
 
-        peer_device_name = request.query_params.get('peer-device')
-        peer_interface_name = request.query_params.get('peer-interface')
+        peer_device_name = request.query_params.get(self._device_param.name)
+        peer_interface_name = request.query_params.get(self._interface_param.name)
+
         if not peer_device_name or not peer_interface_name:
-            raise MissingFilterException(detail='Request must include "peer-device" and "peer-interface" filters.')
+            raise MissingFilterException(detail='Request must include "peer_device" and "peer_interface" filters.')
 
         # Determine local interface from peer interface's connection
         peer_interface = get_object_or_404(Interface, device__name=peer_device_name, name=peer_interface_name)
-        local_interface = peer_interface.connected_interface
+        local_interface = peer_interface._connected_interface
 
         if local_interface is None:
             return Response()

netbox/dcim/apps.py

@@ -4,3 +4,7 @@ from django.apps import AppConfig
 class DCIMConfig(AppConfig):
     name = "dcim"
     verbose_name = "DCIM"
+
+    def ready(self):
+
+        import dcim.signals

netbox/dcim/constants.py

@@ -0,0 +1,399 @@
+
+# Rack types
+RACK_TYPE_2POST = 100
+RACK_TYPE_4POST = 200
+RACK_TYPE_CABINET = 300
+RACK_TYPE_WALLFRAME = 1000
+RACK_TYPE_WALLCABINET = 1100
+RACK_TYPE_CHOICES = (
+    (RACK_TYPE_2POST, '2-post frame'),
+    (RACK_TYPE_4POST, '4-post frame'),
+    (RACK_TYPE_CABINET, '4-post cabinet'),
+    (RACK_TYPE_WALLFRAME, 'Wall-mounted frame'),
+    (RACK_TYPE_WALLCABINET, 'Wall-mounted cabinet'),
+)
+
+# Rack widths
+RACK_WIDTH_19IN = 19
+RACK_WIDTH_23IN = 23
+RACK_WIDTH_CHOICES = (
+    (RACK_WIDTH_19IN, '19 inches'),
+    (RACK_WIDTH_23IN, '23 inches'),
+)
+
+# Rack faces
+RACK_FACE_FRONT = 0
+RACK_FACE_REAR = 1
+RACK_FACE_CHOICES = [
+    [RACK_FACE_FRONT, 'Front'],
+    [RACK_FACE_REAR, 'Rear'],
+]
+
+# Rack statuses
+RACK_STATUS_RESERVED = 0
+RACK_STATUS_AVAILABLE = 1
+RACK_STATUS_PLANNED = 2
+RACK_STATUS_ACTIVE = 3
+RACK_STATUS_DEPRECATED = 4
+RACK_STATUS_CHOICES = [
+    [RACK_STATUS_ACTIVE, 'Active'],
+    [RACK_STATUS_PLANNED, 'Planned'],
+    [RACK_STATUS_RESERVED, 'Reserved'],
+    [RACK_STATUS_AVAILABLE, 'Available'],
+    [RACK_STATUS_DEPRECATED, 'Deprecated'],
+]
+
+# Parent/child device roles
+SUBDEVICE_ROLE_PARENT = True
+SUBDEVICE_ROLE_CHILD = False
+SUBDEVICE_ROLE_CHOICES = (
+    (None, 'None'),
+    (SUBDEVICE_ROLE_PARENT, 'Parent'),
+    (SUBDEVICE_ROLE_CHILD, 'Child'),
+)
+
+# Interface ordering schemes (for device types)
+IFACE_ORDERING_POSITION = 1
+IFACE_ORDERING_NAME = 2
+IFACE_ORDERING_CHOICES = [
+    [IFACE_ORDERING_POSITION, 'Slot/position'],
+    [IFACE_ORDERING_NAME, 'Name (alphabetically)']
+]
+
+# Interface form factors
+# Virtual
+IFACE_FF_VIRTUAL = 0
+IFACE_FF_LAG = 200
+# Ethernet
+IFACE_FF_100ME_FIXED = 800
+IFACE_FF_1GE_FIXED = 1000
+IFACE_FF_1GE_GBIC = 1050
+IFACE_FF_1GE_SFP = 1100
+IFACE_FF_10GE_FIXED = 1150
+IFACE_FF_10GE_CX4 = 1170
+IFACE_FF_10GE_SFP_PLUS = 1200
+IFACE_FF_10GE_XFP = 1300
+IFACE_FF_10GE_XENPAK = 1310
+IFACE_FF_10GE_X2 = 1320
+IFACE_FF_25GE_SFP28 = 1350
+IFACE_FF_40GE_QSFP_PLUS = 1400
+IFACE_FF_100GE_CFP = 1500
+IFACE_FF_100GE_CFP2 = 1510
+IFACE_FF_100GE_CFP4 = 1520
+IFACE_FF_100GE_CPAK = 1550
+IFACE_FF_100GE_QSFP28 = 1600
+# Wireless
+IFACE_FF_80211A = 2600
+IFACE_FF_80211G = 2610
+IFACE_FF_80211N = 2620
+IFACE_FF_80211AC = 2630
+IFACE_FF_80211AD = 2640
+# SONET
+IFACE_FF_SONET_OC3 = 6100
+IFACE_FF_SONET_OC12 = 6200
+IFACE_FF_SONET_OC48 = 6300
+IFACE_FF_SONET_OC192 = 6400
+IFACE_FF_SONET_OC768 = 6500
+IFACE_FF_SONET_OC1920 = 6600
+IFACE_FF_SONET_OC3840 = 6700
+# Fibrechannel
+IFACE_FF_1GFC_SFP = 3010
+IFACE_FF_2GFC_SFP = 3020
+IFACE_FF_4GFC_SFP = 3040
+IFACE_FF_8GFC_SFP_PLUS = 3080
+IFACE_FF_16GFC_SFP_PLUS = 3160
+IFACE_FF_32GFC_SFP28 = 3320
+# Serial
+IFACE_FF_T1 = 4000
+IFACE_FF_E1 = 4010
+IFACE_FF_T3 = 4040
+IFACE_FF_E3 = 4050
+# Stacking
+IFACE_FF_STACKWISE = 5000
+IFACE_FF_STACKWISE_PLUS = 5050
+IFACE_FF_FLEXSTACK = 5100
+IFACE_FF_FLEXSTACK_PLUS = 5150
+IFACE_FF_JUNIPER_VCP = 5200
+IFACE_FF_SUMMITSTACK = 5300
+IFACE_FF_SUMMITSTACK128 = 5310
+IFACE_FF_SUMMITSTACK256 = 5320
+IFACE_FF_SUMMITSTACK512 = 5330
+
+# Other
+IFACE_FF_OTHER = 32767
+
+IFACE_FF_CHOICES = [
+    [
+        'Virtual interfaces',
+        [
+            [IFACE_FF_VIRTUAL, 'Virtual'],
+            [IFACE_FF_LAG, 'Link Aggregation Group (LAG)'],
+        ],
+    ],
+    [
+        'Ethernet (fixed)',
+        [
+            [IFACE_FF_100ME_FIXED, '100BASE-TX (10/100ME)'],
+            [IFACE_FF_1GE_FIXED, '1000BASE-T (1GE)'],
+            [IFACE_FF_10GE_FIXED, '10GBASE-T (10GE)'],
+            [IFACE_FF_10GE_CX4, '10GBASE-CX4 (10GE)'],
+        ]
+    ],
+    [
+        'Ethernet (modular)',
+        [
+            [IFACE_FF_1GE_GBIC, 'GBIC (1GE)'],
+            [IFACE_FF_1GE_SFP, 'SFP (1GE)'],
+            [IFACE_FF_10GE_SFP_PLUS, 'SFP+ (10GE)'],
+            [IFACE_FF_10GE_XFP, 'XFP (10GE)'],
+            [IFACE_FF_10GE_XENPAK, 'XENPAK (10GE)'],
+            [IFACE_FF_10GE_X2, 'X2 (10GE)'],
+            [IFACE_FF_25GE_SFP28, 'SFP28 (25GE)'],
+            [IFACE_FF_40GE_QSFP_PLUS, 'QSFP+ (40GE)'],
+            [IFACE_FF_100GE_CFP, 'CFP (100GE)'],
+            [IFACE_FF_100GE_CFP2, 'CFP2 (100GE)'],
+            [IFACE_FF_100GE_CFP4, 'CFP4 (100GE)'],
+            [IFACE_FF_100GE_CPAK, 'Cisco CPAK (100GE)'],
+            [IFACE_FF_100GE_QSFP28, 'QSFP28 (100GE)'],
+        ]
+    ],
+    [
+        'Wireless',
+        [
+            [IFACE_FF_80211A, 'IEEE 802.11a'],
+            [IFACE_FF_80211G, 'IEEE 802.11b/g'],
+            [IFACE_FF_80211N, 'IEEE 802.11n'],
+            [IFACE_FF_80211AC, 'IEEE 802.11ac'],
+            [IFACE_FF_80211AD, 'IEEE 802.11ad'],
+        ]
+    ],
+    [
+        'SONET',
+        [
+            [IFACE_FF_SONET_OC3, 'OC-3/STM-1'],
+            [IFACE_FF_SONET_OC12, 'OC-12/STM-4'],
+            [IFACE_FF_SONET_OC48, 'OC-48/STM-16'],
+            [IFACE_FF_SONET_OC192, 'OC-192/STM-64'],
+            [IFACE_FF_SONET_OC768, 'OC-768/STM-256'],
+            [IFACE_FF_SONET_OC1920, 'OC-1920/STM-640'],
+            [IFACE_FF_SONET_OC3840, 'OC-3840/STM-1234'],
+        ]
+    ],
+    [
+        'FibreChannel',
+        [
+            [IFACE_FF_1GFC_SFP, 'SFP (1GFC)'],
+            [IFACE_FF_2GFC_SFP, 'SFP (2GFC)'],
+            [IFACE_FF_4GFC_SFP, 'SFP (4GFC)'],
+            [IFACE_FF_8GFC_SFP_PLUS, 'SFP+ (8GFC)'],
+            [IFACE_FF_16GFC_SFP_PLUS, 'SFP+ (16GFC)'],
+            [IFACE_FF_32GFC_SFP28, 'SFP28 (32GFC)'],
+        ]
+    ],
+    [
+        'Serial',
+        [
+            [IFACE_FF_T1, 'T1 (1.544 Mbps)'],
+            [IFACE_FF_E1, 'E1 (2.048 Mbps)'],
+            [IFACE_FF_T3, 'T3 (45 Mbps)'],
+            [IFACE_FF_E3, 'E3 (34 Mbps)'],
+        ]
+    ],
+    [
+        'Stacking',
+        [
+            [IFACE_FF_STACKWISE, 'Cisco StackWise'],
+            [IFACE_FF_STACKWISE_PLUS, 'Cisco StackWise Plus'],
+            [IFACE_FF_FLEXSTACK, 'Cisco FlexStack'],
+            [IFACE_FF_FLEXSTACK_PLUS, 'Cisco FlexStack Plus'],
+            [IFACE_FF_JUNIPER_VCP, 'Juniper VCP'],
+            [IFACE_FF_SUMMITSTACK, 'Extreme SummitStack'],
+            [IFACE_FF_SUMMITSTACK128, 'Extreme SummitStack-128'],
+            [IFACE_FF_SUMMITSTACK256, 'Extreme SummitStack-256'],
+            [IFACE_FF_SUMMITSTACK512, 'Extreme SummitStack-512'],
+        ]
+    ],
+    [
+        'Other',
+        [
+            [IFACE_FF_OTHER, 'Other'],
+        ]
+    ],
+]
+
+VIRTUAL_IFACE_TYPES = [
+    IFACE_FF_VIRTUAL,
+    IFACE_FF_LAG,
+]
+
+WIRELESS_IFACE_TYPES = [
+    IFACE_FF_80211A,
+    IFACE_FF_80211G,
+    IFACE_FF_80211N,
+    IFACE_FF_80211AC,
+    IFACE_FF_80211AD,
+]
+
+NONCONNECTABLE_IFACE_TYPES = VIRTUAL_IFACE_TYPES + WIRELESS_IFACE_TYPES
+
+IFACE_MODE_ACCESS = 100
+IFACE_MODE_TAGGED = 200
+IFACE_MODE_TAGGED_ALL = 300
+IFACE_MODE_CHOICES = [
+    [IFACE_MODE_ACCESS, 'Access'],
+    [IFACE_MODE_TAGGED, 'Tagged'],
+    [IFACE_MODE_TAGGED_ALL, 'Tagged All'],
+]
+
+# Pass-through port types
+PORT_TYPE_8P8C = 1000
+PORT_TYPE_ST = 2000
+PORT_TYPE_SC = 2100
+PORT_TYPE_FC = 2200
+PORT_TYPE_LC = 2300
+PORT_TYPE_MTRJ = 2400
+PORT_TYPE_MPO = 2500
+PORT_TYPE_LSH = 2600
+PORT_TYPE_CHOICES = [
+    [
+        'Copper',
+        [
+            [PORT_TYPE_8P8C, '8P8C'],
+        ],
+    ],
+    [
+        'Fiber Optic',
+        [
+            [PORT_TYPE_FC, 'FC'],
+            [PORT_TYPE_LC, 'LC'],
+            [PORT_TYPE_LSH, 'LSH'],
+            [PORT_TYPE_MPO, 'MPO'],
+            [PORT_TYPE_MTRJ, 'MTRJ'],
+            [PORT_TYPE_SC, 'SC'],
+            [PORT_TYPE_ST, 'ST'],
+        ]
+    ]
+]
+
+# Device statuses
+DEVICE_STATUS_OFFLINE = 0
+DEVICE_STATUS_ACTIVE = 1
+DEVICE_STATUS_PLANNED = 2
+DEVICE_STATUS_STAGED = 3
+DEVICE_STATUS_FAILED = 4
+DEVICE_STATUS_INVENTORY = 5
+DEVICE_STATUS_CHOICES = [
+    [DEVICE_STATUS_ACTIVE, 'Active'],
+    [DEVICE_STATUS_OFFLINE, 'Offline'],
+    [DEVICE_STATUS_PLANNED, 'Planned'],
+    [DEVICE_STATUS_STAGED, 'Staged'],
+    [DEVICE_STATUS_FAILED, 'Failed'],
+    [DEVICE_STATUS_INVENTORY, 'Inventory'],
+]
+
+# Site statuses
+SITE_STATUS_ACTIVE = 1
+SITE_STATUS_PLANNED = 2
+SITE_STATUS_RETIRED = 4
+SITE_STATUS_CHOICES = [
+    [SITE_STATUS_ACTIVE, 'Active'],
+    [SITE_STATUS_PLANNED, 'Planned'],
+    [SITE_STATUS_RETIRED, 'Retired'],
+]
+
+# Bootstrap CSS classes for device/rack statuses
+STATUS_CLASSES = {
+    0: 'warning',
+    1: 'success',
+    2: 'info',
+    3: 'primary',
+    4: 'danger',
+    5: 'default',
+}
+
+# Console/power/interface connection statuses
+CONNECTION_STATUS_PLANNED = False
+CONNECTION_STATUS_CONNECTED = True
+CONNECTION_STATUS_CHOICES = [
+    [CONNECTION_STATUS_PLANNED, 'Planned'],
+    [CONNECTION_STATUS_CONNECTED, 'Connected'],
+]
+
+# Cable endpoint types
+CABLE_TERMINATION_TYPES = [
+    'consoleport', 'consoleserverport', 'interface', 'poweroutlet', 'powerport', 'frontport', 'rearport',
+]
+
+# Cable types
+CABLE_TYPE_CAT3 = 1300
+CABLE_TYPE_CAT5 = 1500
+CABLE_TYPE_CAT5E = 1510
+CABLE_TYPE_CAT6 = 1600
+CABLE_TYPE_CAT6A = 1610
+CABLE_TYPE_CAT7 = 1700
+CABLE_TYPE_MMF_OM1 = 3010
+CABLE_TYPE_MMF_OM2 = 3020
+CABLE_TYPE_MMF_OM3 = 3030
+CABLE_TYPE_MMF_OM4 = 3040
+CABLE_TYPE_SMF = 3500
+CABLE_TYPE_POWER = 5000
+CABLE_TYPE_CHOICES = (
+    (
+        'Copper', (
+            (CABLE_TYPE_CAT3, 'CAT3'),
+            (CABLE_TYPE_CAT5, 'CAT5'),
+            (CABLE_TYPE_CAT5E, 'CAT5e'),
+            (CABLE_TYPE_CAT6, 'CAT6'),
+            (CABLE_TYPE_CAT6A, 'CAT6a'),
+            (CABLE_TYPE_CAT7, 'CAT7'),
+        ),
+    ),
+    (
+        'Fiber', (
+            (CABLE_TYPE_MMF_OM1, 'Multimode Fiber (OM1)'),
+            (CABLE_TYPE_MMF_OM2, 'Multimode Fiber (OM2)'),
+            (CABLE_TYPE_MMF_OM3, 'Multimode Fiber (OM3)'),
+            (CABLE_TYPE_MMF_OM4, 'Multimode Fiber (OM4)'),
+            (CABLE_TYPE_SMF, 'Singlemode Fiber'),
+        ),
+    ),
+    (CABLE_TYPE_POWER, 'Power'),
+)
+
+CABLE_TERMINATION_TYPE_CHOICES = {
+    # (API endpoint, human-friendly name)
+    'consoleport': ('console-ports', 'Console port'),
+    'consoleserverport': ('console-server-ports', 'Console server port'),
+    'powerport': ('power-ports', 'Power port'),
+    'poweroutlet': ('power-outlets', 'Power outlet'),
+    'interface': ('interfaces', 'Interface'),
+    'frontport': ('front-ports', 'Front panel port'),
+    'rearport': ('rear-ports', 'Rear panel port'),
+}
+
+COMPATIBLE_TERMINATION_TYPES = {
+    'consoleport': ['consoleserverport', 'frontport', 'rearport'],
+    'consoleserverport': ['consoleport', 'frontport', 'rearport'],
+    'powerport': ['poweroutlet'],
+    'poweroutlet': ['powerport'],
+    'interface': ['interface', 'circuittermination', 'frontport', 'rearport'],
+    'frontport': ['consoleport', 'consoleserverport', 'interface', 'frontport', 'rearport', 'circuittermination'],
+    'rearport': ['consoleport', 'consoleserverport', 'interface', 'frontport', 'rearport', 'circuittermination'],
+    'circuittermination': ['interface', 'frontport', 'rearport'],
+}
+
+LENGTH_UNIT_METER = 1200
+LENGTH_UNIT_CENTIMETER = 1100
+LENGTH_UNIT_MILLIMETER = 1000
+LENGTH_UNIT_FOOT = 2100
+LENGTH_UNIT_INCH = 2000
+CABLE_LENGTH_UNIT_CHOICES = (
+    (LENGTH_UNIT_METER, 'Meters'),
+    (LENGTH_UNIT_CENTIMETER, 'Centimeters'),
+    (LENGTH_UNIT_FOOT, 'Feet'),
+    (LENGTH_UNIT_INCH, 'Inches'),
+)
+RACK_DIMENSION_UNIT_CHOICES = (
+    (LENGTH_UNIT_MILLIMETER, 'Millimeters'),
+    (LENGTH_UNIT_INCH, 'Inches'),
+)

netbox/dcim/fields.py

@@ -1,10 +1,7 @@
-from netaddr import EUI, mac_unix_expanded
-
 from django.core.exceptions import ValidationError
 from django.core.validators import MinValueValidator, MaxValueValidator
 from django.db import models
-
-from .formfields import MACAddressFormField
+from netaddr import AddrFormatError, EUI, mac_unix_expanded
 
 
 class ASNField(models.BigIntegerField):
@@ -33,7 +30,7 @@ class MACAddressField(models.Field):
             return value
         try:
             return EUI(value, version=48, dialect=mac_unix_expanded_uppercase)
-        except ValueError as e:
+        except AddrFormatError as e:
             raise ValidationError(e)
 
     def db_type(self, connection):
@@ -43,11 +40,3 @@ class MACAddressField(models.Field):
         if not value:
             return None
         return str(self.to_python(value))
-
-    def form_class(self):
-        return MACAddressFormField
-
-    def formfield(self, **kwargs):
-        defaults = {'form_class': self.form_class()}
-        defaults.update(kwargs)
-        return super(MACAddressField, self).formfield(**defaults)

netbox/dcim/fixtures/dcim.json

@@ -70,84 +70,78 @@
     "model": "dcim.devicetype",
     "pk": 1,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 1,
         "model": "MX960",
         "slug": "mx960",
         "u_height": 16,
-        "is_full_depth": true,
-        "is_console_server": false,
-        "is_pdu": false,
-        "is_network_device": true
+        "is_full_depth": true
     }
 },
 {
     "model": "dcim.devicetype",
     "pk": 2,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 1,
         "model": "EX9214",
         "slug": "ex9214",
         "u_height": 16,
-        "is_full_depth": true,
-        "is_console_server": false,
-        "is_pdu": false,
-        "is_network_device": true
+        "is_full_depth": true
     }
 },
 {
     "model": "dcim.devicetype",
     "pk": 3,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 1,
         "model": "QFX5100-24Q",
         "slug": "qfx5100-24q",
         "u_height": 1,
-        "is_full_depth": true,
-        "is_console_server": false,
-        "is_pdu": false,
-        "is_network_device": true
+        "is_full_depth": true
     }
 },
 {
     "model": "dcim.devicetype",
     "pk": 4,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 1,
         "model": "QFX5100-48S",
         "slug": "qfx5100-48s",
         "u_height": 1,
-        "is_full_depth": true,
-        "is_console_server": false,
-        "is_pdu": false,
-        "is_network_device": true
+        "is_full_depth": true
     }
 },
 {
     "model": "dcim.devicetype",
     "pk": 5,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 2,
         "model": "CM4148",
         "slug": "cm4148",
         "u_height": 1,
-        "is_full_depth": true,
-        "is_console_server": true,
-        "is_pdu": false,
-        "is_network_device": false
+        "is_full_depth": true
     }
 },
 {
     "model": "dcim.devicetype",
     "pk": 6,
     "fields": {
+        "created": "2016-06-23",
+        "last_updated": "2016-06-23T03:19:56.521Z",
         "manufacturer": 3,
         "model": "CWG-24VYM415C9",
         "slug": "cwg-24vym415c9",
         "u_height": 0,
-        "is_full_depth": false,
-        "is_console_server": false,
-        "is_pdu": true,
-        "is_network_device": false
+        "is_full_depth": false
     }
 },
 {
@@ -1891,8 +1885,7 @@
     "pk": 1,
     "fields": {
         "name": "Juniper Junos",
-        "slug": "juniper-junos",
-        "rpc_client": "juniper-junos"
+        "slug": "juniper-junos"
     }
 },
 {
@@ -1900,8 +1893,7 @@
     "pk": 2,
     "fields": {
         "name": "Opengear",
-        "slug": "opengear",
-        "rpc_client": "opengear"
+        "slug": "opengear"
     }
 },
 {
@@ -2141,7 +2133,7 @@
     "fields": {
         "device": 1,
         "name": "Console (RE0)",
-        "cs_port": 27,
+        "connected_endpoint": 27,
         "connection_status": true
     }
 },
@@ -2151,7 +2143,7 @@
     "fields": {
         "device": 1,
         "name": "Console (RE1)",
-        "cs_port": 38,
+        "connected_endpoint": 38,
         "connection_status": true
     }
 },
@@ -2161,7 +2153,7 @@
     "fields": {
         "device": 2,
         "name": "Console (RE0)",
-        "cs_port": 5,
+        "connected_endpoint": 5,
         "connection_status": true
     }
 },
@@ -2171,7 +2163,7 @@
     "fields": {
         "device": 2,
         "name": "Console (RE1)",
-        "cs_port": 16,
+        "connected_endpoint": 16,
         "connection_status": true
     }
 },
@@ -2181,7 +2173,7 @@
     "fields": {
         "device": 3,
         "name": "Console",
-        "cs_port": 49,
+        "connected_endpoint": 49,
         "connection_status": true
     }
 },
@@ -2191,7 +2183,7 @@
     "fields": {
         "device": 4,
         "name": "Console",
-        "cs_port": 48,
+        "connected_endpoint": 48,
         "connection_status": true
     }
 },
@@ -2201,7 +2193,7 @@
     "fields": {
         "device": 5,
         "name": "Console",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2211,7 +2203,7 @@
     "fields": {
         "device": 6,
         "name": "Console",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2221,7 +2213,7 @@
     "fields": {
         "device": 7,
         "name": "Console (RE0)",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2231,7 +2223,7 @@
     "fields": {
         "device": 7,
         "name": "Console (RE1)",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2241,7 +2233,7 @@
     "fields": {
         "device": 8,
         "name": "Console (RE0)",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2251,7 +2243,7 @@
     "fields": {
         "device": 8,
         "name": "Console (RE1)",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2261,7 +2253,7 @@
     "fields": {
         "device": 9,
         "name": "Console",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2271,7 +2263,7 @@
     "fields": {
         "device": 11,
         "name": "Serial",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2281,7 +2273,7 @@
     "fields": {
         "device": 12,
         "name": "Serial",
-        "cs_port": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2675,7 +2667,7 @@
     "fields": {
         "device": 1,
         "name": "PEM0",
-        "power_outlet": 25,
+        "connected_endpoint": 25,
         "connection_status": true
     }
 },
@@ -2685,7 +2677,7 @@
     "fields": {
         "device": 1,
         "name": "PEM1",
-        "power_outlet": 49,
+        "connected_endpoint": 49,
         "connection_status": true
     }
 },
@@ -2695,7 +2687,7 @@
     "fields": {
         "device": 1,
         "name": "PEM2",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2705,7 +2697,7 @@
     "fields": {
         "device": 1,
         "name": "PEM3",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2715,7 +2707,7 @@
     "fields": {
         "device": 2,
         "name": "PEM0",
-        "power_outlet": 26,
+        "connected_endpoint": 26,
         "connection_status": true
     }
 },
@@ -2725,7 +2717,7 @@
     "fields": {
         "device": 2,
         "name": "PEM1",
-        "power_outlet": 50,
+        "connected_endpoint": 50,
         "connection_status": true
     }
 },
@@ -2735,7 +2727,7 @@
     "fields": {
         "device": 2,
         "name": "PEM2",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2745,7 +2737,7 @@
     "fields": {
         "device": 2,
         "name": "PEM3",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2755,7 +2747,7 @@
     "fields": {
         "device": 4,
         "name": "PSU0",
-        "power_outlet": 28,
+        "connected_endpoint": 28,
         "connection_status": true
     }
 },
@@ -2765,7 +2757,7 @@
     "fields": {
         "device": 4,
         "name": "PSU1",
-        "power_outlet": 52,
+        "connected_endpoint": 52,
         "connection_status": true
     }
 },
@@ -2775,7 +2767,7 @@
     "fields": {
         "device": 5,
         "name": "PSU0",
-        "power_outlet": 56,
+        "connected_endpoint": 56,
         "connection_status": true
     }
 },
@@ -2785,7 +2777,7 @@
     "fields": {
         "device": 5,
         "name": "PSU1",
-        "power_outlet": 32,
+        "connected_endpoint": 32,
         "connection_status": true
     }
 },
@@ -2795,7 +2787,7 @@
     "fields": {
         "device": 3,
         "name": "PSU0",
-        "power_outlet": 27,
+        "connected_endpoint": 27,
         "connection_status": true
     }
 },
@@ -2805,7 +2797,7 @@
     "fields": {
         "device": 3,
         "name": "PSU1",
-        "power_outlet": 51,
+        "connected_endpoint": 51,
         "connection_status": true
     }
 },
@@ -2815,7 +2807,7 @@
     "fields": {
         "device": 7,
         "name": "PEM0",
-        "power_outlet": 53,
+        "connected_endpoint": 53,
         "connection_status": true
     }
 },
@@ -2825,7 +2817,7 @@
     "fields": {
         "device": 7,
         "name": "PEM1",
-        "power_outlet": 29,
+        "connected_endpoint": 29,
         "connection_status": true
     }
 },
@@ -2835,7 +2827,7 @@
     "fields": {
         "device": 7,
         "name": "PEM2",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2845,7 +2837,7 @@
     "fields": {
         "device": 7,
         "name": "PEM3",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2855,7 +2847,7 @@
     "fields": {
         "device": 8,
         "name": "PEM0",
-        "power_outlet": 54,
+        "connected_endpoint": 54,
         "connection_status": true
     }
 },
@@ -2865,7 +2857,7 @@
     "fields": {
         "device": 8,
         "name": "PEM1",
-        "power_outlet": 30,
+        "connected_endpoint": 30,
         "connection_status": true
     }
 },
@@ -2875,7 +2867,7 @@
     "fields": {
         "device": 8,
         "name": "PEM2",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2885,7 +2877,7 @@
     "fields": {
         "device": 8,
         "name": "PEM3",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -2895,7 +2887,7 @@
     "fields": {
         "device": 6,
         "name": "PSU0",
-        "power_outlet": 55,
+        "connected_endpoint": 55,
         "connection_status": true
     }
 },
@@ -2905,7 +2897,7 @@
     "fields": {
         "device": 6,
         "name": "PSU1",
-        "power_outlet": 31,
+        "connected_endpoint": 31,
         "connection_status": true
     }
 },
@@ -2915,7 +2907,7 @@
     "fields": {
         "device": 9,
         "name": "PSU",
-        "power_outlet": null,
+        "connected_endpoint": null,
         "connection_status": true
     }
 },
@@ -5736,158 +5728,5 @@
         "mgmt_only": true,
         "description": ""
     }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 3,
-    "fields": {
-        "interface_a": 99,
-        "interface_b": 15,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 4,
-    "fields": {
-        "interface_a": 100,
-        "interface_b": 153,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 5,
-    "fields": {
-        "interface_a": 46,
-        "interface_b": 14,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 6,
-    "fields": {
-        "interface_a": 47,
-        "interface_b": 152,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 7,
-    "fields": {
-        "interface_a": 91,
-        "interface_b": 144,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 8,
-    "fields": {
-        "interface_a": 92,
-        "interface_b": 145,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 16,
-    "fields": {
-        "interface_a": 189,
-        "interface_b": 37,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 17,
-    "fields": {
-        "interface_a": 192,
-        "interface_b": 175,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 18,
-    "fields": {
-        "interface_a": 195,
-        "interface_b": 41,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 19,
-    "fields": {
-        "interface_a": 198,
-        "interface_b": 179,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 20,
-    "fields": {
-        "interface_a": 191,
-        "interface_b": 197,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 21,
-    "fields": {
-        "interface_a": 194,
-        "interface_b": 200,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 22,
-    "fields": {
-        "interface_a": 9,
-        "interface_b": 218,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 23,
-    "fields": {
-        "interface_a": 8,
-        "interface_b": 206,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 24,
-    "fields": {
-        "interface_a": 7,
-        "interface_b": 212,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 25,
-    "fields": {
-        "interface_a": 217,
-        "interface_b": 205,
-        "connection_status": true
-    }
-},
-{
-    "model": "dcim.interfaceconnection",
-    "pk": 26,
-    "fields": {
-        "interface_a": 216,
-        "interface_b": 211,
-        "connection_status": true
-    }
 }
 ]

netbox/dcim/fixtures/initial_data.json

@@ -149,8 +149,7 @@
     "pk": 1,
     "fields": {
         "name": "Cisco IOS",
-        "slug": "cisco-ios",
-        "rpc_client": "cisco-ios"
+        "slug": "cisco-ios"
     }
 },
 {
@@ -158,8 +157,7 @@
     "pk": 2,
     "fields": {
         "name": "Cisco NX-OS",
-        "slug": "cisco-nx-os",
-        "rpc_client": ""
+        "slug": "cisco-nx-os"
     }
 },
 {
@@ -167,8 +165,7 @@
     "pk": 3,
     "fields": {
         "name": "Juniper Junos",
-        "slug": "juniper-junos",
-        "rpc_client": "juniper-junos"
+        "slug": "juniper-junos"
     }
 },
 {
@@ -176,8 +173,7 @@
     "pk": 4,
     "fields": {
         "name": "Arista EOS",
-        "slug": "arista-eos",
-        "rpc_client": ""
+        "slug": "arista-eos"
     }
 },
 {
@@ -185,8 +181,7 @@
     "pk": 5,
     "fields": {
         "name": "Linux",
-        "slug": "linux",
-        "rpc_client": ""
+        "slug": "linux"
     }
 },
 {
@@ -194,8 +189,7 @@
     "pk": 6,
     "fields": {
         "name": "Opengear",
-        "slug": "opengear",
-        "rpc_client": "opengear"
+        "slug": "opengear"
     }
 }
 ]

netbox/dcim/formfields.py

@@ -1,26 +0,0 @@
-from netaddr import EUI, AddrFormatError
-
-from django import forms
-from django.core.exceptions import ValidationError
-
-
-#
-# Form fields
-#
-
-class MACAddressFormField(forms.Field):
-    default_error_messages = {
-        'invalid': "Enter a valid MAC address.",
-    }
-
-    def to_python(self, value):
-        if not value:
-            return None
-
-        if isinstance(value, EUI):
-            return value
-
-        try:
-            return EUI(value, version=48)
-        except AddrFormatError:
-            raise ValidationError("Please specify a valid MAC address.")

netbox/dcim/managers.py

@@ -0,0 +1,85 @@
+from django.db.models import Manager, QuerySet
+from django.db.models.expressions import RawSQL
+
+from .constants import NONCONNECTABLE_IFACE_TYPES
+
+# Regular expressions for parsing Interface names
+TYPE_RE = r"SUBSTRING({} FROM '^([^0-9\.:]+)')"
+SLOT_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^(?:[^0-9]+)?(\d{{1,9}})/') AS integer), NULL)"
+SUBSLOT_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^(?:[^0-9\.:]+)?\d{{1,9}}/(\d{{1,9}})') AS integer), NULL)"
+POSITION_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^(?:[^0-9]+)?(?:\d{{1,9}}/){{2}}(\d{{1,9}})') AS integer), NULL)"
+SUBPOSITION_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^(?:[^0-9]+)?(?:\d{{1,9}}/){{3}}(\d{{1,9}})') AS integer), NULL)"
+ID_RE = r"CAST(SUBSTRING({} FROM '^(?:[^0-9\.:]+)?(\d{{1,9}})([^/]|$)') AS integer)"
+CHANNEL_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^.*:(\d{{1,9}})(\.\d{{1,9}})?$') AS integer), 0)"
+VC_RE = r"COALESCE(CAST(SUBSTRING({} FROM '^.*\.(\d{{1,9}})$') AS integer), 0)"
+
+
+class DeviceComponentManager(Manager):
+
+    def get_queryset(self):
+
+        queryset = super().get_queryset()
+        table_name = self.model._meta.db_table
+        sql = r"CONCAT(REGEXP_REPLACE({}.name, '\d+$', ''), LPAD(SUBSTRING({}.name FROM '\d+$'), 8, '0'))"
+
+        # Pad any trailing digits to effect natural sorting
+        return queryset.extra(
+            select={
+                'name_padded': sql.format(table_name, table_name),
+            }
+        ).order_by('name_padded')
+
+
+class InterfaceQuerySet(QuerySet):
+
+    def connectable(self):
+        """
+        Return only physical interfaces which are capable of being connected to other interfaces (i.e. not virtual or
+        wireless).
+        """
+        return self.exclude(form_factor__in=NONCONNECTABLE_IFACE_TYPES)
+
+
+class InterfaceManager(Manager):
+
+    def get_queryset(self):
+        """
+        Naturally order interfaces by their type and numeric position. To order interfaces naturally, the `name` field
+        is split into eight distinct components: leading text (type), slot, subslot, position, subposition, ID, channel,
+        and virtual circuit:
+
+            {type}{slot or ID}/{subslot}/{position}/{subposition}:{channel}.{vc}
+
+        Components absent from the interface name are coalesced to zero or null. For example, an interface named
+        GigabitEthernet1/2/3 would be parsed as follows:
+
+            type = 'GigabitEthernet'
+            slot =  1
+            subslot = 2
+            position = 3
+            subposition = None
+            id = None
+            channel = 0
+            vc = 0
+
+        The original `name` field is considered in its entirety to serve as a fallback in the event interfaces do not
+        match any of the prescribed fields.
+        """
+
+        sql_col = '{}.name'.format(self.model._meta.db_table)
+        ordering = [
+            '_slot', '_subslot', '_position', '_subposition', '_type', '_id', '_channel', '_vc', 'name',
+        ]
+
+        fields = {
+            '_type': RawSQL(TYPE_RE.format(sql_col), []),
+            '_id': RawSQL(ID_RE.format(sql_col), []),
+            '_slot': RawSQL(SLOT_RE.format(sql_col), []),
+            '_subslot': RawSQL(SUBSLOT_RE.format(sql_col), []),
+            '_position': RawSQL(POSITION_RE.format(sql_col), []),
+            '_subposition': RawSQL(SUBPOSITION_RE.format(sql_col), []),
+            '_channel': RawSQL(CHANNEL_RE.format(sql_col), []),
+            '_vc': RawSQL(VC_RE.format(sql_col), []),
+        }
+
+        return InterfaceQuerySet(self.model, using=self._db).annotate(**fields).order_by(*ordering)

netbox/dcim/migrations/0001_initial.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.7 on 2016-06-22 18:21
-from __future__ import unicode_literals
-
 import django.core.validators
 from django.db import migrations, models
 import django.db.models.deletion

netbox/dcim/migrations/0002_auto_20160622_1821.py

@@ -1,7 +1,5 @@
 # -*- coding: utf-8 -*-
 # Generated by Django 1.9.7 on 2016-06-22 18:21
-from __future__ import unicode_literals
-
 from django.db import migrations, models
 import django.db.models.deletion
 

netbox/dcim/migrations/0002_auto_20160622_1821_squashed_0022_color_names_to_rgb.py

@@ -0,0 +1,259 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.14 on 2018-07-31 02:06
+import dcim.fields
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+import utilities.fields
+
+
+class Migration(migrations.Migration):
+
+    replaces = [('dcim', '0002_auto_20160622_1821'), ('dcim', '0003_auto_20160628_1721'), ('dcim', '0004_auto_20160701_2049'), ('dcim', '0005_auto_20160706_1722'), ('dcim', '0006_add_device_primary_ip4_ip6'), ('dcim', '0007_device_copy_primary_ip'), ('dcim', '0008_device_remove_primary_ip'), ('dcim', '0009_site_32bit_asn_support'), ('dcim', '0010_devicebay_installed_device_set_null'), ('dcim', '0011_devicetype_part_number'), ('dcim', '0012_site_rack_device_add_tenant'), ('dcim', '0013_add_interface_form_factors'), ('dcim', '0014_rack_add_type_width'), ('dcim', '0015_rack_add_u_height_validator'), ('dcim', '0016_module_add_manufacturer'), ('dcim', '0017_rack_add_role'), ('dcim', '0018_device_add_asset_tag'), ('dcim', '0019_new_iface_form_factors'), ('dcim', '0020_rack_desc_units'), ('dcim', '0021_add_ff_flexstack'), ('dcim', '0022_color_names_to_rgb')]
+
+    dependencies = [
+        ('dcim', '0001_initial'),
+        ('ipam', '0001_initial'),
+        ('tenancy', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='device',
+            name='rack',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='devices', to='dcim.Rack'),
+        ),
+        migrations.AddField(
+            model_name='consoleserverporttemplate',
+            name='device_type',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='cs_port_templates', to='dcim.DeviceType'),
+        ),
+        migrations.AddField(
+            model_name='consoleserverport',
+            name='device',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='cs_ports', to='dcim.Device'),
+        ),
+        migrations.AddField(
+            model_name='consoleporttemplate',
+            name='device_type',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='console_port_templates', to='dcim.DeviceType'),
+        ),
+        migrations.AddField(
+            model_name='consoleport',
+            name='cs_port',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='connected_console', to='dcim.ConsoleServerPort', verbose_name=b'Console server port'),
+        ),
+        migrations.AddField(
+            model_name='consoleport',
+            name='device',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='console_ports', to='dcim.Device'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='rackgroup',
+            unique_together=set([('site', 'name'), ('site', 'slug')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='rack',
+            unique_together=set([('site', 'facility_id'), ('site', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='powerporttemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='powerport',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='poweroutlettemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='poweroutlet',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='module',
+            unique_together=set([('device', 'parent', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='interfacetemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AddField(
+            model_name='interface',
+            name='mac_address',
+            field=dcim.fields.MACAddressField(blank=True, null=True, verbose_name=b'MAC Address'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='interface',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.AddField(
+            model_name='devicetype',
+            name='subdevice_role',
+            field=models.NullBooleanField(choices=[(None, b'None'), (True, b'Parent'), (False, b'Child')], default=None, help_text=b'Parent devices house child devices in device bays. Select "None" if this device type is neither a parent nor a child.', verbose_name=b'Parent/child status'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='devicetype',
+            unique_together=set([('manufacturer', 'slug'), ('manufacturer', 'model')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='device',
+            unique_together=set([('rack', 'position', 'face')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='consoleserverporttemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='consoleserverport',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='consoleporttemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='consoleport',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.CreateModel(
+            name='DeviceBay',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=50, verbose_name=b'Name')),
+                ('device', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='device_bays', to='dcim.Device')),
+                ('installed_device', models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='parent_bay', to='dcim.Device')),
+            ],
+            options={
+                'ordering': ['device', 'name'],
+            },
+        ),
+        migrations.CreateModel(
+            name='DeviceBayTemplate',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=30)),
+                ('device_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='device_bay_templates', to='dcim.DeviceType')),
+            ],
+            options={
+                'ordering': ['device_type', 'name'],
+            },
+        ),
+        migrations.AlterUniqueTogether(
+            name='devicebaytemplate',
+            unique_together=set([('device_type', 'name')]),
+        ),
+        migrations.AlterUniqueTogether(
+            name='devicebay',
+            unique_together=set([('device', 'name')]),
+        ),
+        migrations.AddField(
+            model_name='device',
+            name='primary_ip4',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='primary_ip4_for', to='ipam.IPAddress', verbose_name=b'Primary IPv4'),
+        ),
+        migrations.AddField(
+            model_name='device',
+            name='primary_ip6',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='primary_ip6_for', to='ipam.IPAddress', verbose_name=b'Primary IPv6'),
+        ),
+        migrations.AlterField(
+            model_name='site',
+            name='asn',
+            field=dcim.fields.ASNField(blank=True, null=True, verbose_name=b'ASN'),
+        ),
+        migrations.AlterField(
+            model_name='devicebay',
+            name='installed_device',
+            field=models.OneToOneField(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='parent_bay', to='dcim.Device'),
+        ),
+        migrations.AddField(
+            model_name='devicetype',
+            name='part_number',
+            field=models.CharField(blank=True, help_text=b'Discrete part number (optional)', max_length=50),
+        ),
+        migrations.AddField(
+            model_name='device',
+            name='tenant',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='devices', to='tenancy.Tenant'),
+        ),
+        migrations.AddField(
+            model_name='rack',
+            name='tenant',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='racks', to='tenancy.Tenant'),
+        ),
+        migrations.AddField(
+            model_name='site',
+            name='tenant',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='sites', to='tenancy.Tenant'),
+        ),
+        migrations.AddField(
+            model_name='rack',
+            name='type',
+            field=models.PositiveSmallIntegerField(blank=True, choices=[(100, b'2-post frame'), (200, b'4-post frame'), (300, b'4-post cabinet'), (1000, b'Wall-mounted frame'), (1100, b'Wall-mounted cabinet')], null=True, verbose_name=b'Type'),
+        ),
+        migrations.AddField(
+            model_name='rack',
+            name='width',
+            field=models.PositiveSmallIntegerField(choices=[(19, b'19 inches'), (23, b'23 inches')], default=19, help_text=b'Rail-to-rail width', verbose_name=b'Width'),
+        ),
+        migrations.AlterField(
+            model_name='rack',
+            name='u_height',
+            field=models.PositiveSmallIntegerField(default=42, validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(100)], verbose_name=b'Height (U)'),
+        ),
+        migrations.AddField(
+            model_name='module',
+            name='manufacturer',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='modules', to='dcim.Manufacturer'),
+        ),
+        migrations.CreateModel(
+            name='RackRole',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=50, unique=True)),
+                ('slug', models.SlugField(unique=True)),
+                ('color', utilities.fields.ColorField(max_length=6)),
+            ],
+            options={
+                'ordering': ['name'],
+            },
+        ),
+        migrations.AddField(
+            model_name='rack',
+            name='role',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='racks', to='dcim.RackRole'),
+        ),
+        migrations.AddField(
+            model_name='device',
+            name='asset_tag',
+            field=utilities.fields.NullableCharField(blank=True, help_text=b'A unique tag used to identify this device', max_length=50, null=True, unique=True, verbose_name=b'Asset tag'),
+        ),
+        migrations.AddField(
+            model_name='rack',
+            name='desc_units',
+            field=models.BooleanField(default=False, help_text=b'Units are numbered top-to-bottom', verbose_name=b'Descending units'),
+        ),
+        migrations.AlterField(
+            model_name='device',
+            name='position',
+            field=models.PositiveSmallIntegerField(blank=True, help_text=b'The lowest-numbered unit occupied by the device', null=True, validators=[django.core.validators.MinValueValidator(1)], verbose_name=b'Position (U)'),
+        ),
+        migrations.AlterField(
+            model_name='interface',
+            name='form_factor',
+            field=models.PositiveSmallIntegerField(choices=[[b'Virtual interfaces', [[0, b'Virtual']]], [b'Ethernet (fixed)', [[800, b'100BASE-TX (10/100ME)'], [1000, b'1000BASE-T (1GE)'], [1150, b'10GBASE-T (10GE)']]], [b'Ethernet (modular)', [[1050, b'GBIC (1GE)'], [1100, b'SFP (1GE)'], [1200, b'SFP+ (10GE)'], [1300, b'XFP (10GE)'], [1310, b'XENPAK (10GE)'], [1320, b'X2 (10GE)'], [1350, b'SFP28 (25GE)'], [1400, b'QSFP+ (40GE)'], [1500, b'CFP (100GE)'], [1600, b'QSFP28 (100GE)']]], [b'FibreChannel', [[3010, b'SFP (1GFC)'], [3020, b'SFP (2GFC)'], [3040, b'SFP (4GFC)'], [3080, b'SFP+ (8GFC)'], [3160, b'SFP+ (16GFC)']]], [b'Serial', [[4000, b'T1 (1.544 Mbps)'], [4010, b'E1 (2.048 Mbps)'], [4040, b'T3 (45 Mbps)'], [4050, b'E3 (34 Mbps)']]], [b'Stacking', [[5000, b'Cisco StackWise'], [5050, b'Cisco StackWise Plus'], [5100, b'Cisco FlexStack'], [5150, b'Cisco FlexStack Plus']]], [b'Other', [[32767, b'Other']]]], default=1200),
+        ),
+        migrations.AlterField(
+            model_name='interfacetemplate',
+            name='form_factor',
+            field=models.PositiveSmallIntegerField(choices=[[b'Virtual interfaces', [[0, b'Virtual']]], [b'Ethernet (fixed)', [[800, b'100BASE-TX (10/100ME)'], [1000, b'1000BASE-T (1GE)'], [1150, b'10GBASE-T (10GE)']]], [b'Ethernet (modular)', [[1050, b'GBIC (1GE)'], [1100, b'SFP (1GE)'], [1200, b'SFP+ (10GE)'], [1300, b'XFP (10GE)'], [1310, b'XENPAK (10GE)'], [1320, b'X2 (10GE)'], [1350, b'SFP28 (25GE)'], [1400, b'QSFP+ (40GE)'], [1500, b'CFP (100GE)'], [1600, b'QSFP28 (100GE)']]], [b'FibreChannel', [[3010, b'SFP (1GFC)'], [3020, b'SFP (2GFC)'], [3040, b'SFP (4GFC)'], [3080, b'SFP+ (8GFC)'], [3160, b'SFP+ (16GFC)']]], [b'Serial', [[4000, b'T1 (1.544 Mbps)'], [4010, b'E1 (2.048 Mbps)'], [4040, b'T3 (45 Mbps)'], [4050, b'E3 (34 Mbps)']]], [b'Stacking', [[5000, b'Cisco StackWise'], [5050, b'Cisco StackWise Plus'], [5100, b'Cisco FlexStack'], [5150, b'Cisco FlexStack Plus']]], [b'Other', [[32767, b'Other']]]], default=1200),
+        ),
+        migrations.AlterField(
+            model_name='devicerole',
+            name='color',
+            field=utilities.fields.ColorField(max_length=6),
+        ),
+    ]