PowerChute Network Shutdown:
Installation


For a summary of possible installation modes - Single, Multiple, Parallel - and the UPS's that support these modes, see the document called "PowerChute Network Shutdown: Operating Modes and Supported UPS Configurations" on the APC Web site. From the Filter by Software/Firmware drop-down box, choose Software Upgrades - PowerChute Network Shutdown and click Submit.
 
Table of Contents
Note: After clicking on a link directly below, press the Back button on your Web browser to return to these contents. Alternatively, press the Ctrl + Home keys.

Software and Hardware Requirements
To install PowerChute Network Shutdown (PCNS) for VMware® ESXi or for VMware ESX OR PowerChute Network Shutdown (PCNS) for Windows® Hyper-V, you must have:
[Top]
Installation and Configuration
To install and operate the PowerChute Network Shutdown software, perform the following steps.
  1. Install the Network Management Card in your UPS. For installation instructions, see the Management Card Installation and Quick Start Guide that was shipped with your card. If you are using Multiple-UPS or a Parallel Silcon UPS configuration, you will use one Network Management Card in each UPS in the system.

    Install the Card in your UPS and configure it with an IP address before beginning the PowerChute Network Shutdown software installation. If you install PowerChute Network Shutdown first, additional steps will be required when installing the Network Management Card (NMC).

  2. Using the Network Management Card user interface, configure the UPS and the Network Management Card. At a minimum, perform these tasks:
  3. Remove any existing version of PowerChute Network Shutdown (PCNS) before starting the installation program.

    WARNING: Do not install and use PCNS on a computer system that uses PowerChute plus, PowerChute Business Edition, or PowerChute Server.

  4. On VMware, the installation program must be run on the ESXi VIMA or the ESX Console Operating System (COS).
    On Hyper-V, the installation program must be run on the server console.

    Note that multiple-byte characters (Chinese for example) are not allowed in the installation path.

    After you finish the installation, you can use the Silent Installation to set up additional servers to have the same PowerChute Network Shutdown configuration.

    For installation on Microsoft Hyper-V Server and Windows Server 2008 Server Core, see Installing on Microsoft Hyper-V Server and Windows Server 2008 Server Core.

    For installation on Windows Hyper-V, you can double-click the installation program icon or execute the file  setup.exe from a command line to launch the installation program for Windows.

    When the Windows Firewall is enabled, you can allow the PCNS installation to configure the firewall automatically by choosing Yes when prompted: PowerChute Network Shutdown ports must be opened in the Windows Firewall to enable communication with the Network Management Card(s). Would you like this configuration to be performed automatically? See Software and Hardware Requirements for more information.

    On ESXi and ESX, to start the PowerChute Network Shutdown installation, perform the following steps.

    1. If you are installing from the CD, locate your installation files in one of the following directories on the CD: ESX, ESXi.
      Copy them to a temporary directory on your server.
       
      If you are installing from the Web site, locate the file  pcns224_OS name.tar.gz  (e.g. pcns224_esxi.tar.gz) on the APC Web site and copy it to a temporary directory on your server. Change your working directory to the temporary directory.
      Type the following commands:
       
           gunzip pcns224_OS name.tar.gz
           tar -xf pcns224_OS name.tar

       
    2. Please see JRE version before proceeding.
    3. To install in a conversational mode, type the following command:
       
      On VIMA
           sudo ./install.sh
       
      On COS
           ./install.sh

      The installer will prompt for the directory to install to and the directory of the system-installed Java. You cannot specify a directory name that contains a space, for either directory.

      If you do not specify an installation directory, it will be installed to /opt/APC (the default). If you do not specify a Java directory, the Java bundled with the installer will be used when appropriate (see JRE version).

    4. Once the execution of install.sh has been completed, you must configure PCNS for logon and the NMC information. Type the following command from the PCNS directory to configure your setup in a conversational mode:
       
      On VIMA
           sudo ./PCNSConfig.sh
       
      On COS
           ./PCNSConfig.sh

  1. Note that if the computer you are installing on has several IP addresses, you will be prompted during the installation to select an IP address and enter its subnet mask.

    Continue with the installation until you are asked to choose the configuration type.

    Different VA models are supported if they are in the same UPS device family. The Symmetra Tower and the Symmetra RM are considered a family. The Symmetra PX is not in the same family and can't be used in combination with them.

    The IP address of the PowerChute Network Shutdown computer is registered with the Network Management Card if a UPS fails to register. You should manually remove it in this circumstance: Registering an IP Address with the Network Management Card.

  2. Enter the initial configuration information:
  3. Enter the security configuration information:

    The administrator user name and authentication phrase authenticate the communication between PowerChute Network Shutdown (PCNS) and the NMC. Because of this you must set the values in PCNS to be the same as those for the NMC. (Note that it is allowable to set a password for PCNS that is different from the password for the NMC.)
     
    In the NMC, the default administrator user name and password are both apc, while the default setting for the authentication phrase is admin user phrase.

    If you are using a Multiple-UPS or a Parallel Silcon UPS configuration, all of the Network Management Cards in the UPS system must use the same administrator user name and authentication phrase.

  4. Complete the software installation.

    PowerChute Network Shutdown registers with the Network Management Card (NMC) automatically so that they can communicate.

    If you entered an invalid user name or authentication phrase at the previous step, the PCNS installer will fail to register with the NMC saying "Security information incorrect. Access denied".

    Windows Hyper-V Notes

    • If you select Cancel to stop the installation, the C:\Program Files\APC\jvm and C:\Program Files\APC\jre\jre1.5.0_18 directories remain in Windows. They must be deleted manually before attempting another installation. (You should also delete the PowerChute directory before attempting another installation).
       
    • The Temp directory might have some sub-directories remaining after the installation. You can remove these manually, but they won't affect your computer system or PowerChute Network Shutdown.

  5. Start PowerChute Network Shutdown.

    On ESXi and ESX, you have a choice whether to start the PCNS daemon. On Windows Hyper-V, the PowerChute Network Shutdown service starts automatically when the installation is completed.

    Afterwards, you can delete the installation files.

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

  6. Open the PowerChute Network Shutdown user interface.

    Using a Web browser, type either of the following URLs:

    https://servername:6547
    https://serverIPaddress:6547
    For example, if your server was named COMP1 with an IP address of 117.14.53.59, you would use one the following URLs:
    https://COMP1:6547
    https://117.14.53.59:6547

    If you are using a browser version other than Microsoft Internet Explorer version 6.0, some functions might not be available.

