PowerChute network shutdown
Installation Guide

 
Table of Contents
 
Installation

Requirements:

  • An APC UPS which supports the use of an APC Web/SNMP Management Card. This currently includes any Smart-UPS with a SmartSlot, any Smart-UPS DP, any Matrix-UPS with a firmware revision of Y or later, any Symmetra, and any Silcon Series UPS.

  • An APC Web/SNMP Management Card (APC part number AP9617; or, AP9606 with a firmware revision of 2.x or later).  If you are also using an APC Environmental Monitoring Card (APC part number AP9612TH), then your Management Card must have firmware revision 3.20 or greater.
    • If necessary, you can update your APC Web/SNMP Management Card firmware from APC's web site.
    • PowerChute network shutdown cannot be used with APC PowerNet SNMP Adapters (cards). If your card has an APC part number of AP9605, AP9205, or AP9603, contact APC support or your APC dealer to upgrade the card.

  • One of the following operating systems: MacOS X, Windows NT, Windows 2000, Windows XP, NetWare, HP-UX, Solaris, Linux, or AIX.  Be sure that you have the correct installation file for your operating system; for details, see APC's web site.
  • The IP address for the APC Management Card.

 

  • A  Java Virtual Machine (JVM), version 1.2.2 or later, on your server for all operating systems except Windows NT/2000/XP.  For AIX, JVM version 1.2.2 or 1.3.0 is required.

 

  • If you are installing PowerChute network shutdown on more than 50 computers powered by the same UPS, read the document "PowerChute network shutdown with a UPS powering more than 50 computers" before continuing the installation. To obtain the document, go to the Software Downloads page on APC's Web site and then select the page for PowerChute network shutdown.
 
  • A monitor with resolution of 800 x 600 or greater.

    Note: Do not install and use PowerChute network shutdown on a computer system that uses PowerChute plus.

