DMP IM 990-2838.book
Transcription
DMP IM 990-2838.book
PowerChute Network Shutdown v3.1 Installation Guide Windows Linux Hyper-V VMware 990-2838H-001 Publication Date: November, 2013 Introduction PowerChuteTM Network Shutdown (PowerChute) works in conjunction with the UPS Network Management Card (NMC) to provide network-based shutdown of multiple computer systems. In the case of a UPS critical event, the software performs a graceful, unattended system shutdown before the UPS battery is exhausted. The number of protected systems is limited only by the capacity of the UPS. View these Application Notes for detailed information on using PowerChute in specific environments. After installation, it is essential to configure the software using the PowerChute Setup wizard. This ensures that PowerChute is aware of UPS critical events in order to protect your system. Product Center The PowerChute Product Center page has many links to useful up-to-date information. This includes background information on virtualization, loss of communications, and application notes which discuss varied subject matter including possible UPS configurations. PowerChute Network Shutdown: Installation Guide Software and Hardware Requirements To install PowerChute Network Shutdown (PowerChute), you must have the following: • A supported operating system and web browser, as listed on the website, Operating System and Compatibility Chart. • Disk space You need 100 MB of free space on your hard drive for the actual installation process. To install using a virtual appliance, you need between 2 GB and 3 GB of free space. • JRE You must have a supported Java™ Runtime Environment (JRE), as seen for the different operating systems PowerChute gives you the option of installing a “private” JRE. A PowerChute installation takes up about 15 MB of space if you have already installed a public JRE. A PowerChute installation takes up about 135 MB of space when you accept the option of installing the private JRE with PowerChute. If there is no supported public JRE present on the OS, then you have to choose the private JRE option to continue with the installation. For most operating systems, you can download a Java Runtime Environment from http:// java.com. • The computer hardware requirements are a 700 MHz processor and 256 MB of memory. • On a graphical interface with PowerChute: A monitor with a minimum resolution of 800 x 600; however, 1024 x 768 or greater is recommended. • A UPS which supports the use of a Network Management Card (NMC). This currently includes: - any Smart-UPS with a card slot or an embedded NMC - any Smart-UPS DP UPS - any Galaxy UPS that works with an AP963n NMC (where n is a number) - any Symmetra UPS, and any Silcon Series UPS PowerChute Network Shutdown: Installation Guide • A Network Management Card (part number AP9617, AP9618, AP9619, AP9630, AP9631, AP9635) 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 NMC firmware from the APC website. - PowerChute Network Shutdown cannot be used with PowerNet SNMP Adapters (cards). If your card has a part number of AP9605, AP9606, AP9205, or AP9603, contact customer support or your dealer to upgrade the card.x • You must know the IP address for each NMC. • Firewall PowerChute needs to be able to connect to the NMC Web Access port (default: TCP port 80) and receive data inbound to UDP port 3052. When the Windows Firewall is enabled, you can allow the PowerChute installation to configure the firewall automatically for the required ports. • Windows PowerShell 2.0 or higher is required for Hyper-V support on PowerChute. For instructions on how to install PowerShell 2.0 on Windows Server 2008, see http:// msdn.microsoft.com/en-us/library/ff637750(v=azure.10).aspx. • You must have administrator or root privileges to run the installer. • You must uninstall PowerChute plus, PowerChute Business Edition, PowerChute Personal Edition, and PowerChute Server before installing PowerChute. PowerChute Network Shutdown: Installation Guide Preliminary Steps in Installing To install and operate the PowerChute Network Shutdown software, perform the following steps first. 1. Install the Network Management Card (NMC) in your UPS and configure it with an IP address before beginning the PowerChute installation. For installation instructions, see the Network Management Card installation guide that was shipped with your card. 2. Using the NMC user interface, configure the UPS and the Network Management Card. At a minimum, perform these tasks: b a. When configuring a shutdown, set the Low Battery Duration field value to at least five minutes. b. Set the authentication phrase for the administrator. The administrator authentication phrase and the administrator user name must be the same for the NMC and PowerChute. 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. We recommend that you change the defaults for security reasons. Different NMC account types and PowerChute With firmware version 6.0.6 and above of the NMC, it is possible to add multiple users with different account types - Administrator, Device, Read-only, and Network-Only. PowerChute can use an Administrator or Device account instead of the built-in "apc" account to communicate with the NMC. To do this: 1. Create an account on the NMC, either an Administrator or Device account, using Configuration - Security - Local Users - Management. You must log on using the superuser account ("apc") to add new users. 2. On the NMC user interface, go to the Configuration - Shutdown page. 3. Select the new account you created from the User Name drop-down under PowerChute Shutdown Parameters. 4. Use the same user name in PowerChute. The Authentication Phrase must also match. PowerChute Network Shutdown: Installation Guide Installation Guide PowerChute Network Shutdown Windows section Installing PowerChute Network Shutdown See these sections: • • • Installing on Windows and Windows Server Core Upgrading the Software Uninstalling on Windows PowerChute Network Shutdown: Installation Guide Installing on Windows and Windows Server Core To install on Windows in order to monitor a VMware host, see the VMware section of this help. To install on Hyper-V, see the Hyper-V section of this help. Follow these steps below. 1. Locate the PowerChute installation executable file, Setup-x32.exe or Setup-x64.exe, on the PowerChute CD or download it from the APC website. You must have administrator rights to run the installer. Double-click on the file. (If you downloaded from the website, you need to extract the exe file from the zip file). 2. A warning dialog, below, displays if you downloaded the exe from the web: click the Run button. 3. At the welcome dialog, click on Next to continue. At the License Agreement dialog, if you agree with the terms, click I Agree to continue. 4. When configuring for a Java Runtime Environment (JRE), if a valid public JRE is detected, you can choose between using it or the private JRE that is bundled with PowerChute. See JRE for information on using a public or a private JRE installation. PowerChute Network Shutdown: Installation Guide 5. If Hyper-V is not detected, you see the VMware Support dialog shown below; choose Do not enable VMware Support. If Hyper-V is detected, you see the Hyper-V Support dialog shown below; choose Do not enable Hyper-V Support and click Next to proceed. 6. Enter an installation folder location or accept the default. PowerChute Network Shutdown: Installation Guide 7. When your Windows Firewall is enabled, you can allow the PowerChute 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 Firewall for more information. After installation, it is necessary to configure PowerChute in order to protect your system. On Windows, the PowerChute setup wizard opens automatically after you click the Finish button on this dialog: On Windows Server Core, you see the following dialog, follow the steps there: PowerChute Network Shutdown: Installation Guide Upgrading the Software If you have v3.0 or higher of PowerChute already installed on your target machine, the installation process asks you whether you want to perform an upgrade rather than a complete installation. Upgrading enables you to retain your existing configuration settings. For earlier versions of PowerChute, you must uninstall the software before installing v3.1. It is not necessary to run the PowerChute setup wizard after the upgrade on Windows. You cannot upgrade from a 32-bit version to a 64-bit version of PowerChute, you must do a full installation. Also, you must manually uninstall the old version first. PowerChute Network Shutdown: Installation Guide Uninstalling on Windows On Windows, use the Uninstall option under PowerChute Network Shutdown in the Windows Start menu. On Windows Server Core, follow these steps. 1. Open a command prompt window. 2. Type C:\Program Files\APC\PowerChute\uninstall.exe and press Enter. On Windows Server 2012, PowerChute must be uninstalled using Add/Remove Programs. 1. Right-click the PowerChute Network Shutdown menu option in the Start menu. 2. Click Uninstall in the options menu that displays on the bottom of the screen. PowerChute Network Shutdown: Installation Guide Silently Installing the Software Installing silently means the installation is unattended or non-interactive. It is not possible to roll out your event configurations or shutdown settings using a silent installation. You can however, use pcnsconfig.ini to do this. See the section on INI files in the online help. Silent Install on Windows Perform the following steps: 1. Edit the silent installations file to set the required parameters; see Editing your silent installation file. 2. Type the following on one line at the Windows command line: Setup.exe /S /F silentInstall.ini If a silent installation fails, see Appendix A: Error codes for silent installations. PowerChute Network Shutdown: Installation Guide Editing your silent installation file On standard Windows operating systems, the file that guides silent installations is named silentInstall.ini. The file is a plain text file and can be edited with a standard text editor. Each field or line has a value that the installer needs in order to carry out the installation. The table below explains the fields available in the silent installation file. Field name Description applicationDirectory= Specifies the installation folder. Type the folder name after “=”, ensuring it has valid characters for the operating system. Note: You can’t use multiple-byte characters (Chinese for example) and some single byte high-ASCII characters, e.g. ß, é, ä, in the installation path. acceptEula=yes Yes signifies acceptance of the software licence agreement. The installation will not proceed unless yes is specified here. *INSTALL_JAVA= System | PCNS The value System here signifies you want to use the public JRE for your PowerChute installation. The value PCNS here signifies you want to use the private JRE. *The installation detects whether the JRE meets the requirements, see JRE. REGISTER_WITH_NMC= yes | no Using yes or no, specify whether PowerChute should be registered with the Network Management Card (NMC) or not. MODE= single | redundant | parallel Use single, redundant, or parallel to specify the UPS configuration mode. For detailed information, see “PowerChute Network Shutdown Operating Modes and supported UPS Configurations “ here. NETWORKCONFIG= IPv4 | IPv6 Specify your internet protocol with IPv4 or IPv6. IPV6NETWORKCONFIG= unicast | multicast When you are using IPv6 only (you entered NETWORKCONFIG= IPv6 above) you must specify the communication mechanism here. See also UNICAST_ADDRESS= and MULTICAST_ADDRESS=. For detailed information, see “The Communications Process of PowerChute Network Shutdown” here. IP_1= IP_2= IP_3= IP_4= IP_5= IP_6= IP_7= # IP_8= # IP_9= On each line, specify the IP address of each NMC that will be communicating with this PowerChute installation. You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). PowerChute Network Shutdown: Installation Guide Field name Description IP_1_Outlet= IP_2_Outlet= IP_3_Outlet= IP_4_Outlet= IP_5_Outlet= IP_6_Outlet= IP_7_Outlet= # IP_8_Outlet= # IP_9_Outlet= This applies only to UPS devices with outlet groups (for example, Smart-UPS SMX and SMT devices). Specify the outlet group that supplies power to the PowerChute installation. PORT= This is the NMC web port: 80 for HTTP; 443 for HTTPS. PROTOCOL= HTTP | HTTPS Use HTTP or HTTPS to specify which protocol you are using. acceptCerts=true This is required if you are using HTTPS as the NMC protocol and the SSL certificate is self-signed. USERNAME= PASSWORD= AUTHENTICATION_PHRASE= Enter the user name, password, and authentication phrase to validate PowerChute communication with the NMC. (The authentication phrase reverts to the default if not specified). You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). Note: We recommend that you change the defaults for security reasons. The acceptable characters for username and password are: • the alphabet in both lowercase and uppercase (a to z and A to Z) • numbers from 0 to 9 • these characters: _!\"#$%&'()*+,-./:;<=>?@^`{|}[]~ The password length must be from 3–32 characters, and the username from 3–10 characters. The authentication phrase must be 15–32 ASCII characters. LOCAL_IP_ADDRESS= This information applies to a PowerChute server with multiple network cards. Use it to specify the IP address of the card that will communicate with PowerChute. UNICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and unicast in IPV6NETWORKCONFIG= unicast | multicast, you must specify your unicast host address here. MULTICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and multicast in IPV6NETWORKCONFIG= unicast | multicast, the Network Management card will send UDP packets to the multicast address you specify here. PowerChute Network Shutdown: Installation Guide Installation Guide PowerChute Network Shutdown Linux section Installing PowerChute Network Shutdown See these sections: • • • Installation Steps on Linux Upgrading the Software Uninstalling on Linux PowerChute Network Shutdown: Installation Guide Installation Steps on Linux You must have root privileges to perform the installation. 1. If you are installing from the CD, locate your installation files in one of the following directories on the CD: Linux_x32 or Linux_x64. Copy them to a temporary directory on your server. 2. If you are installing from the website, locate the file pcns310Linux.tar.gz on the APC website and copy it to a temporary directory on your server. Change your working directory to the temporary directory. Then type the following commands: gunzip pcns310Linux.tar.gz tar -xf pcns310Linux.tar 3. If you are not logged on as the root user, you need to run the installer using sudo, or switch to root user context using the su command and then run the installer. ./install.sh After a web download you need to grant execute permissions: chmod +x install.sh 4. At the License Agreement, if you agree with the terms, type Yes and press the Enter key to continue. Type No to exit. 5. When configuring for a Java Runtime Environment (JRE), if a valid public JRE is detected, you can choose between using it or the private JRE that is bundled with PowerChute (see JRE). If using the public JRE, you must enter its path.Enter an installation folder location or accept the default. You cannot specify a directory name that contains a space, either for the installation or the Java directory. If you do not specify an installation directory, it will be installed to the default: /opt/APC. The PowerChute Network Shutdown daemon starts automatically when the installation is completed. You can then delete the installation files. After installation, it is necessary to configure your system in order to protect it. You must open the browser and enter the PowerChute URL: https://<your_machine_name/ IP>:6547 Follow the steps in the PowerChute setup wizard to complete your configuration. PowerChute Network Shutdown: Installation Guide Upgrading the Software If you have v3.0 or higher of PowerChute already installed on your target machine, the installation process asks you whether you want to perform an upgrade rather than a complete installation. Upgrading enables you to retain your existing configuration settings. You cannot upgrade from a 32-bit version to a 64-bit version of PowerChute, you must do a full installation. Also, you must manually uninstall the old version first. After an Linux upgrade, it is not necessary to run the PowerChute setup wizard. PowerChute Network Shutdown: Installation Guide Uninstalling on Linux On Linux: • Run the uninstall script located in the PowerChute directory from a terminal prompt. /opt/APC/PowerChute/uninstall • To uninstall in silent mode, run the uninstall script located in the PowerChute directory, with the -q option. /opt/APC/PowerChute/uninstall -q PowerChute Network Shutdown: Installation Guide Silently Installing the Software Installing silently means the installation is unattended or non-interactive. It is not possible to roll out your event configurations or shutdown settings using a silent installation. You can however, use pcnsconfig.ini to do this. See the section on INI files in the online help. Silent Install on Linux Edit the silentInstall.sample file to set the required parameters; see Editing your silent installation file. Type the following command to start the installation, as an administrator: ./install.sh –f silentInstall.sample If a silent installation fails, see Appendix A: Error codes for silent installations. PowerChute Network Shutdown: Installation Guide Editing your silent installation file On the Linux operating system, the file that guides silent installations is named silentInstall.sample. The file is a plain text file and can be edited with a standard text editor. Each field or line has a value that the installer needs in order to carry out the installation. The table below explains the fields available in the silent installation file. Field name Description INSTALL_DIR= Specifies the installation directory. Type the directory name after “=”, ensuring it has valid characters for the operating system. Note: You can’t use multiple-byte characters (Chinese for example) and some single byte high-ASCII characters, e.g. ß, é, ä, in the installation path. JAVA_DIR= Specifies the JRE directory. Type the path where the public JRE is installed on the system e.g. /usr/local/bin/jre/jre1.7.0_40. If this value is blank or absent, the private JRE is installed. acceptEula=yes Yes signifies acceptance of the software licence agreement. The installation will not proceed unless yes is specified here. REGISTER_WITH_NMC= yes | no Using yes or no, specify whether PowerChute should be registered with the Network Management Card (NMC) or not. MODE= single | redundant | parallel Use single, redundant, or parallel to specify the UPS configuration mode. For detailed information, see “PowerChute Network Shutdown Operating Modes and supported UPS Configurations “ here. NETWORKCONFIG= IPv4 | IPv6 Specify your internet protocol with IPv4 or IPv6. IPV6NETWORKCONFIG= unicast | multicast When you are using IPv6 only (you entered NETWORKCONFIG= IPv6 above) you must specify the communication mechanism here. See also UNICAST_ADDRESS= and MULTICAST_ADDRESS=. For detailed information, see “The Communications Process of PowerChute Network Shutdown” here. IP_1= IP_2= IP_3= IP_4= IP_5= IP_6= IP_7= # IP_8= # IP_9= On each line, specify the IP address of each NMC that will be communicating with this PowerChute installation. IP_1_Outlet= IP_2_Outlet= IP_3_Outlet= IP_4_Outlet= IP_5_Outlet= IP_6_Outlet= IP_7_Outlet= # IP_8_Outlet= # IP_9_Outlet= This applies only to UPS devices with outlet groups (for example, Smart-UPS SMX and SMT devices). Specify the outlet group that supplies power to the PowerChute installation. You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). PowerChute Network Shutdown: Installation Guide Field name Description PORT= This is the NMC web port: 80 for HTTP; 443 for HTTPS. PROTOCOL= HTTP | HTTPS Use HTTP or HTTPS to specify which protocol you are using. acceptCerts=true This is required if you are using HTTPS as the NMC protocol and the SSL certificate is self-signed. USERNAME= PASSWORD= AUTHENTICATION_PHRASE= Enter the user name, password, and authentication phrase to validate PowerChute communication with the NMC. (The authentication phrase reverts to the default if not specified). Note: We recommend that you change the defaults for security reasons. The acceptable characters for username and password are: • the alphabet in both lowercase and uppercase (a to z and A to Z) • numbers from 0 to 9 • these characters: _!\"#$%&'()*+,-./:;<=>?@^`{|}[]~ The password length must be from 3–32 characters, and the username from 3–10 characters. The authentication phrase must be 15–32 ASCII characters. LOCAL_IP_ADDRESS= This information applies to a PowerChute server with multiple network cards. Use it to specify the IP address of the card that will communicate with PowerChute. UNICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and unicast in IPV6NETWORKCONFIG= unicast | multicast, you must specify your unicast host address here. MULTICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and multicast in IPV6NETWORKCONFIG= unicast | multicast, the Network Management card will send UDP packets to the multicast address you specify here. PowerChute Network Shutdown: Installation Guide Installation Guide PowerChute Network Shutdown Hyper-V section Installing PowerChute Network Shutdown See these sections: • • • Installing on Windows Hyper-V Upgrading the Software Uninstalling on Hyper-V Remote Server Administration Tools The Remote Server Administration Tools must be installed for Hyper-V and Failover Clustering (Windows Server 2012). The PowerChute powershell scripts will not work correctly (for either VM migration or VM shutdown) if these are not installed. To verify: 1. Launch Powershell. 2. Run the command Get-Module -ListAvailable. 3. Check that Hyper-V and FailoverClusters are shown: PowerChute Network Shutdown: Installation Guide Installing on Windows Hyper-V The Hyper-V server can be part of a Windows failover cluster or a standalone host. If it is part of a cluster, then PowerChute can perform a migration of the virtual machines during a shutdown. (See also Remote Server Administration Tools.) Follow these steps below. 1. Locate the PowerChute installation executable file, Setup-x64.exe, on the PowerChute CD or download it from the APC website. You must have administrator rights to run the installer. Double-click on the file. (If you downloaded from the website, you need to extract the exe file from the zip file). 2. A warning dialog, below, displays if you downloaded the exe from the web: click the Run button. 3. At the welcome dialog, click on Next to continue. At the License Agreement dialog, if you agree with the terms, click I Agree to continue. Enter an installation folder location or accept the default. 4. When configuring for a Java Runtime Environment (JRE), if a valid public JRE is detected, you can choose between using it or the private JRE that is bundled with PowerChute. See JRE for information on using a public or a private JRE installation. PowerChute Network Shutdown: Installation Guide 5. At the dialog below, choose Enable Hyper-V Support and your installation proceeds. 6. When your Windows Firewall is enabled, you can allow the PowerChute 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 Firewall for more information. After installation, it is necessary to configure PowerChute in order to protect your system. PowerChute Network Shutdown: Installation Guide See the final dialog below, if you installed on Hyper-V server, you have to go to another machine in order to configure this installation of PowerChute. In the graphic below, Hyper-V machine at step 2 represents the machine name or the IP address of your Hyper-V machine. On a standard Windows machine when you have enabled Hyper-V in this installation process, the PowerChute setup wizard opens automatically after you click the Finish button. PowerChute Network Shutdown: Installation Guide Upgrading the Software If you have v3.0 or higher of PowerChute already installed on your target machine, the installation process asks you whether you want to perform an upgrade rather than a complete installation. Upgrading enables you to retain your existing configuration settings. After an upgrade on a Windows installation of PowerChute with Hyper-V support enabled, it is not necessary to run the PowerChute setup wizard. However in order to use the virtualization features, you must go into the Shutdown Settings screen of the PowerChute user interface and enable VM migration, and VM shutdown and startup. PowerChute Network Shutdown: Installation Guide Uninstalling on Hyper-V On Windows, use the Uninstall option under PowerChute Network Shutdown in the Windows Start menu. On Windows Server Core, follow these steps. 1. Open a command prompt window. 2. Type C:\Program Files\APC\PowerChute\uninstall.exe and press Enter. On Windows Server 2012, PowerChute must be uninstalled using Add/Remove Programs. 1. Right-click the PowerChute Network Shutdown menu option in the Start menu. 2. Click Uninstall in the options menu that displays on the bottom of the screen. PowerChute Network Shutdown: Installation Guide Silently Installing the Software Installing silently means the installation is unattended or non-interactive. It is not possible to roll out your event configurations or shutdown settings using a silent installation. You can however, use pcnsconfig.ini to do this. See the section on INI files in the online help. Silent Install on Hyper-V Perform the following steps: 1. Edit the silent installations file to set the required parameters; see Editing your silent installation file. 2. Type the following on one line at the Windows command line: Setup.exe /S /F silentInstall.ini If a silent installation fails, see Appendix A: Error codes for silent installations. PowerChute Network Shutdown: Installation Guide Editing your silent installation file On Hyper-V, the file that guides silent installations is named silentInstall_HyperV.ini. The file is a plain text file and can be edited with a standard text editor. Each field or line has a value that the installer needs in order to carry out the installation. The table below explains the fields available in the silent installation file. Field name Description applicationDirectory= Specifies the installation folder. Type the folder name after “=”, ensuring it has valid characters for the operating system. Note: You can’t use multiple-byte characters (Chinese for example) and some single byte high-ASCII characters, e.g. ß, é, ä, in the installation path. acceptEula=yes Yes signifies acceptance of the software licence agreement. The installation will not proceed unless yes is specified here. *INSTALL_JAVA= System | PCNS The value System here signifies you want to use the public JRE for your PowerChute installation. The value PCNS here signifies you want to use the private JRE. *The installation detects whether the JRE meets the requirements, see JRE. REGISTER_WITH_NMC= yes | no Using yes or no, specify whether PowerChute should be registered with the Network Management Card (NMC) or not. MODE= single | redundant | parallel Use single, redundant, or parallel to specify the UPS configuration mode. For detailed information, see “PowerChute Network Shutdown Operating Modes and supported UPS Configurations “ here. NETWORKCONFIG= IPv4 | IPv6 Specify your internet protocol with IPv4 or IPv6. IPV6NETWORKCONFIG= unicast | multicast When you are using IPv6 only (you entered NETWORKCONFIG= IPv6 above) you must specify the communication mechanism here. See also UNICAST_ADDRESS= and MULTICAST_ADDRESS=. For detailed information, see “The Communications Process of PowerChute Network Shutdown” here. IP_1= IP_2= IP_3= IP_4= IP_5= IP_6= IP_7= # IP_8= # IP_9= On each line, specify the IP address of each NMC that will be communicating with this PowerChute installation. IP_1_Outlet= IP_2_Outlet= IP_3_Outlet= IP_4_Outlet= IP_5_Outlet= IP_6_Outlet= IP_7_Outlet= # IP_8_Outlet= # IP_9_Outlet= This applies only to UPS devices with outlet groups (for example, Smart-UPS SMX and SMT devices). Specify the outlet group that supplies power to the PowerChute installation. You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). PowerChute Network Shutdown: Installation Guide Field name Description PORT= This is the NMC web port: 80 for HTTP; 443 for HTTPS. PROTOCOL= HTTP | HTTPS Use HTTP or HTTPS to specify which protocol you are using. acceptCerts=true This is required if you are using HTTPS as the NMC protocol and the SSL certificate is self-signed. USERNAME= PASSWORD= AUTHENTICATION_PHRASE= Enter the user name, password, and authentication phrase to validate PowerChute communication with the NMC. (The authentication phrase reverts to the default if not specified). Note: We recommend that you change the defaults for security reasons. The acceptable characters for username and password are: • the alphabet in both lowercase and uppercase (a to z and A to Z) • numbers from 0 to 9 • these characters: _!\"#$%&'()*+,-./:;<=>?@^`{|}[]~ The password length must be from 3–32 characters, and the username from 3–10 characters. The authentication phrase must be 15–32 ASCII characters. LOCAL_IP_ADDRESS= This information applies to a PowerChute server with multiple network cards. Use it to specify the IP address of the card that will communicate with PowerChute. UNICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and unicast in IPV6NETWORKCONFIG= unicast | multicast, you must specify your unicast host address here. MULTICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and multicast in IPV6NETWORKCONFIG= unicast | multicast, the Network Management card will send UDP packets to the multicast address you specify here. HYPERVVIRTUALINSTALL= true | false Specify true to enable the Hyper-V virtualization features. ENABLE_GUESTVM_MIGRATION= Specify true to enable the migration of virtual machines (VMs). GUESTVM_MIGRATION_DURATION= Specify the duration for VM migration, with a range of 0–172800 seconds. The default value is 120. CUSTOM_TARGET_HOST= true | false Specify true to enable customization of the target host list for VM migration. CUSTOM_TARGET_FILE= Specify the file containing the list of target hosts. Enter the full path of the file. ENABLE_GUESTVM_SHUTDOWN= true | false Specify true to enable the shutdown of VMs. GUESTVM_SHUTDOWN_DURATION= Specify the duration for VM shutdown, with a range of 0–172800 seconds. The default value is 120. ENABLE_GUESTVM_STARTUP= true | false Specify true to enable the startup of VMs. GUESTVM_STARTUP_DURATION= Specify the delay time for the startup process for when a critical event occurs during the VM startup. The range is 0–172800 seconds. The default value is 120. PowerChute Network Shutdown: Installation Guide Installation Guide PowerChute Network Shutdown VMware section Installing PowerChute Network Shutdown with VMware Support You have three different ways of deploying or installing PowerChute in order to monitor VMware hosts: • • • Installing on Windows to Monitor VMware Hosts Deploying the PowerChute Virtual Appliance Installing on vSphere Management Assistant (vMA) See also Upgrading the software, Silently Installing the Software, Uninstalling. Recommendations on Deploying/ Installing PowerChute We recommend the following in a VMware environment: VMware Setup Recommended Deployment/ Installation of PowerChute VMware Hosts in multiple clusters PowerChute installed on a physical Windows machine Single VMware host that is not managed by vCenter Server PowerChute virtual appliance VMware hosts in one cluster for Single, Redundant or Parallel UPS configurations PowerChute virtual appliance or PowerChute installed on a physical Windows machine VMware hosts managed by vCenter Server which is running on a physical machine PowerChute installed on a physical Windows machine Using vCenter Server running on a VM or vCenter Server Virtual Appliance (VCSA) PowerChute virtual appliance or PowerChute installed on a physical Windows machine Advanced UPS configuration, see graphic below. See application notes for background information. PowerChute installed on a physical Windows machine PowerChute Network Shutdown: Installation Guide Installing on Windows to Monitor VMware Hosts PowerChute Network Shutdown can be installed on a physical Windows machine in order to remotely monitor VMware hosts. Follow these steps below. 1. Locate the PowerChute installation executable file for Windows, Setup-x32.exe or Setup-x64.exe, on the PowerChute CD or download it from the APC website. You must have administrator rights to run the installer. Double-click on the file. (If you downloaded from the website, you need to extract the exe file from the zip file). 2. A warning dialog, below, displays if you downloaded the exe from the web: click the Run button. 3. At the welcome dialog, click on Next to continue. At the License Agreement dialog, if you agree with the terms, click I Agree to continue. 4. When configuring for a Java Runtime Environment (JRE), if a valid public JRE is detected, you can choose between using it or the private JRE that is bundled with PowerChute. See JRE for information on using a public or a private JRE installation. PowerChute Network Shutdown: Installation Guide 5. Choose Enable VMware Support at the dialog below. 6. Enter an installation folder location or accept the default and your installation proceeds. 7. When your Windows Firewall is enabled, you can allow the PowerChute 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 Firewall for more information. PowerChute Network Shutdown: Installation Guide After installation, it is necessary to configure PowerChute in order to protect your system. The PowerChute setup wizard opens automatically after you click the Finish button. PowerChute Network Shutdown: Installation Guide Deploying the PowerChute Virtual Appliance The PowerChute Virtual Appliance is a virtual machine image with CentOS Linux 5.8 running PowerChute Network Shutdown v3.1 pre-installed. The advantages of using the PowerChute virtual appliance are ease of installation and that little specialized knowledge is needed. The Schneider Electric KBase http://www.apc.com/site/support/index.cfm/faq/ index.cfm (FAQ ID is FA159775), has some information on installing the vSphere Client. Follow these steps below to deploy the virtual appliance. 1. Locate the PowerChute virtual appliance file, PCNS_3.1_OVF10.ova, on the PowerChute CD or download it from the APC website. 2. Log on to the VMware host or vCenter Server using your vSphere Client. 3. Select File - Deploy OVF Template from the menu. PowerChute Network Shutdown: Installation Guide 4. At the Deploy from a file or URL field, enter the path to the .OVA file. 5. The OVA details are displayed. Click the Next button. 6. When the End User Licence Agreement (EULA) is displayed, click Accept and then Next. PowerChute Network Shutdown: Installation Guide 7. Accept the default name and specify the datacenter and then click on the + sign and highlight Discovered virtual machine if necessary, and click Next. 8. This step is not relevant if you are deploying to a standalone host. Specify a host or a cluster and click Next. If you specify a cluster, you will be asked to specify a host within that cluster. PowerChute Network Shutdown: Installation Guide 9. This step is not relevant if you are deploying to a standalone host. Specify a configured datastore on your system that has sufficient disk space to deploy the virtual appliance. Click Next 10. At Disk Format, choose the default disk layout option by clicking Next. PowerChute Network Shutdown: Installation Guide 11. At Networking Properties, if you want to use fixed IP-addressing, then fill in these field values as necessary. If you are using DHCP, you do not need to fill in the fields, so just click Next. 12. The options you have chosen display again, click Finish to commence the installation. The time taken to deploy the appliance depends on your network speed. PowerChute Network Shutdown: Installation Guide This message box below displays when the installation has completed successfully and PowerChute Network Shutdown 3.1 for VMware displays as a VM in the inventory: 13. Power on your PowerChute virtual machine. 14. To access the PowerChute Network Shutdown user interface, you need to find out its URL. Click on the Console tab or right-click on the VM in the left-hand pane and select Open Console. 15. On the first boot of the appliance you will be prompted to create a password for the root user. Take care to store this password safely for future use. The welcome screen displays. The URL for your new installation of PowerChute displays in the To configure PowerChute Network Shutdown, browse to: sentence. 16. Browse to https://<IP_Address>:6547 to launch the PowerChute setup wizard. PowerChute Network Shutdown: Installation Guide Installing on vSphere Management Assistant (vMA) PowerChute Network shutdown can also be installed on the vSphere Management Assistant (vMA). There are two steps, see Deploying vMA on a VMware Host. and Installing PowerChute on the vMA. Deploying vMA on a VMware Host. The web page vSphere Management Assistant provides more information. Alternatively, you can call VMware customer support. The Schneider Electric KBase http://www.apc.com/site/support/index.cfm/faq/index.cfm (FAQ ID is FA159775), has some information on installing the vSphere Client. vSphere Management Assistant (vMA) was previously known as VMware Infrastructure Management Assistant (VIMA). Follow these steps to install vMA. 1. Download the vMA installation files from vSphere Management Assistant, and extract the files. 2. Log on to the VMware host or vCenter server using your vSphere Client. 3. Select File - Deploy OVF Template from the menu. PowerChute Network Shutdown: Installation Guide 4. At the Deploy from a file or URL field, enter the path to the .OVF file you extracted at step 1 above. 5. The vMA and OVF details are displayed. Click the Next button. 6. When the End User Licence Agreement (EULA) is displayed, click Accept and then Next. PowerChute Network Shutdown: Installation Guide 7. Accept the default vMA name (and location) or enter alternatives, and click Next. 8. At Disk Format, choose the default disk layout option by clicking Next. PowerChute Network Shutdown: Installation Guide 9. The options you have chosen display again, click Finish. The vMA software is now installed, and it should be displaying in the left-hand pane. 10. Select the vMA in the left-hand pane. 11. Power on the vMA virtual machine, then follow the instructions on configuring the IP address, setting vi-admin password, etc. PowerChute Network Shutdown: Installation Guide Installing PowerChute on the vMA You must have root privileges to perform the installation. 1. If you are installing from the CD, locate your installation files in the ESXi directory on the CD. Copy them to a temporary directory on your server. 2. If you are installing from the website, locate this file on the APC website and copy it to a temporary directory on your server: pcns310ESXi.tar.gz 3. Change your working directory to the temporary directory. Then type the following commands: sudo gunzip pcns310ESXi.tar.gz sudo tar -xf pcns310ESXi.tar 4. Type: sudo ./install.sh After a web download you need to grant execute permissions: sudo chmod +x install.sh 5. At the License Agreement, if you agree with the terms, type Yes and press the Enter key to continue. Type No to exit. 6. When configuring for a Java Runtime Environment (JRE), if a valid public JRE is detected, you can choose between using it or the private JRE that is bundled with PowerChute (see JRE). If using the public JRE, you must enter its path.Enter an installation folder location or accept the default. You cannot specify a directory name that contains a space, either for the installation or the Java directory. If you do not specify an installation directory, it will be installed to the default: /opt/APC. The PowerChute Network Shutdown service starts automatically when the installation is completed. You can then delete the installation files. 7. Go to a computer that has a browser and open the PowerChute user interface with: https://<server_ip_address>:6547 Follow the steps in the PowerChute setup wizard to complete your configuration. PowerChute Network Shutdown: Installation Guide Upgrading the software You can’t upgrade from a 32-bit version to a 64-bit version of PowerChute, you must do a full installation. Also, you must manually uninstall the old version first. Upgrading enables you to retain your existing configuration settings. Upgrades are only possible if your existing version of PowerChute is 3.0 or greater. If you have v3.0 or higher of PowerChute already installed on your target machine, the installation process asks you whether you want to perform an upgrade rather than a complete installation. See the table below for information on upgrades: Upgrade possible? Run the PowerChute setup wizard after an upgrade? Installing on Windows to Monitor VMware Hosts No - Deploying the PowerChute Virtual Appliance No - Installing on vSphere Management Assistant (vMA) Yes Yes PowerChute Install Type PowerChute Network Shutdown: Installation Guide Uninstalling Uninstalling PowerChute on a a vMA: • Run the uninstall script located in the PowerChute directory from a terminal prompt. /opt/APC/PowerChute/uninstall • To uninstall in silent mode, run the uninstall script located in the PowerChute directory, with the -q option. /opt/APC/PowerChute/uninstall -q In addition, for a virtual appliance installation, you should remove the appliance from inventory: • Right-click on the virtual appliance in vSphere Client, and choose Remove from inventory. PowerChute Network Shutdown: Installation Guide Silently Installing the Software Installing silently means the installation is unattended or non-interactive. It is not possible to roll out your event configurations or shutdown settings using a silent installation. You can however, use pcnsconfig.ini to do this. See the section on INI files in the online help. Silent Install on VMware You cannot install silently using the virtual appliance method, see Deploying the PowerChute Virtual Appliance. Edit the silent installation file silentInstall.sample to set the required parameters; see Editing your silent installation file. Type the following command to start the installation: sudo ./install.sh –f silentInstall.sample If a silent installation fails, see Appendix A: Error codes for silent installations. PowerChute Network Shutdown: Installation Guide Editing your silent installation file When monitoring a VMware host with PowerChute Network Shutdown, your silent installation file could have any of the names specified below: • Monitoring from a Windows machine, the file is: silentInstall_VMware.ini. • Monitoring from a Windows machine and using the Advanced Cluster configuration, the file is: silentInstall_VMware-AdvancedCluster.ini. • Monitoring from a VM, the file is: silentInstall_VMware.sample. These are plain text files and can be edited with an available text editor. Each field or line has a value that the installer needs in order to carry out the installation. The table below explains the fields available in the silent installation file. Field name Description The fields directly below, applicationDirectory and INSTALL_JAVA, are used when you are monitoring a VMware host from a Windows machine with PowerChute Network Shutdown (see Installing on Windows to Monitor VMware Hosts). applicationDirectory= Specifies the installation folder. Type the folder name after “=”, ensuring it has valid characters for the operating system. Note: You can’t use multiple-byte characters (Chinese for example) and some single byte high-ASCII characters, e.g. ß, é, ä, in the installation path. INSTALL_JAVA= System | PCNS The value System here signifies you want to use the public JRE for your PowerChute installation. The value PCNS here signifies you want to use the private JRE. The installation detects whether the public JRE meets the requirements, see JRE. The fields directly below, INSTALL_DIR and JAVA_DIR, are used when you are monitoring a VMware host from a VM with PowerChute Network Shutdown (see Installing PowerChute Network Shutdown with VMware Support). INSTALL_DIR= Specifies the installation directory. Type the path where the public JRE is installed on the system e.g. \usr\bin. Note: You can’t use multiple-byte characters (Chinese for example) and some single byte high-ASCII characters, e.g. ß, é, ä, in the installation path. JAVA_DIR= Specifies the JRE directory. Type the directory name after “=”, ensuring it has valid characters for the operating system. If this value is blank or absent, the private JRE is installed. Specify a public JRE for PowerChute by setting the path to the JRE executable. See JRE. acceptEula=yes Yes signifies acceptance of the software licence agreement. The installation will not proceed unless yes is specified here. REGISTER_WITH_NMC= yes | no Using yes or no, specify whether PowerChute should be registered with the Network Management Card (NMC) or not. MODE= single | redundant | parallel Use single, redundant, or parallel to specify the UPS configuration mode. See the online help, UPS Configuration Options, for more information. NETWORKCONFIG= IPv4 | IPv6 Specify your internet protocol with IPv4 or IPv6. PowerChute Network Shutdown: Installation Guide Field name Description IPV6NETWORKCONFIG= unicast | multicast When you are using IPv6 only (having entered NETWORKCONFIG= IPv6 above) you must specify the communication mechanism here. See also UNICAST_ADDRESS= and MULTICAST_ADDRESS=. For detailed information, see “The Communications Process of PowerChute Network Shutdown" here. IP_1= IP_2= IP_3= IP_4= IP_5= IP_6= IP_7= # IP_8= # IP_9= On each line, specify the IP address of each NMC that will be communicating with this PowerChute installation. IP_1_Outlet= IP_2_Outlet= IP_3_Outlet= IP_4_Outlet= IP_5_Outlet= IP_6_Outlet= IP_7_Outlet= # IP_8_Outlet= # IP_9_Outlet= This applies only to UPS devices with Outlet Groups (for example, Smart-UPS SMX and SMT devices). Specify the outlet group that supplies power to the PowerChute installation. PORT= This is the NMC web port: 80 for HTTP; 443 for HTTPS. PROTOCOL= HTTP | HTTPS Use HTTP or HTTPS to specify which protocol you are using. acceptCerts=true This is required if you are using HTTPS as the NMC protocol and the SSL certificate is self-signed. USERNAME= PASSWORD= AUTHENTICATION_PHRASE= Enter the user name, password, and authentication phrase to validate PowerChute communication with the NMC. (The authentication phrase reverts to the default if not specified). You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). You can comment out unneeded entries by putting the # character at the beginning of the line (see examples 8 and 9). Note: We recommend that you change the defaults for security reasons. The acceptable characters for username and password are: • the alphabet in both lowercase and uppercase (a to z and A to Z) • numbers from 0 to 9 • these characters: _!\"#$%&'()*+,-./:;<=>?@^`{|}[]~ The password length must be from 3–32 characters, and the username from 3–10 characters. The authentication phrase must be 15–32 ASCII characters. LOCAL_IP_ADDRESS= This information applies to a PowerChute server with multiple network cards. Use it to specify the IP address of the card that will communicate with PowerChute. UNICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and unicast in IPV6NETWORKCONFIG= unicast | multicast, you must specify your unicast host address here. MULTICAST_ADDRESS= When you have specified IPv6 in NETWORKCONFIG= IPv4 | IPv6 and multicast in IPV6NETWORKCONFIG= unicast | multicast, he Network Management card will send UDP packets to the multicast address you specify here. PowerChute Network Shutdown: Installation Guide Field name Description ESXIVIRTUALINSTALL= true | false Enable the VMware virtualization features with true. See the VMware Configuration sections in the online help for details. ESXI_CONFIGURATION_MODE= standalone | managed by vcenter Specify the mode in which your ESXi servers are configured. See the online help for more information on this. ESXIHOST_ADDRESS= When the ESXI_CONFIGURATION_MODE= field above is “standalone”, specify the IP Address or the host name or the FQDN (Fully Qualified Domain Name) of the ESXi host to be managed. ESXIHOST_USERNAME= When the ESXI_CONFIGURATION_MODE= field above is “standalone”, specify the user name of the ESXi host. ESXIHOST_PASSWORD= When the ESXI_CONFIGURATION_MODE= field above is “standalone”, specify the password of the ESXi host VCENTERSERVER_ADDRESS= When the ESXI_CONFIGURATION_MODE= field above is “managed by vcenter”, specify the IP Address or the host name or the FQDN (Fully Qualified Domain Name) of the vCenter server. VCENTERSERVER_USERNAME= When the ESXI_CONFIGURATION_MODE= field above is “managed by vcenter”, specify the user name of the vCenter server. VCENTERSERVER_PASSWORD= When the ESXI_CONFIGURATION_MODE= field above is “managed by vcenter”, specify the password of the vCenter server. ENABLE_GUESTVM_SHUTDOWN= true | false Enable shutdown of the guest VMs with true. GUESTVM_SHUTDOWN_DURATION= Specify the duration for guest VM shutdown, with a range of 0–172800 seconds. The default value is 120. ENABLE_VAPP_SHUTDOWN= true | false Enable shutdown of the vApps with true. FORCE_VAPP_SHUTDOWN= true | false When this value is set to true, PowerChute will shut down all VMs in the vApp. This will happen even if some of the VMs are running on a VMware host that is not affected by the UPS critical event. If you set this to false then some of the VMs will not be shut down gracefully. VAPP_SHUTDOWN_DURATION Specify the duration for vApp shutdown, with a range of 0–172800 seconds. The default value is 120. ENABLE_GUESTVM_STARTUP= true | false Enable start-up of the guest VMs that were shut down by PCNS with true. GUESTVM_STARTUP_DURATION= Specify the duration to delay the shutdown process, if a critical event occurs during start-up of VMs. The range is 0–172800 seconds. The default value is 120. ENABLE_VAPP_STARTUP= true | false Enable start-up of the vApps that were shut down by PowerChute with true. VAPP_STARTUP_DURATION= Specify the duration to delay the shutdown process, if a critical event occurs during start-up of vApps. The range is 0–172800 seconds. The default value is 120. This field below is present when you do NOT use the Advanced UPS configuration. TARGETHOST_LIST= <host 1> | <host 2> | <others> Specify a list of target hosts to be shut down when a critical power event occurs. Use the “|” character to separate the hosts. PowerChute Network Shutdown: Installation Guide Field name Description The fields below are present when you use the Advanced UPS configuration. NMCIP_0 to NMCIP_n = These fields are used to associate each VMware Host with the UPS-NMC that it is being powered by. HOSTLIST_0 to HOSTLIST_n = - Use NMCIP_0 to NMCIP_n= to specify the NMC IP address. - Use HOSTLIST_0 to HOSTLIST_n to specify the equivalent ESXi hosts mapped to that NMC (by using the ESXi host IP address, name, or the FQDN (Fully Qualified Domain Name). Use the | character to separate the entries. Example of a UPS which is NOT outlet-aware, where the specified NMC (NMCIP_0 value) powers the two hosts in HOSTLIST_0: NMCIP_0=10.179.133.141 HOSTLIST_0=10.179.133.112 |10.179.133.113 Example of a UPS which is outlet-aware, where the specified NMC (10.179.133.145) powers the two hosts listed (ESXi1.testlab.com, ESXi2.testlab.com, and their outlets 0, 1 (after the & character) NMCIP_1=10.179.133.145 HOSTLIST_1= ESXi1.testlab.com&0|ESXi2.testlab.com&1 ENABLE_GUESTVM_MIGRATION= true | false Enable the migration of VMs with true. GUEST_VM_MIGRATION_DURATION = Specify the duration for VM Migration. The range is 0–172800 seconds. The default value is 120. The three fields below support registration and configuration of a physical NMC in an Advanced UPS Configuration. To signify a physical NMC, you enter an IP for NMCIP_n and leave HOSTLIST_n blank: for example, NMCIP_2=10.179.133.148 and HOSTLIST_2= SHUTDOWN_VIRTUAL_HOSTS_n = yes | no Specify the host number (n) and yes to perform VM operations — like VM migration and shutdown and vApp shutdown — on all hosts being monitored by PowerChute. This is recommended if the UPS is powering a storage array or the physical machine where PowerChute is installed. SHUTDOWN_LOCAL_MACHINE_n= yes | no PHYSICAL_NMC_OUTLET_n = 0|1|2|3 Specify yes to shut down the machine (n) where PowerChute is installed. This is recommended if the UPS is powering the PowerChute machine. Specify the outlet group number (n) that PowerChute registers with. 0 is the Main Outlet Group. Any other numbers represent the Switched Outlet Groups. PowerChute Network Shutdown: Installation Guide Appendix A: Error codes for silent installations When using silent installations (and upgrades), you can use the list of error codes in the table below to understand what’s going wrong when the installation fails. For silent install using the shell script install.sh the error message is written to the terminal standard output. The error code can be retrieved using the $? variable. For Windows, the error code is written to a file called PCNSinstall.log. Error Code Error Message 0 1 Description Success: Indicates that installation succeeded. Usage: install.sh [-f <config file>]: Silent install with configuration file. Usage: Indicates that unrecognized parameters were passed to the installer. install.sh [-h|-H]: Print help. 4 Error: install.sh must be run with root privileges! Administrator Only: Indicates that a nonadministrator has tried to run the installer. 5 Error: Unknown OS. Unsupported OS: The installer has detected an Operating System it cannot support. 6 PowerChute Network Shutdown is already installed. Upgrade is not supported for this version. Upgrade Not Supported: Indicates that PowerChute cannot support upgrade from a previous installation of PowerChute. Please uninstall the existing PowerChute to continue with installation of PowerChute v.3.0.x. This can be due to the versioning being too old, or an attempted upgrade of a previous multiple install. Installation cancelled. 7 Installation cancelled. User Abort: Indicates that the user has aborted installation. 8 You must remove the installed version of PowerChute Plus. PC Plus Detected: Indicates that the installer has aborted due to the detection of a version of PowerChute Plus. 9 You must remove the installed version of PowerChute Business Edition Server. PowerChute Business Edition Detected: Indicates that the installer has aborted due to the detection a version of PowerChute Business Edition. 10 You must remove the installed version of PowerChute Server. PowerChute Server Detected: Indicates that the installer has aborted due to the detection of a version of PowerChute Server. PowerChute Network Shutdown: Installation Guide Error Code Error Message Description The error code 11 only applies on to the Japanese Standard installer. 11 VMware [Server/ Workstation/ Player] has been detected on your system. This version of PowerChute Network Shutdown does not support VMware. Please uninstall VMware Server, or consult www.apc.com for the required version of PowerChute Network Shutdown. HyperV or VMware Detected: Indicates that the installer has aborted due to the detection of HyperV or VMware. or Microsoft Windows Hyper-V has been detected on your system. This version of PowerChute Network Shutdown does not support Hyper-V. Please disable Hyper-V, or consult www.apc.com for the required version of PowerChute Network Shutdown. 12 One of: Error: Too many INSTALL_DIR in silentConfiguration.ini. Invalid Install Directory: Indicates that the installer has aborted due to an invalid target directory. Error: INSTALL_DIR must start with '/'. Installation directory must start with "/". Error: INSTALL_DIR must not contain white space. Error: INSTALL_DIR must not contain back slash "\". Error: INSTALL_DIR is not configured. Installation directory must not contain white space " ". Installation directory must not contain back slash "\". Failed to create directory <install directory>. 13 Installation cancelled. Invalid Java Version: Invalid version of Java specified in configuration file. 14 This version of PowerChute Network Shutdown does not support the Japanese language. Please consult www.apc.com for the required version of PowerChute Network Shutdown. Unsupported Locale: The installer has detected an attempt to install an English build on a Japanese system. 15 Can't find <zip filename> Zipfile Missing: Indicates that the installer cannot find the zipfile, from which to extract the PowerChute install. 16 Error: Invalid file <filename> Silent Configuration Missing: Indicates that the installer has aborted because the specified silent configuration file could not be read. 17 Error: EULA must be accepted by setting ACCEPT_EULA=YES in config file EULA Not Accepted: Indicates that the installer has aborted because the End User Licence Agreement was not accepted. 18 [Error]: <configuration value> is not defined in <configuration file>. Silent Configuration Missing Parameter: Indicates that required parameters are missing from the silent configuration file. 19 [Error]: Too many <configuration value> in <configuration file> Silent Configuration Multiple Parameters: Indicates that a parameter is duplicated in the silent configuration file. PowerChute Network Shutdown: Installation Guide Error Code 20 Error Message Description Error: Too many JAVA_DIR in <configuration file>. Invalid Java Directory: Indicates that the installer has aborted due to an invalid Java directory specified in the silent configuration file. One of: Error: JAVA_DIR must start with "/". Error: JAVA_DIR must not contain white space " ". Error: JAVA_DIR must not contain back slash "\". Error: Invalid JAVA_DIR. <directory> does not exist. Java is not available on the path. Please specify a java directory. 21 [Error]: <21> Installation cancelled. Registry Failure: Indicates the installer has aborted due to an inability to write registry entries. 22 [Error]: <22> Installation cancelled. Service Failure: The installer failed to register the PCNS service. 23 [Error]: <23> Installation cancelled. M11 Backup Failure: The installer has failed to back up the m11.cfg data store during an upgrade. 24 ERROR: Invalid value for LOCAL_IP_ADDRESS specified in silent configuration file. The IP address was not specified: The installer cannot determine the host IP address, due to multiple network adapters. Aborting with error code <error code>. Invalid Localhost specified in the silent install configuration file. The IP address specified is not associated with the target server. 25 ERROR: Cannot write to specified ini configuration file: <ini file> Invalid INI. The silent installer cannot write to the pcnsconfig.ini file in the installation directory. 28 ERROR: Invalid value for mode specified in silent configuration file. Invalid Mode. Silent install configuration file specifies an invalid value for MODE. 29 ERROR: Invalid value for port specified in silent configuration file. Invalid Port. Silent install configuration file specifies an invalid value for PORT. 30 ERROR: Invalid value for protocol specified in silent configuration file. Invalid Protocol. Silent installation configuration file specifies an invalid value for PROTOCOL. The valid values are HTTP and HTTPS. 31 ERROR: Not enough UPS Network Management Card addresses specified in silent configuration file for specified mode. A minimum of 2 IP addresses are required for Redundant, Parallel, and Advanced Cluster UPS Configurations. 32 UPS Network Management Card has not responded to registration attempt. Registration has failed due to a timeout. Registration failed with NMC due to timeout. The NMC host address and the connection attempt were both fine, but the NMC failed to respond. 33 Bad UPS Network Management Card host address supplied. Registration has failed. The registration failed with NMC due to a bad host address. 34 Could not connect to UPS Network Management Card. Registration has failed. Registration failed with NMC because incorrect security information - user name, password, authentication phrase - was sent. 35 Could not register with UPS Network Management Card. Please check your configuration. Registration failed with NMC for a reason other than those cited in the error codes directly above. 36 Incorrect security details given. Registration has failed. Bad Security Values. Registration failed with NMC due to incorrect security credentials. PowerChute Network Shutdown: Installation Guide Error Code Error Message Description 37 UPS Network Management Cards specified are not part of a parallel setup. Not Parallel: Parallel registration attempted, but the NMCs are not part of a parallel configuration. 40 UPS Network Management Cards are not of the same family. Registration has failed. Not Same Models. Registration failed due to one or more NMCs not having the same model type. 41 Registration has failed due to untrusted SSL certificates presented from the UPS Network Management Card. SSL Error. Registration failed due to one or more NMCs presenting an untrusted SSL Certificate. 42 ERROR: Invalid value for <outlet group> specified in silent configuration file. Invalid outlet group. Silent installation configuration file specifies an invalid value for IP_<n>_Outlet 43 ERROR: Invalid value for username specified in silent configuration file. Invalid User Name specified in the silent install configuration file. The username has failed to pass the regex. 44 ERROR: Invalid value for password specified in silent configuration file. Invalid Password specified in the silent install configuration file. The password given has failed to pass the regex. 45 ERROR: Invalid value for authentication phrase specified in silent configuration file. Invalid Authentication Phrase specified in the silent install configuration file. The authentication phrase has failed to pass the regex. 47 Failed to establish an SSL connection to the UPS Network Management Card. Please verify the address and port specified. There was an SSL handshake error. 48 A valid JRE has not been detected. Please go to www.java.com (http://www.java.com) and install java, or change INSTALL_JAVA in the silentInstall.ini file. You need to install a supported public JRE or use the private JRE. 49 Silent configuration file contains multiple UPS Network Management Card addresses. Only one is required for single mode. There are too many NMC addresses set up: The silent installation configuration file specifies too many NMC addresses for the specified mode. 50 ERROR: Invalid value for NetworkConfig specified in silent configuration file. The NetworkConfig field value is invalid in the INI silent configuration file. 51 ERROR: Invalid value for IPv6NetworkConfig specified in silent configuration file. The IPv6NetworkConfig field value is invalid in the INI silent configuration file. Error codes 52–56 only apply in a VMware environment. 52 ERROR: Invalid value for ESXiConfigurationMode specified in silent configuration file. The ESXiConfigurationMode field value is invalid in the INI silent configuration file. 53 ERROR: Connection to VCenter Server <vCenter Server IP/Hostname> failed. There was a vCenter Server connection error. 54 ERROR: Connection to ESXi Host <ESXi IP/ Hostname> failed. There was a VMware Host connection error. 55 Invalid vCenter Server address. You have entered an invalid vCenter Server hostname. 56 Invalid ESXi Host address. You have entered an invalid VMware hostname. PowerChute Network Shutdown: Installation Guide Error Code Error Message Description Error codes 57, 58, and 59 only apply in VMware and Hyper-V environments. 57 Duration <Virtualization Operation name> entered is not a numeric value. Virtualization Operations – your duration value is not numeric. 58 Duration <Virtualization Operation name> should be between 0-172800. Virtualization Operations – your duration value range is outside the minimum and maximum values. 59 ERROR: Network mode is <IPv4/IPv6>. Please enter valid <IPv4/ IPv6>address for <NMC_IP/IP_1/ LOCAL_IP_ADDRESS > key. You have entered an IPv4 address instead of an IPv6 address or vice versa. PowerChute Network Shutdown: Installation Guide Schneider Electric IT Corporation Legal Disclaimer The information presented in this manual is not warranted by the Schneider Electric IT Corporation to be authoritative, error free, or complete. This publication is not meant to be a substitute for a detailed operational and site specific development plan. Therefore, Schneider Electric IT Corporation assumes no liability for damages, violations of codes, improper installation, system failures, or any other problems that could arise based on the use of this Publication. The information contained in this Publication is provided as is and has been prepared solely for the purpose of evaluating data center design and construction. This Publication has been compiled in good faith by Schneider Electric IT Corporation. However, no representation is made or warranty given, either express or implied, as to the completeness or accuracy of the information this Publication contains. IN NO EVENT SHALL SCHNEIDER ELECTRIC IT CORPORATION, OR ANY PARENT, AFFILIATE OR SUBSIDIARY COMPANY OF SCHNEIDER ELECTRIC IT CORPORATION OR THEIR RESPECTIVE OFFICERS, DIRECTORS, OR EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL, OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS, CONTRACT, REVENUE, DATA, INFORMATION, OR BUSINESS INTERRUPTION) RESULTING FROM, ARISING OUT, OR IN CONNECTION WITH THE USE OF, OR INABILITY TO USE THIS PUBLICATION OR THE CONTENT, EVEN IF SCHNEIDER ELECTRIC IT CORPORATION HAS BEEN EXPRESSLY ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. SCHNEIDER ELECTRIC IT CORPORATION RESERVES THE RIGHT TO MAKE CHANGES OR UPDATES WITH RESPECT TO OR IN THE CONTENT OF THE PUBLICATION OR THE FORMAT THEREOF AT ANY TIME WITHOUT NOTICE. Copyright, intellectual, and all other proprietary rights in the content (including but not limited to software, audio, video, text, and photographs) rests with Schneider Electric It Corporation or its licensors. All rights in the content not expressly granted herein are reserved. No rights of any kind are licensed or assigned or shall otherwise pass to persons accessing this information. This Publication shall not be for resale in whole or in part. 免責条項 本書に掲載の情報は、Schneider Electric が、信頼でき、誤りがなく、完全であること と保証するものではありません。本書は、詳細な運用および特定サイトを対象とした 開発計画の代替として意図されたものではありません。従って、Schneider Electric は、 本書の使用に基づいて発生する可能性がある損傷、法規違反、据付の誤り、システム 障害、またはその他の問題に対する責任を負わないものとします。 本書に含まれる情報は「現状のまま」で提供されるものであり、データセンターの設 計および建設を評価する目的のみに対応しています。本書は Schneider Electric によっ て作成されていますが、本書に含まれている情報に関する完全性あるいは正確さにつ いて、明示、暗示を問わず、事実の表示を保証をするものではありません。 いかなる場合においても、SCHNEIDER ELECTRIC、系列会社、または子会社、ある いはそれらの各事務所、役員、従業員は、SCHNEIDER ELECTRIC がそれらの損害 の危険性を明確に助言した場合でも、本書またはその内容の使用または非使用に関連 した、またはその結果生起した取引、契約、収入、データ、情報の損失または事業の 中断を含むがこれに限定されないあらゆる直接、間接、必然的、懲罰的、特別または 付随的損害に関して責任を負いません。SCHNEIDER ELECTRIC は、本書またはそ の形式に関し、またはその内容を事前に通知することなくいつでも変更または更新す る権利を保持します。 ソフトウェア、オーディオ、ビデオ、テキストおよび写真を含むがこれに限定されな い内容物の著作権、知的所有権、およびその他の所有権は Schneider Electric およびそ のライセンサーが保有します。本文に保証を明記されない内容物に関するあらゆる権 利を保有します。あらゆる権利のライセンス付与または譲渡は認められません。ま た、本情報を取得した人物への権利の許可も認められません。 本書の一部または全部の再販は禁じられています。 Worldwide Customer Support Customer support is available at no charge via e-mail or telephone. Contact information is available at www.apc.com/support/contact. Copyright © 1999–2013 Schneider Electric. All rights reserved. 990-2838H-001 2013-11-21