librenms-librenms/doc/Support/Adding-a-Device.md
Neil Lathwood 1ee2e8e0e0 Updated to use new theme for docs site (#9320)
* Updated to use new theme for docs site

* Updated theme location

* Removed librenms.css

* Updated index page + re-added librenms.css

* Use built in theme modification

* flexbox grid, dump bootstrap

* tidy up things

* Added path and updated deploy script + mkdocs config

* Removed db schmea changes

* Updated to install python/pip 3

* Removed pip3 install

* Pip3 install

* Updated deploy-docs

* Updated deploy-docs
2018-10-27 23:04:34 +01:00

1.8 KiB

source: Support/Adding-a-Device.md path: blob/master/doc/

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 yourhostname [community] [v1|v2c] [port] [udp|udp6|tcp|tcp6]

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

./addhost.php mydevice.example.com 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: SNMP Port defaults to 161

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