Tripp Lite PowerAlert

Transcription

1 Tripp Lite PowerAlert VMware Installation Instructions PowerAlert supports all VMware operating systems. This document details the steps required to properly confi gure PowerAlert to protect and shut down all versions of ESXi servers. Step 1: Install VMware vsphere Management Assistant (vma) PowerAlert must be installed on a virtual machine to provide the management of the UPS and trigger an ESXi shutdown upon detecting an event such as a power outage. The recommended confi guration is to install VMware s vsphere Management Assistant (vma) on the ESXi server, and then install PowerAlert onto the vma. Please visit for more information about downloading and installing the vma on ESXi host machines. If you already have a virtual machine, Windows or Linux, onto which you would like PowerAlert installed, then instead of installing the vma you can download and install VMware s vsphere CLI onto the target virtual machine, which provides the same scripting functionality as is built into the vma. Please visit VMware s web site for more information about downloading and installing the vsphere CLI. Step 2: Install VMware Tools VMware Tools must be installed on each virtual machine that is to gracefully shut down when the host receives a power outage notifi cation. 1. Open a vsphere Client and connect to an ESXi host server. 2. Click the Virtual Machines tab. 3. Per each virtual machine: a. Right-click on the VM, select Power Power On b. Right-click on the VM, select Open Console c. Right-click on the VM, select Guest Install VMware Tools d. Complete the VMware Tools installation via the virtual machine s console 1111 W. 35th Street, Chicago, IL USA Copyright 2012 Tripp Lite. All rights reserved.

2 Step 3: Configure ESXi Shutdown The ESXi host must be configured to allow automatic startup and shutdown of virtual machines (guest operating systems). The following steps provide information on configuring the ESXi host to gracefully shutdown the virtual machines: 1. Click the Configuration tab. 2. Select Virtual Machine Startup/Shutdown. 3. Click Properties, located in the top right hand corner of the panel. 4. Select the checkbox to allow virtual machines to start and stop automatically with the system. 5. Enter the appropriate default startup delay and default shutdown delay desired. 6. Choose Guest Shutdown for Shutdown Action. 7. Per each virtual machine that is to be shut down during a power outage: a. Select and highlight the VM b. Click the Move Up button until the VM is listed in the Automatic Startup section 8. Use the Move Up and Move Down buttons to order all VMs as desired. The following screen depicts a correctly configured Virtual Machine Startup and Shutdown dialog: 2

3 Step 4: Configure vma PowerAlert communicates through the network and must have ports 161, 162, 3664 and 3665 open in the firewall to allow it to communicate freely. Using the VIMA s Console, please enter the following commands to open these ports: sudo iptables I INPUT --p udp --dport 161 m state state NEW j ACCEPT sudo iptables I INPUT --p udp --dport 162 m state state NEW j ACCEPT sudo iptables I INPUT --p udp --dport 3664 m state state NEW j ACCEPT sudo iptables I INPUT --p udp --dport 3665 m state state NEW j ACCEPT Use the following command to save the firewall changes: service iptables save Step 5: Install PowerAlert Network Shutdown Agent PowerAlert Network Shutdown Agent does not communicate directly with the UPS. Instead, it communicates through the network to remotely connect to an SNMPWEBCARD installed in the UPS powering the ESXi Server, or to a PowerAlert Local running on a computer external from the ESXi Server. The Shutdown Agent continually monitors the SNMPWEBCARD or PowerAlert Local to determine when a critical shutdown event, such as a power outage, occurs. Installing the PowerAlert Network Shutdown Agent as detailed in Sections 5 and 6 of this document is the recommended solution. This solution requires the UPS powering the ESXi Server to have a Tripp Lite SNMPWEBCARD installed into it. An alternate configuration not requiring an SNMPWEBCARD is to install PowerAlert Local instead, which communicates directly to the UPS via an RS232 connection, and is detailed in Steps 7 and 8 of this document. Install PowerAlert Network Shutdown Agent onto the vma s virtual machine, or any other VM with a supported operating system. The steps below detail the installation onto VIMA. 1. Download the latest version of PowerAlert Nework Shutdown Agent for VMware ESXi from Tripp Lite s website at which contains all of the files to install PowerAlert Network Shutdown Agent onto the vma virtual machine, based on OpenSUSE. 2. Upload the RPM package to VIMA using a SCP Client. 3. Use the following command to install PowerAlert: sudo rpm ivh pasda-app xx-1.i386-opensuse.rpm nodeps Note: Four VMware script missing warnings will appear after the installation completes. Please disregard these warnings. 3

