mirror of
https://github.com/librenms/librenms.git
synced 2024-10-07 16:52:45 +00:00
Rework documentation (#13709)
* Rework documentation * Slightly adjust theme * wip * fixes * Remove unneeded header * Re-added Acknowledgement.md file * Added Acknowledgement.md to mkdocs.yml Co-authored-by: Neil Lathwood <[email protected]>
This commit is contained in:
co-authored by
Neil Lathwood
parent
ee00f59ce6
commit
8f474dd4d4
@@ -1 +0,0 @@
|
||||
<meta http-equiv="refresh" content="0; url=/API" />
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/ARP.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `list_arp`
|
||||
|
||||
Retrieve a specific ARP entry or all ARP entries for a device
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Alerts.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_alert`
|
||||
|
||||
Get details of an alert
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Bills.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `list_bills`
|
||||
|
||||
Retrieve the list of bills currently in the system.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/DeviceGroups.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_devicegroups`
|
||||
|
||||
List all device groups.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Devices.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `del_device`
|
||||
|
||||
Delete a given device.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Inventory.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_inventory`
|
||||
|
||||
Retrieve the inventory for a device. If you call this without any
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Locations.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `add_location`
|
||||
|
||||
Add a new location
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Logs.md
|
||||
path: blob/master/doc/
|
||||
|
||||
All the `list_*logs` calls are aliased to `list_logs`.
|
||||
|
||||
Retrieve all logs or logs for a specific device.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/PortGroups.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_graph_by_portgroup`
|
||||
|
||||
Get the graph based on the group type.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Port_Groups.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_port_groups`
|
||||
|
||||
List all port groups.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Devices.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `get_all_ports`
|
||||
|
||||
Get info for all ports on all devices. Strongly recommend that you use
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Routing.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `list_bgp`
|
||||
|
||||
List the current BGP sessions.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Services.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `list_services`
|
||||
|
||||
Retrieve all services
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/Switching.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `list_vlans`
|
||||
|
||||
Get a list of all VLANs.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/System.md
|
||||
path: blob/master/doc/
|
||||
|
||||
### `system`
|
||||
|
||||
Display Librenms instance information.
|
||||
|
||||
@@ -1,6 +1,3 @@
|
||||
source: API/index.md
|
||||
path: blob/master/doc/
|
||||
|
||||
## Versioning
|
||||
|
||||
Versioning an API is a minefield which saw us looking at numerous
|
||||
|
||||
Reference in New Issue
Block a user