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

API add_device: Add ping_ping fallback option (#15637)

Browse Source 
* API add_device: Add ping_ping fallback option
improve docs a little

* More docs refinement
This commit is contained in:
Tony Murray
2023-12-17 11:08:37 -06:00
committed by GitHub
parent fa2919bb78
commit e7114e33f9
2 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
doc/API/Devices.md
View File

@@ -1178,27 +1178,27 @@ Route: `/api/v0/devices`
Input (JSON): Input (JSON):
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
template using replacements: {{ $hostname }}, {{ $sysName }}, template using replacements: {{ $hostname }}, {{ $sysName }},
{{ $sysName_fallback }}, {{ $ip }} {{ $sysName_fallback }}, {{ $ip }}
- snmpver: SNMP version to use, v1, v2c or v3. During checks detection order is v2c,v3,v1
- port: SNMP port (defaults to port defined in config). - port: SNMP port (defaults to port defined in config).
- transport: SNMP protocol (defaults to transport defined in config). - transport: SNMP protocol (udp,tcp,udp6,tcp6) Defaults to transport defined in config.
- snmpver: SNMP version to use, v1, v2c or v3. Defaults to v2c.
- port_association_mode: method to identify ports: ifIndex (default), ifName, ifDescr, ifAlias - port_association_mode: method to identify ports: ifIndex (default), ifName, ifDescr, ifAlias
- poller_group: This is the poller_group id used for distributed - poller_group: This is the poller_group id used for distributed poller setup. Defaults to 0.
poller setup. Defaults to 0.
- location or location_id: set the location by text or location id - location or location_id: set the location by text or location id
- force_add: Set to true to force the device to be added regardless of it being able
to respond to snmp or icmp.
For SNMP v1 or v2c Options:
- 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
SNMP v1 or v2c credentials:
- community: Required for SNMP v1 or v2c. - community: Required for SNMP v1 or v2c.
For SNMP v3 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
@@ -1206,9 +1206,8 @@ For SNMP v3
- cryptopass: SNMP Crypto Password - cryptopass: SNMP Crypto Password
- 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: Boolean, set to true for ICMP only.
- 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.
- hardware: Device hardware. - hardware: Device hardware.

2
includes/html/api_functions.inc.php
View File

@@ -445,7 +445,7 @@ function add_device(Illuminate\Http\Request $request)
$device->snmp_disable = 1; $device->snmp_disable = 1;
} }
(new ValidateDeviceAndCreate($device, ! empty($data['force_add'])))->execute(); (new ValidateDeviceAndCreate($device, ! empty($data['force_add']), ! empty($data['ping_fallback'])))->execute();
} catch (Exception $e) { } catch (Exception $e) {
return api_error(500, $e->getMessage()); return api_error(500, $e->getMessage());
} }