mirror of
https://github.com/librenms/librenms.git
synced 2024-09-21 18:38:25 +00:00
9f591c0aa2
* Update Documentation Most work in Graylog and SNMP Fixed many code tags, spelling and wording. Added SNMP PowerShell example. * Update SNMP-Configuration-Examples.md Fix TOC brackets
46 lines
1005 B
Markdown
46 lines
1005 B
Markdown
source: API/ARP.md
|
|
path: blob/master/doc/
|
|
|
|
### `list_arp`
|
|
|
|
Retrieve a specific ARP entry or all ARP entries for a device
|
|
|
|
Route: `/api/v0/resources/ip/arp/:query`
|
|
|
|
Query can be:
|
|
- An IP address
|
|
- A MAC address
|
|
- A CIDR network (192.168.1.0/24)
|
|
- `all` and set ?device=_hostname_ (or device id)
|
|
|
|
Input:
|
|
|
|
- device if you specify all for the query then you need to populate this
|
|
with the hostname or id of the device.
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/ip/arp/1.1.1.1
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/ip/arp/192.168.1.0/24
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/ip/arp/all?device=localhost
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"message": "",
|
|
"count": 1,
|
|
"arp": [
|
|
{
|
|
"port_id": "229",
|
|
"mac_address": "da160e5c2002",
|
|
"ipv4_address": "1.1.1.1",
|
|
"context_name": ""
|
|
}
|
|
]
|
|
}
|
|
```
|