MGE UPS SYSTEMS

Network Shutdown Module Protection for other platforms

--

This section presents a step by step procedure to run Network Shutdown Module on an unsupported platform

Before starting the actual installation, it is assumed that you are aware of the installation prerequisites concerning Java Virtual Machine.

This procedure follows 4 steps :

Step 1) Files retrieval

You first need to download the three basic files needed for Network Shutdown Module execution on any platform :

xmlclient.jar : Network Shutdown Module core program (java archive)
xmlclient.lbl : Network Shutdown Module message translation file (XML Ascii file)
xmlclient.cfg : Network Shutdown Module configuration file (XML Ascii file)

These are available from MGE Network solution page.

Step 2) Customising Network Shutdown Module configuration

This step will allow you to configure Network Shutdown Module through xmlclient.cfg file.

In this file, modify the parameters with a text editor.

Default values: Modifications:
<XML-AGENT server=""/> Supply the name (or IP address) of the server hosting Network Management Proxy or Card. To that end, modify the Network Management Proxy or Card parameter among the general parameters as follows:
<XML-AGENT server="name of server or IP address"
/>

<BROADCAST_ADMINS
name="AdminBroadcast">
<EXECUTE>xmlc_brdc ADMINS /message /date</EXECUTE> </BROADCAST_ADMINS>


<BROADCAST_USERS name="AdminBroadcast"> <EXECUTE>xmlc_brdc USERS /message /date</EXECUTE> </BROADCAST_USERS>

In order to enable users notifications of UPS events, xmlc_brdc shoud be replaced by a program (ie Windows netsend or Unix msg) or a script that allows to alert users when the Network Shutdown Module notify feature cannot be used (ie on Unix system where daemon initialization cannot access to a graphical context).
This should be done for both BROADCAST_ADMINS and BROADCAST_USERS sections.


Please, refer to Advanced On-line Manual (section: Network Shutdown Module > Installation).

<SHUTDOWN>
<EXECUTE>Shutdown.sh
</EXECUTE>
</SHUTDOWN>
Shutdown.sh should be replaced by an equivalent
which allow to shutdown properly the system.
An example of Unix shutdown.sh script is available in the Network Shutdown Module Unix packages.
 
Step 3) Commands to start, stop and configure Network Shutdown Module

The following links or scripts should also be created in order to easily use Network Shutdown Module :

Function : Command line :
start java -cp xmlclient.jar XMLClient -start
(or -start -console for Unix)
stop java -cp xmlclient.jar XMLClient -stop
setup java -cp xmlclient.jar XMLClient -setup

Notes :

You may need to modify java to point to your favorite JVM, and classpath ("-cp" or "-classpath") options : Please refer to your Operating System Guide for links or scripts creation and to your JVM documentation for launcher options.

Please pay attention to case letter if your system is case sensitive, like Unix systems does.

Examples of Unix scripts are available in each package. See the above step 1 for more information.

Step 4) Enabling automatic Network Shutdown Module startup at system boot time

It is also necessary to register Network Shutdown Module startup at system boot time (ie runlevel 3 for Unix systems) in order to enable protection. You can simply add a call to the above start script or link into your system startup.

For example, on Unix SysV platforms, you can simply add the following line to your /etc/inittab file to start protection at runlevel 3 :

xmlc:3:once:path_to_your_xmlclient_startup_script/start.sh >/dev/null 2>&1

Your system is now protected.

 
--