Add the ability to do global search by tags

[BrunoBlanes]

NetBox version

v4.0.2

Feature type

New functionality

Proposed functionality

Add a field to select one or more tags and filter results by them, even when no query is given, and make it work with the existing search fields in a way that one could look up only objects that match all specified tags and are of a specific object type.

Use case

Tags are useful for sorting objects into categories, for example, I set the same tag to all objects that are allocated to a specific client, IP, Prefix, VLAN, etc., let's call that tag 13500, which represents the client's ID on my ERP. I currently have a couple of integrations which do use tags to identify objects.

By having the ability to search, globally, by tags, I can find the resources of said category faster, without the need to dive into every object menu.

The tags menu isn't that well invested and so it does not return much information about the object and does not allow me to filter by objects with multiple tags as parameter.

Database changes

None as far as I could guess since this is just a search and UI improvement, maybe some new indexing.

External dependencies

None.

[Mailstorm-ctrl]

You might benefit more from custom fields than this functionality. Custom fields will achieve what you are wanting (search by value of custom field).

So what you'd do is create a custom field and assign it to whatever objects you want (or leave blank for everything). So you may do "Client Number" as the field name and then you just input whatever the client number is for that particular object.

However, the proper way to do this is to make a tenant (which I assume you are doing) for every client you have and assign the appropriate objects to that tenant. Then in that Tenant you'd have a custom field for the customer ID in your ERP. That way whenever you go to an object, you can just look at the tenant information then from there get the customer ID.

You'd have to change/modify your integrations but this is the way you'd want to do.

[BrunoBlanes]

That would solve the Client ID problem, but Tags can be used for much more than just that, for example, if I'd like to lookup all equipment that is allocated to clients under contract I'd have a tag for that, or IP addresses that are monitored via ICMP, I'd add a tag for that. And then you can start to mix and match tags for advanced filtering.

Tags are easier and more interactive than custom fields, which is not to say they don't have their own use case, for example, we use custom fields under Sites to register the Contract ID for each site with our local power supply company, so in case we have a power outage, we have the right info within Netbox.