4 Step 5: Install PowerAlert Network Shutdown Agent continued PowerAlert manages and monitors the UPS, and then executes a script that instructs an ESXi host to shut down upon receiving a critical event, such as a power outage. The PowerAlert installation provides sample commandline scripts that trigger the ESXi shutdown ( shutdownesxi.bat for Windows, shutdownesxi.sh for Linux). These scripts, however, must be modified and configured for use in your environment, as follows: 1. Upload the shutdownesxi.sh script file to the VIMA s /home/vi-admin directory using a SCP Client. 2. On the VIMA, change to the home directory: cd /home/vi-admin 3. Change the attributes of the script by using the following command: sudo chmod 755 shutdownesxi.sh 4. Edit the configuration file: sudo vi shutdownesxi.sh 5. Change the parameters in the desired script to connect with the target ESXi host. a. The --server parameter specifies the address of the ESXi host b. The --username parameter specifies the user name used to log into the host c. The --password parameter specifies the password used to log into the host 6. This script can be extended as desired to shut down multiple hosts. 7. Save the changes to the script: :qcr (CR=carriage return) Sample Script #!/bin/bash # Change directory to directory containing vicfg script files cd /usr/bin # Resolves "server version unavailable" error caused by perl # module wanting to check a certificate, which may not be # available export PERL_LWP_SSL_VERIFY_HOSTNAME=0 # Trigger the host to shutdown based upon its preconfigured # settings. Be sure to change the server, username and password # parameters before use./vicfg-hostops --server username root --password <MyPassword> --operation shutdown force Note: It is suggested that you test your modified script before use within PowerAlert to ensure it performs successfully. 4

5 Step 6: Configure PowerAlert Network Shutdown Agent PowerAlert Network Shutdown Agent can be installed to detect a shutdown event such as a power outage, and is configured to monitor either a SNMPWebCard or a PowerAlert Local running externally from the ESXi host. (If you installed or are using PowerAlert Local, then please disregard this step). For conceptual convenience, the architecture of the SNMPWEBCARD shutdown solution is shown below: Basic Configuration The vma virtual machine only offers a command line interface; therefore, it is necessary to configure the PowerAlert Network Shutdown Agent using its paconfig.ini configuration text file. Alternatively, the Advance Configuration section, detailed below, provides information about using the PowerAlert Console from a remote Windows or Linux machine to configure the Shutdown Agent. Installing the PowerAlert Network Shutdown Agent RPM installs a sample configuration text file, named sample_paconfig.ini. Below is content from a sample configuration file: [PA_Remote] Server= SNMPMacAddress=00:06:67:23:66:6d SNMPVersion=1 SNMPCommunity=tripplite SNMPPort=161 SNMPTrapPort=162 [RemoteEvent] ShutdownEvents=On Battery ShutdownDelay=15 EnableExecuteCommand=true ExecuteCommandOnSet=/home/vi-admin/shutdownesxi.sh ExecuteCommandDelay=5 ExecuteCommandOnClear= [PA_Engine] EnableShutdownTimer=0 RemoteLoopbackDelay=2 RemoteThreadCount=25 RemoteTrapPort=162 5

6 Step 6: Configure PowerAlert Network Shutdown Agent continued The configuration file must be modified and configured for use in your environment, as follows: 1. Change the directory to the root installation directory: cd /var/tripplite/poweralert 2. Copy the sample configuration file: sudo cp sample_paconfig.ini paconfig.ini 3. Edit the configuration file: sudo vi paconfig.ini 4. In the PA_Remote section, change the Server to the appropriate IPv4 address. 5. In the PA_Remote section, the SNMPMacAddress is optional. Either enter the appropriate address, or remove the example value. 6. In the RemoteEvent section, change ShutdownEvents to Low Battery if you require maximum runtime. 7. In the RemoteEvent section, the ExecuteCommandDelay is the time the Shutdown Agent will wait before executing the shutdownesxi.sh script. 8. Save the changes to the configuration file: :qcr (CR=carriage return) After the file is changed, you must stop the PowerAlert Agent, delete all data files, and then restart the Agent. This is accomplished by entering the following commands: sudo service pasdad stop cd /var/tripplite/poweralert/data sudo rm rf * sudo service pasdad start It is also important to ensure that the PowerAlert Agent is configured to run at startup. Please enter the following command to enable running the Agent at startup: sudo chkconfig pasdad on 6