To install and operate the PowerChute network shutdown software, perform the following steps.

  1. Install the APC Management Card in your UPS. (See the Management Card Installation and Quick Start Guide. If you are using MacOS X to configure you Management card please refer to the release notes (relnotes.htm))

    Install the Management Card in your UPS and configure it with an IP address before beginning the software installation. If you install the software first, additional steps will be required when installing the Management Card. See your Management Card User's Manual for instructions on installing the Management Card.

  2. Configure the UPS and the Management Card. Use the Management Card user interface to configure the UPS so that it meets your needs. At a minimum, APC recommends setting the following:
    • On the Configuration page, set the Low-Battery Duration to at least five minutes
    • On the User Manager page, set the Administrator User Name, Password and Authentication Phrase. You will need to enter the same information when you install the software.

      Note: The Management Card uses the same default User Name, Password and Authentication Phrase as the software.

  3. Select the installation program for the operating system(s) that you require. The installation program must be run on the server console.  You must remove any existing version of PowerChute network shutdown before starting the installation program.

    To start the PowerChute network shutdown installation program:

    For installation on Mac OS X, perform the following steps:

    1. Log in as a System Administrator.
    2. Go to the folder where the PowerChute Netowk installation files are located.
    3. Double click on the file install.command
    4. A teminal window will open prompting you for your password.
    5. Enter your your password.
    6. Proceed with the installation, described in Step 4, below.

    For installation on Windows NT, Windows 2000, or Windows XP, you can double-click the installation program icon or execute the file pcns211.exe from a command line. After you complete the installation, you can then use the Silent Installation to set up many computers to have the same PowerChute network shutdown configuration.

    For Installation on NetWare, perform the following steps:

    1. If you downloaded the file pcns201.exe from the web, copy the file to a temporary directory on the SYS: volume of the NetWare file server; then execute the file to extract the installation files.  If you are obtaining the software from a CD-ROM, copy the installation files from the NetWare directory on the CD-ROM to a temporary directory on the SYS: volume of your NetWare file server.
    2. From the server's System Console command prompt, enter the following commands (where tempdirectory represents the location of the installation files). To install to a different volume, use the name of that volume instead of SYS: in the two envset commands.
      load Java   <Enter>
      envset CWD=SYS:\tempdirectory   <Enter>

      Note: Enter the following envset command all on one line, and the Java load command on the next.

      envset CLASSPATH=$CLASSPATH;SYS:\tempdirectory\pcns201.jar;
      SYS:\
      tempdirectory\util.jar;SYS:\tempdirectory\swingall.jar   <Enter>

      Java load   <Enter>

    For installation on AIX, Solaris, Linux and HP-UX, perform the following steps. After you finish the installation, you can use the Silent Installation to set up many servers to have the same PowerChute network shutdown configuration.

    1. Make sure the location of the JVM executable (java.exe) is in the PATH environment variable.
    2. If you downloaded the file pcns201.tar from the APC Web site, copy the file to a temporary directory on the file server. Then extract the installation files using the following command:
      tar xvf pcns201.tar

      If you are obtaining the software from a CD-ROM, copy the installation files from the CD-ROM to a temporary directory on the file server.

    3. Change your working directory to the directory containing the installation files. Then type the following command:

      java -cp .:pcns201.jar:swingall.jar:util.jar load

  4. At the following prompt, choose "yes" to continue the installation:

    You are about to install a new application. Continue?

    Note: If you already have PowerChute network shutdown installed, you must first remove the old version. You will not be able to continue the installation process until you remove the old version.

  5. When the "About" box is displayed, select Next.

  6. Select "I agree" to accept the terms of the PowerChute network shutdown license agreement and to continue with the installation. If you do not accept the agreement, you must select "Cancel" and will not be able to install PowerChute network shutdown.

  7. Select the location where the PowerChute network shutdown software will be installed. To choose a location other than the default, type the full path name including the drive letter or volume name, or (except on NetWare) use the Browse button. Select Next.

  8. Enter the Initial Configuration information:

    • Management Card IP: This is the network address of the APC Web/SNMP Management Card attached to your UPS.

    • The http port number being used by the Management Card. The default is 80; you do not need to change this number unless you changed the http port being used by your Management Card.  If you are using a Parallel Silcon UPS, all of the Management Cards must use the same http port.

    • The PowerChute network shutdown http port number.  Please do not change the port setting from the default value of 3052.  Modifying the default http port number is not presently supported in the adapter, and will affect communication with the adapter. 

    Click Next to continue.

  9. Enter the Security Configuration information

    Always configure the same User Name, Authentication Phrase, and Password for both PowerChute network shutdown and the Web/SNMP Management Card. The default settings are the same for both interfaces. If you have not changed the default settings in the Management Card, select Next; otherwise, enter the same values used by the Management Card.

    The User Name and Authentication Phrase are used to authenticate the communication between PowerChute network shutdown and the Management Card. The User Name and Password are used to log into the user interface of PowerChute network shutdown and of the Management Card.

    Note: You may see Java exceptions displayed during the installation of PowerChute network shutdown.  The errors are cosmetic, and will not affect the successful completion of the installation or operation of PowerChute network shutdown.

     

  10. Complete the Software Installation.

    After you complete the Security information and select Next, PowerChute network shutdown registers with the Management Card so that PowerChute network shutdown and the Management Card can communicate.

    If PowerChute network shutdown cannot register with the Management Card, you will receive an error message. You may continue the installation, but you will have to enter the server IP address manually at the Management Card.

    Note: If you select the Cancel button to stop the installation, you must then delete the PowerChute directory.

  11. Start the PowerChute network shutdown process

    The PowerChute network shutdown service (on Windows NT, Windows 2000, and Windows XP), process (on NetWare) or daemon (on MacOS X and UNIX) starts automatically when the installation is completed (except for AIX, on which you must start the daemon manually). The installation files can be deleted.

    Note: After installation, set access on the PowerChute directory so that only authorized users can access, execute, or remove the software.

  12. Open the PowerChute network shutdown user interface:

    Using a web browser, enter either of the following URLs:

    servername:3052
    serverIPaddress:3052
    For example, if your server is named COMP1 and has an IP address of 117.14.53.59, use one the following URLs:
    COMP1:3052
    117.14.53.59:3052
    If, during the installation of PowerChute network shutdown, you chose a web server port other than 3052 (the default), use that web server port in the URL.

    Note: PowerChute network shutdown has been designed for use with the following browser versions:

    • Microsoft Internet Explorer version 4.0 or later
    • Netscape Navigator version 4.05 or later

    If you are using a browser version other than one of these, some functions may not be available.

 
