# Install and Upgrade Applications

Note: ServiceLink is not supported for MiCollab deployments in MiCloud Flex on GCP (Google Cloud Platform) environment.

## Description

Use this panel to upgrade and install MiCollab software for applications, services and security update blades.

Note:

- Ensure that the MiCollab server is NOT processing calls during an upgrade. Upgrading should be done outside of business hours.

- For Virtual MiCollab and MiVoice Business Express systems that are installed in a VMware environment, you can only use this panel to perform upgrades within the same release (for example, from Release 7.1 to 7.1 SP1). For major upgrades (for example from Release 7.0 to 7.x or from Release 7.x/8.x to 9.0) you must deploy a new OVA file. Refer to the MiCollab Installation and Maintenance Guide or MiVoice Business Express Deployment Guide for instructions.

- If you are using Internet Explorer to do these procedures, ensure that the Browser mode and Document mode are set to IE 9 or higher. To access these settings, press F12 while Internet Explorer is open. After you select the correct modes, the software installation will proceed smoothly.

- Downgrading MiCollab software to a previous (lower) release (for example, from Release 7.1 to 7.0) is not supported.

- All new MiCollab installations from R9.2 onwards will have MiCollab Client in an integrated mode by default.

- In case of an upgrade to R9.2 and above, the MiCollab servers in co-located mode will remain in co-located mode only.

## Installed Application Summary Tab

The Installed Application Summary tab lists the MiCollab applications, services and security update blades that are currently installed on the server.

Note: In case of a download error due to network time-out or network error, the Admin again needs to start the downloading process manually. Downloads will not continue for that single file which ran into an error, but if some downloads were successful before the error, the download will not be repeated once the download resumes.

Field | Description
--- | ---
Blade | Abbreviated name of blade
Version | Version number of currently installed application blade
Status | Installation status (installed)
Description | Full name of application. In some cases a brief description of the application is also provided
Documentation | Link to documentation (if provided)

## Install Applications Tab

Use the Install Applications tab to perform the following functions:

- Select the PBX type with which this server will interact (the first time you access the tab)

- View application information for unique MiCollab software releases.

- Determine the current status of your applications, services and security patches

- Install new applications, services and security update blades

- Upgrade existing applications (service pack updates), services and security patches

## Selecting a MiCollab Version and Determining its Software Status

Use this procedure to select a MiCollab software version and determine the current status of its applications, services and security patches. By default, the system displays information pertaining to the currently installed MiCollab software version.

To select a MiCollab software version and determine the status of its applications, services and security patches:

1. Under ServiceLink, click Install Applications.

2. Click the Install Applications tab.

3. To view licensed applications, services and security patches for a particular MiCollab software release, make a selection from the Select a version drop down menu:

   The system downloads application information from online Software Download Center (SWDLC) and displays it in a table. Note that application information for the currently installed MiCollab version is displayed by default.

   Field | Description
   --- | ---
   Application | The name of the application, service or security patch.
   Version | This field lists the latest version of application software that is available for this version of MiCollab .
   Install | If this field contains the word installed, the latest version of application software is currently installed on the system. If this field contains a blank check box, new application software is available for installation. To install it, select the check box and click the Install button. If this field contains a preselected check mark, new application software will be installed when you click the Install button.
   Update | If this field contains a preselected check mark, updated application software will be installed when you click the Install button.
   Download Online | Use this field to specify whether the software is to be downloaded from Software Download Center (the default) or locally from CD/DVD or USB. To download from SWDLC, select the check box. To download locally, clear the check box.

4. To view application information for a different version of MiCollab software (if available), make a selection from the Select a version drop down menu.

To download software from SWDLC, the firewall should allow the following connections and URLs:

- Licence entitlement:

  - register.mitel-amc.com port 22

  - sync.mitel-amc.com port 22

- Access token for contact delivery network

  - swdlgw.mitel.com port 443 (occurs during available blade software list update)

- Content delivery/blades Akamai

  - swdl.mitel.com port 443 (download of software)

