CyberPower Personal Linux Software User Guide

CyberPower Personal Linux Software

Getting Started

Name
pwrstat The UPS power state command tool.

Synopsis

Description
pwrstat is an interface in PowerPaneI for Linux which allows users to receive UPS status and configure UPS settings.

Type the following command to list the manual: man pwrstat

Options
The pwrstat parameters, their functions, and the examples are described below:

Note 1
The following arguments should follow -pwrfail.

Note 2
The following arguments should follow -lowbatt.

Note 3
The following arguments should follow -cloud.

Note 4

1. The parameters of -pwrfail and -lowbatt need to be set independently.
2. Both the shell scripts pwrstatd-lowbatt.sh and pwrstatd-powerfail.sh will be copied to Jetc during the installation procedure.
3. The parameter —cmd can be any shell script in the system, and it should be run as root to modify the settings.
4. The default system settings for -pwrfail and -lowbatt

The Examples for Configuring pwrstat Options

• Example 1: Configure the setting when a power failure event occurs. pwrstat -pwrfail -delay 60 -active on -cmd/etc/pwrstatd-powerfail.sh -duration 60 -shutdown on In the setting above, it will take 60 seconds to run a shell script named pwrstatd-powerfail.sh in the directory /etc, and the system will be shut down after a power failure event occurs for 60 seconds.
• Example 2: Configure the setting when the low battery event occurs. pwrstat-lowbatt -runtime -runtime -capacity -capacity – active on -cmd /etc/pwrstatd-lowbatt.sh -duration 1 -shutdown on In the setting above, it will take 1 minute to run a shell script named pwrstatd-lowbatt.sh in the directory /etc, and the system will be shut down when either the remaining runtime is less than 300 seconds, or the battery capacity is lower than 35%.
• Example 3a: Configure the connection to PowerPanel Cloud.
  pwrstat -cloud -active on -account example@cyberpower.com -password pass123
  Assuming PowerPanel Cloud account/password: example@cyberpower.com / pass123. In the setting above, the connection to PowerPanel Cloud will be activated when users correctly enter their PowerPanel Cloud account and password.
• Example 3b: Verify the connection to PowerPanel Cloud.

pwrstat -verify

To verify whether the account and password are correct, enter the command above.

There are three results, described below:

1. When both the account and password are correct, the system will show Verify successfully.
2. When either the account or password is incorrect, the system will show Verify failed.
3. When a network issue exists, the system will show Connect failed

The Daemon Page

Name
pwrstatd The UPS power state daemon.

Description
pwrstatd is the daemon of PowerPanel for Linux, which runs immediately when the system starts up and communicates with the UPS.

Type the following command to list the operations and the configuration files of the daemon: man pwrstatd

Operations of the Daemon
The commands for operating the pwrstatd daemon and their functions are described below:

Configuration Files of the Daemon
The configuration files and their functions are described below:

Note 5
pwrstatd.conf can be edited by using any text editor. To start editing the configuration file, type the following command as root:  vi/etc/pwrstatd.conf *

Take the text editor, vi, for example.
The changes edited in the text editor will take effect after restarting pwrstatd. To restart the daemon, type the following command: /etc/init.d/pwrstatd restart

Note 6
To send the e-mail content in /etc/pwrstatd-email.sh, it is necessary to set ENABLE_EMAIL=yes and enter both the RECEIPT_ADDRESS and the SENDER_ADDRESS correctly in /etc/pwrstatd-lowbatt.sh or /etc/pwrstatd- powerfail.sh. For details about installing the e-mail package in Ubuntu, please refer to troubleshooting 6.

Event Logs of the Daemon
The event logs of the pwrstatd daemon are located in the directory: /var/log. The file named pwrstatd.log records all the power events.

Checking Daemon Settings

Type the following command to show the configuration of pwrstat:

Below is the example for daemon configuration:

Action for Power Failure:

Action for Battery Low:

Monitoring UPS Status

Type the following command to show UPS properties and the current status:

pwrstat -status
Below is an example for the UPS model, CP585:

Note 7
Some of the listed items above will only be displayed when the UPS model supports the related functions.

CYBERPOWER POWERPANEL
Please visit https://www.cyberpower.com/content/software/eula/to see the complete EULA terms.