Documentation
Table of Contents
4 Frontend maintenance mode
Overview
Zabbix web frontend can be temporarily disabled in order to prohibit access to it. This can be useful for protecting the Zabbix database from any changes initiated by users, thus protecting the integrity of database.
Zabbix database can be stopped and maintenance tasks can be performed while Zabbix frontend is in maintenance mode.
Users from defined IP addresses will be able to work with the frontend normally during maintenance mode.
Configuration
In order to enable maintenance mode, the maintenance.inc.php file (located in /conf of the Zabbix HTML document directory on the webserver) must be modified to uncomment the following lines:
// Maintenance mode.
define('ZBX_DENY_GUI_ACCESS', 1);
// Array of IP addresses, which are allowed to connect to frontend (optional).
$ZBX_GUI_ACCESS_IP_RANGE = array('127.0.0.1');
// Message shown on warning screen (optional).
$ZBX_GUI_ACCESS_MESSAGE = 'We are upgrading MySQL database till 15:00. Stay tuned...';| Parameter | Details |
|---|---|
| ZBX_DENY_GUI_ACCESS | Enable maintenance mode: 1 – maintenance mode is enabled, disabled otherwise |
| ZBX_GUI_ACCESS_IP_RANGE | Array of IP addresses, which are allowed to connect to frontend (optional). For example: array('192.168.1.1', '192.168.1.2') |
| ZBX_GUI_ACCESS_MESSAGE | A message you can enter to inform users about the maintenance (optional). |
Mostly the maintenance.inc.php file is located in /conf of Zabbix HTML document directory on the web server. However, the location of the directory may differ depending on the operating system and a web server it uses.
For example, the location for:
- SUSE and RedHat is
/etc/zabbix/web/maintenance.inc.php. - Debian-based systems is
/usr/share/zabbix/conf/.
See also Copying PHP files.
| Parameter | Details |
|---|---|
| ZBX_DENY_GUI_ACCESS | Enable maintenance mode: 1 – maintenance mode is enabled, disabled otherwise |
| ZBX_GUI_ACCESS_IP_RANGE | Array of IP addresses, which are allowed to connect to frontend (optional). For example: array('192.168.1.1', '192.168.1.2') |
| ZBX_GUI_ACCESS_MESSAGE | A message you can enter to inform users about the maintenance (optional). |
Display
The following screen will be displayed when trying to access the Zabbix frontend while in maintenance mode. The screen is refreshed every 30 seconds in order to return to a normal state without user intervention when the maintenance is over.
IP addresses defined in ZBX_GUI_ACCESS_IP_RANGE will be able to access the frontend as always.