Home
A PHP based Control Panel to control multiple APC Switched Rack PDUs via SNMPv3. A single panel to switch (on, off, restart) the attached devices between different states.
(Dark/Light Mode based on User System Settings)
- Web server with PHP
- PHP module:
php-snmp - APC Switched Rack PDU(s) with enabled SNMPv3
No 🚀 science: Upload a single PHP file on a Webserver, enter the PDU IP address and the SNMPv3 access data with an editor and the script is ready for use.
Administration -> Network -> SNMPv3: access -> Tick checkbox -> Confirm by clicking on Apply
Administration -> Network -> SNMPv3: user profiles -> choose profile from list
Administration -> Network -> SNMPv3: user profiles -> User Profiles
| Fields | Description | Exceptions |
|---|---|---|
User Name |
The SNMP user name can contain up to 32 characters in length and include any combination of alphanumeric characters (uppercase letters, lowercase letters, and numbers). |
|
Authentication Passphrase |
The password must be 15-32 ASCII characters long. | |
Authentication Protocol |
Enable MD5
|
|
Privacy Passphrase |
The password must be 15-32 ASCII characters long. | |
Privacy Protocol |
Enable DES
|
ℹ️ The authentication via Authentication Passphrase and via Privacy Passphrase is optional. Leave both fields empty, if you don't want to use it.
ℹ️ There is an option to authentication via Authentication Passphrase only. If you want to go this route, leave the field for Privacy Passphrase empty.
ℹ️ If you want to authenticate via Authentication Passphrase AND via Privacy Passphrase, you have to enter the passphrase at the same time. Otherwise if you do it step by step (enter and save, enter and save) you will delete the previous entry.
Administration -> Network -> SNMPv3: access control -> choose profile from list
Administration -> Network -> SNMPv3: access control -> User Profiles
ℹ️ It is recommended to enable NMS IP/Host Name when the script is running as expected without this option. A wrong entry causes a timeout and the script can't feedback why it will fail, which makes troubleshooting difficult.
Open the PHP file with a text editor of your choice
Between line 40 - 47 you have to enter the access data you have entered in the PDU before
| PHP script | APC Control Panel | Description |
|---|---|---|
| $apcPDUs['001']['active'] | n/a | By setting it to true, you activate the script to query the PDU with the underlying access data. The query is deactivated with false. |
| $apcPDUs['001']['ipAddress'] | n/a | Insert the IPv4 address where the PDU can be reached. |
| $apcPDUs['001']['userProfile'] | User Name | Enter the User Name that you previously saved in the PDU. |
| $apcPDUs['001']['authenticationPassphrase'] | Authentication Passphrase | Enter the Authentication Passphrase that you previously saved in the PDU. |
| $apcPDUs['001']['authenticationProtocol'] | Authentication Protocol | Leave this option untouched. Make sure that you have activated the option in the PDU. |
| $apcPDUs['001']['privacyPassphrase'] | Privacy Passphrase | Enter the Privacy Passphrase that you previously saved in the PDU. |
| $apcPDUs['001']['privacyProtocol'] | Privacy Protocol | Leave this option untouched. Make sure that you have activated the option in the PDU. |
| $apcPDUs['001']['securityLevel'] | Privacy Protocol | With this option you can specify which authentication should be used:noAuthNoPriv = No Authentication & Privacy Passphrase are used. Just User Name.authNoPriv = Combination of User Name & Authentication Passphrase are used.authPriv = Combination of User Name, Authentication & Privacy Passphrase are used.ℹ️ When you try to connect for the first time, start with the first option noAuthNoPriv. If the connection is successfully established, switch to the next higher level. This should speed up any troubleshooting. |
Between line 50 - 57 you can repeat the step above for a second PDU
In case you want to manage more than two PDUs, just copy the block between line 50 and 57, replace the value 002 against 003 in the appropiate variable for the new block and add the access data for the additional PDU.
ℹ️ Depending on how many PDUs you want to control at the end, it can be beneficial to adjust the front end which is based on Bootstrap 5. The current layout is designed to manage 2-3 PDUs that can be easily operated from an iPad.
Upload the file to the web directory
ℹ️ Rename the file name if a different index.php is already existing.
php -v
Otherwise install PHP
Debian/Ubuntu/Raspian
sudo apt update -y && sudo apt upgrade -y && sudo apt install php php-snmp -y
CentOS/RHEL/Fedora
sudo yum update -y && sudo yum upgrade -y && sudo yum install php php-snmp -y
or
sudo dnf update
sudo dnf upgrade
sudo dnf install php php-snmp
ℹ️ Technically the script should work with PHP 5 and higher. However it has been never tested on a different version than PHP 7.4
php -m | grep -i snmp
Otherwise install PHP module php-snmp
Debian/Ubuntu/Raspian
sudo apt update -y && sudo apt upgrade -y && sudo apt install php-snmp -y
CentOS/RHEL/Fedora
sudo yum update -y && sudo yum upgrade -y && sudo yum install php-snmp -y
or
sudo dnf update
sudo dnf upgrade
sudo dnf install php-snmp
If a firewall is set up on the web server, in order to communicate with the PDUs the firewall need to be adjusted accordingly.
SNMP use the following ports:
- 161 (UDP)
The code is kept very simple and offers a reduced handling to deal with possible errors that occur.
If you haven't specify an ErrorLog directive on your Web server configuration, issues should be logged in the following log:
Apache
sudo tail -f /var/log/apache/error.log
or
sudo tail -f /var/log/httpd/error.log
Nginx
sudo tail -f /var/log/nginx/error.log
Alternatively show errors via the PHP error reporting:
Add the following code at the real beginning of the script:
ini_set('display_errors', 1);
ini_set('display_startup_errors', 1);
error_reporting(E_ALL);
Depending on the server configuration it may be need to enable error reporting via php.ini:
display_errors = On
display_startup_errors = On
ℹ️ This options are global and affects all PHP projects on the Web server.
In case of connection errors, you should try if your host is in general able to connect to the desired PDU:
snmpwalk -v3 -l authPriv -u <User Name> -a MD5 -A <Authentication Passphrase> -x DES -X <Privacy Passphrase> <PDU IP> 1.3.6.1.4.1.318.1.1.12.1.1
Example:
snmpwalk -v3 -l authPriv -u SNMPuser -a MD5 -A vqbjkA8IS7c0kxWl -x DES -X THyWZDCprfMu0oJG 192.168.1.20 1.3.6.1.4.1.318.1.1.12.1.1