Network Shutdown Module V3 User guide Network Shutdown Module V3 – User Manual Page 1/53
Network Shutdown Module V3 User guide Table of Contents 1 Introduction to the Network Solution ................................................................................... 4 1.1 1.2 1.3 1.4 Overview............................................................................................................................................ 4 Monitoring the UPSs over the network ...............................................................................................
Network Shutdown Module V3 User guide 7.8.1 7.8.2 7.8.3 7.8.4 7.8.5 7.9 8 9 Action settings Tab ........................................................................................................................................ 38 Events Tab ..................................................................................................................................................... 42 Test tab ....................................................................................................
Network Shutdown Module V3 User guide 1 Introduction to the Network Solution 1.1 Overview 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.
Network Shutdown Module V3 User guide 1.2 Monitoring the UPSs over the network Depending on your needs, you can either use: Network Shutdown Module V3 – User Manual • your Internet browser to monitor each UPS, as 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 MGE UPSs with these NMS, you can use one of the Network Management System.
Network Shutdown Module V3 User guide 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: • continuously wait for information from the Mgt. Card connected to the MGE UPSs. • warns administrators and users if AC power fails and proceeds with graceful system shutdown before the end of battery backup power is reached.
Network Shutdown Module V3 User guide 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) The Network Management Card: • manages communication with the UPS. • periodically accesses the information concerning the UPS, • makes this information available to the connected applications (Network Shutdown Modules, Web Browser, Network Management Systems, Enterprise Power Manager) 1.4.
Network Shutdown Module V3 User guide 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 installing the Network Solution, the UPS must be set up as indicated in the steps below. • Shut down the computers to be protected by the UPS.
Network Shutdown Module V3 User guide 2.2 2.2.1 Software Installation Pre-requisites On the System Hosting « Network Shutdown Module V3 » 2.2.1.1 Windows Compatibilities: See on APC Web site, Software / Firmware download area ‘’Software Upgrades – MGE Accessories”. 2.2.1.2 Linux Compatibilities: See on APC Web site, Software / Firmware download area ‘’Software Upgrades – MGE Accessories”. 2.2.1.
Network Shutdown Module V3 User guide 2.2.2 On the System that Displays Web-based Graphical User Interface Important: The Network Shutdown Module graphical interface can be accessed remotely using a simple Web browser. Access to this interface is secured through SSL connection (default configuration) and must also be secured through Login & password. The Network Shutdown Module graphical interface has been tested with: • Mozilla Firefox 2.0 or 3.0 is recommended for better performance.
Network Shutdown Module V3 User guide 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 or Linux: • 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.
Network Shutdown Module V3 User guide 2.4 Software Installation Procedure This section informs on how to install Network Shutdown Module to protect the computer system. Before starting the installation: • it is necessary first to install a Network Management Card in the UPS or the Mgt. • make sure you have the necessary administrator rights to install Network Shutdown Module (for Windows and Linux). • it is assumed that you are aware of the installation prerequisites.
Network Shutdown Module V3 User guide • Configure your password (recommended) • For multi-UPS systems, please refer to the chapter "Multi UPS systems" . • The Network Shutdown Module is now configured by default. You can anyway customize the Network Shutdown Module and for example configure your password (recommended). • The installed components are automatically started. • It is possible to test Network Shutdown Module.
Network Shutdown Module V3 User guide 2.5 Application deployment and silent installation (advanced) After customizing the Network Shutdown Module configuration (name or IP address of Network Management Card, 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.
Network Shutdown Module V3 User guide 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.
Network Shutdown Module V3 User guide 3.3 Users accounts configuration Click on the Users item of the Configuration section on the left menu. The default Login «MGEUPS» and default Password «MGEUPS» 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.
Network Shutdown Module V3 User guide 4 Use 4.1 Monitoring the server and the UPS(s) 4.1.
Network Shutdown Module V3 User guide • • Enter the Login and Password (optional) The following page appears: Server and UPS supervision Section « Information on the protected server» • 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.
Network Shutdown Module V3 User guide 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. • UPS logs: Only displays the UPS events. • System logs: Only displays the System events. • • Use the Export … Use the Clear… button to record the displayed data into a CSV file. button to clear the displayed data.
Network Shutdown Module V3 User guide 4.3 UPS Events list The icons in the Status view represent the event severity. Icon Event status Normal. With this event, the device is coming back to a normal status. Event list: • • • • • • • • • • • Communication with "Management Card " is restored. The system is powered by the utility. The UPS output is on. Communication restored with UPS. Battery OK. UPS returns to normal load. UPS OK. Bypass: Return on UPS. End of low battery alarm.
Network Shutdown Module V3 User guide 4.4 Test the communication with the UPS After the installation, it is important to check that Network Shutdown Module communicates with the agent. 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 Meaning AC power The installation is in correct running order.
Network Shutdown Module V3 User guide 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: • Event log: It is possible to consult the Event log. • 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.
Network Shutdown Module V3 User guide 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.
Network Shutdown Module V3 User guide 5.3 Shutdown Configuration Shutdown Configuration page From this screen, you can define the following parameters: • • Use central configuration provided by Management Card: With this function, all the Network Shutdown Modules will obtain their configuration from the card.
Network Shutdown Module V3 User guide • Message broadcast to the administrator A message is sent over the network to administrators connected to the server protected by Network Shutdown Module. Check following Windows pre-requisite > Default value : activated • Message broadcast to users A message is sent over the network to users connected to the server protected by Network Shutdown Module. Check following Windows pre-requisite > Default value : activated 5.
Network Shutdown Module V3 User guide 5.5 Events and actions (advanced configuration) Basic principles: Network Shutdown Module receives events (e.g. Utility Failure) from the UPS and in reply to these events executes actions (e.g. notification, e-mail, etc.). The above interface allows links between events and actions to be configured, as well as customizing protection for the machine hosting Network Shutdown Module.
Network Shutdown Module V3 User guide 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 technical support 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.
Network Shutdown Module V3 User guide • • 2 unitary UPSs through Static Transfer Switch: • 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.
Network Shutdown Module V3 User guide 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. • Operating system: the Operating System name of the machine hosting the Network Shutdown Module. • Contact / Location: the location of the machine hosting the Network Shutdown Module the contact person for the machine hosting the Network Shutdown Module.
Network Shutdown Module V3 User guide 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 • • • • Click on the Add button Key in the first IP address Key in the next IP addresses (Click on the Add button).
Network Shutdown Module V3 User guide 7 Appendix 7.1 Single UPS Mode compatibility See on APC Web site, Software / Firmware download area ‘’Software Upgrades – MGE Accessories”. 7.2 Multi-UPS Mode Compatibility list See on APC Web site, Software / Firmware download area ‘’Software Upgrades – MGE Accessories”. 7.
Network Shutdown Module V3 User guide 7.5 Application deployment and silent installation 7.5.
Network Shutdown Module V3 User guide 7.5.2 Customized installation package After having customized the Network Shutdown Module configuration (name or IP address of Network Management Card, events and actions, etc.), you can build a Network Shutdown Module installation package which contains your specific configuration. You can then deploy this Network Shutdown Module configuration on other machines which have the same operating system.
Network Shutdown Module V3 User guide 7.5.3 Install the Shutdown Module in silent mode In addition to Network Shutdown Module installation in standard mode where the user configures the parameters during the installation, it is possible to install Network Shutdown Module in silent mode i.e. with no user interaction. Follow these steps to install Network Shutdown Module in silent mode: • Make sure you have administrator rights.
Network Shutdown Module V3 User guide 7.5.
Network Shutdown Module V3 User guide 7.6 Single UPS Shutdown Sequence Typical example of the backup time provided by a UPS connected to Network Management Card: 1 As soon as it detects the loss of AC power, the Mgt. Card notifies the Network Shutdown Modules that the system is running on battery power. 2 The Mgt. Card then continuously monitors the criteria set to trip the shutdown procedure. The procedure is launched if: 1.
Network Shutdown Module V3 User guide 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. ω The Output load level of the first UPS is less than 50 %. ω 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.
Network Shutdown Module V3 User guide 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 (e.g. User Notification) then you have the possibility to select the different tabs for the considered action: • In the “Settings” tab, you can configure the selected action that is executed by the Network Shutdown Module.
Network Shutdown Module V3 User guide 7.8.1.1 The different actions • There are several actions classified into two categories: • Standard actions By default, Network Shutdown Module only uses these actions to ensure the machine's protection and to inform users. • Customized actions These user-customized actions give access to additional functions.
Network Shutdown Module V3 User guide 7.8.1.2 «System Shutdown» Action When personalizing the action System shutdown in the action configuration page, you can choose the type of shutdown: • • For Windows, there is a choice of shutdown depending on your system and your requirements. Click on the Parameter button, to read the help on the shutdown type: For Linux, only the shutdown option is currently supported. Shutdown parameters • Shutdown (-shutdown: default selection).
Network Shutdown Module V3 User guide 7.8.1.3 «Send email» Action Follow these steps to create a Send email action: Configure the send email action • • • • • • • • 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.
Network Shutdown Module V3 User guide 7.8.2 Events Tab In this tab you can associate the action with the event(s) that will trigger the action: Events Tab 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.
Network Shutdown Module V3 User guide • Communication failure Communication between Network Management Card and UPS (or NSM) has failed or [Communication between Network Management Card and UPS is restored] 7.8.2.
Network Shutdown Module V3 User guide 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. Some actions can trigger the shutdown!! Test Tab 7.8.4 The action parameters (execute and send email) The Parameter...
Network Shutdown Module V3 User guide The following parameters can be transmitted to actions: Parameter /object /value /message /date /ldate /hostname 7.8.
Network Shutdown Module V3 User guide 7.8.5.4 mgeRunAs software utility (For Windows NT/2000/XP/2003) • Presentation: Network Shutdown Module action is carried out in the security context of the user's account. It may be necessary to modify the context before certain actions may be run. MgeRunAs.exe is the means for a user to run specific tools and programs with permissions that are different from those assigned to the user's account.
Network Shutdown Module V3 User guide 7.9 FAQ and Error messages During use: (Linux) How to use Network Shutdown Module system tray with Gnome? The NSM systray isn’t displayed in Gnome. Some older versions of Gnome do not allow to automate NSM Systray launch minimized to the tray on login on Gnome. To do so manually : • Open up your GNOME menu, • Select Preferences followed by Sessions.
Network Shutdown Module V3 User guide In the HTML pages. 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.
Network Shutdown Module V3 User guide 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). NMS (Network Management System) The NMS supervises SNMP devices connected to the TCP-IP Network.
Network Shutdown Module V3 User guide 9 Acknowledgements 9.1 SQLite Huge thanks from 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 software development to the Pi3Web Project. http://pi3web.sourceforge.net/ License Copyright (c) 1997-2003 Pi3 Development Group. All rights reserved.
Network Shutdown Module V3 User guide 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.
Network Shutdown Module V3 User guide * 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.
Network Shutdown Module V3 User guide 9.5 Lighttpd Huge thanks from the software development 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.
