Filtering on fields of related objects using double underscore syntax (?tenant__name=foo)

[sdktr]

Hi Guys,

I had the below functionality in mind as being available in netbox 'in the past'. But since it's not in the filtering guide I have my doubts.

Basically, should filtering by a field of a related object work? On the demo instance and my own it doesn't filter out any results. How do people implement a filter on to get all the Sites for a tenant, for which they don't (yet) have the tenantID?

1. Create a Site with Tenant set to 'tenant1'
2. Access the Site endpoint (GUI or API)
3. Try filtering on the name of the tenant1 using:
   https://netbox/dcim/sites/?tenant__name=tenant1 (e.g.: https://demo.netbox.dev/api/dcim/sites/?tenant__name=NC%20State%20University)
4. Alternatively try tenant__display

Any insights will be appreciated

[jeremystretch]

This has never been supported in NetBox. You may be thinking of the underlying Django ORM, which does support following model relations using a double underscore.

[sdktr]

Ah thanks for clearing that up, I must have been confused by filtering capabilities in AWX (uses django as well). Works pretty well to avoid some additional client logic and requests.

https://docs.ansible.com/automation-controller/latest/html/controllerapi/filtering.html

Would it make sense to poll for interest in the form of a feature request? Or are other alternatives available to ease the filtering by a client?

[jeremystretch]

You would need to devise a rough technical implementation first. I invite you to explore the manner in which filters are currently generated. I don't believe django-filter provides any native capability to support this but I could be wrong.