summaryrefslogtreecommitdiffstats
path: root/collectors/python.d.plugin/isc_dhcpd/README.md
blob: 712943d99a75a4f98daac5e0b558d4441d3620ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<!--
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"
-->

# ISC DHCP monitoring with Netdata

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:

1.  **Pools utilization** Aggregate chart for all pools.

    -   utilization in percent

2.  **Total leases**

    -   leases (overall number of leases for all pools)

3.  **Active leases** for every pools

    -   leases (number of active leases in pool)

## 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:
    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
```

The module will not work If no configuration is given.

---