[Top]
Installing on Microsoft Hyper-V Server and Windows Server 2008 Server Core
This section is a continuation from a step in the Installation and Configuration section. If you haven't done so already, please read that section until you see a cross-reference to this procedure.
  1. Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
     
  2. Locate the installation file or files on the CD and copy them to a temporary directory on your server. If necessary, unzip the installation file.
     
  3. Go to the temporary directory, and type cscript install.vbs at the command prompt.
    The installation script begins and you are asked to enter a PowerChute Network Shutdown (PCNS) instance: 1, 2, or 3.
     
  4. Type one of the values and press Enter.
     
  5. When prompted for the installation directory, press Enter to accept the default or type your custom directory path.
     
  6. If the directory you specified already exists, you need to confirm that the installation should go there by typing y and pressing Enter.
     
  7. Type the full directory location of your Java software [e.g. C:\Program Files\java\jre1.5.0_18 ] and press Enter. Confirm the directory by typing y and pressing Enter.
     
  8. When asked whether you want to install PCNS, type y and press Enter.
     
  9. Next, you need to configure your installation. Go to the group1 directory, e.g. C:\Program Files\APC\PowerChute\group1.
     
  10. Type cscript PCNSConfig.vbs at the command prompt to begin the configuration.
     
  11. This opens a new command window. You need to specify your UPS configuration type: single, parallel, etc. Type the number (from 1 to 4) that corresponds to your UPS configuration type, and press Enter.
     
  12. At Management Card IP, you specify the network IP address of the Network Managment Card (NMC) attached to your UPS.
     
  13. At Management Card Port #, type the NMC port number or just press Enter to accept the default of 80.
    Do not change this number unless you changed the HTTP port being used by your NMC. For a Multiple-UPS or a Parallel Silcon UPS configuration, all of the Network Management Cards must use the SAME HTTP port.
     
  14. Next, you specify security information. The administrator user name and authentication phrase authenticate the communication between PCNS and the NMC. Because of this you must set the values in PCNS to match the values for the NMC. (Note that it is allowable to set a password for PCNS that is different from the password for the NMC.)
     
    In the NMC, the default administrator user name and password are both apc. The default setting for the authentication phrase is admin user phrase.
     
    If you are using a Multiple-UPS or a Parallel Silcon UPS configuration, all of the Network Management Cards in the UPS system must use the same administrator user name and authentication phrase.
     
    At the three prompts, Administrator User Name, Administrator Password, and Authentication Phrase, type the appropriate values and press Enter. Note: The password and phrase you type are masked, that is, not displayed, for security reasons.
     
  15. At Do you wish to register these settings?, the installation script is asking you to confirm your previous four entries. Type yes and press Enter to continue.
     
  16. Type y and press Enter to start PCNS.
