mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Doc api fixes (#7950)

Browse Source 
* doc: fix get_port_ip_info name

Signed-off-by: Misha Komarovskiy <zombah@gmail.com>

* doc: Update API Routing.md

* Add list_bgp output example
* Fix typo in list_ospf output example

Signed-off-by: Misha Komarovskiy <zombah@gmail.com>
This commit is contained in:
Misha Komarovskiy
2017-12-24 00:55:41 +03:00
committed by Neil Lathwood
parent 7b0c0c8ca7
commit 6009d209cf
2 changed files with 28 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/API/Ports.md
View File

@@ -145,7 +145,7 @@ Output:
}
```
### `get_port_info`
### `get_port_ip_info`
Get all IP info (v4 and v6) for a given port id.

31
doc/API/Routing.md
View File

@@ -15,6 +15,8 @@ Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bgp
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bgp?hostname=host.example.com
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/bgp?asn=1234
```
Output:
@@ -22,10 +24,28 @@ Output:
{
"status": "ok",
"err-msg": "",
"count": 0,
"bgp_sessions": [
]
{
"bgpPeer_id": "4",
"device_id": "2",
"astext": "",
"bgpPeerIdentifier": "1234:1b80:1:12::2",
"bgpPeerRemoteAs": "54321",
"bgpPeerState": "established",
"bgpPeerAdminStatus": "running",
"bgpLocalAddr": "1234:1b80:1:12::1",
"bgpPeerRemoteAddr": "0.0.0.0",
"bgpPeerInUpdates": "3",
"bgpPeerOutUpdates": "1",
"bgpPeerInTotalMessages": "0",
"bgpPeerOutTotalMessages": "0",
"bgpPeerFsmEstablishedTime": "0",
"bgpPeerInUpdateElapsedTime": "0",
"context_name": ""
},
...
],
"count": 100
}
```
@@ -122,6 +142,7 @@ Input:
Example:
```curl
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ospf
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/ospf?hostname=host.example.com
```
Output:
@@ -145,6 +166,8 @@ Output:
"ospfNbmaNbrPermanence": "dynamic",
"ospfNbrHelloSuppressed": "false",
"context_name": ""
]
}
],
"count": 1
}
```