Silent Installation

On Mac OS X, Windows, and UNIX systems, you can install PowerChute network shutdown from a command line, which allows you to set up quickly many servers that run the same operating system and that have the same PowerChute network shutdown configuration. To install PowerChute network shutdown silently, perform the following steps:

  1. Complete a normal installation on one server.

  2. Configure PowerChute network shutdown to have all of the settings that you want.

  3. Copy the m11.cfg and silentInstall.ini files from the PowerChute directory.

  4. Edit the silentInstall.ini file to have new parameters, if required.  When editing the silentInstall.ini file, do not enclose values in quotation marks. Also, preface all path separators ('\' for Windows; '/' for MacOS and UNIX) with an escape character ('\').

    • Edit the applicationDirectory parameter to specify the directory in which you want to install PowerChute network shutdown.
    • Set the RegisterWithAdapter parameter in the silentInstall.ini file to "yes" or "no" to indicate whether the installation should register this host's IP address with the Management Card.

      Note: This parameter is necessary only if you are installing PowerChute network shutdown on more than 50 computers for one Management Card.  See the document "PowerChute network shutdown with a UPS powering more than 50 computers," available from the download page for PowerChute network shutdown for your operating system on APC's Web site.

     
    • If you are installing for a UPS with a different IP address, uncomment and edit the adapterIPAddress parameter in the silentInstall.ini file.  Enter the IP address of the Management Card that is in the UPS.

  5. Put the m11.cfg file, the silentInstall.ini file, and the PowerChute network shutdown installation files, in a temporary directory on the new server.

  6. For an installation on Mac OS X, use the following command line:

    sudo java -cp .:pcns200.jar:swingall.jar:util.jar load -q tempdir/silentInstall.ini

    For an installation on Windows, type the following as the command line:
    C:\temp dir\pcns211.exe -q temp dir\silentInstall.ini
    where temp dir is the location of the Installation program and of the valid m11.cfg and silentInstall.ini files.

    Note: If you are using a directory name containing spaces, enclose the path name with quotation marks. Otherwise, no quotation marks are required. For example:
    C:\pcinstall\pcns211.exe -q "C:\Program Files\InstallDir\silentInstall.ini"

    C:\pcinstall\pcns21
    1.exe -q C:\InstallDir\silentInstall.ini
    For an installation on UNIX, use the following command on one line:
    Java home dir/bin/java -cp .:pcns201.jar:swingall.jar:util.jar load -q tempdir/silentInstall.ini
    After you complete the installation, check the install.log and errors.log files for error conditions.

 
Registering an IP Address with the Management Card

If the installation program cannot communicate with the Web/SNMP Management Card, you must manually register the IP address of the computer on which PowerChute network shutdown is installed. In some cases, the installation program registers the IP address, but is unable to confirm that it is registered; in such cases, you must check to ensure that the IP address is registered.

  1. Access the Management Card's web user interface by using the Management Card IP address as the URL.

  2. From the Management Card user interface, click on the UPS model name displayed on the menu.

  3. Select the PowerChute menu option. This will display a list of the IP addresses which are registered with this Management Card.

  4. To add a new IP address, type the IP address of the server on which PowerChute network shutdown is installed in the Add Client IP Address field, and select the Add button.

    To remove existing IP addresses, select each address from the Configured Client IP Addresses list, and select Remove.

 
PowerChute network shutdown Configuration Utility

The stand-alone PowerChute network shutdown Configuration Utility is not part of the PowerChute network shutdown user interface. The Configuration Utility allows you to change the following PowerChute network shutdown settings after you install PowerChute network shutdown:

  • IP address of the Management Card to monitor (not applicable for Parallel Silcon UPS)
  • Port number of the Management Card to monitor
  • PowerChute network shutdown port number
  • Administrator User Account
  • Administrator Password
  • Security Phrase

To run the Configuration Utility, perform the following steps:

  1. Stop the PowerChute service or daemon.
  2. Copy the m11.cfg file into the \PowerChute\lib directory.
  3. From the /lib directory, run the Configuration Utility using the command for your operating system, described below.
  4. Make the desired changes.
  5. Copy the m11.cfg file back into the \PowerChute directory.

On Mac OS X

sudo java -cp .:confutil.jar:swingall.jar:m11.jar:ds.jar:
collections.jar:jsdk.jar PCNSUtilApp
  <Enter>

On Windows NT, Windows 2000, and Windows XP:

Java home dir\bin\java -cp .;confutil.jar;swingall.jar;m11.jar;ds.jar;
collections.jar;jsdk.jar PCNSUtilApp

On NetWare:

If you installed PowerChute network shutdown to a non-default directory, use the name of that directory instead of PowerChute in the envset commands below:

envset CWD=SYS:\PowerChute  <Enter>
envset CLASSPATH=$CLASSPATH;SYS:\PowerChute\confutil.jar;SYS:\PowerChute\m11.jar;
SYS:\PowerChute\util.jar;SYS:\PowerChute\swingall.jar
  <Enter>

java -cp .;confutil.jar;swingall.jar;m11.jar;ds.jar;collections.jar;
jsdk.jar PCNSUtilApp
  <Enter>

On AIX, Linux, HP-UX, or Solaris

Java home dir\bin\java -cp .:confutil.jar:swingall.jar:m11.jar:ds.jar:
collections.jar:jsdk.jar PCNSUtilApp
  <Enter>
The Configuration Utility can also be used to set up m11.cfg files for silent installations where the same PowerChute network shutdown configuration is used to monitor multiple Management Cards, as follows:
  1. Perform a complete installation.
  2. Copy the m11.cfg file to \lib directory.
  3. Run the Configuration Utility.
  4. Use the Configuration Utility to change the Management Card IP address.
  5. Use the modified m11.cfg file to perform a command line installation. (See Silent Installation, step #4)
 
Using PowerChute network shutdown on MacOS X 

You must have Mac OS X 10.1 or later with BSD utilities installed to use PowerChute network shutdown.

To stop PowerChute network shutdown, type the following at the command line:

sudo /Library/StartupItems/comapcpcns/comapcpcns stop

To start PowerChute network shutdown manually, type the following at the command line:

sudo /Library/StartupItems/comapcpcns/comapcpcns start

To remove PowerChute network shutdown, run the uninstall script.  If you do not intend to reinstall the software, remove the server IP address from the Management Card using the PowerChute option on the Management Card user interface menu.

 
Using PowerChute network shutdown on Windows NT, Windows 2000, or Windows XP 

You must have Windows NT version 4.0, Windows 2000, or Windows XP to use PowerChute network shutdown. Always use the latest available Service Pack.

The PowerChute directory includes executables to shut down some common applications. See the section Run Command File in the Help file for information on setting up PowerChute network shutdown to run these executables.

  • shutnote.exe - To shut down Lotus Notes/Domino
  • shutback.exe - To shut down Microsoft BackOffice
  • shutiis.exe - To shut down Microsoft Internet Information Server
  • shutncs.exe - To shut down Netscape Enterprise Server
 
Using PowerChute network shutdown on NetWare

You must have NetWare 5.1 or 6.0 to use PowerChute network shutdown.

PowerChute network shutdown requires Java Virtual Machine (JVM), version 1.2.2 or later, on your server. Obtain this JVM and the associated operating system patches from the Novell web site, or contact your Novell service provider.

Before installing PowerChute network shutdown, make sure that the file SYS:\ETC\HOSTS includes a line with your file server's IP address and server name.

Installing PowerChute network shutdown on NetWare requires a screen resolution of 800 x 600 or 1024 x 768.

To stop the PowerChute network shutdown process, do the following:

  1. Enter this command at the server prompt to obtain the number of the PowerChute process:
    Java -sh
  2. Enter this command to stop the PowerChute process:
    Java -killprocess number
    For example, if the PowerChute process number is 22, use this command:
    Java -kill22

To start the PowerChute process, execute the file APCpcns.ncf in the PowerChute directory.

To remove PowerChute network shutdown, you must stop the PowerChute process, delete the PowerChute directory, and remove the following startup lines from the AUTOEXEC.NCF file:

# Start APC's PowerChute network shutdown application
SYS:PowerChute\APCpcns
If you do not intend to reinstall the software, remove the server IP address from the Management Card by using the PowerChute option of the card's user interface menu.
 
Using PowerChute network shutdown on HP-UX

You must have HP-UX 10.20 or 11.00 to use PowerChute network shutdown. XWindows is required to install PowerChute network shutdown.

PowerChute network shutdown requires Java Virtual Machine (JVM), version 1.2.2 or later, on your server. Obtain this JVM and the associated operating system patches from the HP web site, or contact your HP service provider.

To stop PowerChute network shutdown, type the following at the command line:

/etc/rc.APCpcns stop
To start PowerChute network shutdown manually, type the following at the command line:
/etc/rc.APCpcns start

To remove PowerChute network shutdown, run the uninstall script. If you do not intend to reinstall the software, remove the server IP address from the Management Card by using the PowerChute option on the Management Card user interface menu.

 
Using PowerChute network shutdown on Solaris

You must have Solaris 2.7 or 2.8 (SPARC) to use PowerChute network shutdown. XWindows is required to install PowerChute network shutdown.

PowerChute network shutdown requires Java Virtual Machine (JVM), version 1.2.2 or later, on your server. Obtain this JVM from the Sun Microsystems web site, or contact your Sun Microsystems service provider.

When the daemon starts, the script adds 256 file handles; delete ulimit -n 256 from the PCNS startup script if you do not need them.

To stop PowerChute network shutdown, type the following at the command line:

/etc/rc2.d/S99PowerChute stop
To start PowerChute network shutdown manually, type the following at the command line:
/etc/rc2.d/S99PowerChute start

To remove PowerChute network shutdown, run the uninstall script. If you do not intend to reinstall the software, remove the server IP address from the Management Card using the PowerChute option on the Management Card user interface menu.

 
Using PowerChute network shutdown on Linux

You must have RedHat Linux 7.1 or 7.2 to use PowerChute network shutdown. XWindows is required to install PowerChute network shutdown.

PowerChute network shutdown requires Java Virtual Machine (JVM), version 1.2.2 or later, on your server. Obtain this JVM from http://www.blackdown.org, or contact your Linux vendor or service provider.

To stop PowerChute network shutdown, type the following at the command line:

/etc/rc.d/init.d/PowerChute stop
To start PowerChute network shutdown manually, type the following at the command line:
/etc/rc.d/init.d/PowerChute start

To remove PowerChute network shutdown, run the uninstall script. If you do not intend to reinstall the software, remove the server IP address from the Management Card using the PowerChute option on the Management Card user interface menu.

 
Using PowerChute network shutdown on AIX

You must have AIX 4.3.3 to use PowerChute network shutdown. XWindows is required to install PowerChute network shutdown.

PowerChute network shutdown requires Java Virtual Machine (JVM), version 1.2.2 or 1.3.0, on your server. Obtain this JVM and the associated operating system patches from the IBM web site, or contact your IBM service provider.

After the installation is complete, you must start the PowerChute network shutdown daemon manually or reboot the system. The installation program cannot start the PowerChute network shutdown daemon on AIX.

To stop PowerChute network shutdown, type the following at the command line:

/etc/rc.APCpcns stop
To start PowerChute network shutdown manually, type the following at the command line:
/etc/rc.APCpcns start

To remove PowerChute network shutdown, run the uninstall script. If you do not intend to reinstall the software, remove the server IP address from the Management Card using the PowerChute option on the Management Card user interface menu.

You may see Java exceptions displayed during the installation of PowerChute network shutdown on AIX.  These errors are cosmetic, and will not affect the successful completion of the installation.