mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
6575042f5f
* clean up all but header incrementing in Creating-Transport.md * make Device-Dependencies.md mdl happy * make Entities.md as mdl happy as possible... one long table line left * make mdl as happy as possible for index.md * clean up Introduction.md as much as possible * minor formatting cleanup... move each icon onto its own row * make ack and notes the same style * clean Macros.md up * clean Rules.md up as much as possible * tweak one line a bit to get it to format a bit nicer * a bit more format tweaking, making sure it does not sure with > * clean up as much as possible for Templates.md * make Testing.md as mdl happy as possibly * clean Transports.md up as much as possible * clean as many issues as possible for Alerts.md * clean up as much of ARP.md as possible * clean up as much as possible for Bills.md * make DeviceGroups.md as mdl happy as possible * cleanup Devices.md * make as mdl happy as possible Inventory.md and index.md * mdl cleanup for Logs.md and PortGroups.md * make Ports.md and Routing.md as happy as possible * clean up Services.md, Switching.md, and Systems.md as much as possible * more markup cleanup * lots more md cleanup udner Devloping/ * reapply bits from #10343 that accidentally got removed when merging
44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
source: API/ARP.md
|
|
path: blob/master/doc/
|
|
|
|
### `list_arp`
|
|
|
|
Retrieve a specific ARP entry or all ARP enties for a device
|
|
|
|
Route: `/api/v0/resources/ip/arp/:ip`
|
|
|
|
- ip is the specific IP you would like to query, if this is all then
|
|
you need to pass ?device=_hostname_ (or device id)
|
|
- This may also be a cidr network, for example 192.168.1.0/24
|
|
|
|
Input:
|
|
|
|
- device if you specify all for the IP 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": ""
|
|
}
|
|
]
|
|
}
|
|
```
|