openfibernet · funzoneq · Jan 28, 2019 · Jan 28, 2019 · Jan 28, 2019 · Jan 29, 2019
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -17,15 +17,20 @@ about: Report a reproducible bug in the current release of NetBox
 -->
 ### Environment
 * Python version:  <!-- Example: 3.5.4 -->
-* NetBox version:  <!-- Example: 2.3.6 -->
+* NetBox version:  <!-- Example: 2.5.2 -->
 
 <!--
-    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).
+    Describe in detail the exact steps that someone else can take to reproduce
+    this bug using the current stable release of NetBox (or the current beta
+    release where applicable). Begin with the creation of any necessary
+    database objects and call out every operation being performed explicitly.
+    If reporting a bug in the REST API, be sure to reconstruct the raw HTTP
+    request(s) being made: Don't rely on a wrapper like pynetbox.
 -->
 ### Steps to Reproduce
-
+1.
+2.
+3.
 
 <!-- What did you expect to happen? -->
 ### Expected Behavior

diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,5 @@
 fabfile.py
 *.swp
 gunicorn_config.py
+.DS_Store
+.vscode
diff --git a/.travis.yml b/.travis.yml
@@ -5,7 +5,6 @@ addons:
   postgresql: "9.4"
 language: python
 python:
-  - "2.7"
   - "3.5"
 install:
   - pip install -r requirements.txt

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -16,8 +16,6 @@ or join us in the #netbox Slack channel on [NetworkToCode](https://networktocode
 
 ### Build Status
 
