summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/isc_dhcpd/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'collectors/python.d.plugin/isc_dhcpd/README.md')
-rw-r--r--collectors/python.d.plugin/isc_dhcpd/README.md32
1 files changed, 25 insertions, 7 deletions
diff --git a/collectors/python.d.plugin/isc_dhcpd/README.md b/collectors/python.d.plugin/isc_dhcpd/README.md
index f90cd041e..5830bd63e 100644
--- a/collectors/python.d.plugin/isc_dhcpd/README.md
+++ b/collectors/python.d.plugin/isc_dhcpd/README.md
@@ -1,11 +1,18 @@
-# isc_dhcpd
+<!--
+title: "ISC DHCP monitoring with Netdata"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/python.d.plugin/isc_dhcpd/README.md
+sidebar_label: "ISC DHCP"
+-->
-Module monitor leases database to show all active leases for given pools.
+# ISC DHCP monitoring with Netdata
-**Requirements:**
+Monitors the leases database to show all active leases for given pools.
+
+## Requirements
- dhcpd leases file MUST BE readable by Netdata
- pools MUST BE in CIDR format
+- `python-ipaddress` package is needed in Python2
It produces:
@@ -21,17 +28,28 @@ It produces:
- leases (number of active leases in pool)
-## configuration
+## Configuration
+
+Edit the `python.d/isc_dhcpd.conf` configuration file using `edit-config` from the Netdata [config
+directory](/docs/configure/nodes.md), which is typically at `/etc/netdata`.
+
+```bash
+cd /etc/netdata # Replace this path with your Netdata config directory, if different
+sudo ./edit-config python.d/isc_dhcpd.conf
+```
Sample:
```yaml
local:
- leases_path : '/var/lib/dhcp/dhcpd.leases'
- pools : '192.168.3.0/24 192.168.4.0/24 192.168.5.0/24'
+ leases_path: '/var/lib/dhcp/dhcpd.leases'
+ pools:
+ office: '192.168.2.0/24' # name(dimension): pool in CIDR format
+ wifi: '192.168.3.10-192.168.3.20' # name(dimension): pool in IP Range format
+ 192.168.4.0/24: '192.168.4.0/24' # name(dimension): pool in CIDR format
+ wifi-guest: '192.168.5.0/24 192.168.6.10-192.168.6.20' # name(dimension): pool in CIDR + IP Range format
```
-In case of python2 you need to install `py2-ipaddress` to make plugin work.
The module will not work If no configuration is given.
---