API mac search (#12964)

* API find a switchport with the mac from device * fix style * convert SQL to Eloquent * convert SQL to Eloquent * git mistake * Global use App\Models\Port * git mistake partII * Refractor Eloquent - Not finish but easier to help for others * Better Eloquent Query without filter option * Validation * fix style * Add filter option and DOC * convert to the better macToHex method * add a maxToHex unit test * fix style * fix style * fix syle - seems my dev:check is running again :-) * Fix phpStan * phpStan #2
2024-10-07 16:52:45 +00:00 · 2021-08-10 02:33:04 +02:00
parent 9c534a1a90
commit 93209a0fc8
4 changed files with 201 additions and 27 deletions
--- a/doc/API/Ports.md
+++ b/doc/API/Ports.md
@@ -90,6 +90,111 @@ Output:
 }
 ```

+### `ports_with_associated_mac`
+
+Search for ports matching the search mac.
+
+Route: `/api/v0/ports/mac/:search?filter=first`
+
+-  search a mac address in fdb and print the ports ordered by the mac count of the associated port.
+
+Input:
+
+  -
+
+Example:
+
+```curl
+curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports/mac/00:11:22:33:44:55
+curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports/mac/001122.334455?filter=first
+curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports/mac/001122334455?filter=first
+```
+
+Output:
+
+```json
+{
+  "status": "ok",
+  "message": "",
+  "port": [
+    {
+      "port_id": "323",
+      "device_id": "55",
+      "port_descr_type": null,
+      "port_descr_descr": null,
+      "port_descr_circuit": null,
+      "port_descr_speed": null,
+      "port_descr_notes": null,
+      "ifDescr": "GigabitEthernet0/0/0",
+      "ifName": "Gi0/0/0",
+      "portName": null,
+      "ifIndex": "1",
+      "ifSpeed": "1000000000",
+      "ifConnectorPresent": "true",
+      "ifPromiscuousMode": "false",
+      "ifHighSpeed": "1000",
+      "ifOperStatus": "up",
+      "ifOperStatus_prev": null,
+      "ifAdminStatus": "up",
+      "ifAdminStatus_prev": null,
+      "ifDuplex": "fullDuplex",
+      "ifMtu": "1560",
+      "ifType": "ethernetCsmacd",
+      "ifAlias": "ASR Interconnect Trunk",
+      "ifPhysAddress": "84bf20853e00",
+      "ifHardType": null,
+      "ifLastChange": "42407358",
+      "ifVlan": "",
+      "ifTrunk": "",
+      "ifVrf": "0",
+      "counter_in": null,
+      "counter_out": null,
+      "ignore": "0",
+      "disabled": "0",
+      "detailed": "0",
+      "deleted": "0",
+      "pagpOperationMode": null,
+      "pagpPortState": null,
+      "pagpPartnerDeviceId": null,
+      "pagpPartnerLearnMethod": null,
+      "pagpPartnerIfIndex": null,
+      "pagpPartnerGroupIfIndex": null,
+      "pagpPartnerDeviceName": null,
+      "pagpEthcOperationMode": null,
+      "pagpDeviceId": null,
+      "pagpGroupIfIndex": null,
+      "ifInUcastPkts": "128518576",
+      "ifInUcastPkts_prev": "128517284",
+      "ifInUcastPkts_delta": "1292",
+      "ifInUcastPkts_rate": "4",
+      "ifOutUcastPkts": "128510560",
+      "ifOutUcastPkts_prev": "128509268",
+      "ifOutUcastPkts_delta": "1292",
+      "ifOutUcastPkts_rate": "4",
+      "ifInErrors": "0",
+      "ifInErrors_prev": "0",
+      "ifInErrors_delta": "0",
+      "ifInErrors_rate": "0",
+      "ifOutErrors": "0",
+      "ifOutErrors_prev": "0",
+      "ifOutErrors_delta": "0",
+      "ifOutErrors_rate": "0",
+      "ifInOctets": "12827393730",
+      "ifInOctets_prev": "12827276736",
+      "ifInOctets_delta": "116994",
+      "ifInOctets_rate": "387",
+      "ifOutOctets": "14957481766",
+      "ifOutOctets_prev": "14957301765",
+      "ifOutOctets_delta": "180001",
+      "ifOutOctets_rate": "596",
+      "poll_time": "1483779150",
+      "poll_prev": "1483778848",
+      "poll_period": "302"
+    }
+  ]
+}
+
+
 ### `get_port_info`

 Get all info for a particular port.