ST AppNote - ShoreTel | Support

ST AppNote - ShoreTel | Support
ST AppNote 17037 (AN 17037)
August, 2017
Best Practices for UC75 Deployment
Description: This Application Note describes the best practices for UC75 Virtual Machine
deployment as a part of a small to mid-size ShoreTel Unified Communications system setup.
Environment: ShoreTel IP-PBX versions Connect ONSITE
This document describes the best practices for deploying a ShoreTel Connect SBE 100 ONSITE
system on the ShoreTel UC75 server with VMWare ESXi Hypervisor 6.x. It covers hypervisor
installation, virtual machine provisioning, and deployment as well as installing ShoreTel Connect
ONSITE software and deploying additional virtual machines as the site requirement prescribes.
ShoreTel. Brilliantly simple business communications.
Page 1 of 21
Contents.......................................................................................................................... 2
Introduction ..................................................................................................................... 3
UC 75 Technical Specifications ...................................................................................... 3
Sourcing and USB creation of VMware ESXi 6.x ............................................................ 3
Install VMware ESXi on the UC75 server........................................................................ 5
Upload & Deploy Windows Server ISO (thick client) ....................................................... 6
Deploy ShoreTel Switch OVAs ..................................................................................... 11
Install SMIS Provider for RAID monitoring .................................................................... 12
Document and Software Copyrights.............................................................................. 21
Trademarks ................................................................................................................... 21
Additional Resources .................................................................................................... 21
ShoreTel. Brilliantly simple business communications.
Page 2 of 21
The UC75 server consists of a ShoreTel Branded 1U server, a 16 GB USB memory thumb drive,
and a Microsoft Windows Server 2016 COA (Certificate of Authenticity) license sticker. The
virtual machine hypervisor software is not included. This guide assumes VMware ESXi 6.5
software will be used for the host ‘bare-metal’ hypervisor OS.
UC 75 Technical Specifications
Mother Board
Storage Adapter
Hard Drives
SuperMicro X11SSM w/Intel Xeon E3-1275v6 3.8GHz
16GB DDR4 RAM 2400MHz ECC (2x8GB)
LSI MegaRAID SAS 9341-4i (12Gbps SAS3)
Seagate EC3.5v5 1 TB (x2 configured RAID 1)
SuperMicro 512L-200B 1U w/200W PS
Sourcing and USB creation of VMware ESXi 6.x
You can use your own purchased copy of vSphere or the free version available from VMWare.
The free version is feature limited. Visit the VMware website to learn more.
VMware vSphere Essentials Kit –
VMware vSphere Free Version –
A MyVMware account is required to use the vSphere free version. If you do not already have a
MyVMware account, you can create one from this link.
Once you have signed-in, click on the License & Download tab and copy the license key down
for future use. Begin the manual download of the most recent VMware vSphere Hypervisor
6.5x - Binaries available.
Copy USB drive contents to lab PC
Important! Before you do anything else, copy the entire contents of the included USB drive to
a folder on the desktop of your client lab PC. The contents include the sbe_version30.0.iso file.
In the following section, you will completely erase the USB drive to create a bootable USB drive
installer of VMware ESXi hypervisor, and therefore it is necessary to copy the contents now.
Note: You must review and accept the End User License Agreements (EULA), which are located
on the USB in the EULA subdirectory.
ShoreTel. Brilliantly simple business communications.
Page 3 of 21
Bootable USB creation
You can use a program like Rufus to turn the ISO image into a bootable USB installer. You can
download Rufus from here: Rufus runs as an executable and does not
actually install on your computer.
1. At the above web page: Scroll down to the Download section and download the
current Rufus version. Select the “Save” option to save the program to the lab PC.
2. Start the Rufus app by double clicking the rufus.exe from your download location. You
will be presented with an Open File – Security warning dialog. Click Run button to
3. Ensure you have copied off all contents from the USB drive.
4. Insert the USB drive. Once the USB drive is recognized, you will see the Device label at
the top change to reflect the USB drive is the focused device.
Note: All the contents of the USB drive will be overwritten.
5. About halfway down the app you will see the Format Options box. Make sure the
Create a bootable disk using setting is checked and click on the CD icon at the right.
(see red rectangle in image below) to open a file browse window. Navigate to and
select the VMware ESXi 6.x hypervisor ISO you previously downloaded.
6. Click the Start button. You may receive the following warning. Click Yes.
ShoreTel. Brilliantly simple business communications.
Page 4 of 21
7. A warning will be displayed that all previous data on the USB drive will be overwritten.
Click OK to proceed.
8. Once complete, the status bar will be green, and you can Close the Rufus application.
9. Remove the USB drive from the lab PC.
Install VMware ESXi on the UC75 server
1. Place the newly created VMware USB in one of the rear USB ports of the UC75 chassis.
2. Connect the video display, keyboard, and network connection.
3. Connect the UC75 to a power source., the UC75 powers on as soon as it is connected
to a power source.
4. As the display is flashing thru POST, press the F11 function key to access the boot
5. Select the USB drive to boot from, and then complete the following steps:
a. VMware installer will load and ask if you wish to install. Press Enter to continue
b. Accept EULA by pressing F11
c. Select disk AVAGO (capacity 931.00 GiB) to install to, and then press Enter.
d. Select the appropriate language, and then press Enter to continue.
e. Create and record a root user password, verify the password, and then press
Press F11 to confirm the installation.
6. Once installation has completed, remove the USB drive and press the Enter key to
reboot the UC75.
Configure network on UC75 server
1. When the VMware server has completed booting, you can press the F2 function key to
enter the Management Configuration. The root user password, which you created
during the installation process above, will be required for these changes.
Configure the ESXi server s with a static IP address that is outside your network’s DHCP
scope or that is reserved out of the scope to avoid any possible IP conflicts.
2. Using the arrow keys, navigate to Configure Management Network, and then press
3. Arrow down to IPv4 Configuration, and then press Enter.
ShoreTel. Brilliantly simple business communications.
Page 5 of 21
4. Select Set static IPv4 address, and then use the spacebar key to toggle the selection.
5. Change IPv4 Address, Subnet Mask, and Default Gateway to your network settings.
6. Press Enter to return to the Configure Management Network screen.
7. Press ESC to exit the Configuration screen.
8. Type Y to confirm the changes.
9. Press ESC to logout.
You can now reach the UC75 server via the ‘thin client’ (web browser) or by ‘thick client’
(VMware vSphere Client). The thick client must be installed if you wish to deploy any of the
ShoreTel switch OVA files available in ShoreTel Director, such as Virtual Service Appliance
(Collaboration), vPhone, vTrunk, virtual Mobility Router, virtual Edge Gateway, and so on.
Upload & Deploy Windows Server ISO (thick client)
Install vSphere Client (Thick Client)
Download the vSphere client software from this link:
Install the software on the lab PC. You will use this PC to access the UC75 server and
administer the virtual machines. This ‘thick’ client is necessary for deploying any of the ShoreTel
switch OVAs. The web or ‘thin’ client is unable to deploy these OVAs.
Assign a license key to Vsphere Hypervisor
1. Open the vSphere Client and point it to the UC75 host via the IP address that you
assigned to it in previous steps.
The user name will be root and the password will be the same password you previously
configured during the ESXi installation.
2. You will receive a Security Warning Dialog. Place a check in the Install this certificate…
checkbox, and then click the Ignore button.
ShoreTel. Brilliantly simple business communications.
Page 6 of 21
3. You will be presented with Evaluation notice. Click OK to acknowledge the dialog.
4. Highlight the IP address of the Host in the upper left. (Shown here as
5. You can enter the free, or purchased ESXi license key you recorded earlier from the
VMware site. Click the Configuration tab, and then select the first item under Software
section, Licensed Features. Once you have selected Licensed Features, click Edit…
6. In the Assign License dialog, select the Assign a new license key to this host radio
7. Click the Enter Key… button.
8. Type or paste the license key in the appropriate field, and then click OK. Click OK again
to close dialog.
ShoreTel. Brilliantly simple business communications.
Page 7 of 21
Uploading the sbe_version30.0.iso to the datastore
1. On the Configuration tab, select Storage under Hardware.
2. In the Datastores window, highlight datastore1. Right-click and select Browse
3. In the Datastore Browser window, highlight the slash and click the Add Folder icon.
4. Name the new folder ISO, and then click OK.
5. Select the ISO folder to highlight it, click the Upload icon
, and then select Upload
6. Browse to the sbe_version30.0.ISO you saved on the desktop folder of your lab PC and
select it. The ISO will take approximately 10 minutes to upload.
7. Click Yes to confirm the upload warning.
8. Close the Datastore browser when done.
Deploy UC Virtual machine.
This same method can be used for both the HQ server and a WinDVS server.
1. In the vSphere client, click on the menu bar item File – New – Virtual machine.
2. Click Next on Configuration. (Leave the radio button on Typical.)
3. Give the virtual machine a name such as HQ_Connect, and then click Next.
4. Click Next on Storage. (Leave default settings)
5. Change the version for Guest Operating System to Microsoft Windows Server 2016
(64-bit), and then click Next.
ShoreTel. Brilliantly simple business communications.
Page 8 of 21
6. On Network dialog, change Adapter to VMXNET 3, and then click Next.
7. For HQ server or DVS VM, change the virtual disk size to 200 GB and select the Thin
Provision radio button. Click Next.
8. On the Ready to Complete window, be sure that Edit virtual machine settings before
completion is checked. Click Continue.
9. Refer to the Getting Started Guide for proper allocation of memory/CPU resources for
the virtual machine you are deploying now.
10. Click on New CD/DVD, select the radio button for Datastore ISO file, and click the
Browse button. Double click datastore1, and then double click the ISO folder.
11. Highlight the sbe_version30.0.iso you previously uploaded and click OK.
12. At the top of the Properties window, place a check in the Connect at power on
checkbox for the CD/DVD.
ShoreTel. Brilliantly simple business communications.
Page 9 of 21
13. Click Finish.
14. You will now see the newly created VM in the left-hand pane. Select it and right-click to
bring up the context sensitive menu. Select Open Console.
15. Click on the Power On icon.
or VM – Power – Power On.
16. The virtual machine will power on and run thru a DISM install process. You will be asked
to confirm the install. Press Y for yes, and then click the Enter key.
17. The imaging process will begin and take approximately 10-12 mins to complete. The
VM will automatically power off when imaging is complete.
18. Power the VM back on as described above.
19. In the Console menu bar, click VM - Guest - Send Ctrl+Alt+Delete. Out of box
credentials are Administrator with a password of changeme .
20. You will be prompted to change your administrator password, it is recommended that
you do so to maintain prudent security practices.
21. Before doing anything else it is imperative that you go to Start Button - Windows
Administrative Tools - Services and change Quality Windows Audio Video
Experience to Startup Type Automatic, start the service, and then click OK to save
22. Close the Services window and the Administrative Tools window.
23. In the console window, click VM – Guest – Install/Upgrade VMware Tools.
24. Click OK in the Install VMware Tools dialog.
ShoreTel. Brilliantly simple business communications.
Page 10 of 21
25. Allow 15-20 seconds for the VMware tools ISO to be mounted as a CD/DVD, and then
open File Explorer in the console.
26. In File Explorer, select This PC in the left-hand window.
27. You will see a DVD Drive with VM as the icon. Double click this icon to initiate the
VMWare tools installer.
28. Click Next > Next > Install.
29. Once installation is complete, click the Finish.
30. A VM restart will be required. Click Yes to perform the restart.
31. Once rebooted, you will need to set a production IP address and host name.
32. Close the console window, and then restart the system. Refer to the ShoreTel Connect
Planning & Install Guide for further installation and implantation information.
Deploy ShoreTel Switch OVAs
Get switch OVAs from ShoreTel Director
Various switch OVAs are included with ShoreTel Connect Director and can be downloaded to
your client/lab PC for deployment using the vSphere ‘thick’ client.
1. In Director, go to System > Downloads.
2. You can select and download the Conferencing Collaboration Service Appliance from
here by clicking it and then clicking OK in the Save File dialog.
3. The system will prompt for location. Save the OVA locally on the client Lab PC you are
ShoreTel. Brilliantly simple business communications.
Page 11 of 21
4. Once the download is complete, open the vSphere client.
Deploy OVA using vSphere Thick Client
1. Go to File > Deploy OVF Template.
2. Use the Browse button to point to the OVA file you just downloaded.
3. Click Next.
4. Click Next.
5. Give the switch a meaningful name. (eg. VSA), and then click Next.
6. Change the radio button to Thin Provision, and then click Next.
7. Click Finish. The VM will be deployed.
8. Click Close when done.
9. You will see a new VM in the left-hand pane. You can now open a console window by
right-clicking the VM name and selecting Open Console.
10. Power on the VM and follow the configuration instructions as per the ShoreTel Connect
Planning and Installation Guide for the specific appliance you deployed.
Install SMIS Provider for RAID monitoring
1. Run the vSphere Client to connect to the ESXi host
2. Enable SSH on the ESXi host: Configuration > Software > Security Profile >
Services > Properties > SSH > Options… button > Start button > OK button.
3. Place ESXi host in Maintenance Mode: Summary > Commands >Enter Maintenance
4. Download the latest SMIS Provider from Broadcom with the link below.,+Controllers,+and+ICs&pf=RAID+Controller+Cards&pn
5. Under Management Software and Tools, locate Latest SMIS Providers for VMware
6.0 and 6.5, accept license the agreement, and save the file to the local disk.
6. Unzip the SMIS file and locate the vmware-esx-provider-lsiprovider.vib file.
ShoreTel. Brilliantly simple business communications.
Page 12 of 21
7. Use an SCP client for Windows, such as WinSCP, to copy the vmware-esx-providerlsiprovider.vib to the ESXi host /tmp directory.
8. Use Putty or another SSH tool to log into the ESXi host with root and the previously
established password.
9. Run command esxcli software vib install –v /tmp/vmware-esx-provider-lsiprovider.vib
Installation Result
Message: The update completed successfully, but the system needs to be rebooted for the
changes to be effective.
Reboot Required: true
VIBs Installed: LSI_bootbank_lsiprovider_500.04.V0.66-0002
VIBs Removed:
VIBs Skipped:
10. Disable SSH on the ESXi host: Configuration > Software > Security Profile >
Services > Properties > SSH > Options > Stop button > OK button.
11. Exit Maintenance Mode: Summary > Commands > Exit Maintenance Mode.
12. Reboot the ESXi host: Summary > Commands > Reboot.
13. Select the ESXi host: Configuration > Health Status > Supermicro Super Server >
The RAID controller and drives status are displayed
The RAID status must be checked manually. To check the status automatically and have an email
sent, follow the steps below.
Site specific configurations, such as firewall settings, may require additional changes to get email
delivery functioning.
The installation is performed on the HQ server. A remote PC can be used, but the installation
steps will be different.
Start and run SSH when the host starts.
ShoreTel. Brilliantly simple business communications.
Page 13 of 21
Storcli – command line tool communicates with the RAID card
Putty – Allows Putty plink to be used with the Windows batch file
Windows batch – Runs Storcli to check the RAID status and email a recipient
IIS 6.0 Manager – Edit relay to allow use of SMTP on HQ
Task scheduler – Runs the batch file at defined intervals
Follow the steps below to install the storcli utility driver. This utility can monitor the RAID
controller to show failed drives or failed RAID status.
1. Enable SSH on the ESXi host: Configuration > Security Profile > Services Properties >
SSH > Options > Start and stop with host > Start.
2. Click OK to save changes.
3. Download the latest MegaRAID Storcli from Broadcom with the link provided below.,+Controllers,+and+ICs&pf=RAID+Controller+Cards&pn
4. Under Management Software and Tools locate Latest MegaRAID Storcli for All OS,
accept license agreement and save it to the local disk.
5. Unzip the Storcli file and locate vmware-esx-storcli-x.xx.xx.vib under
6. Use an SCP client for Windows, such as WinSCP, to copy the vmware-esx-storclix.xx.xx.vib to the ESXi host /tmp directory.
7. Use Putty or another SSH tool to log into the ESXi host with root and the previously
established password.
8. Run the esxcli software vib install –v /tmp/vmware-esx-storcli-x.xx.xx.vib --no-sigcheck command.
ShoreTel. Brilliantly simple business communications.
Page 14 of 21
Installation Result
Message: Operation finished successfully.
Reboot required: false
VIBs Installed: LSI_bootbank_vmware-esx-storcli-1.23.02_1.23.02-01
VIBs Removed:
VIBs Skipped:
Useful commands to run on the ESXi host
/opt/lsi/storcli/storcli /c0 show
/opt/lsi/storcli/storcli /c0 /vall show
/opt/lsi/storcli/storcli /c0 /eall /sall show rebuild
1. Remove Putty version 0.60 from Programs and Features, and follow the prompts.
2. Download the current version of Putty from the link below.
3. Click on the Windows 64 bit installer and save the file to the local disk.
4. Launch the putty installer file from the saved location and follow the prompts to take
the default installation.
Windows batch file setup:
1. Create a directory on the HQ server: C: \uc75 .
2. Create a file in the uc75 directory called raidmon.bat .
3. Edit the file and add the text below, replacing ESXi host IP, ESXi password, and HQ IP,
mail recipient with the site-specific information.
ShoreTel. Brilliantly simple business communications.
Page 15 of 21
plink.exe ESXi_host_IP -l root -pw ESXi_password > "c:\uc75\status.txt" 2>&1
"/opt/lsi/storcli/storcli /c0 show"
find /c "FATAL" c:/uc75/status.txt
if %errorlevel% equ 0 goto noconnect
find /c " Dgrd " c:/uc75/status.txt
if %errorlevel% equ 0 goto degraded
goto done
powershell -command "& {Send-MailMessage -SmtpServer HQ_IP -To mail_recipient -From -Subject 'UC75 Connection timed out' -Body 'FATAL ERROR: Network
error: Connection timed out'}"
goto done
powershell -command "& {Send-MailMessage -SmtpServer HQ_IP -To mail_recipient -From -Subject 'UC75 RAID Degraded' -Body 'The RAID has degraded. Urgent
action required'}"
goto done
4. Save the file.
ShoreTel. Brilliantly simple business communications.
Page 16 of 21
IIS 6.0 Manager:
1. On the HQ server, launch Windows Start on the task bar.
2. Click the Windows Administrative Tools.
3. Open the Internet Information Services (IIS) 6.0 Manager.
4. Expand SHORETEL (local computer).
5. Select [SMTP Virtual Server #1], and then right-click, and open Properties.
6. Select the Access tab.
7. Select the Relay option.
8. Click Add and enter the HQ server’s IP address.
9. Click OK on each screen to save the entry.
10. Select [SMTP Virtual Server #1], right-click, and then click Start.
Task Scheduler:
1. On the HQ server, launch Windows Start on the task bar.
2. Select the search function and enter task scheduler.
3. Click on Task Scheduler Library, right-click, and select Create Task.
4. Select General Tab, and then complete the Enter a Name field.
5. Select Run whether user is logged in or not.
6. Configure for: Windows Server 2016.
7. Select Triggers tab, and then click New.
8. Select Repeat task every: customer defined for a duration of: indefinitely.
9. Click OK to save.
10. In the Actions tab, click New.
11. Browse to c: \uc75, and then select the script.
12. Click OK to save.
13. Click OK to exit task creation
14. If prompted for the user account information for running this task, enter User Name
Administrator and previously established password.
ShoreTel. Brilliantly simple business communications.
Page 17 of 21
Test script and Task Scheduler functionality:
1. On the HQ server, ensure that the Task Scheduler is enabled with a time to start and
interval to run.
2. Edit the raidmon.bat file, changing the value below from 0 to 1
if %errorlevel% equ 1 goto degraded
3. Save the file.
4. Double-click the raidmon.bat file to launch the script.
5. Press “y” to store the key in cache for putty. An email should arrive in the recipient
6. Allow the Task Scheduler to run the batch file based on the interval. Another email
should arrive in the recipient mailbox
7. Edit the raidmon.bat file, changing the value below from 1 to 0
if %errorlevel% equ 0 goto degraded
8. Save the file.
Commands to display status:
/opt/lsi/storcli/storcli /c0 show
/opt/lsi/storcli/storcli /c0 /vall show
/opt/lsi/storcli/storcli /c0 /eall /sall show rebuild
Commands to change drive states and start the rebuild.
/opt/lsi/storcli/storcli /c0 /e62 /sX set missing
/opt/lsi/storcli/storcli /c0 /e62 /sX set offline
/opt/lsi/storcli/storcli /c0 /e62 /sX set good
/opt/lsi/storcli/storcli /c0 /e62 /sX start rebuild
C0 = controller 0
E62 = enclosure ID
sX = slot, s0 for drive 0 or s1 for drive 1
ShoreTel. Brilliantly simple business communications.
Page 18 of 21
Additional Information:
The RAID controller card model is LSI MegaRAID SAS 9341-4i (12Gbps SAS3).
The controller card does not have a connection to the HD LED on the front panel of
the UC75. Drive activity will not show on the HD LED.
The controller card does not output an audio alarm when there is a RAID failure.
Accessing the controller card BIOS to configure the virtual drive is done from the
system BIOS setup, which you access by pressing F11 when the server is booting up.
MegaRAID card occupies PCI card slot 6. This slot is set to EFI (Extensible Firmware
Interface), and therefore the configuration is accessed via system BIOS. Use Ctrl+R
during boot to access the RAID controller configuration. This key combination is not
The UC75 hard disk drive information is below. This can be used to order a new
drive in the event of hard disk failure.
Seagate 1TB
The MegaRAID Storage Manager (MSM) is a tool that communicates to the RAID
controller. The utility is a GUI based tool that allows monitoring of the RAID and
drive health, rebuild status and drive actions. This utility, if installed, needs to be on
the same subnet as the ESXi host. Information can be found on the Broadcom site. It
ShoreTel. Brilliantly simple business communications.
Page 19 of 21
was not included in this document because it must be manually refreshed on RAID
or drive status changes, and this tool is unresponsive during the RAID rebuild.
LSI Storage Authority Software is another tool that monitors the RAID status. This
tool could be used to monitor the RAID health. Instructions can be found on the
Broadcom website. The tool was not evaluated at this time.
ShoreTel. Brilliantly simple business communications.
Page 20 of 21
Document and Software Copyrights
Copyright © 2017 by ShoreTel, Inc., Sunnyvale, California, U.S.A. All rights reserved. Contents of
this publication may not be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose, without prior written authorization of ShoreTel Communications, Inc.
ShoreTel, Inc. reserves the right to make changes without notice to the specifications and materials
contained herein and shall not be responsible for any damage (including consequential) caused by
reliance on the materials presented, including, but not limited to typographical, arithmetic or listing
ShoreTel, Inc., ShoreTel, ShoreTel Connect, ShoreWare, ShoreGear, and ShorePhone are
trademarks of ShoreTel, Inc. in the United States and/or other countries. VMware is either a
registered trademark or trademark of VMware Corporation in the United States and/or other
countries. Microsoft, Windows are either registered trademarks or trademarks of Microsoft
Corporation in the United States and/or other countries. All other copyrights and trademarks herein
are the property of their respective owners.
Additional Resources
• ShoreTel Partner Site
• VMware Community Forums
• VMware Knowledge Base
August 2017
ShoreTel. Brilliantly simple business communications.
S. Lopez &
M. Modzelewski
Original App Note
Page 21 of 21
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF