Merge branch 'bdlamprecht-master'

README.md

@@ -131,6 +131,18 @@ However, if you don't need this functionality, leave these blank.
 [napalm-doc]: http://napalm.readthedocs.io/en/latest/index.html
 [netbox-napalm-doc]: https://netbox.readthedocs.io/en/latest/configuration/optional-settings/#napalm_username
 
+### Customizable Reporting
+
+NetBox includes [customized reporting][netbox-reports-doc] that allows the user to write Python code and determine the validity of the data within NetBox.
+The `REPORTS_ROOT` variable is setup as a mapped directory within this Docker container to `/reports/` and includes the example directly from the documentation for `devices.py`.
+However, it has been renamed to `devices.py.example` which prevents NetBox from recognizing it as a valid report.
+This was done to avoid unnessary issues from being opened when the default does not work for someone's expectations.
+
+To re-enable this default report, simply rename `devices.py.example` to `devices.py` and browse within the WebUI to `/extras/reports/`.
+You can also dynamically add any other report to this same directory and NetBox will be able to see it without restarting the container.
+
+[netbox-reports-doc]: https://netbox.readthedocs.io/en/stable/additional-features/reports/
+
 ### Custom Initialization Code (e.g. Automatically Setting Up Custom Fields)
 
 When using `docker-compose`, all the python scripts present in `/opt/netbox/startup_scripts` will automatically be executed after the application boots in the context of `./manage.py`.

docker-compose.yml

@@ -15,10 +15,10 @@ services:
     - ./startup_scripts:/opt/netbox/startup_scripts:ro
     - ./initializers:/opt/netbox/initializers:ro
     - ./configuration:/etc/netbox/config:ro
+    - ./reports:/etc/netbox/reports:ro
     - netbox-nginx-config:/etc/netbox-nginx/
     - netbox-static-files:/opt/netbox/netbox/static
     - netbox-media-files:/opt/netbox/netbox/media
-    - netbox-report-files:/etc/netbox/reports:ro
   netbox-worker:
     <<: *netbox
     depends_on:

reports/devices.py.example

@@ -0,0 +1,46 @@
+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.connected_endpoint 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.connected_endpoint 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)
+