[Top]
Silent Installation and Configuration
You can perform a silent PowerChute Network Shutdown (PCNS) installation on systems with a single UPS only and with a single instance only. You must perform a normal installation on multiple Smart-UPS devices, multiple Symmetra devices or Parallel Silcon UPS systems (see Multiple-UPS configuration). In addition, each of your servers must have the same operating system.

ESXi and ESX Console Operating System (COS) Silent Installation
Edit silentInstall.sample to specify the PCNS install directory, and the Java directory, and specify "YES" for the EULA statement. For example,
CFG_INSTALL_DIR=C:\Program Files\APC
CFG_JAVA_DIR=C:\Program Files\Java\jre1.5.0_18
CFG_ACCEPT_EULA=YES
If the install destination directory is not entered, it will be installed to /opt/APC. If a Java directory is not entered, the Java bundled with the installer will be used when appropriate (see JRE version).

Type the following command to start the installation:
 
On VIMA
     sudo  ./install.sh -f silentInstall.sample
On COS
     ./install.sh -f silentInstall.sample

To complete the configuration silently:

  1. Change your working directory to the PowerChute/group1 directory.
  2. Edit silentConfig.sample and enter appropriate values such as the IP address of the NMC, the User ID and the password.
  3. Type:
    On VIMA
          sudo ./PCNSConfig.sh -f silentConfig.sample
    On COS
         ./PCNSConfig.sh -f silentConfig.sample