## Upgrading and Installing Software

1. Log on to Mitel MiAccess (formerly known as Mitel Connect).

2. From the left menu, select Software Download Center.

3. Under Navigate by categories, select MiCollab or enter MiCollab in the search box and press Enter.

4. Click MiCollab.

5. Click the download icon for the appropriate MiCollab Software Download version.

6. Download the required application .iso files (for example MiCollab NuPoint Unified Messaging) to a network drive or to a folder on your PC. Do not change the names of the files. When you click a link, you are presented with a software Disclaimer.

7. Save the application .iso files to a network drive.

8. Copy the files to CD/DVD or USB (physical or virtual).

## Connect CD/DVD/USB

To Physical Systems

- CD/DVD: To connect a CD/DVD to a physical platform, insert the CD/DVD in the drive
- USB: To connect a CD/DVD to a physical platform, connect the USB drive.

To Virtual Systems

- CD/DVD

  Prerequisites:

  - Before adding the CD/DVD drive, turn off the virtual machine.

  - If the ISO image files are not available on a local or shared datastore, upload them to a datastore from your local system by using the datastore file browser.

  To connect a CD/DVD to a virtual platform:

  1. In the vSphere Client Application, right-click on the virtual instance (for example: vMiCollab 6.2.3.0 build) and then click Edit Settings. The Virtual Machine Properties window opens.

  2. Click the Virtual Hardware tab.

  3. From the New device drop-down menu, select CD/DVD Drive and click Add. The new drive appears at the bottom of the Virtual Hardware list.

  4. Expand New CD/DVD Drive and select the device type.

     Option | Action
     --- | ---
     Client Device | Select to connect the CD/DVD device to a physical DVD or CD device on the system from which you access the vSphere Web Client. From the Device Mode drop-down menu, select Passthrough CD-ROM. When you turn on the virtual machine, select the media to connect to from the VM Hardware panel on the virtual machine Summary tab.
     Host Device | Select to connect the CD/DVD device to a physical DVD or CD device on the host. From the CD/DVD Media drop-down menu, select the media to connect to. From the Device Mode drop-down menu, select Emulate CD-ROM.
     Datastore ISO File | Select to connect the CD/DVD device to an ISO file that is stored on a datastore accessible to the host. Browse to the file containing the ISO image to connect to and click OK.

  5. (Optional) Select Connect At Power On to connect the device when the virtual machine turns on.

  6. (Optional) To change the device node from the default, select a new mode from the Virtual Device Node drop-down menu.

  7. Click OK.

- USB: You can add one or more USB passthrough devices from a client computer to a virtual machine on the virtual machine Summary page in the vSphere Web Client. The devices must be connected to a client computer that connects to the ESXi host on which the virtual machine resides.

  Prerequisites:

  - Ensure that a USB Controller is present.

  - Ensure that the vSphere Client application has access to the ESXi host on which the virtual machines are running.

  - Upload the ISO image files to the USB device.

  To connect a USB to a virtual platform:

  1. In the vSphere Client Application, right-click on the virtual instance (for example: vMiCollab 6.2.3.0 build) and then click Edit Settings. The Virtual Machine Properties window opens.

  2. Click the Virtual Hardware tab.

  3. Click the USB icon to the right of USB Devices under VM Hardware and select an available device from the drop-down menu.

  A Connecting label and a spinner appear, which indicates that a connection is in progress. When the device has successfully connected and the Summary tab refreshes, the device is connected and the device name appears next to USB Devices.

## Select a Software Download Method

By default, all software is set to download from the Software Download Center (SWDLC). You may, however, download the software from local storage media (CD/DVD or USB). Use this procedure to specify which download method you wish to use for each application, either the SWDLC or local.

To select the download method for an application:

1. Clear the Download Online check box.

   Each application now has its own Download Online check box. The boxes are cleared, indicating that MSL will attempt to download the application software from local media rather than the SWDLC.

