www.eaton.
www.eaton.com Network Shutdown Module V3 User Manual Table of Contents 1 Introduction to the EATON’s Network Solution................................................................... 3 1.1 1.2 1.3 1.4 Overview ...............................................................................................................................................3 Monitoring the UPSs over the network..................................................................................................
www.eaton.com 7.2.2 7.2.3 7.2.4 7.3 7.4 7.5 « simple » configurations.............................................................................................................................34 Simple associations of the previous configurations.....................................................................................36 Configurations NOT supported....................................................................................................................
www.eaton.com 1 Introduction to the EATON’s Network Solution 1.1 z z z z z z Overview EATON’s Network Solution: provides information on events concerning the supply of power to the computers connected to your computer network, carries out automatic shutdown of computer systems, monitors and controls all the UPSs connected to the network.
www.eaton.com 1.2 Monitoring the UPSs over the network Depending on your needs, you can either use: your Internet browser to monitor each UPS, as Management Proxy, Management Card and Shutdown Module include a Web server. your company’s standard Network Management System: > HP-Openview, > CA Unicenter, > HP Insight Manager, > IBM Tivoli Netview, >… To simplify integration of EATON UPSs with these NMS, you can use one of the Network Management System Kits for EATON devices.
www.eaton.com 1.3 Protecting the computers / servers The Network Shutdown Module installed on each of the servers to be protected performs this function. Note that the Shutdown Module is available on several Operating Systems. The Shutdown modules: z continuously wait for information from the Mgt. Proxy or Mgt. Card connected to the EATON UPS. z warns administrators and users if AC power fails and proceeds with graceful system shutdown before the end of battery backup power is reached.
www.eaton.com 1.4 Connecting the UPS 1.4.1 Connecting to the Network This function can be performed either through network Cards inserted in the UPS (Network Management Card) or through a software “agent” running on a nearby PC that is called the Network Management Proxy. Note that the Network Management Proxy is available only on Windows.
www.eaton.com Connection with Network Management Proxy On the diagram above, three types of connections are required: a point-to-point link (serial or USB), z the electrical power cables, z the TCP/IP communication network. z 1.4.3 Network Performances The Network Management Card is designed to support a maximum of: z 35 Network Shutdown Module connections in standard secure mode z 100 connections with NSM 3.10 min. and NMC 66102/DA min.
www.eaton.com 2 Installation Note: This user manual only applies to Network Shutdown Module V3. For previous versions of Network Shutdown Module V2.x, please read the HTML on line manual. 2.1 Hardware Pre-requisites (Electrical and Network Connections) Connection steps Before connecting the UPS, you must first decide on a software and hardware architecture. Before installing the EATON Network Solution, the UPS must be set up as indicated in the steps below.
www.eaton.com 2.2 Software Installation Pre-requisites 2.2.1 On the System Hosting « Network Shutdown Module V3 » 2.2.1.
www.eaton.com z z Mac Intel Mac PowerPC Mac OS X 10.4, 10.5, 10.6 Mac OS X 10.4, 10.5 2.2.1.4 Standby configuration (Windows): In Configuration Panel -> Power Option properties: You must unselect the Standby configuration of your Operating System to be compliant with the Network Shutdown Module. With the standby configuration checked your system is not protected. z If you want to save energy, please prefer the hibernate feature. z 2.2.1.
www.eaton.com 2.3 Quick Start To install the Network Shutdown Module in 5 minutes, please perform the following steps on a machine running Windows 2000 / XP / 2003 / 2008 / Vista / 7, Linux or Mac OSX: z Step 1 (Pre-requisites) Check that following connections are operational: > the electrical connection between the UPS and the server to protect > the network connection between the UPS and the Network Management Card (or Proxy).
www.eaton.com 2.4 Software Installation Procedure This section informs on how to install Network Shutdown Module to protect the computer system. Before starting the installation: z it is necessary first to install a Network Management Card in the UPS or the Mgt. Proxy on a server. z make sure you have the necessary administrator rights to install Network Shutdown Module (for Windows and Linux). z it is assumed that you are aware of the installation prerequisites.
www.eaton.com Power device settings > Save your configuration z Configure your password (recommended) z For multi-UPS systems, please refer to the chapter "Multi UPS systems" . z The Network Shutdown Module is now configured by default. You can anyway customize the Network Shutdown Module and for example configure your password (recommended). z The installed components are automatically started. z It is possible to test Network Shutdown Module.
www.eaton.com 2.5 Application deployment and silent installation (advanced) After customizing the Network Shutdown Module configuration (name or IP address of Network Management Card/Proxy, events and actions, etc.), you can build a Network Shutdown Module installation package that contains your specific configuration. You can then deploy this Network Shutdown Module configuration on other machines that have the same operating system.
www.eaton.com 3 Minimal configuration steps 3.1 Introduction In this chapter we describe the basic and minimal configuration steps that must be performed before using the Network Shutdown Module. The other and optional configuration possibilities are described later. 3.2 The IP address of the UPS that powers your server.
www.eaton.com Load shedding configuration on UPS powershare outlets Remark: This load shedding function is not available if the UPS doesn’t have any switchable outlet. Note: For multi-UPS configurations, you have the possibility to enter several names or IP addresses (using the [Add] button). For these advanced configurations, please refer to the Chapter « Multi – UPS systems ».
www.eaton.com 3.3 Users accounts configuration Click on the Users item of the Configuration section on the left menu. The default Login «admin» and default Password «admin» with Visualization – Management rights. Note: For security reasons we advise you to remove this default login and to create a new login with new access password. User accounts configuration You can configure several user accounts.
www.eaton.com 4 Use 4.1 Monitoring the server and the UPS(s) 4.1.1 Local access From the system where the Network Shutdown Module is installed, z You can use the following shortcut: For Windows: Start -> Programs -> EATON -> Network Shutdown Module -> Supervision For Linux (KDE): K-> EATON -> Network Shutdown Module -> Supervision For Linux (Gnome): Applications -> EATON -> Network Shutdown Module -> Supervision For Mac OSX: Applications -> Utilities -> EATON -> Network Shutdown Module->Supervision.
www.eaton.com z Enter the Login and Password (optional) z The following page appears: Server and UPS supervision Section « Information on the protected server» z z z Server name / IP address: The Network name of the machine hosting the Network Shutdown Module and its IP address. Operating system: The operating system of the machine hosting the Network Shutdown Module.
www.eaton.com Battery: Charging / Discharging / Battery fault. Output: Main output status (ON/OFF/Internal Failure/On Automatic Bypass/Manual By Pass/Overload). Or output outlet status (ON/OFF). The outlet group that powers the device is highlighted in bold Values z Output Load Level: The output load level of the device. z Battery capacity: Battery capacity of the device. z Backup time: The device remaining backup time. z z Note that this view is impacted when any device status is affected.
www.eaton.com 4.2 System and UPS event log In the Supervision section, Select the Log item, and the following page appears: Network Shutdown Module event Log Use the filter in the top right to choose the data to display: All: Displays all the logs. z UPS logs: Only displays the UPS events. z System logs: Only displays the System events. z Use the Export … Use the Clear… z z 4.3 button to record the displayed data into a CSV file. button to clear the displayed data.
www.eaton.com z Redundancy lost (for multi-UPS systems) Warning. A problem has occurred on the device. Your application is still powered. Event list: z The system is powered by the UPS battery. z Output on automatic bypass. z Output on manual bypass. z Protection lost z Redundancy lost (for multi-UPS systems) Critical. A serious problem has occurred on the device. This problem requires an urgent action. Your application might NOT BE powered anymore. Event list: z UPS output is off. z Battery fault.
www.eaton.com 4.4 Test the communication with the UPS After the installation, it is important to check that Network Shutdown Module communicates with the agent (Mgt. Proxy or the Network Management Card). 4.4.1 Simple Tests Test 1: When Network Shutdown Module starts, an icon is displayed by default in the task bar, if you’re running Windows or Linux (Gnome or KDE). It can indicate one of the following status conditions: Icon Description AC power Meaning The installation is in correct running order.
www.eaton.com 4.4.2 Advanced tests For test purpose, it is also possible to display the messages in verbose mode and check the content. Messages in verbose mode: z Event log: It is possible to consult the Event log. z Advanced trace: We warn you against the use of disk space for this Trace mode. To validate verbose mode : > in the bin/dae and bin/netsystray directory of the application, rename the file called debugMode.off into debugMode.
www.eaton.com 5 Other Configuration possibilities 5.1 Introduction Basic configuration steps are described before (refer to Power devices and Users). In this chapter we describe other configuration possibilities. 5.2 Configure system parameters Click on the System item of the Configuration section on the left menu System parameters configuration This page lets you enter the system parameters for the application. It contains: The system administrator name. z The system localisation.
www.eaton.com 5.3 Shutdown Configuration Shutdown Configuration page From this screen, you can define the following parameters: z Use central configuration provided by Management Card/Proxy: With this function, all the Network Shutdown Modules will obtain their configuration from the card (or proxy).
www.eaton.com Remark: If the shutdown timer on a client is the criterion that trips the shutdown procedure, automatic restart of the client is not guaranteed (the case where AC power returns and only the client station is shut down). z Message broadcast to the administrator A message is sent over the network to administrators connected to the server protected by Network Shutdown Module.
www.eaton.com 5.4 Checking for Upgrades This function gives you access to EATON software updates. Your Enterprise Power Manager will always be up to date if you select the Check automatically option. When a new software version is detected, just follow the wizard instructions. Note: This operation will preserve your database information. Check for upgrade window 5.5 Events and actions (advanced configuration) Basic principles: Network Shutdown Module receives events (e.g.
www.eaton.com Modifying events and actions is only necessary if you require your protection module to operate in a particular way. The default configuration ensures optimal protection of your installation. Modifying parameters must therefore be done with care as it could compromise the protection of your installation.
www.eaton.com 6 Multi-UPS Systems 6.1 Caution Please check complete list of UPSs compatible with our Redundancy/Parallel mode service: Caution: We strongly recommend you contact trained EATON personnel for setup, in order to guarantee the integrity of your high-availability system. Recommendations: For the UPS Models it is better to Enable "Communication Shutoff orders" so that the UPS accepts Network Management Card off commands. Exception for 2 UPSs in Hot standby (Sequential redundancy).
www.eaton.com z z 2 UPSs in serial redundancy: z 2 unitary UPSs through Static Transfer Switch: z UPSs powering a server with multiple power supplies: Some simple combinations of these electrical associations are also supported by Network Shutdown module. Important: To know the list of multi-UPS configurations that are supported by the Network Shutdown Module, please refer to the appendix List of tested multi-UPS configurations.
www.eaton.com Following information is displayed: Information on the protected server section Server name / IP address: the Network name of the machine hosting the Network Shutdown Module and its IP address. z Operating system: the Operating System name of the machine hosting the Network Shutdown Module. z Contact / Location: the location of the machine hosting the Network Shutdown Module the contact person for the machine hosting the Network Shutdown Module.
www.eaton.com 6.3 Create a multi-UPS configuration For the multi-UPS configurations, you have to enter the IP address of each UPS that electrically powers the machine hosting the Network Shutdown Module. From the, Configuration->Communication page, please proceed as follows: Multi-UPS configuration z z z z Click on the Add button Key in the first IP address Key in the next IP addresses (Click on the Add button).
www.eaton.com 7 Appendix 7.1 Single UPS Mode compatibility 7.1.1 Card/Proxy compatibility In single UPS Mode, Network Shutdown Module V3 is compatible with following cards/Proxy: z Network Management Card Minislot 66102 (BA is the Minimum firmware revision) z Industrial Network Management Card Minislot 66103 z Network Management Card Transverse 66074 z Network Management Card Minislot – 66244 z Network Management Proxy V5 7.1.
www.eaton.com Note: The status of the Normal Secours box is not yet supervised by Network Shutdown Module V3 z 2 UPSs in Hot-Standby: Single Phase Comet EXRT, EXRT Note: Specific configuration for 2 UPSs in Hot standby (Sequential redundancy).
www.eaton.com 7.2.3 Simple associations of the previous configurations Servers with single power supply (and Multiple STS): z Single Phase (without synchro) Pulsar Extreme C Pulsar M, EX STS 16A (without synchro) Notes: z z z This configuration has also been tested with 3 STSs The Network Shutdown Module V3 is NOT compatible with a configuration where UPS1 and UPS2 are replaced by 2 groups of UPSs.
www.eaton.com 7.2.
www.eaton.com 7.3 Examples of Multi UPS configurations Electrical drawing 7.
www.eaton.com 7.5 Application deployment and silent installation 7.5.1 Introduction Network Shutdown Module offers powerful features to easily deploy the application on several computers: z z z Silent Installation Providing some command line parameters to the installer Re-packaging of a customized application According to your needs you have several possibilities: First example: Your computers are powered by a single UPS and you are using the Network Shutdown Module default configuration.
www.eaton.com Build customized package z In the Package section, click on the Build customized package button to build a customized package. z From the dialog box, then click on "OK". z A confirmation message is displayed when the package is built. You will find in this message the path and the name of the new package. z Copy this package to the other machines in your chosen directory. Note that the Customized installation package will be installed in default installation directory.
www.eaton.com z Build a customized package with specific parameters (ex: The Network Management Card IP address, the events and actions …). z Copy this package to the “target” machine in your chosen directory. z (Linux) If necessary execute the command: chmod 755 nsm_linux_xx_3_xx_xx.run z To start the installation procedure, run the command: -install -silent ./ -install -silent OSX). to validate silent mode for Windows.
www.eaton.com z The following exclusive options define the installation / uninstallation mode : -install (with additional options if necessary) -uninstall (with additional options if necessary) z Additional options : -silent Runs the installer without user interactions -installPath Provides the installation path as parameter -debug Starts installer in debug mode -agentName Provides the Card/proxy IP name as parameter -help For the complete list of options 7.
www.eaton.
www.eaton.com Example A UPS protects 3 machines hosting a Network Shutdown Module. Machine 3 is programmed to shut down before the others to take some of the load off the UPS. Machine 1 Machine 2 Machine 3 None None 100 sec 120 sec 60 sec 180 sec Shutdown timer Shutdown duration The main output shutdown duration is equal to 180 sec. It is the shutdown duration of the machine 2 (maximum of all the shutdown duration).
www.eaton.com 7.7 Multi UPS shutdown sequence (example with Static Transfer Switch) Typical example of the backup time provided by 2 UPSs in redundancy through Static Transfer Switch. z The Output load level of the first UPS is less than 50 %. z The Output load level of the second UPS is 0 %. 1 As soon as they detect the loss of AC power, the Mgt. Cards notify the Network Shutdown Modules that the system is running on battery power.
www.eaton.com 7.8 Additional information on events and actions 7.8.1 Action settings Tab In the Action settings tab you can configure the actions that are executed by the Network Shutdown Module. Action settings tab Select an action in the Action List (eg. User Notification) then you have the possibility to select the different tabs for the considered action: z In the “Settings” tab, you can configure the selected action that is executed by the Network Shutdown Module.
www.eaton.com z Customized actions These user-customized actions give access to additional functions. Action name User notification Role A message is displayed on the screen of the protected machine, its importance is indicated by a colored symbol: - Green: Information message. - Yellow: Alarm message. - Red: Critical alarm message. - Grey: Communication Lost.
www.eaton.com Shutdown parameters z Shutdown (-shutdown: default selection). This option shuts down your applications and the system, but does not de-energize the computer. The system offers the user the choice to de-energize the computer, in which case it is the UPS that cuts power. On most NT, 2000 and XP systems, this configuration is necessary if you want the server to restart as soon as mains power returns. z Hibernate (-standby).
www.eaton.com 7.8.1.4 Execute Action Follow these steps to create an action « Execute a program »: z z z z z Action settings tab Click on the Add button Name: Enter the name of the new action (unique action identifier) Type: Select Execute Command line: Fill in the command line (the Browse… button will help you find the path of the program to be executed). The following utilities are supplied to help you customize your Execute actions: - Shutdown.bat (Windows script ) or shutdown.
www.eaton.com 7.8.1.5 «Send email» Action Follow these steps to create a Send email action: Configure the send email action z z z z z z z z Click on the Add button Name: Enter the name of the new action (unique action identifier) Type: Select "Send email" Server: Enter the name of the relay SMTP server (e.g. mail.server.com) Recipient: Enter the e-mail address. To send the message to several recipients, separate their addresses by a comma or semi colon.
www.eaton.com 7.8.2 Events Tab In this tab you can associate the action with the event(s) that will trigger the action : Events Tab z z z Select the action from the left hand side of the above screen => The list of events already associated with this event appear (checked boxes) Check (or uncheck) the events you wish to associate with this action Save your configuration using Save change(s) button. For each event, an on-line help is displayed when the mouse pointer is positioned over it.
www.eaton.com z Communication failure Communication between Network Management Card/Proxy and UPS (or NSM) has failed or [Communication between Network Management Card/Proxy and UPS is restored] 7.8.2.
www.eaton.com 7.8.3 Test tab In the "Test" tab you can execute the action (by simulating the event occurrence). You can select the event. Warning! This action will be really executed. Check that you're ready to perform this test.
www.eaton.com 7.8.4 The action parameters (execute and send email) The Parameter... buttons let you access following screen: The action parameters (execute and send email) The following parameters can be transmitted to actions: Parameter /object /value /message /date /ldate /card_proxy /hostname 7.8.
www.eaton.com z your own system shutdown solution to be used. z For further information refer to the "shutdown.bat" file in the Network Shutdown Module installation directory. . 7.8.5.2 Shutdown.sh (Linux Script) The "shutdown.sh" script lets you customize the system shutdown. z For further information refer to the "shutdown.sh" file in the Network Shutdown Module installation directory. /bin/tools. 7.8.5.
www.eaton.com z Localisation: The executable may be found in the Network Shutdown Module installation directory (by default ). z Instructions for use: 1. Fill in the domain name as well as the user's name and password. 2. Indicate the program or command to be run using the specified account. 3. Click the Generate button. 4. Copy the command line and paste it in your application.
www.eaton.com 7.9 FAQ and Error messages During Installation: (Linux) I’m running Debian Sarge (or some other distribution), and the NSM installer doesn't display the text properly. Some older systems are not configured to support UTF-8 by default. z The first solution is to switch your system to be UTF-8 compliant, but which may cause you some problem.
www.eaton.com z z wmsystray (http://freshmeat.net/projects/wmsystray/) for WindowMaker, xfce4-systray for XFCE. (Linux) The menu or the systray are missing Some desktop or windows manager do not provide a way to register menus with sub menu z Solution 1: copy the NSM menu files to your desktop $ cp /desktop/*.
www.eaton.com In the page “Configuration -> Power Device”, when I click on the “Add” button the expected page is not displayed Solution: Check if an anti popup filter is activated on your web browser and configure this filter to accept the page. Check you don’t have the highest security level on IE Cannot display the UPS properties page. HTTP 404 error with IE. Solution: Check the URL entered.
www.eaton.com 8 Glossary IP address / name When TCP/IP is installed on a computer, an address and a name are assigned to the system. Each address or name are unique and the address is made up of four numbers, each between 0 and 256 (e.g. 168.8.156.210). Network Management Proxy Network Management Proxy is used to control a UPS and connect it to the TCP/IP network. NMS (Network Management System) The NMS supervises SNMP devices connected to the TCP-IP Network.
www.eaton.com 9 Acknowledgements 9.1 SQLite Huge thanks from the EATON software development team to the SQLite Project http://www.sqlite.org/. Their generous donation of the source code to the public domain helped us for this project. 9.2 Pi3Web Huge thanks from the EATON software development team to the Pi3Web Project. http://pi3web.sourceforge.net/ License Copyright (c) 1997-2003 Pi3 Development Group. All rights reserved.
www.eaton.com of the license, you may always continue to use it under the terms of that version. You may also choose to use such covered code under the terms of any subsequent version of the license published by the PHP Group. No one other than the PHP Group has the right to modify the terms applicable to covered code created under this License. 6. Redistributions of any form whatsoever must retain the following acknowledgment: "This product includes PHP, freely available from ".
www.eaton.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * OF THE POSSIBILITY OF SUCH DAMAGE.
www.eaton.com 9.5 Lighttpd Huge thanks from the EATON software development team to the Lighttpd Project. Copyright (c) 2004, Jan Kneschke, incremental All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: - Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
