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
186 lines
3.8 KiB
Markdown
186 lines
3.8 KiB
Markdown
source: API/Devices.md
|
|
path: blob/master/doc/
|
|
|
|
### `get_all_ports`
|
|
|
|
Get info for all ports on all devices. Strongly recommend that you use
|
|
the `columns` parameter to avoid pulling too much data.
|
|
|
|
Route: `/api/v0/ports`
|
|
|
|
-
|
|
|
|
Input:
|
|
|
|
- columns: Comma separated list of columns you want returned.
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports?columns=ifName%2Cport_id
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"message": "",
|
|
"ports": [
|
|
{
|
|
"ifName": "Gi0/0/0",
|
|
"port_id": "1"
|
|
},
|
|
{
|
|
"ifName": "Gi0/0/1",
|
|
"port_id": "2"
|
|
},
|
|
...
|
|
{
|
|
"ifName": "Vlan 3615",
|
|
"port_id": "5488"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### `get_port_info`
|
|
|
|
Get all info for a particular port.
|
|
|
|
Route: `/api/v0/ports/:portid`
|
|
|
|
- portid must be an integer
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports/323
|
|
```
|
|
|
|
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_ip_info`
|
|
|
|
Get all IP info (v4 and v6) for a given port id.
|
|
|
|
Route: `/api/v0/ports/:portid/ip`
|
|
|
|
- portid must be an integer
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ports/323/ip
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"message": "",
|
|
"addresses": [
|
|
{
|
|
"ipv4_address_id": "290",
|
|
"ipv4_address": "192.168.99.292",
|
|
"ipv4_prefixlen": "30",
|
|
"ipv4_network_id": "247",
|
|
"port_id": "323",
|
|
"context_name": ""
|
|
}
|
|
]
|
|
}
|
|
```
|