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. |
Summary of Installation Possibilites for Operating Systems |
You can install PowerChute Network Shutdown (PCNS) interactively on ALL operating systems cited in the first column of the table below. This is true for single, multiple, and parallel UPS configurations. |
The table shows the possibilities for other types of installations: silent installations, interactive upgrades, and silent upgrades.
Note: With multiple-instances configurations, neither silent installations, interactive upgrades, nor silent upgrades are possible.
Installation Possibilities for Operating Systems |
Operating Systems that PCNS can be installed on |
UPS Configuration |
Other Possible Installation Types |
Windows® (Server, 2000, 2003, 2008, XP, Vista, Itanium) |
Single UPS |
- Silent Installation - Interactive Upgrade - Silent Upgrade |
Multiple/ Parallel UPS |
- Silent Installation - Interactive Upgrade - Silent Upgrade |
Windows Server 2008 Server Core |
Single UPS |
- Silent Installation |
Red Hat® Linux® 9 Red Hat Enterprise Linux AIX™ Solaris™ 10 for x64/ x86 SUSE® |
Single UPS |
- Silent Installation - Interactive Upgrade |
HP-UX® |
Single UPS |
- Silent Installation |
Mac OS XSM
|
Single UPS |
- Silent Installation |
Novell® NetWare® |
Single UPS |
- Silent Installation |
Software and Hardware Requirements |
Note: All references to UNIX® in this file include the Solaris™, HP-UX®, and AIX™ operating systems.
|
To
install PowerChute Network Shutdown (PCNS), you must have the following:
- A supported operating system as listed in the Compatibility Chart for PCNS on the APC Web site.
(Additional information on supported operating systems can be found in other sections of this help as listed in the table of contents above).
- For an ordinary, non-silent installation:
Operating System |
Processor |
Memory |
Windows® |
700 MHz |
256 MB |
UNIX |
360 MHz |
256 MB |
Linux® VMware® |
700 MHz |
256 MB |
Mac® OS X |
600 MHz |
256 MB |
Novell® NetWare® |
700 MHz |
512 MB |
- For a silent installation:
Operating System |
Processor |
Memory |
Windows |
700 MHz |
512 MB |
UNIX |
440 MHz |
512 MB |
All Linux (except those versions mentioned in the following row) and VMware |
700 MHz |
512 MB |
Red Hat® Linux® 9, Red Hat®
Enterprise Linux®, SUSE® |
2.4 GHz |
512 MB |
Mac OS X |
600 MHz |
512 MB |
- An
APC UPS which supports the use of an APC Network Management Card (NMC). This
currently includes any Smart-UPS UPS with a card slot or an embedded
NMC, any Smart-UPS DP UPS, any Galaxy UPS, any Matrix-UPS UPS with a
firmware revision of Y or later, any Symmetra UPS, and any Silcon
Series UPS.
- An
APC Network Management Card (APC part number AP9617, AP9618, AP9619, AP9630, AP9631) with a firmware version of 3.3.1 or later.
Or a Symmetra PX2 (which has an internal Network Management Card, OG-9354).
- You can update your APC NMC firmware from the
APC 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.
- If you are using Multiple-UPS (Smart-UPS, Symmetra) or Parallel Silcon UPS configurations, you use one NMC with each UPS in the system. The Synchronization option in the NMC should be disabled.
- The IP address for each APC Network Management Card (NMC).
- If you are using a firewall, the http communication "port" used by the Network Management Card (default:80/TCP), and "port" 3052 (TCP and UDP), must be open for communication with PCNS.
On Windows, when the Windows Firewall is enabled, you can allow the PCNS installation to configure the firewall automatically. That is, the NMC communication port (UDP 3052) is registered as an exception in the firewall and enabled. Also, all Web user interface ports, both HTTP and HTTPS for all instances, are registered but left as disabled for security reasons. If you want to enable remote access to a particular Web user interface, you can enable the appropriate exception.
- The following lists the six possible communication "ports" used by the PCNS Web user interface when using a Multiple-UPS configuration with Multiple-PCNS instances functionality and the http or the https protocol (see the Web/SSL section of the Online Help).
In the list, host represents the IP address of the PCNS machine.
The usage with http is:
- Instance 1: http://host:3052
- Instance 2: http://host:2161
- Instance 3: http://host:2260
The usage with https is:
- Instance 1: https://host:6547
- Instance 2: https://host:6548
- Instance 3: https://host:6549
- A supported Java™ Runtime Environment (JRE) as listed in the Compatibility Chart for PCNS on the APC Web site.
On Windows EXCEPT the Itanium and Server 2008 Server Core versions, PCNS has to determine whether it installs JRE or uses a version already installed on your system. If your JRE version is lower in number than the installation JRE, it installs the packaged JRE. If your JRE version is higher, PCNS uses your JRE version that is closest in number to the PCNS installation package (for example, if PCNS is packaged with JRE 5.0 Update 13 and you have JRE 5.0 Update 14 and 15, the installation program uses Update 14, not 15).
Note: PCNS does NOT uninstall any version of JRE.
On HP-UX, AIX, Solaris 10 for x64/ x86, NetWare, Mac OS X, and Windows Itanium/ Server 2008 Server Core, PCNS does NOT install JRE.
On Linux, VMware, and SPARC versions of Solaris, PCNS gives you a choice whether or not to install JRE.
For most operating systems, you can download a Java Runtime Environment from http://java.sun.com.
NetWare 6 has JRE 1.3.1. Other versions of JRE are available on Novell's Web site.
- If you are installing PowerChute Network Shutdown on more than 50
computers powered by the same UPS, read the document "PowerChute
Network Shutdown with more than 50 computers on one UPS" before
continuing the installation. To obtain the document, go to the Software Uploads page
on the APC Web site and select PowerChute Network Shutdown.
- If you have a Parallel Silcon UPS, read the document "PowerChute
Network Shutdown with a Parallel Silcon UPS System" before continuing
the installation. To obtain the document, go to the Software Downloads page
on the APC Web site and, select PowerChute Network Shutdown for Windows
- Parallel Silcon Configuration Guide.
- If you are installing on a multiple Smart-UPS or multiple
Symmetra configuration, see Multiple-UPS configuration.
- For the GUI installer: A monitor with a minimum resolution of 800 x 600; however, 1024 x
768 or greater is recommended.
- You must have administrator privileges for the server (the host computer).
Upgrading the Software |
The installation process will perform an upgrade rather than a complete installation if you have v2.2 or higher of PowerChute Network Shutdown (PCNS) already installed. This is a simpler operation than the full installation process and it also enables you to retain your existing configuration settings. |
Note: See Running on Windows and Running on Linux, VMware, and UNIX for background information.
If any of the points below is true, upgrading is NOT possible and you should go to Installation:
- If your system is configured for multiple-PCNS instances.
- If the computer you are installing on has several IP addresses (for example, several network interface cards).
- If you are running any of the following OS's:
- Mac OS X
- Novell NetWare
- Windows Server 2008 Server Core
- HP-UX.
WARNING:
Do not install and use PowerChute Network Shutdown on a computer system
that uses PowerChute plus, PowerChute Business Edition, or PowerChute Server.
- The installation program must be run on the server console.
To start the PowerChute Network Shutdown installation, choose from the sections directly below specifying different operating systems and hardware.
For installation on an Itanium/ IA-64 edition of Windows, follow these steps:
- Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
- Set the path to the Java file:
JavaHomeDir\java
-cp .;install.jar;util.jar load
for example: "C:\Program Files\j2sdk\jre\bin\java -cp .;install.jar;util.jar load"
Double quotation marks are used here because of the space in Program Files.
- Use
install.jar and util.jar included on the CD or up on the APC Web site, to commence the
installation.
For
installation on Windows, you can
double-click the installation program icon or execute the file setup.exe
from a command line. Launch the installation program for Windows. After
you complete the installation, you can use the Silent Installation to set up
additional computers to have the same PowerChute Network Shutdown
configuration.
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.
For
installation on Linux, VMware, and UNIX, perform the following steps.
After you finish the installation, you can use the Silent Installation to set up
additional servers to have the same PowerChute Network Shutdown
configuration.
- If you are installing from the CD, locate your installation files in one of the following directories on the CD: Aix, Hpux, Linux, LinuxIA64, Solaris, Solaris_x86. 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_linux.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. Then type the following commands:
gunzip pcns224_OS name.tar.gz
tar -xf pcns224_OS name.tar
- To install in a conversational mode, type the following command:
./install.sh
You cannot specify a directory name that contains a space, either for the installation or the Java directory.
If you do not type a Java directory when prompted, the Java bundled with the installer will be used when appropriate (see JRE version).
- Once the execution of install.sh has been completed, you must configure your setup to complete the installation. Type the following command from the PowerChute directory:
./PCNSConfig.sh
Note: PCNSConfig.sh should never be run twice.
For installation on NetWare, perform the following steps.
- If you
downloaded the file pcns224net.exe from the APC Web site, 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 the software is on a CD, copy the installation files (install.jar and util.jar) from
the NetWare directory on the CD to a temporary directory on the
SYS: volume of your NetWare file server.
- From the server's System Console command prompt, enter the
following command (where tempdirectory represents the location of the
installation files).
java -cp SYS:\tempdirectory\install.jar;SYS:\tempdirectory\util.jar load
- Complete
the software installation.
Note:
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.
- After installation, set access on the PowerChute directory so that only authorized users can access, execute, or remove the software.
The PowerChute Network Shutdown service (on Windows), the daemon (on Linux, VMware, UNIX, and Mac OS X), or the process (on NetWare) starts automatically when the installation is completed. You
can then delete the installation files.
- 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.
Silently Upgrading the Software |
You can perform a silent PowerChute Network Shutdown (PCNS) upgrade on Windows operating systems (other than Windows Server 2008 Server Core). |
A silent upgrade is NOT possible on a system with multiple-PCNS instances.
You use the Windows command line to perform the silent upgrade, as specified in the steps below:
- Check whether the applicationDirectory value in the silentInstall.ini file matches your current PCNS installation directory. If not, edit the file to set the correct value. Precede each path separator ('\' for Windows) with an escape character ('\').
- Copy silentInstall.ini from the PowerChute installation directory, along with the PowerChute Network Shutdown installation files, to a temporary directory on the server you wish to upgrade.
- Use the commands specified below (where tempdir signifies your temporary directory).
If there are spaces in the path to the temporary directory, enclose the path in quotation marks. As examples, the first path below needs quotes (because of Program Files), the second does not:
"C:\Program Files\InstallDir\silentInstall.ini"
C:\InstallDir\silentInstall.ini
- For a
silent upgrade on an Itanium edition of Windows:
JavaHomeDir\java -cp
.;install.jar;util.jar load -s C:\tempdir\pcns224\silentInstall.ini
- For a
silent upgrade on Windows, navigate to the temporary directory on the new server, and type the
following command on one line:
C:\tempdir\setup.exe -s
C:\tempdir\silentInstall.ini
where tempdir is the location of the installation program and
of the valid silentInstall.ini
file.
After you complete the installation, check the pcnsinst.log and errors.log files for error conditions (the latter will only exist when the upgrade 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.).
Installation and Configuration |
To install and
operate the PowerChute Network Shutdown software, perform the following
steps. (If you are upgrading from PCNS v2.2 or higher, refer to Upgrading the Software). |
Note: See Running on Windows for background information on Windows.
- 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).
- Using the Network
Management Card user interface, configure the UPS and the Network
Management Card. At a minimum, perform these tasks:
- Under the UPS tag, on the
Configuration-shutdown page, set the Low Battery Duration field value to at least five
minutes.
- Under the UPS tag, on the PowerChute-configuration page, you can set the authentication phrase for the administrator. While under the Administration tag, on the Local Users-administrator page, you can set the user name and password.
The administrator user name and authentication phrase authenticate the communication between PowerChute Network Shutdown 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.
- 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.
- 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.
To start the PowerChute Network Shutdown installation, choose from the sections directly below specifying different OS systems and hardware.
For installation on Windows Server 2008 Server Core, see Installing on Windows Server 2008 Server Core.
For installation on an Itanium/ IA-64 edition of Windows, follow these steps:
- Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
- Set the path to the Java file:
JavaHomeDir\java
-cp .;install.jar;util.jar load
for example: C:\Program Files\j2sdk\jre\bin\java -cp .;install.jar;util.jar load
- Use
install.jar and util.jar included on the CD or up on the APC Web site, to commence the installation.
For
installation on Windows, you can
double-click the installation program icon or execute the file setup.exe
from a command line. Launch the installation program for Windows. After
you complete the installation, you can use the Silent Installation to set up
additional computers to have the same PowerChute Network Shutdown
configuration.
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.
For
installation on Linux, VMware, and UNIX, perform the following steps.
After you finish the installation, you can use the Silent Installation to set up
additional servers to have the same PowerChute Network Shutdown
configuration.
- If you are installing from the CD, locate your installation files in one of the following directories on the CD: Aix, Hpux, Linux, LinuxIA64, Solaris, Solaris_x86. 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_linux.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. Then type the following commands:
gunzip pcns224_OS name.tar.gz
tar -xf pcns224_OS name.tar
- Please see JRE version before proceeding.
To install in a conversational mode, type the following command:
./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).
- 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:
./PCNSConfig.sh
Note: PCNSConfig.sh should never be run twice.
For installation on NetWare, perform the following steps.
- If you
downloaded the file pcns224net.exe from the APC Web site, 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 the software is on a CD, copy the installation files (install.jar and util.jar) from
the NetWare directory on the CD to a temporary directory on the
SYS: volume of your NetWare file server.
- From the server's System Console command prompt, enter the
following command (where tempdirectory represents the location of the
installation files).
java -cp SYS:\tempdirectory\install.jar;SYS:\tempdirectory\util.jar load
For installation on Mac OS X, perform the following steps.
- If the software is on a CD, copy the installation files from the MacOS X folder to a folder on the Mac.
- Go to the folder on the Mac where you put the installation files.
- Double click on the file install.command
- A terminal window opens, prompting you for your password.
- Enter your password.
- Proceed with the installation.
- 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 installation type on a GUI installer:
- Select
Custom Install if you have a Multiple-UPS or a Parallel Silcon UPS configuration. Then select the appropriate setting for your UPS system, and select Next if installing on Windows.
- Select
Typical Install otherwise.
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.
- Enter
the initial configuration information:
Click Next
to continue if installing on Windows, Mac OS X, and NetWare.
- 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.
Note:
Any Java exceptions displayed during the installation will not affect
the successful completion of the installation or operation of
PowerChute Network Shutdown.
- 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 did not match at NMC IP address" in the status box. Click the Back button and type the correct user name, password, and authentication phrase.
If you are doing a custom installation, and PowerChute Network Shutdown cannot register with the NMC,
you receive another error message "Cannot communicate with the Management Card". You can continue the installation, but you must enter the server IP address
manually at the Network Management Card.
On NetWare, a pop-up message asks whether changes to the autoexec.ncf file can be made. You should select Yes (otherwise the service won't start when the OS starts).
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.
- Start
PowerChute Network Shutdown.
The PowerChute Network Shutdown service (on Windows) and the process (on NetWare) start automatically when the installation is completed. You have a choice whether to start the daemon (on Linux, VMware, UNIX, and Mac OS X). 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.
- 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.
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 proceedure.
- Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
- 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.
- 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.
- Type one of the values and press Enter.
- When prompted for the installation directory, press Enter to accept the default or type your custom directory path.
- If the directory you specified already exists, you need to confirm that the installation should go there by typing y and pressing Enter.
- 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.
- When asked whether you want to install PCNS, type y and press Enter.
- Next, you need to configure your installation. Go to the group1 directory, e.g. C:\Program Files\APC\PowerChute\group1.
- Type cscript PCNSConfig.vbs at the command prompt to begin the configuration.
- 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.
- At Management Card IP, you specify the network IP address of the Network Managment Card (NMC) attached to your UPS.
- 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.
- 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.
- 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.
- Type y and press Enter to start PCNS.
Windows Server 2008 Server Core |
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:
- Perform a normal installation and configuration on one server.
- Copy the installation files and m11.cfg to a temporary directory on your other server.
- Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
- Type cscript install.vbs /f silentInstall.sample at the command prompt.
The installation starts and completes without user inputs.
- Next, you configure PCNS. Go to the group1 directory, for example, C:\Program Files\APC\PowerChute\group1.
- 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:
- Manually install the appropriate JRE version, or any supported Java version as listed in the Compatibility Chart for PCNS on the APC Web site.
- 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.
- 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
- Type cscript install.vbs /f silentInstall.sample at the command prompt.
The installation starts and completes without user inputs.
- Next, you configure PCNS. Go to the group1 directory, for example, C:\Program Files\APC\PowerChute\group1.
- 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
- Type cscript PCNSConfig.vbs /f silentConfig.sample at the command prompt.
The configuration starts and completes without user inputs.
You can install PowerChute Network Shutdown (PCNS) from a command line. To install
PCNS silently, perform the following steps:
- Complete a normal installation on one server.
- Configure PowerChute Network Shutdown to your requirements.
- Edit the silentInstall.ini
file to set new parameters, if required. Precede each path separator ('\' for Windows and '/' for the Mac) 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.
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. (Log in as root to do this for the Mac OS X).
Use the commands
specified below on the relevant system (where tempdir signifies your temporary directory).
For all systems, if there are
spaces in the path to the temporary directory, enclose the path in quotation marks. As examples, the first path below needs quotes (because of Program Files), the second does not:
"C:\Program Files\InstallDir\silentInstall.ini"
C:\InstallDir\silentInstall.ini
- For an
installation on an Itanium edition of Windows:
JavaHomeDir\java -cp
.;install.jar;util.jar load -s C:\tempdir\pcns224\silentInstall.ini
- For an
installation on Windows, navigate to the temporary directory on the new server, and type the
following command on one line:
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.
- For an
installation on Mac OS X, navigate to the temporary folder on the new server, and type the
following command on one line:
sudo java -cp .:install.jar:util.jar load -s /tempfolder/silentInstall.ini
where tempfolder 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.).
For an installation on Linux, VMware, or UNIX, edit silentInstall.sample and specify the install destination 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:
./install.sh -f silentInstall.sample
To complete the configuration silently:
- Change your working directory to the PowerChute/group1 directory.
- Edit silentConfig.sample and enter appropriate values such as the IP address of the NMC, the User ID and the password.
- Type: ./PCNSConfig.sh -f silentConfig.sample
The steps above create the m11.cfg file. To replicate this configuration to other servers:
- Change your working directory to the PowerChute/group1 directory.
- 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.
- Type: ./PCNSConfig.sh -f silentConfig.sample
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. |
- Access the Network
Management Card's user interface by using the Network Management Card IP
address as the URL.
- Click on the UPS tab
- 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.
- 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.
- IP address of the Network Management Card to monitor
- Port number of the Network Management Card to monitor
- Administrator User Account
- Administrator Password
- Security Phrase
To run the Configuration Utility, type the relevant commands listed in the
sections below for your operating system.
Note:
The following instructions assume that you installed PowerChute Network
Shutdown to the default directory.
- If you have Java
in the system path, from the PowerChute\group1\lib directory, type this command on one line:
java -cp
m11.jar;confutil.jar;..\comp\Notifier.jar;..\comp\
CommandFileRunner.jar;..\comp\ds.jar PCNSUtilApp
- If java is not in the system path, from the PowerChute\group1\lib directory, type this command on one line:
Java home dir\bin\java
-cp m11.jar;confutil.jar;..\comp\Notifier.jar;..\comp\
CommandFileRunner.jar;..\comp\ds.jar PCNSUtilApp
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.
Copy the m11.cfg file to the PowerChute/group1/lib directory. The default installation directory is /opt/APC/PowerChute/group1.
- If java is in the path statement, from the PowerChute/group1/lib directory, type this command on one line:
java -cp
m11.jar:confutil.jar:../comp/Notifier.jar:../comp/
CommandFileRunner.jar:../comp/ds.jar PCNSUtilApp
- If java is not in the path statement, type this command on one line:
Java home dir/bin/java
-cp m11.jar:confutil.jar:../comp/Notifier.jar:../comp/
CommandFileRunner.jar:../comp/ds.jar PCNSUtilApp
Type 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.
Stop the PowerChute Network Shutdown service.
- In Linux and VMware, use the command /etc/rc.d/init.d/PowerChute stop
- In Solaris, use the command /etc/rc2.d/S99PowerChute stop
- In AIX, use the command /etc/rc.APCpcns stop
- In HP-UX, use the command /sbin/init.d/pcns stop
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.
- In Linux and VMware, use the command /etc/rc.d/init.d/PowerChute start
- In Solaris, use the command /etc/rc2.d/S99PowerChute start
- In AIX, use the command /etc/rc.APCpcns start
- In HP-UX, use the command /sbin/init.d/pcns start
You can use the Configuration Utility to set up m11.cfg files to monitor several Network Management Cards by using the same PowerChute Network
Shutdown configuration that you used for silent installations.
- Perform a complete installation.
- Copy the m11.cfg file to the /lib directory.
- Run the Configuration Utility.
- Use the Configuration Utility to change the Network Management Card IP address.
- Use the modified m11.cfg file to perform a command line installation. (See Silent Installation, step #4.)
- While the PowerChute NetWare Shutdown daemon is running, copy m11.cfg to the lib directory under the PowerChute installation directory. The default installation directory is SYS:\APC\PowerChute\group1.
- On the System Console, type the following command on one line:
java -cp SYS:\installation directory\lib\m11.jar;SYS:\installation directory\lib\confutil.jar;SYS:\
installation directory\comp\Notifier.jar;SYS:\installation directory\comp\CommandFileRunner.jar;SYS:\install directory\comp\ds.jar PCNSUtilApp
- Change the settings and save them.
- Exit from the wizard.
- Restart the daemon.
- Log in as root.
- Copy the m11.cfg file to the PowerChute/group1/lib folder. (The default installation folder is /Users/Shared/Applications/APC/PowerChute/group1/ and the lib folder is under group1.)
- Stop the PowerChute daemon.
- Type the following command on one line:
java -cp m11.jar:confutil.jar:../comp/Notifier.jar:../comp/CommandFileRunner.jar:../comp/ds.jar PCNSUtilApp
- Enter the IP address of the Network Management Card you wish to monitor, and click Save. Your configuration settings are saved.
- Click OK. On the following screen, click Exit.
- 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 daemon.
Running on Windows®
|
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.
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.
Running on Linux, VMware, and UNIX |
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:
- In Linux and VMware, use the command /etc/rc.d/init.d/PowerChute stop
- In Solaris, use the command /etc/rc2.d/S99PowerChute stop
- In AIX, use the command /etc/rc.APCpcns stop
- In HP-UX, use the command /sbin/init.d/pcns stop
To start
PowerChute Network Shutdown manually, type the following at the command
line:
- In Linux and VMware, use the command /etc/rc.d/init.d/PowerChute start
- In Solaris, use the command /etc/rc2.d/S99PowerChute start
- In AIX, use the command /etc/rc.APCpcns start
- In HP-UX, use the command /sbin/init.d/pcns start
To uninstall in a conversational mode, run the uninstall script located
in the PowerChute directory. For example, type the following command:
/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:
/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.
On UNIX, when the daemon
starts, the script adds 256 file handles; delete ulimit -n 256 from the
PowerChute Network Shutdown (PCNS) startup script if you do not need them.
For information
on using the Configuration Utility, see Running
the Configuration Utility on Linux, VMware, or UNIX.
- Confirm the
process ID for Java with this command:
java -show
- Kill the Java
process:
java -killxxx (where xxx is
a process ID)
- Delete the line
for PCNS in autoexec.NCF (#START PowerChute ,,,,,,)
nwconfig
- Delete the SYS:Pwrchute directory
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.
To restart the PowerChute Network Shutdown daemon, follow these steps:
- Confirm the process ID for Java with this command
java -show
Kill the Java process
java -killxxx (xxx is a
process ID)
Run APCpcns.ncf in the
PowerChute directory.
For information on using the Configuration Utility, see Running
the Configuration Utility on NetWare.
Running on Mac OS X®
|
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 re-install the software, remove the server IP address from the Management Card using the PowerChute option on the Network Management Card user interface menu.
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.
For information on using the Configuration Utility, see Running
the Configuration Utility on Mac OS X.
Follow these steps to uninstall PowerChute Network Shutdown (PCNS) on the Server Core platform.
- Close any command prompt windows that are accessing PCNS.
- Go to the PowerChute directory, e.g. C:\Program Files\APC\PowerChute.
- Type cscript uninstall.vbs and press Enter.
- 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.
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):
- Network
communication lost events
- UPS
communication lost events
- UPS off
- UPS on battery
events
- Environmental
Monitoring Card events
- Runtime Exceeded
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.
- Two identical critical events (such as UPS: On Battery ) occurring in succession on two UPSs cause a shutdown.
Any configured delay time is counted down first.
- Two different critical events (such as UPS: On Battery and PowerChute cannot communicate with the Management Card ) occurring in succession on two UPSs cause a shutdown.
The shutdown is initiated after the critical event state expires in 10 seconds. No configured delay time is counted down.
- Two Low Battery OR two UPS off events occurring in succession on two UPSs cause a shutdown.
The shutdown is initiated after the critical event state expires in 10 seconds. No configured delay time is counted down.
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:
- Neither scheduled shutdowns nor sync control are supported.
- For the second and third PCNS instances on a machine, shutdown is disabled. That is, even if more than one UPS in either the second or the third instance has a critical event it will NOT lead to a shutdown.
- The second and third PCNS instances can execute a command file but NOT if a Multiple-UPS configuration in one of those instances is turned off. (See Run Command File Action in the Online Help).
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.