7 Step 6: Configure PowerAlert Network Shutdown Agent continued Advanced Configuration Configuring the advanced features of PowerAlert Shutdown Agent requires the usage of the PowerAlert Shutdown Agent Console (GUI). The Console is a Java program, which installs with every PowerAlert package and can connect remotely from another VM to the PowerAlert engine running on VIMA given the IP address of VIMA. Use the following command to determine the IP address of VIMA, as it is probably different than the IP address of the ESXi server: /sbin/ifconfig You need to launch a PowerAlert Shutdown Agent Console and connect to the PowerAlert engine daemon ( pasdad ) running on VIMA. You can do this from any machine that has a network connection to VIMA. The PowerAlert console is a Java GUI, so you need to install PowerAlert on whichever VM or computer you planned to use to configure PowerAlert. Please make sure, however, that your non-vima PowerAlert is either configured not to start automatically, unable to detect the UPS being used by VIMA, or uninstalled when you are finished with your configuration. Launch the Console on the non-vima system onto which PowerAlert was installed by using the -a command line argument, as follows: On Linux: sudo cd /var/tripplite/poweralert/console sudo./pasda_console.sh a<vima-ip-address> On Windows: cd \program files\tripplite\poweralert\console java jar sdaconsole.jar a<vima-ip-address> The above directories may be different depending upon the operating system used. Further, the -a option does not have a space between it and the IP address. The PowerAlert Shutdown Agent is configured to shut down an ESXi server by performing the following steps: 1. Click the Execute Command tab in the middle panel on the right side. 2. Select the desired delay upon receiving notification from the monitored PowerAlert before the Shutdown Agent notifies the ESXi host. 3. Enter the complete path to the shutdownesxi script file in the command to execute field. 4. Select the event(s) that will trigger the batch file execution upon entering into an alarm state from the list in the middle panel on the left side. 5. Click the Save button to save the changes. An ESXi host correctly configured to shut down its virtual machines should include the virtual machine onto which the Shutdown Agent is installed; therefore, the Shutdown Agent itself should be configured with Shutdown options disabled. 7

8 Step 6: Configure PowerAlert Network Shutdown Agent continued The following screen depicts a sample Shutdown Agent (Windows) console configured to execute the VIMA script file when a power outage occurs on the monitored UPS. 8

9 Step 7: Install PowerAlert Local PowerAlert Local communicates directly with the UPS via an RS232 serial connection to determine when a critical shutdown event, such as a power outage, occurs. Installing PowerAlert Local as detailed in Steps 7 and 8 of this document is NOT the recommended solution. The recommended solution uses Tripp Lite s PowerAlert Network Shutdown Agent to remotely connect to an SNMPWEBCARD, as documented in Steps 5 and 6. This solution should only be used when an SNMPWEBCARD is not desired. Install PowerAlert Local onto the vma s virtual machine, or any other VM with a supported operating system. The steps below detail the installation onto VIMA. 1. Download the latest version of PowerAlert Local for VMware ESXi from Tripp Lite s website at com, which contains all of the files to install PowerAlert Local onto the vma virtual machine, based on OpenSUSE. 2. Upload the RPM package to VIMA using a SCP Client. 3. Use the following command to install PowerAlert: sudo rpm ivh pal-app xx-1.i386-opensuse.rpm nodeps Note: Four VMware script missing warnings will appear after the installation completes. Please disregard these warnings. PowerAlert manages and monitors the UPS, and then executes a script that instructs an ESXi host to shut down upon receiving a critical event, such as a power outage. The PowerAlert installation provides sample commandline scripts that trigger the ESXi shutdown ( shutdownesxi.bat for Windows, shutdownesxi.sh for Linux). These scripts, however, must be modified and configured for use in your environment, as follows: 4. Upload the shutdownesxi.sh script file to the VIMA s /home/vi-admin directory using a SCP Client. 5. On the VIMA, change to the home directory: cd /home/vi-admin 6. Change the attributes of the script by using the following command: sudo chmod 755 shutdownesxi.sh 7. Edit the configuration file: sudo vi shutdownesxi.sh 8. Change the parameters in the desired script to connect with the target ESXi host. a. The --server parameter specifies the address of the ESXi host b. The --username parameter specifies the user name used to log into the host c. The --password parameter specifies the password used to log into the host 9. This script can be extended as desired to shut down multiple hosts. 10. Save the changes to the script: :qcr (CR=carriage return) 9

