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
240 lines
3.9 KiB
Markdown
240 lines
3.9 KiB
Markdown
source: API/Switching.md
|
|
path: blob/master/doc/
|
|
|
|
### `list_vlans`
|
|
|
|
Get a list of all VLANs.
|
|
|
|
Route: `/api/v0/resources/vlans`
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/vlans
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"vlans": [
|
|
{
|
|
"vlan_id": "31",
|
|
"device_id": "10",
|
|
"vlan_vlan": "1",
|
|
"vlan_domain": "1",
|
|
"vlan_name": "default",
|
|
"vlan_type": "ethernet",
|
|
"vlan_mtu": null
|
|
},
|
|
...
|
|
],
|
|
"count": 100
|
|
}
|
|
```
|
|
|
|
### `get_vlans`
|
|
|
|
Get a list of all VLANs for a given device.
|
|
|
|
Route: `/api/v0/devices/:hostname/vlans`
|
|
|
|
- hostname can be either the device hostname or id
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/devices/localhost/vlans
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"count": 0,
|
|
"vlans": [
|
|
{
|
|
"vlan_vlan": "1",
|
|
"vlan_domain": "1",
|
|
"vlan_name": "default",
|
|
"vlan_type": "ethernet",
|
|
"vlan_mtu": null
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
### `list_links`
|
|
|
|
Get a list of all Links.
|
|
|
|
Route: `/api/v0/resources/links`
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/links
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"links": [
|
|
{
|
|
"id": 10,
|
|
"local_port_id": 100,
|
|
"local_device_id": 1,
|
|
"remote_port_id": 200,
|
|
"active": 1,
|
|
"protocol": "lldp",
|
|
"remote_hostname": "host2.example.com",
|
|
"remote_device_id": 2,
|
|
"remote_port": "xe-0/0/1",
|
|
"remote_platform": null,
|
|
"remote_version": "Example Router v.1.0"
|
|
},
|
|
...
|
|
],
|
|
"count": 100
|
|
}
|
|
```
|
|
|
|
### `get_links`
|
|
|
|
Get a list of Links per giver device.
|
|
|
|
Route: `/api/v0/devices/:hostname/links`
|
|
|
|
- hostname can be either the device hostname or id
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/devices/localhost/links
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"links": [
|
|
{
|
|
"id": 10,
|
|
"local_port_id": 100,
|
|
"local_device_id": 1,
|
|
"remote_port_id": 200,
|
|
"active": 1,
|
|
"protocol": "lldp",
|
|
"remote_hostname": "host2.example.com",
|
|
"remote_device_id": 2,
|
|
"remote_port": "xe-0/0/1",
|
|
"remote_platform": null,
|
|
"remote_version": "Example Router v.1.0"
|
|
},
|
|
...
|
|
],
|
|
"count": 10
|
|
}
|
|
```
|
|
|
|
### `get_link`
|
|
|
|
Retrieves Link by ID
|
|
|
|
Route: `/api/v0/resources/links/:id`
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/link/10
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"links": [
|
|
{
|
|
"id": 10,
|
|
"local_port_id": 100,
|
|
"local_device_id": 1,
|
|
"remote_port_id": 200,
|
|
"active": 1,
|
|
"protocol": "lldp",
|
|
"remote_hostname": "host2.example.com",
|
|
"remote_device_id": 2,
|
|
"remote_port": "xe-0/0/1",
|
|
"remote_platform": null,
|
|
"remote_version": "Example Router v.1.0"
|
|
}
|
|
],
|
|
"count": 1
|
|
}
|
|
```
|
|
|
|
### `list_fdb`
|
|
|
|
Get a list of all ports FDB.
|
|
|
|
Route: `/api/v0/resources/fdb/:mac`
|
|
|
|
- mac is the specific MAC address you would like to query
|
|
|
|
Input:
|
|
|
|
-
|
|
|
|
Example:
|
|
|
|
```curl
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/fdb
|
|
curl -H 'X-Auth-Token: YOURAPITOKENHERE' https://librenms.org/api/v0/resources/fdb/1aaa2bbb3ccc
|
|
```
|
|
|
|
Output:
|
|
|
|
```json
|
|
{
|
|
"status": "ok",
|
|
"ports_fdb": [
|
|
{
|
|
"ports_fdb_id": 10,
|
|
"port_id": 10000,
|
|
"mac_address": "1aaa2bbb3ccc",
|
|
"vlan_id": 20000,
|
|
"device_id": 1,
|
|
"created_at": "2019-01-1 01:01:01",
|
|
"updated_at": "2019-01-1 01:01:01"
|
|
},
|
|
...
|
|
],
|
|
"count": 100
|
|
}
|
|
```
|