The steps above create the m11.cfg file. To replicate this configuration to other servers:

  1. Change your working directory to the PowerChute/group1 directory.
  2. Re-edit silentConfig.sample (to enter the different details related to the new server and UPS's) and copy m11.cfg file to the working directory.
  3. Type:
    On VIMA
          sudo ./PCNSConfig.sh -f silentConfig.sample
     
    On COS
         ./PCNSConfig.sh -f silentConfig.sample

Windows Hyper-V Silent Installation
You can install PowerChute Network Shutdown (PCNS) silently from a command line. To install PCNS silently, perform the following steps:
  1. Complete a normal installation on one server.
     
  2. Configure PowerChute Network Shutdown to your requirements.
     
  3. Edit the silentInstall.ini file to set new parameters, if required. Precede each path separator ('\') with an escape character ('\').

    • Specify the PCNS installation directory at  applicationDirectory.
       
    • Type the relevant values in the following fields: AdministratorUserName=, AuthenticationPassword=, AuthenticationPhrase=.
      The user name and authentication phrase must match the Network Management Card or the silent installation will not work.
       
      In the NMC, the default administrator user name and password are both apc, while the default setting for the authentication phrase is admin user phrase.
       
    • If you are installing PowerChute Network Shutdown for a UPS with a different IP address, uncomment the adapterIPAddress parameter and type the IP address of the Network Management Card that is in the UPS.
       
    • If you are installing PowerChute Network Shutdown on more than 50 computers for one Network Management Card, set the RegisterWithAdapter parameter to "yes" or "no" to indicate whether the installation should register this host's IP address with the Network Management Card.

      Note: See the document "PowerChute Network Shutdown with more than 50 computers on One UPS," available from the download page for PowerChute Network Shutdown for your operating system on the APC Web site.

  4. Copy the  m11.cfg file, and the  silentInstall.ini file from the PowerChute installation directory, along with the PowerChute Network Shutdown installation files, to a temporary directory on the new server.
     
  5. Navigate to the temporary directory on the new server, and type the following command on one line. (If there are spaces in the path to the temporary directory, enclose the path in quotation marks. For example, a path with Program Files needs to be enclosed in quotes: "C:\Program Files\InstallDir\silentInstall.ini".)
    C:\tempdir\setup.exe -s C:\tempdir\silentInstall.ini
     
    where tempdir is the location of the installation program and of the valid  m11.cfg  and  silentInstall.ini  files.
    After you complete the installation, check the  pcnsinst.log  and  errors.log  files for error conditions (the latter will only exist when the installation has not been successful). On Windows, in a standard setup, pcnsinst.log can be found in C:\Documents and Settings\Administrator\Local Settings\Temp\ and error.log in a tmpjex0n directory under the Temp directory (n can be 1, 2, 3, etc.).

Microsoft Hyper-V Server and Windows Server 2008 Server Core Silent Installation
There are two ways you might want to use silent installations and configurations. See A. and B. below.

A. If you have several servers and you want to have the same PCNS setup for each server:

  1. Perform a normal installation and configuration on one server.
     
  2. Copy the installation files and m11.cfg to a temporary directory on your other server.
     
  3. Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
     
  4. Type cscript install.vbs /f silentInstall.sample at the command prompt.
     
    The installation starts and completes without user inputs.
     
  5. Next, you configure PCNS. Go to the group1 directory, for example, C:\Program Files\APC\PowerChute\group1.
     
  6. Type cscript PCNSConfig.vbs /f silentConfig.sample at the command prompt.
     
    The configuration starts and completes without user inputs.

B. If you want to install PCNS on only one server, or if you want to install different configurations of PCNS on several servers:

  1. Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
     
  2. Locate the installation file or files on the CD and copy them to a temporary directory on your server. If necessary, unzip the installation file.
     
  3. Go to the temporary directory, and edit silentInstall.sample to specify the number of PCNS instances, the PCNS install directory, and the Java directory, and specify "YES" for the EULA statement. For example,
    CFG_INSTANCE_NUMBER=1
    CFG_INSTALL_DIR=C:\Program Files\APC
    CFG_JAVA_DIR=C:\Program Files\Java\jre1.5.0_18
    CFG_ACCEPT_EULA=YES
  4. Type cscript install.vbs /f silentInstall.sample at the command prompt.
     
    The installation starts and completes without user inputs.
     
  5. Next, you configure PCNS. Go to the group1 directory, for example, C:\Program Files\APC\PowerChute\group1.
     
  6. Edit silentConfig.sample to specify the Network Management Card IP address, the administrator user name and password, and the authentication phrase. For example,
    adapterIPAddress=192.168.0.148
    username=apc
    password=apc
    AuthenticationPhrase=admin user phrase
    If your server has two or more IP addresses, you need to specify which of the IP addresses to use for PCNS through LocalHostIPAddress and which of the IP addresses to use for its subnet mask through LocalHostSubnetMask. For example,
    LocalHostIPAddress=192.168.0.149
    LocalHostSubnetMask=255.255.255.0
    If the NMC port number is different from its default value of 80, specify the number to adapterPort. For example,
    adapterPort=8000
    If you do not want to register the host IP address to NMC, specify no to RegisterWithAdapter.
    RegisterWithAdapter=no
  7. Type cscript PCNSConfig.vbs /f silentConfig.sample at the command prompt.
     
    The configuration starts and completes without user inputs.
[Top]
Registering an IP Address with the Management Card
If the installation program cannot communicate with the Network 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 Network Management Card's user interface by using the Network Management Card IP address as the URL.
  2. Click on the UPS tab
  3. Click the clients link under the PowerChute menu option to display a list of the IP addresses which are registered with this Network Management Card.
  4. To add a new IP address, click the Add Client button, and type the IP address of the server on which PowerChute Network Shutdown is installed in the Add Client IP Address: field, and click Apply.

    To remove existing IP addresses, select an address on the PowerChute Network Shutdown Clients page and click Delete Client.

[Top]
Using the PowerChute Network Shutdown Configuration Utility on Windows Hyper-V
The stand-alone PowerChute Network Shutdown Configuration Utility allows you to change the following PowerChute Network Shutdown (PCNS) settings:

Note: The following instructions assume that you installed PowerChute Network Shutdown to the default directory.

[Top]
Running the Configuration Utility on Windows Hyper-V
Copy the m11.cfg file to the PowerChute\group1\lib directory. (The default installation directory is C:\Program Files\APC\PowerChute\group1\.)

Note: If there are spaces in the path to the java directory, enclose the path in quotation marks.

Enter the IP address of the Network Management Card you wish to monitor, and click Save. Your configuration settings have been saved. Click OK. On the following screen, click Exit.

In the Windows Control Panel, stop the PowerChute Network Shutdown service. Delete the m11.cfg file from the PowerChute directory. Move the modified m11.cfg file from the PowerChute\group1\lib directory to the PowerChute directory. Start the PowerChute Network Shutdown service.

[Top]
Running on VMware ESXi and ESX
It is NOT possible to use the upgrade option for the same version numbers. That is, you could not, for example, "upgrade" from v2.2.4 to v2.2.4 (simply in order to upgrade your JRE).

To stop PowerChute Network Shutdown, type the following at the command line:

On VIMA
      sudo /etc/rc.d/init.d/PowerChute stop
 
On COS
     /etc/rc.d/init.d/PowerChute stop
To start PowerChute Network Shutdown manually, type the following at the command line:
On VIMA
      sudo /etc/rc.d/init.d/PowerChute start
 
On COS
     /etc/rc.d/init.d/PowerChute start

Important: In order for PowerChute Network Shutdown to be able to shut down the virtual machines (VM) on VMware ESXi or ESX, you need to configure a Guest Shutdown on each VM.

Consult your ESXi and ESX documentation on how to do this, or look it up on the APC by Schneider KBase (answer ID is 10380): http://emea-en.apc.com/cgi-bin/emea_en.cfg/php/enduser/std_alp.php?ISOCountryCode=us.

To uninstall in a conversational mode, run the uninstall script located in the PowerChute directory. For example, type the following command:

On VIMA
      sudo /opt/APC/PowerChute/uninstall
 
On COS
     /opt/APC/PowerChute/uninstall

If you do not intend to reinstall the software, remove the server IP address from the Network Management Card using the Network Management Card's Web interface menu. See Registering an IP Address with the Management Card.

The PowerChute directory sometimes remains after an uninstall. You can remove this manually, but it won't affect your computer system or PowerChute Network Shutdown.

To uninstall in a silent mode, run the uninstall script located in the PowerChute directory, with a "q" option. For example, type the following command:

On VIMA
      sudo /opt/APC/PowerChute/uninstall -q

    Please type in a password when prompted.
 
On COS
     /opt/APC/PowerChute/uninstall -q

It is possible to change the version of Java used by PCNS by editing the java.cfg file found in the PCNS installation directory (for example /opt/APC/PowerChute/group1 ). In the file, type the directory path of the Java location you want to use and save the file. Then stop and restart the daemon.

[Top]
Running on Windows Hyper-V
If you need to upgrade your Java Runtime Environment (JRE), it is possible to upgrade rather than install PCNS. That is, you could, for example, "upgrade" from v2.2.4 to v2.2.4 simply in order to upgrade your JRE. See Upgrading the Software.

In an upgrade on Windows, your current installation directory is always retained.

When the Java Virtual Machine (JVM) application that comes with the PCNS package is installed, it is placed in Program Files\APC\jre.

Important: In order for PowerChute Network Shutdown to be able to shut down the virtual machines (VM) on Windows Hyper-V, you need to configure a guest operating system on each VM.

Consult your Hyper-V documentation on how to do this, or look it up on the APC by Schneider KBase (answer ID is 10381): http://emea-en.apc.com/cgi-bin/emea_en.cfg/php/enduser/std_alp.php?ISOCountryCode=us.

Some directories, including the PowerChute directory and the Java directory, can remain after an uninstall or an upgrade. You can remove them manually, but they won't affect your computer system or PowerChute Network Shutdown. For example, when you upgrade from v2.2.1 to 2.2.4, the JVM package installed in Program Files\jre will not be deleted automatically.

Always use the latest available Windows Service Pack.

The PowerChute directory includes DLL files to shut down some common applications. See the Run Command File section in the Online Help file for information on which applications and how to shut them down.

To remove PowerChute Network Shutdown, uninstall the program from the Control Panel. If you do not intend to reinstall the software, remove the server IP address from the Network Management Card using the Network Management Card's Web interface menu. See Registering an IP Address with the Management Card.

For information on using the Configuration Utility, see Running the Configuration Utility on Windows Hyper-V.

[Top]
Uninstalling on Microsoft Hyper-V Server and Windows Server 2008 Server Core
Follow these steps to uninstall PowerChute Network Shutdown (PCNS) on the Server Core platform.
  1. Close any command prompt windows that are accessing PCNS.
  2. Go to the PowerChute directory, e.g. C:\Program Files\APC\PowerChute.
  3. Type cscript uninstall.vbs and press Enter.
  4. When asked, confirm that you want to uninstall PCNS by typing y and pressing Enter.

Both the PowerChute directory and uninstall.vbs remain after an uninstall. You can remove them manually, though they won't affect the operation of your computer system.
 

[Top]
Multiple-UPS configuration
In a Multiple-UPS configuration, PowerChute Network Shutdown (PCNS) recognizes a group of two or more UPSs as a single UPS.

At least one of these UPSs, a) only shares the load, and b) operates as a stand-by to back up a faulty unit. This configuration is also known as a redundant UPS configuration.