10 Step 7: Install PowerAlert Local continued Sample Script #!/bin/bash # Change directory to directory containing vicfg script files cd /usr/bin # Resolves "server version unavailable" error caused by perl # module wanting to check a certificate, which may not be # available export PERL_LWP_SSL_VERIFY_HOSTNAME=0 # Trigger the host to shutdown based upon its preconfigured # settings. Be sure to change the server, username and password # parameters before use./vicfg-hostops --server username root --password <MyPassword> --operation shutdown force It is suggested that you test your modified script before use within PowerAlert to ensure it performs successfully. 10

11 Step 8: Configure PowerAlert Local PowerAlert Local communicates directly via an RS232 communications port to detect a critical event, such as a power outage. (If you installed or are using PowerAlert Network Shutdown Agent, then please disregard this step.) For conceptual convenience, the architecture of the serial connection shutdown solution is shown below: Basic Configuration A sample configuration INI file was provided in the PowerAlert installation. This file must be manually modified using a text editor so it conforms to your environment. Please follow the instructions in the INI file. After the file is changed, you must stop the PowerAlert Agent, delete all data files, and then start the Agent. This is accomplished by entering the following commands: sudo service pald stop cd /var/tripplite/poweralert/data sudo rm rf * sudo service pald start It is also important to ensure that the PowerAlert Agent is configured to run at startup. Please enter the following command to enable running the Agent at startup: sudo chkconfig pald on 11

12 Step 8: Configure PowerAlert Local continued Advanced Configuration Configuring the advanced features of PowerAlert Local requires the usage of the PowerAlert Console (GUI). The Console is a Java program, which installs with every PowerAlert package and can connect remotely from another VM to the PowerAlert engine running on VIMA given the IP address of VIMA. Use the following command to determine the IP address of VIMA, as it is probably different than the IP address of the ESXi server: /sbin/ifconfig You need to launch a PowerAlert Console and connect to the PowerAlert engine daemon ( pald ) running on VIMA. You can do this from any machine that has a network connection to VIMA. The PowerAlert console is a Java GUI, so you need to install PowerAlert on whichever VM or computer you planned to use to configure PowerAlert. Please make sure, however, that your non-vima PowerAlert is either configured not to start automatically, unable to detect the UPS being used by VIMA, or uninstalled when you are finished with your configuration. Launch the Console on the non-vima system onto which PowerAlert was installed by using the -a command line argument, as follows: On Linux: sudo cd /var/tripplite/poweralert/console sudo./pal_console.sh a<vima-ip-address> On Windows: cd \program files\tripplite\poweralert\console java jar paconsole.jar a<vima-ip-address> The above directories may be different depending upon the operating system used. Further, the -a option does not have a space between it and the IP address. PowerAlert is configured to shut down an ESXi server by performing the following steps: 1. Click the Settings menu option at the top of the screen. 2. Click the Events menu option. 3. Select the event(s) that will trigger the batch file execution upon entering into an alarm state. 4. Check the Execute Command Script action. 5. Click the Settings button below the action settings. 6. Select the desired delay before the Shutdown Agent will notify the ESXi host to shut down. 7. Enter the absolute path to the shutdownesxi script file in the command to execute field. An ESXi host correctly configured to shut down its virtual machines should include the virtual machine onto which the Shutdown Agent is installed; therefore, the Shutdown Agent itself should be configured with Shutdown options disabled. 12

13 Step 8: Configure PowerAlert Local continued The following screen depicts a sample (Windows) console configured to execute a command script: The following screen depicts a sample Execute Command Settings dialog configured to execute the shutdownesxi script file: 13

14 1111 W. 35th Street, Chicago, IL USA Copyright 2012 Tripp Lite. All rights reserved