-NetBox is built against both Python 2.7 and 3.5. Python 3.5 or higher is strongly recommended.
-
 |             | status |
 |-------------|------------|
 | **master** | [![Build Status](https://travis-ci.org/digitalocean/netbox.svg?branch=master)](https://travis-ci.org/digitalocean/netbox) |
@@ -39,21 +37,21 @@ and run `upgrade.sh`.
 
 ## Alternative Installations
 
-* [Docker container](https://github.com/ninech/netbox-docker) (via [@cimnine](https://github.com/cimnine))
+* [Docker container](https://github.com/netbox-community/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.
+- [pynetbox](https://github.com/digitalocean/pynetbox) - A 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.
+- [netbox-client-ruby](https://github.com/ninech/netbox-client-ruby) - A Ruby client library for Netbox
+- [powerbox](https://github.com/BatmanAMA/powerbox) - A PowerShell library for Netbox
 
 ## Ansible Inventory
 
-- [netbox-as-ansible-inventory](https://github.com/AAbouZaid/netbox-as-ansible-inventory) Ansible dynamic inventory script for Netbox.
-
+- [netbox-as-ansible-inventory](https://github.com/AAbouZaid/netbox-as-ansible-inventory) - Ansible dynamic inventory script for Netbox
diff --git a/base_requirements.txt b/base_requirements.txt
@@ -1,25 +1,72 @@
-# django-filter-1.1.0 breaks with Django-2.1
-Django>=1.11,<2.1
+# 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
-# django-filter-2.0.0 drops Python 2 support (blocked by #2000)
-django-filter==1.1.0
+
+# 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
-# https://github.com/encode/django-rest-framework/issues/6053
-djangorestframework==3.8.1
+
+# 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
-Markdown
-natsort
-ncclient
+
+# 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
-paramiko
+
+# 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
-xmltodict
diff --git a/docs/additional-features/reports.md b/docs/additional-features/reports.md
@@ -44,7 +44,7 @@ class DeviceConnectionsReport(Report):
 
         # 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:
+            if console_port.connected_endpoint is None:
                 self.log_failure(
                     console_port.device,
                     "No console connection defined for {}".format(console_port.name)
@@ -63,7 +63,7 @@ class DeviceConnectionsReport(Report):
         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:
+                if power_port.connected_endpoint is not None:
                     connected_ports += 1
                     if power_port.connection_status == CONNECTION_STATUS_PLANNED:
                         self.log_warning(
@@ -128,4 +128,4 @@ 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.
+where ``<module>`` is the name of the python file in the ``reports`` directory without the ``.py`` extension.  One or more report modules may be specified.
diff --git a/docs/additional-features/tags.md b/docs/additional-features/tags.md
@@ -1,6 +1,6 @@
 # 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"`.
+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 (for 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.
 

diff --git a/docs/administration/netbox-shell.md b/docs/administration/netbox-shell.md
@@ -9,7 +9,7 @@ This will launch a customized version of [the built-in Django shell](https://doc
 ```
 $ ./manage.py nbshell
 ### NetBox interactive shell (jstretch-laptop)
-### Python 2.7.6 | Django 1.11.3 | NetBox 2.1.0-dev
+### Python 3.5.2 | Django 2.0.8 | NetBox 2.4.3
 ### lsmodels() will show available models. Use help(<model>) for more info.
 ```
 

diff --git a/docs/administration/replicating-netbox.md b/docs/administration/replicating-netbox.md
@@ -30,7 +30,7 @@ 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.
+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
 

diff --git a/docs/api/overview.md b/docs/api/overview.md
@@ -104,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. 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.  
+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.
 
@@ -122,6 +122,52 @@ When a base serializer includes one or more nested serializers, the hierarchical
 }
 ```
 
+## Brief Format
+
+Most API endpoints support an optional "brief" format, which returns only a minimal representation of each object in the response. This is useful when you need only a list of the objects themselves without any related data, such as when populating a drop-down list in a form.
+
+For example, the default (complete) format of an IP address looks like this:
+
+```
+GET /api/ipam/prefixes/13980/
+
+{
+    "id": 13980,
+    "family": 4,
+    "prefix": "192.0.2.0/24",
+    "site": null,
+    "vrf": null,
+    "tenant": null,
+    "vlan": null,
+    "status": {
+        "value": 1,
+        "label": "Active"
+    },
+    "role": null,
+    "is_pool": false,
+    "description": "",
+    "tags": [],
+    "custom_fields": {},
+    "created": "2018-12-11",
+    "last_updated": "2018-12-11T16:27:55.073174-05:00"
+}
+```
+
+The brief format is much more terse, but includes a link to the object's full representation:
+
+```
+GET /api/ipam/prefixes/13980/?brief=1
+
+{
+    "id": 13980,
+    "url": "https://netbox/api/ipam/prefixes/13980/",
+    "family": 4,
+    "prefix": "192.0.2.0/24"
+}
+```
+
+The brief format is supported for both lists and individual objects.
+
 ## 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.
@@ -215,7 +261,7 @@ A list of objects retrieved via the API can be filtered by passing one or more q
 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:
+Certain filters can be included multiple times within a single request. 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

diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md
@@ -133,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
@@ -223,6 +231,14 @@ The file path to the location where custom reports will be kept. By default, thi
 
 ---
 
+## 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
@@ -235,7 +251,7 @@ The time zone NetBox will use when dealing with dates and times. It is recommend
 
 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.
+Enable this option to run the webhook backend. See the docs section on the webhook backend [here](../additional-features/webhooks/) for more information on setup and use.
 
 ---
 
@@ -258,7 +274,7 @@ 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](https://redis.io/) is a key-value store which functions as a very lightweight database. It is required when enabling NetBox [webhooks](../additional-features/webhooks/). A Redis connection is configured using a dictionary similar to the following:
 
 ```
 REDIS = {
@@ -267,6 +283,7 @@ REDIS = {
     'PASSWORD': '',
     'DATABASE': 0,
     'DEFAULT_TIMEOUT': 300,
+    'SSL': False,
 }
 ```
 
@@ -299,3 +316,9 @@ The TCP port to use when connecting to the Redis server.
 Default: None
 
 The password to use when authenticating to the Redis server (optional).
+
+### SSL
+
+Default: False
+
+Use secure sockets layer to encrypt the connections to the Redis server.
diff --git a/docs/core-functionality/circuits.md b/docs/core-functionality/circuits.md
@@ -25,7 +25,7 @@ Circuit types are fully customizable.
 
 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.