librenms-librenms/doc/Support/Adding-a-Device.md
Tony Murray 3bd9920e38 docs: Continue to reorganize docs (#7762)
* docs: Continue to reorganize things
Make landing pages for /Installation, /API, etc.
Split API out into multiple docs
Properly use multi-level navigation
Add lower nav buttons (tops are bug so disable for now)
Add logo for fanciness
Refine index page a bit

* Improve API TOC layout

* Couple of fixes.

* Fix API/API-Docs, assumed it was at the right url.
2017-11-19 01:19:18 +00:00

1.7 KiB

source: Support/Adding-a-Device.md

Adding Device

You have two options for adding a new device into LibreNMS. You can add a device via the cli or by using the WebUI.

CLI

Using the command line via ssh you can add a new device by changing to the directory of your LibreNMS install and typing (be sure to put the correct details).

./addhost.php [community] [v1|v2c] [port] [udp|udp6|tcp|tcp6]

As an example, if your device is configured to use the community my_company using snmp v2c then you would enter:

./addhost.php my_company v2c

Please note that if the community contains special characters such as $ then you will need to wrap it in '. I.e: 'Pa$$w0rd'.

WebUI

Using the web interface, go to Devices and click Add Device. Enter the details required for the device that you want to add and then click 'Add Host'. As an example, if your device is configured to use the community my_company using snmp v2c then you would enter:

Add device

Ping Only Device

You can add ping only devices into LibreNMS through the WebUI. When adding the device switch the SNMP button to "off". Device will be added into LibreNMS as Ping Only Device and will show ICMP Response Graph.

  • Hostname: IP address or DNS name.
  • Hardware: Optional you can type in whatever you like.
  • OS: Optional this will add the Device's OS Icon.

How to add ping only devices

Ping Only

If you would like to add devices automatically then you will probably want to read the Auto-discovery Setup guide.

You may also want to add devices programatically, if so, take a look at our API documentation