Specifically, PCNS can manage up to three Smart-UPS or Symmetra units (of the same model type) providing redundant backup power to a single server. Each UPS in the system has its own Network Management Card (AP9617, AP9618, AP9619, AP9630, AP9631).

Caution: In a Multiple-UPS configuration, each UPS must have enough capacity to carry all the electrical load of the computer system. So, for example, if you had two UPSs in a Multiple-UPS configuration, and one stops supplying power, the other UPS must have enough capacity to continue supplying power to protect the computer system.

Requirements: For a Multiple-UPS configuration, you must have PowerChute Network Shutdown 2.2 or greater. You can't upgrade to a Multiple-UPS configuration from a previous version of PCNS: you must uninstall, install the new version, and re-configure your options.

With a Multiple-UPS configuration, PCNS always recognizes and logs the events in the categories listed below (see the text on individual events in the List of Events section in the Online Help):

For the Environmental Monitoring Card and Runtime Exceeded events, any actions you configured for the event will be instigated (see the Configuring Events section in the Online Help).

Multiple-UPS configuration Shutdown and Critical Events
Critical events can cause a shutdown in Multiple-UPS configurations.

PCNS always processes the following conditions as critical events: a) a low battery condition, b) a UPS off condition, or c) any event with the  Shut Down System  action enabled on the  Configure Events  page.

PCNS follows these rules when it detects critical events in a Multiple-UPS configuration.

[Top]
Multiple-PCNS Instances in a Multiple-UPS configuration
You can have three instances of PowerChute Network Shutdown (PCNS) on one computer where each instance monitors a Multiple-UPS configuration.

Requirements: This only functions with PCNS v2.2.2 or above and the UPS model Smart-UPS RT (3, 5, 7.5, 10, and 20 kVA) on Windows, UNIX, Linux, or VMware.

Limitations:

See Advanced Configuration of Multiple-UPS Configurations in the Online Help.


 

Entire contents copyright © 2009 by Schneider Electric. All rights reserved. Reproduction in whole or in part without permission is prohibited. All trademarks, product names, and corporate names are the property of their respective owners and are used for informational purposes only.