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

Fix API add_device markdown (#15684)

Browse Source
This commit is contained in:
Tony Murray
2024-01-09 17:36:59 -06:00
committed by GitHub
parent f7243f538b
commit 389cdcbcb2
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/API/Devices.md
View File

@@ -1179,6 +1179,7 @@ Route: `/api/v0/devices`
Input (JSON): Input (JSON):
Fields: Fields:
- hostname (required): device hostname or IP - hostname (required): device hostname or IP
- display: A string to display as the name of this device, defaults to - display: A string to display as the name of this device, defaults to
hostname (or device_display_default setting). May be a simple hostname (or device_display_default setting). May be a simple
@@ -1192,13 +1193,16 @@ Fields:
- location or location_id: set the location by text or location id - location or location_id: set the location by text or location id
Options: Options:
- force_add: Skip all checks and attempts to detect credentials. Add the device as given directly to the database. - force_add: Skip all checks and attempts to detect credentials. Add the device as given directly to the database.
- ping_fallback: if snmp checks fail, add the device as ping only instead of failing - ping_fallback: if snmp checks fail, add the device as ping only instead of failing
SNMP v1 or v2c credentials: SNMP v1 or v2c credentials:
- community: Required for SNMP v1 or v2c. - community: Required for SNMP v1 or v2c.
SNMP v3 credentials: SNMP v3 credentials:
- authlevel: SNMP authlevel (noAuthNoPriv, authNoPriv, authPriv). - authlevel: SNMP authlevel (noAuthNoPriv, authNoPriv, authPriv).
- authname: SNMP Auth username - authname: SNMP Auth username
- authpass: SNMP Auth password - authpass: SNMP Auth password
@@ -1207,6 +1211,7 @@ SNMP v3 credentials:
- cryptoalgo: SNMP Crypto algorithm (AES, DES) - cryptoalgo: SNMP Crypto algorithm (AES, DES)
For ICMP only: For ICMP only:
- snmp_disable: set to true for ICMP only. Disables SNMP checks and polling. - snmp_disable: set to true for ICMP only. Disables SNMP checks and polling.
- os: OS short name for the device (defaults to ping). - os: OS short name for the device (defaults to ping).
- sysName: sysName for the device. - sysName: sysName for the device.