Netbox Report give an error to find rack information

[nikunj-tele]

Hi ,

I have an issue with report to get the Empty rack and also want to find an single switch (no other device ) in rack

When I test the script on console it shows success but the output may be not correct as I have one empty rack which did not showing in CLI

$ /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py  runreport empty_rack1.py
[18:06:44] Running empty_rack1.FindEmptyRackSwitches...
[18:06:45] empty_rack1.FindEmptyRackSwitches: SUCCESS
[18:06:45] empty_rack1.FindEmptyRackSwitches: Duration 0 minutes, 0.02 seconds
[18:06:45] Finished

Now When I check same on the NetBox UI -> Reports, it gives following message and "Run Again" button is also disabled

Code :-

from extras.reports import Report
from dcim.models import Rack, Device

class FindEmptyRackSwitches(Report):
    title = "Switches in Empty Racks"
    description = "This report identifies switches located in racks with no assigned devices."

    def get_data(self):
  
        racks = Rack.objects.prefetch_related("devices")

        empty_racks = []
        switches_in_empty_racks = []

        for rack in racks:
            if not rack.devices.count():  # Check for no assigned devices
                empty_racks.append(rack)

                for device in rack.devices.all():
                    if device.device_type.name == "Switch":
                        switches_in_empty_racks.append(device)

        return {
            "empty_racks": empty_racks,
            "switches_in_empty_racks": switches_in_empty_racks,
        }

    def format_data(self, data):
       
        output = f"## Empty Racks with No Devices\n\n"
        if data["empty_racks"]:
            for rack in data["empty_racks"]:
                output += f"- Rack: {rack.name}\n"
        else:
            output += "All racks have at least one device assigned.\n"

        if data["switches_in_empty_racks"]:
            output += "\n## Switches in Empty Racks\n\n"
            for switch in data["switches_in_empty_racks"]:
                output += f"- Switch: {switch.name} ({switch.device_type.name})\n"

        return output

report_order = (FindEmptyRackSwitches,)

what could be the error or where I made an mistake?

Thanks in Advance :)

[candlerb]

Hmm, "this report is invalid". Do you see any logs from journalctl -eu netbox?

There's a way to identify syntax errors in scripts here. When I run that, I see no errors.

However, your report doesn't have any test_XXX methods. Maybe that's what Netbox is complaining about? Your functions get_data and format_data are never called from anywhere.

There are sample reports you can copy here.

[nikunj-tele]

Hi @candlerb ,
Thanks for looking into this issue

There is nothing showing in journalctl output

here is the ouput

$ /opt/netbox/venv/bin/python3 errorreport.py
Traceback (most recent call last):
  File "errorreport.py", line 1, in <module>
    from extras.reports import Report
ModuleNotFoundError: No module named 'extras'
$ /opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py  runreport errorreport.py
[21:05:11] Running errorreport.FindEmptyRackSwitches...
[21:05:12] errorreport.FindEmptyRackSwitches: SUCCESS
[21:05:12] errorreport.FindEmptyRackSwitches: Duration 0 minutes, 0.02 seconds
[21:05:12] Finished
$

[nikunj-tele]

it seems there is an some issue in the second part (finding single switch in rack has some issue) , I tried to rewrite the following code and spilt it by the function then found some issue with second part of following code ---

First function test_single_switch_rack works well (I have test it and it worked well)!

from dcim.models import Rack, Device
from extras.reports import Report

class RackReport(Report):
    description = "Report on empty racks and racks with one switch"

   # def test_empty_rack(self):
   #     for rack in Rack.objects.all():
   #         devices = Device.objects.filter(rack=rack)
   #         if devices is None or not devices:
   #             self.log_success(rack)
   #         else:
   #             self.log_info(rack, "This rack is not empty.")

    def test_single_switch_rack(self):
        for rack in Rack.objects.all():
            devices = Device.objects.filter(rack=rack, device_type__name='Switch')
            if devices is not None and devices.count() == 1:
                self.log_success(rack)
            else:
                self.log_info(rack, "This rack does not have exactly one switch.")