2. Select a download method for each application:

   - To download from local media (CD/DVD or USB), clear the Download Online check box for the application.

   - To download from the SWDLC, select the Download Online check box for the application.

3. If installing from USB, click Query USB Storage Devices.

The system attempts to detect USB devices connected to the local computer. For each device that is found, the following information is displayed: Vendor name, Model name, and Volume label. When you install or upgrade an application, the system will search these devices for software (ISO files). If a device is not detected, it will not be searched.

## Install New Software

The first time you access the Install Applications tab, you will be prompted to select the type of PBX with which the server will interact: MiVoice 5000 , MiVoice Business , MiVoice MX-ONE , MiVoice Office 400, or MiVoice Office 250 .

To install new applications, services and patches:

1. Under ServiceLink, click Install Applications.

2. Click the Install Applications tab. If prompted, select the PBX Type with which this server will interact and then click Next.

   The list of licensed applications, services and security patches for the currently installed version of MiCollab appears.

   Note: The MiVoice 5000 , MiVoice MX-ONE , and MiVoice Office 400, are only supported in MiCollab Client Integrated Mode. If you are deploying MiCollab with one of these platforms, run the MiCollab Client Integration Wizard.

3. To display information for a different version of MiCollab software (if available), use the Select a version drop down menu.

4. Under the Install column:

   Field Contents | Description
   --- | ---
   | The word installed indicates that the latest version of the application software is currently installed on the system.
   | A blank check box indicates that new application software is available. To install it, select the check box and click the Install button.
   | A preselected check box indicates that new application software will be installed when you click the Install button.

5. Select the software download method, either from the Online (SWDLC) or local media (CD/DVD or USB).

6. Click Install to install the applications/services you have selected.

   Software downloads are queued and installed sequentially from the SWDLC or local media.

7. If required, you will be prompted to insert any optional software CD/DVDs. Click Continue. Progress is displayed.

8. When installation is complete, click Clear this report. The MSL server manager displays the installed applications.

9. Remove the CD/DVD, disconnect the USB, dismount the network share, or dismount the vSphere Datastore.

## Upgrade Existing Software

To upgrade existing applications, services and patches:

1. Under ServiceLink, click Install Applications.

2. Click the Install Applications tab.

   The list of licensed applications, services and security patches for the currently installed version of MiCollab appears.

3. To display information for a different version of MiCollab software (if available), use the Select a version drop down menu.

4. Under the Update column, a preselected check box displays for each currently installed application/service that will be upgraded with new software when you complete this procedure.

5. Select the software download method, either from the SWDLC preselected check boxes.

   Software downloads are queued and installed sequentially from the SWDLC or local media.

6. If required, you will be prompted to insert any optional software CD/DVDs. Click Continue. Progress is displayed.

7. When installation is complete, click Clear this report. The MSL server manager displays the installed applications.

8. Remove the CD/DVD, disconnect the USB, or dismount the vSphere Datastore.

Note: You can install and upgrade software simultaneously.

## Scheduler tab

Use the Scheduler tab to configure the server to download the latest available application updates at a specific date and time. Only applications available online on the SWDLC are downloaded. You can schedule the update downloading to be a one-time event, or one that recurs weekly or monthly. Optionally you can choose to receive notifications that will alert you about the available updates.

Note: The scheduler option is available only on a MiCollab or an MiVBX server.

Schedule Summary

Displays the result of the last scheduled event execution.

Scheduling Options

Complete the following steps to create a new scheduled event:

1. Under ServiceLink, click Install Applications. The Application Installation and Upgrade page opens.

2. Click the Scheduler tab.

3. In the Scheduling Options, select Enabled from the Scheduler service status drop-down.

4. Select the Send update notification check box if you want to be notified about an available update.

5. Configure the date, time, and frequency of downloading updates.

6. Click Save. The scheduler displays a confirmation that updates will be downloaded as scheduled by you.

Note: The installation needs to be done manually after the blades are downloaded as per the time scheduled in the scheduler.