API mac search

[mpikzink]

A useful API search if you are looking for a client that is not included in LNMS. This can be used to locate the connected switchport based on the client MAC.

Please give a short description what your pull request is for

DO NOT DELETE THE UNDERLYING TEXT

Please note

Please read this information carefully. You can run ./lnms dev:check to check your code before submitting.

• Have you followed our code guidelines?
• If my Pull Request does some changes/fixes/enhancements in the WebUI, I have inserted a screenshot of it.

Testers

If you would like to test this pull request then please run: ./scripts/github-apply <pr_id>, i.e ./scripts/github-apply 5926
After you are done testing, you can remove the changes with ./scripts/github-remove. If there are schema changes, you can ask on discord how to revert.

[Jellyfrog]

I think this should return all ports matching the Mac Instead?
Something like

Port::whereHas('fdbEntries', function($q) use ($search) {
   $q->where('mac_address', $search);
})->get();

[mpikzink]

I just want to get the Downlink.
e.g. :

PortsFdb::whereIn('port_id',PortsFdb::where('mac_address', $search)->select('port_id'))
->groupBy('port_id')
->orderByRaw('count(port_id)')
->select('port_id')
->first()
->port;

[murrant]

@mpikzink your code has two queries, but the inside on isn't actually executed. Also, it looks like you want to select the port, so perhaps you should start with Port:: for the query.

[mpikzink]

@Murrat Yes I need a port. But I am looking for a port that "only" has this MAC in the FDB. Traditionally as SQL query I can only achieve this via a subquery so that I can count the remaining MAC addresses on the port in the FDB.

[murrant]

Remember that a MAC can be on many ports (switch downlinks).

Subquery is supported, but that is not the correct syntax

[mpikzink]

I know that it can be on many ports but I think if I search for a client the client will be on the port with the fewest count of other MACs. I have this (first commit) option in our setup since a year and it works very well for our client search which we use multiple times per day. I will have a look for the right syntax for laravel.

BTW: Since my first commit I think my chosen route is also not the best place and I need to describe in the doc as well.

[Jellyfrog]

I think for this endpoint we except all ports that match to be returned.
Add a filter option if you want more granular results.
Also, there should already be some function to normalize the Mac address, so users can search with different formats

[murrant]

Yay, unit tests :)

[librenms-bot]

This pull request has been mentioned on LibreNMS Community. There might be relevant details there:

https://community.librenms.org/t/21-8-0-changelog/16685/1