debug log from the second function test_single_switch_rack

$ /opt/netbox/venv/bin/python /opt/netbox/netbox/manage.py runscript --loglevel debug RackReport.py
Traceback (most recent call last):
  File "/opt/netbox/netbox/manage.py", line 10, in <module>
    execute_from_command_line(sys.argv)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/__init__.py", line 442, in execute_from_command_line
    utility.execute()
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/__init__.py", line 436, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/base.py", line 412, in run_from_argv
    self.execute(*args, **cmd_options)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/core/management/base.py", line 458, in execute
    output = self.handle(*args, **options)
  File "/opt/netbox/netbox/extras/management/commands/runscript.py", line 78, in handle
    module, script = get_module_and_script(module_name, script_name)
  File "/opt/netbox/netbox/extras/scripts.py", line 470, in get_module_and_script
    module = ScriptModule.objects.get(file_path=f'{module_name}.py')
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/db/models/manager.py", line 87, in manager_method
    return getattr(self.get_queryset(), name)(*args, **kwargs)
  File "/opt/netbox/venv/lib/python3.8/site-packages/django/db/models/query.py", line 637, in get
    raise self.model.DoesNotExist(
extras.models.scripts.DoesNotExist: ScriptModule matching query does not exist.
$ /opt/netbox/venv/bin/python RackReport.py

[candlerb]

No, d.tenant.slug

[nikunj-tele]

it looks like i cannot use rack and tenant__name /tenant__slug together..

>>> Device.objects.filter(tags__slug='switch', tenant__slug='eu-xx', rack='4').count()
0
>>> Device.objects.filter(tags__slug='switch', rack='4').count() <--- only rack wihtout tenant_slug
1
>>> Device.objects.filter(tags__slug='switch', tenant__slug='eu-xx', rack='4').count()   <----rack and tenant slug together
0
>>> Device.objects.filter(tenant__slug='eu-xx' , tags__slug='switch').count()
79
>>> Device.objects.filter(tenant__slug='eu-xx' , tags__slug='switch').count()

[nikunj-tele]

d.tenant.slug
Traceback (most recent call last):
File "", line 1, in
AttributeError: 'NoneType' object has no attribute 'slug'

[nikunj-tele]

d.tenant.slug
Traceback (most recent call last):
File "", line 1, in
AttributeError: 'NoneType' object has no attribute 'slug'

[candlerb]

>>> d = Device.objects.filter(rack='9', role__slug='bmc-switch',).first()
>>> d.tenant
>>> d.tenant.slug
Traceback (most recent call last):
File "", line 1, in
AttributeError: 'NoneType' object has no attribute 'slug'

This device doesn't have any tenant set. Therefore, if you add a filter for tenant__slug="foo" it will filter it out.

EDIT: just to be clear, adding multiple filter arguments treats them as AND, not OR (i.e. filter will only show those devices which have tag X and role Y and tenant Z).

Every device must have a role, but it doesn't have to have a rack or a tenant. (i.e. they can be unset).

[nikunj-tele]

Hi @candlerb ,

Thank you for your support, I have fixed the issue and used following script to fix the issue

from dcim.models import Rack, Device
from extras.reports import Report
from django.db.models import Count

def test_empty_rack(report, region):
    racks_data = Rack.objects.prefetch_related('devices').annotate(device_count=Count('devices')).filter(tenant__slug=region)
    for rack in racks_data:
        device_count = rack.device_count
        if device_count == 0:
            report.log_failure(rack, f" Rack {rack}  is Empty")
        else:
            report.log_success(rack)

class RackReport(Report):
    description =  (
    "Report to find empty racks"
    )
    def test_empty_report_region_1(self):
         test_empty_rack(self, "region-1")

    def test_empty_report_region_2(self):
         test_empty_rack(self, "region-2")