CyberPower PowerPanel Shutdown Service User's Manual

User’s Manual
PowerPanel
Shutdown Service
Graceful Shutdown and
Notification service to ensure
power protection of your computer
Revision 1.1
TABLE OF CONTENTS
INTRODUCTION…………………………………...…………………
1
INSTALLATION GUIDE…………………………………...…………
2
CONFIGURATION GUIDE…………………...………………...……
4
Events……………………………………………………………….
4
Logs………………………………………………………………
4
Actions……………………………..…………………………….
4
Action Configuration………………………………………..
5
Events Description……………………………. ……………
8
Recipients……………………………. …………………………
9
Log Settings……………………………. ………………………
10
Protected System……………………………. …………………..
10
Protected System Information……………………………….
10
Protected System Authorization…………………………….
10
Power System……………………………..………………………
12
Power System Information……………………………. …….
12
Power System Locations……………………………………..
12
Help……………………………..…………………………………...
13
Content……………………………..…………………………….
13
Logout……………………………..………………………………..
13
PowerPanel Shutdown Service
INTRODUCTION
Overview
CyberPower Network Management Card allows UPS to be managed, monitored, and configured
via Internet Browser.
Servers/workstations protected by UPS must be installed with
PowerPanel Shutdown Service to enjoy extra value-packaged features.
Application:
Features
CyberPower Network Management System:
Remote management and configuration of UPS via Web Browser or NMS
Supports TCP/IP, UDP, SNMP, HTTP protocol
Automatic events notification via SNMP Trap
Flexible Event Action setting
Auto-shutdown to protect servers/workstations from data loss due to power failure.
Schedule shutdown/startup/reboot of UPS remotely
Event logging to trace UPS operation history
SNMP MIB provided
10Mbps fast Ethernet compatible
Quick installation and user friendly interface
Security management provided.
PowerPanel Shutdown Service:
UPS status notification
Define recipients of event notification
Safe shutdown operation
Configure graceful shutdown of the protected server/workstation.
User Programmable Command File
In event action section, we provide flexibility for addition of your own command file to
performance specific action.
1
PowerPanel Shutdown Service
INSTALLATION GUIDE
Step 1. Install PowerPanel Shutdown Service software.
Insert PowerPanel Shutdown Service CD to the server or workstation.
will guide you through the following setup process:
1. Click Next to continue Setup.
It is
recommended that you close all other
applications before continuing.
2. Select the folder where you would like the
PowerPanel Shutdown Service to be
installed, and then click Next to continue.
3. Select the Start Menu folder in which you
would like Setup to create the program’s
shortcut, then click Next to continue.
2
The installation wizard
PowerPanel Shutdown Service
4. Wait until the PowerPanel Shutdown
Service is finished installation.
5. Click Finish to exit Setup.
By default, the
computer will enter the web browser of
PowerPanel Shutdown Service
immediately after Finish is clicked.
Refresh the check box of Run PowerPanel
Shutdown Service if you don’t want to
enter the web browser immediately.
3
PowerPanel Shutdown Service
Step 2. Configure Trap Notification and Event Action on CyberPower Network
Management System.
(The Installation of CyberPower Network Management Card please refer to Appendix 1)
1. Open the Web Browser and enter the IP address of CyberPower Network Management
System. (The procedures to establish the IP address please refer to Appendix 2.)
2. Type the username and the password on the login screen to enter the configuration page.
By default, the username is “cyber” and the password is “cyber”.
3. Click on Trap Notification page, selected from Network menu.
4. Enter the IP address of the server or workstation that protected by PowerPanel Shutdown
Service. Please note only two servers or workstations are allowed.
5. Setup the Community of Trap Notification, maximum of 15 characters and then click Apply
to activate the settings.
The default value is “public”.
6. Enter Event Action page, selected from Events menu.
7. Ensure Informational, Warning, and Critical notification are enabled for SNMP Trap.
4
PowerPanel Shutdown Service
Step 3. Enter PowerPanel Shutdown Service.
Option 1:
1. Click Control PowerPanel Shutdwon Service selected from PowerPanel Shutdown
Service folder from the Program Menu of Windows Start Menu.
2. Put the default username “cyber” and the default password “cyber” on the login screen.
Option 2:
1. Open the Web Browser and enter the IP address of the server or workstation protected by
PowerPanel Shutdown Service suffixed with a port number :3052.
For example, if the IP
address of the server / workstation is 192.168.20.2, enter http://192.168.20.2:3052.
2. Put the default username “cyber” and the default password “cyber” on the login screen.
Step 4. Establish the connection between PowerPanel Shutdown Service and CyberPower
Network Management System
1. Enter Location page selected from Power System menu.
2. Fill in the IP Address, Event Acceptance, and Access Authorization.
The IP Address of Power System could be searched on CyberPower Network
Management System page. Click Configure to establish the IP Address.
Confirm the Event Acceptance string to be the same with Trap Notification
Community of Trap Notification from Network menu on the CyberPower Network
Management System. The string is “public” by default. If the default string is
different to Community of Trap Notification, please click Configure to revise it.
Confirm the Access Authorization string to be the same with must be the same with
the Community string of Access Control on CyberPower Network Management
System. The string is “public” by default. If the default string is different to
Community of Access Control, please click Configure to revise it.
3. Click Apply to make all changes become effective.
5
PowerPanel Shutdown Service
CONFIGURATION INSTRUCTION
Events
Logs
The Logs page displays the most recent UPS events in chronological order.
To delete the event log, click Clear. The event logs can also be automatically cleared by the
expiration date. By default, the event log expiration date is one week. Log Settings serves to
configure the expiration date of the event logs.
Click Refresh to update the contents of the event log.
Actions
The Event Actions lists the actions taken by the PowerPanel Shutdown Service when the UPS
event occurs.
The UPS events are distinguished into three levels: Critical, Warning, and Informational.
The Critical events that may cause the UPS to stop supplying power to its connected
equipments require your immediate attention. The Warning events alert you to situations that
should be monitored. The Informational events report data about the UPS's operation.
To read description of an event, click any event name or go to Events Description.
The possible actions for each event are Logging, Notification, Run Command File and
Shutdown. To configure the possible actions, click the event name.
Note: To ensure PowerPanel Shutdown Service could work correctly, all options for the SNMP
Trap notification configured from the Event Action page of the CyberPower Network
Management System must be enabled.
6
PowerPanel Shutdown Service
Action Configuration
Logging: To enable or to disable logging of an event. By default, all events are
logged. To disable logging of an event, refresh the check of Enable Logging of Event.
Notification: To manage the list of recipients who will be notified when the event
occurs.
。 Notify Local User: To notify users who are login on local machine currently. Notify
Local User is enabled by default for all critical events and warning events.
。 Notify Specific User: To notify users who are listed on the Recipients page,
selected from the Event menu.
。 Notify Users Connected with This Server: to notify users who are accessing this
server at present.
。 Notify All Users: To notify all users connected to the same domain or workgroup
as this server.
。 Enable Repeat Notifications: To setup the interval for the periodical repeat of
event notification. This configuration enables only for Critical Events and Warning
Events, except the Battery Charger Abnormal event and the Self-Test Failure
event.
Run Command File: To configure running of a command file. The command file
enables the computer to perform specific action before the OS is shutdown.
。 Enable Command File Execution: To check this box to enable the running of a
command file prior to OS Shutdown.
。 Choose Command File Name: To choose the command file to execute. The
command file must previously be saved in the folder “cmdfiles” under the
PowerPanel Shutdown Service software installation folder, such as: C:\Program
Files\PowerPanel Shutdown Service\cmdfiles.
7
PowerPanel Shutdown Service
。 Duration of Execution: To configure the approximate execution time for the
command file. The duration of execution should be within 60 minutes or available
runtime, whatever comes first. If the execution time for the command file exceeds
available runtime for regular shutdown service, the command file will stop running.
Shutdown: Check this box to enable the PowerPanel Shutdown Software to start the
shutdown activities. Go to Shutdown Settings page selected from the Protected
System menu for further configuration.
Note: Shutdown Command is applied by default when critical events occur.
Click "Apply" at the bottom of the screen to confirm the changes of the entire
configuration. Click "Cancel" to ignore all changes.
Event Description
Critical Events alert you very serious UPS condition that may cause the UPS shutdown
shortly. A Critical Event requires your immediate attention and action.
Low Battery: The UPS batteries become drained. Once low battery, the UPS unit
will possibly shutdown in order to protect the batteries from total discharge.
Overload: Load on the UPS has exceeded the certain amount of UPS capacity (VA /
Watts). Once overload, the UPS unit will possibly shutdown in order to protect its
connected equipments.
Warning Events report abnormal UPS condition. A Warning Event requires you to
monitor the UPS.
Power Failure: The utility power fails or is in poor quality. When power failure, the
UPS is switched to battery operation.
UPS Overheated: The UPS inner temperature is too high that may cause damage.
Battery Charger Abnormal: The UPS battery charger has failed and the battery
cannot be charged. When Battery charger abnormal occurs, the battery run time may
be insufficient.
Self-Test Failure: The result of UPS self-test is negative. UPS Self-Test allows the
user to test the UPS without having to unplug the unit from the wall. When running
the Self-Test, the UPS unit will switch to the battery power and the unit will beep.
Self-Test Failure may result from UPS overload or insufficient battery power.
Scheduled Shutdown Initiated: The Power System is ready to scheduled shutdown
at three minutes later. The shutdown schedule is configured on the CyberPower
Network Management System.
Calibration Started: A UPS runtime calibration has been initiated. This event occurs
when the UPS is on Deep Battery Test. When the test is performed, the UPS will go
to battery power until the battery power becomes low, which allows user to estimate
the battery runtime.
Communication Not Established: Communication with the UPS has been lost or
not established.
8
PowerPanel Shutdown Service
Informational Events posts general UPS condition.
Battery Capacity Recovered: The UPS low battery condition is recovered. This
event occurs only after Low Battery event had occurred.
Normal Load: Load on the UPS back to normal load. This event occurs only after
Overload event had occurred.
Power Restored: Utility power has been restored, the UPS is no longer stay on
battery operation. This event occurs only after Power Failure event had occurred.
UPS is no longer overheated: The UPS inner temperature has descended to
appropriate degree. This event occurs only after UPS Overheated event had
occurred.
Calibration Complete: UPS runtime calibration is completed. This event occurs only
after Calibration Started event had occurred.
UPS Self-Test Passed: The UPS has passed its internal diagnostic self-test.
Communication Established: Communication to the UPS has been established.
This event occurs only after Communication Not Established event had occurred.
Recipients
The Recipients page, displays users who will receive notification while event occurs.
Click Add Recipient to enter the Edit Box. Fill up the username on Edit Box and then click
Apply to confirm it or Cancel to ignore it. Click Delete Recipient to delete username from the
list.
Log Settings
The Log Settings page allows configuration for Event Log Entry Expiration.
Event Log Expiration: Specifies expiration date of the events in the Event Log. The
expiration options are never, one day, one week, two weeks, one month, two
months, half year, and one year. The default value is one week. Select one
expiration date and then click "Apply" to have the option become active.
9
PowerPanel Shutdown Service
Protected System
Protected System is definded as the server or the workstation that is powered by Power System
and protected by PowerPanel Shutdown Service.
Protected System Information
The Information page selected from Protected System menu displays the Computer Name,
Operation System name, System Version of the Operation System, and the IP Address of the
computer protected by PowerPanel Shutdown Service. The IP address of the computer is also
displayed on the main menu.
Login Authorization
Login Authorization serves to establish or change the username and password used to login
the PowerPanel Shutdown Service interface. The username and the password must be no
more than 20 characters, no shorter than 3 characters. The default username is cyber and the
password is cyber.
The PowerPanel Shutdown Service interface will automatically logout 3 minutes after the
configuration page stays motionless.
Shutdown Settings
Shutdown Settings provides configuration of the following shutdown parameters:
OS Shutdown: Setup the type of the computer when the OS shutdown by
PowerPanel Shutdown Service. Select Shutdown option or Hibernation option. The
support of Hibernation option subjects to the computer specification.
Logging: To enable or to disable logging of a shutdown event in Event Logs.
Notification: To manage the list of recipients who will be notified when a shutdown
event occurs.
10
PowerPanel Shutdown Service
Run Command File: To configure the PowerPanel Shutdown Service to run a
command before shutting down the OS.
The details about how to configure Logging, Notification, and Run Command File, please
refer to Events / Action Configuration.
11
PowerPanel Shutdown Service
Power System
Power System is defined as the UPS or other Power electronic product that supplies power to
the server or workstation protected by PowerPanel Shutdown Service.
Power System Information
The Information page selected from Power System menu displays Power System given
name, model name, and version.
Power System Locations
The Location page serves to configure IP Address, Event Acceptance, and Access
Authorization that interacts between Power System and PowerPanel Shutdown Service.
IP Address displays the address of the Power System assigned on a computer
network. Click the IP address to access to Power System management interface.
Click Configure to establish or change the IP Address.
Event Acceptance displays the same string of Trap Notification Community
configured in advance on the CyberPower Network Management System. To ensure
PowerPanel Shutdown Service to receive the Event from Power System, this Event
Acceptance string must be configured.
Access Authorization allows PowerPanel Shutdown Service to get information from
the Power System. The Access Authorization must be the same with the Community
of Access Control configured on the CyberPower Network Management System,
which must be configured in advance, Otherwise, the PowerPanel Shutdown
Service and the Power System will not be able to communicate.
Click Configure to enter the edit boxes for IP Address, Event Acceptance and Access
Authorization.
Click Apply to validate all change.
Click Cancel to ignore all change and return to Power System Locations page.
Click Default to restore default value of Event Acceptance and Access
Authorization.
12
PowerPanel Shutdown Service
Help
Content
Help menu of PowerPanel Shutdown Service homepage configuration instruction. Click each
name to see the instruction.
Logout
Click Logout to exit the PowerPanel Shutdown Service. The Shutdown Service will also
automatically logout after the system stays motionless for 3 minutes.
Click Back to Login page to enter the Login page. Put the username and password of the
protected system on the boxes and click Login to enter the PowerPanel Shutdown Service.
13
">