How to use FruitWorks DownBoy

Please note that this product is currently in beta, and as such these instructions are liable to change. Please review them if you are upgrading from an older version of Shutdown Manager, even if you are familiar with the product.

As with all beta software, it is also strongly recommended that you test the product in a suitable environment before deploying it to a production server.

 

Installing or Upgrading FruitWorks Shutdown Manager

First ensure that you have downloaded the latest version from the Downloads section.

If you are upgrading from an older version then it is strongly recommended that you uninstall the old version first. See instructions later in this section if you need to do this.

Launch the setup program and proceed as you see fit. You are welcome to change the installation folder if you wish, but it's fairly small in size. Shutdown Manager doesn't need to setup a database or create cache files so it's not going to take up a large amount of room on your installation drive. A typical installation takes up a few hundred KB in the installation folder, and then a few hundred KB to a few MB in the logfile folder (more on this later).

Once installed, launch the main application by clicking on Start > Programs > FruitWorksShutdown Manager > Shutdown Manager. You will be presented with the window similar to the one shown below, with the exception that the Shutdown Order box will be empty.

As you will see, Shutdown Manager has already queried your Hyper-V Host to get a list of the installed Virtual Machines (you might refer to these as "Guests", "VMs", or "Virtual Servers"). The next step is to add one or more of your Virtual Machines to the Shutdown Order list. You can do this using either the Add or the Add All buttons. Remove will remove a single Virtual Machine from the Shutdown Order, whilst Clear will clear the Shutdown Order list completely so that you can start again.

Once all of your chosen Virtual Machines are in the Shutdown Order list you can use the Move Up and Move Down buttons to adjust the Shutdown Order. Select a Virtual Machine in the Shutdown Order list and then click on either Move Up or Move Down accordingly. At execution time, Shutdown Manager will shudown the Virtual Machines in the order specified in the list, from top to bottom.

You can now set the Additional Settings to determine whether your Hyper-V host will either Do Nothing, Shutdown or Restart once all of the Virtual Machines have been shutdown.

This would be a good point to click on the Save button to save your chosen Shutdown Order and Additional Settings. This creates a file called Shutdown Manager.ini in the application's ProgramData folder (usually C:\ProgramData\FruitWorks\Shutdown Manager)

 

Testing Virtual Machines for Compatibility

You can use the three buttons in the Additional Settings pane to test and confirm that Shutdown Manager is able to shutdown all of your Virtual Machines gracefully:

Verify Chosen VMs
This will check that the selected Virtual Machine has the necessary Hyper-V tools installed such that it will respond to a shutdown command.

Shutdown Selected VM
This will immediately send the Shutdown command to the selected Virtual Machine.

Shutdown All VMs Now
This will execute the shutdown sequence as it appears in the Shutdown Order list. It is strongly recommended that you first Save your settings before executing this, as otherwise you may lose you changes if you have also set Shutdown Manager to Shutdown or Restart the Host.

 

Calling Shutdown Manager from the command line
(eg as part of a UPS-triggered shutdown script, or after Windows Updates have been run)

Once you're happy that Shutdown Manager is configured as you want it, you can add it as a command line to your shutdown script that fires when the UPS sends a shutdown signal to your server. To do this, add the following line to the end of your shutdown script (adding the path to your Shutdown Manager installation, which will be C:\Program Files\FruitWorks\Shutdown Manager\ if you accepted the default installation folder):

ShutMan.exe /execute

This will cause the Shutdown Manager console application to load, to read-in the INI file containing your preferred Shutdown Order, and execute the plan accordingly. Once all Virtual Machines have been shutdown then it will then either exit, or shutdown the host, or restart the host - depending upon the option that you chose.

 

Over-riding the shutdown or restart commands

You can also call Shutdown Manager with an override command to either shutdown or restart the host, regardless of what has been set in the INI-file. This allows you to have a single INI-file that contains the correct Virtual Machine Shutdown Order for your environment. You can then use this single INI file whether you want to shutdown the Host (eg when triggered by your UPS software) or restart the Host (eg after installing Windows Updates on the hosts). To do this, use the following commands to either restart or shutdown the Host accordingly:

ShutMan.exe /restart

ShutMan.exe /shutdown

 

Viewing or Clearing the Shutdown Manager logfile

You can view the Shutdown Manager logfile by clicking on Tools > View Log. This will open the logfile in Notepad for you to view. This logfile can be useful for troubleshooting purposes if Shutdown Manager is failing to shutdown one of your Virtual Machines gracefully. It also gives you a record of the activity performed during the last Shutdown sequence.

You can clear the Shutdown Manager logfile by clicking on Tools > Clear Log. This simply purges Shutdown Manager.log which is contained in the application's ProgramData folder (usually C:\ProgramData\FruitWorks\Shutdown Manager).