Platform upgrade

When upgrading the Adaptiva infrastructure to a newer version it is important to follow a top-down upgrade model. The order of upgrade should be as follows:

1. Adaptiva Server component

2. Adaptiva Client on the Adaptiva Server

3. Adaptiva Workbench on the Adaptiva Server (if applicable)

4. Adaptiva Workbench on administrator systems

5. All Adaptiva Clients

6. OneSiteDownloader in Boot Images (if applicable)

IMPORTANT: Elevated SQL permissions (sysadmin) is required to successfully complete the upgrade for both the account running the upgrade as well as the Adaptiva Server SYSTEM account.

Platform Component Upgrade Options

The options for upgrading each individual component are below:

Adaptiva Server

• Manual - Manually execute the new version of adaptiva-server-<version>-windows.exe and select the Upgrade option. Select Quick Upgrade or select Advanced Upgrade and select Next through each screen. No changes are required. This will also automatically launch the Adaptiva client upgrade. Click Launch, then Upgrade.

Adaptiva Workbench

• Manual - Manually execute the new version of AdaptivaWorkbenchSetup.exe and select the Upgrade option.

• Unattended - AdaptivaWorkBenchSetup.exe -installorupgrade

Adaptiva Client

• Manual - Manually execute the new version of adaptiva-client-<version>-windows.exe and select the Upgrade option.

• Unattended - adaptiva-client-<version>-windows.exe -installorupgrade -servername <serverFQDN>

  When upgrading Adaptiva clients using the -installorupgrade option, the current configuration, content cache, and all settings will be preserved. The P2P Client MSI Installer can also be used to perform a client upgrade as described above.

  IMPORTANT: When using Cloud functionality, be sure to include the appropriate command line parameters to enable this feature. I.e. -cloudrelay

Boot Image

• Manual - See the Adaptiva OneSite OSD User Guide to update the Boot image with the new OneSiteDownloader.exe. We recommend using the OneSite Boot Image Powershell Script. Alternatively you can use DISM or 7-Zip.

Server Upgrade

Be sure to review the database permissions as documented in the Installation Prerequisites section here: SQL permissions

New Antivirus Exclusions

For information about new required antivirus exclusions, see the Antivirus Exceptions section.

Server Upgrade Options

Quick Upgrade

Use this option to keep all the settings unchanged and begin the server upgrade.

• TLS Settings will default to self-signed with the server's FQDN and IP Address(es) in Subject Alternate Name list.

• A SQL login account will be created on the Adaptiva SQL Server. If the Adaptiva SQL Server is a remote server this will cause AdaptivaServerSetup to fail.

• If the TLS Settings and the Adaptiva Reporting Account have never been set, you must perform an Advanced Upgrade.

Advanced Upgrade

Use this option to customize each settings of the server upgrade.

1. Right click adaptiva-server-<version>-windows.exe, and then select Run as administrator.

1. Click Advanced Upgrade.

2. The following screen is used to provide the TLS Certificate configuration for use with the Admin Portal. Select which TLS Security Setting will be used to secure the Admin Portal.

Select one of the following TLS security settings, based on the preferences of your organization. These settings allow secure access to the Adaptiva Admin Portal for devices with the certificate:

• Select TLS Using A Certificate Authority (CA) to use a certificate you exported from a Certificate Authority. If you choose this option, the CA-based certificate must be installed on the devices requiring access to the Adaptiva Admin portal. An auto-enrollment GPO can be configured and targeted to specific devices or a wild-card certificate can be used.

  • Click Install A CA-Issued X.509 Certificate.

  • Click Browse, and then navigate to the location of the Certificate PEM File.

  • Click Browse, and then navigate to the location of the Private Key PEM File.

• Select TLS Using Self-signed Certificate to use a self-signed certificate. If you choose this option, you must provide the certificate to every Adaptiva Administrator who must add it to the Certificate store on the device from which they access the Adaptiva Admin Portal. See Add Certificate to the Root Store

  • Click Create A Self-signed X.509 Certificate.

  • Enter the names or IP addresses associated with the servers that host the Adaptiva Admin Portal. Be sure to include server details for NETBIOS, FQDN, DNS Alias or IP Address. Separate each entry by comma.

1. Click Next.

2. On the Integrations screen, you can optionally configure to integrate with Microsoft ConfigMgr or Workspace One. Click Next.

3. On the SQL Database screen, you will default to your exiting SQL configuration. Click Next.

4. On the SQL Login screen, you will need to provide a login account for reporting access. If you have previously configured these settings, leave the default values. Complete the fields as follows:

Use Windows Authentication -- Check this if the reporting account has been created in the domain.

This box will be checked and greyed out when Windows Authentication mode has been specified in SQL Server.

Domain Name -- Enter the NETBIOS domain name used for the reporting account.

Leave blank if Use Windows Authentication is unchecked and a SQL Login account is to be used.

User Name -- Enter the account name to use for the reporting account.

Password / Confirm Password -- Enter and confirm the password for the reporting account.

1. Click Next and the upgrade will proceed.

2. When the installation is complete, the Post-Installation Verifications screen will run connection checks.

Some of these checks may be skipped based on the settings selected. Also, there is a known issue when the Kerberos authentication protocol is selected for the Adaptiva database: The Read-Only Account Write Access Denied will report Failed. This can be ignored.

Client Upgrade on Server

You need to install the latest version of the Adaptiva Client the OneSite server.

Leave the default settings and click Upgrade.

Updated Admin Portal Build

When you open the Admin Portal you may a notification that an upgrade is available, click OK.

At the top of the windows, click on Dismiss for any notifications.

(Optional) Add New License Keys

OneSite Patch and its add-on License keys should only be added AFTER upgrading to a version of the OneSite Platform that supports that product. Contact Adaptiva Support if you have questions.

License keys can only be added in the Adaptiva Admin Portal. See License your Adaptiva solution

Automatic Client Upgrade

After you upgrade the Adaptiva Server, you can use the Client Upgrade feature for clients on version 9.3 or later. To upgrade older client versions, use the Legacy Client Upgrade (Windows) feature.

Legacy Client Upgrade (Windows)

Before continuing, make sure the Adaptiva Server has been updated to the latest version of the Adaptiva Client. The Client installer will be obtained from the Adaptiva Server client install folder. This folder can be found by using the ADAPTIVACLIENT environment variable.

1. Connect to the Admin Portal using a web browser (except Internet Explorer) -- <http://AdaptivaServerFQDN:[port]

2. Enter the appropriate credentials or click on Login with Active Directory

3. Click the gear icon | Settings | Legacy Client Upgrade (Windows).

4. At the top the dashboard will display the current coverage of the different versions in an overall chart and by location.

1. The Client Auto Upgrade must be enabled before the settings can be changed. Once enabled, it will stay enabled.

If it is already enabled, the last saved configurations will be set in each section below. Update as required and click on Save and Deploy.

IMPORTANT: Clicking Save and Deploy, or Deploy, will immediately execute the workflow to perform the upgrade based on the settings in the form.

Click to enable Enable Auto Client Upgrade.

Scheduling

1. Next to Schedule Start Time, click on the calendar icon to select the date and time. This will be the day and time that the client upgrade should start.

Clients that come online after the specified Start Time and have not yet received the policy will apply the policy immediately.

Click anywhere off the widget to close it. Notice the date and time has been entered into Schedule Start Time

1. Toggle Use Server Time Zone to have the specified start date and time refer to the time zone of the Adaptiva Server.

Target Groups

1. Toggle Use All Adaptiva Clients or click on Browse to select one or more Adaptiva Groups or ConfigMgr collections. When selecting a Group or collection, check the box next to the item. When finished selecting all groups/collections, click on Add to List.

Load Balancing

1. Toggle Use Load Balancing to enable load balancing. If not enabled, ALL targeted clients will execute the policy on the start date and time.

2. Set the Load Balance interval

The load balance interval can be between 0 and 100 Days, Hours or Minutes.

When Load Balancing is enabled, each client will be randomly divided across the load balance interval entered.

Installation

Choose either Server FQDN or IP Address. The Adaptiva Client can be installed using either the -servername or -serverip switches. This option determines which option is used. Notice the command line will change based on the options selected, e.g. The FQDN or IP address of the Adaptiva Server has been automatically entered.

IMPORTANT: Verify that automatic discovery found the correct Server Name or IP Address by reviewing the Command Line that was auto-generated.

To Override the FQDN or IP Address, toggle Override Server FQDN or IP Address and enter the Name or IP Address to use.

IMPORTANT: If the Name or IP Address previously used is changed, it will cause the client to be inactivated and re-activated, which will then trigger a review of all content in the AdaptivaCache folder as well as new policy downloads. If the FQDN or IP Address needs to be changed to support a DNS CNAME Alias see the following article here. How-To: Redirect OneSite client to a different Adaptiva server -- Adaptiva Support Portal

Choose any of the below options:

• Use Cloud Relay: Allows the Adaptiva client to communicate with http://services.adaptiva.cloud when unable to communicate via UDP to the on-premises Adaptiva Server.

IMPORTANT: If any of the in-scope clients have been previously configured to use the Cloud Relay Service, be sure to enable this setting otherwise client communications will stop using the Adaptiva Cloud Relay server.

• Bind to HTTP URL: Allows the Adaptiva client to communicate with the on-premises Adaptiva Server via the defined HTTP Port. This adds the -serverurl <url> to the command line.

When the Bind to HTTP URL is enabled, enter the URL of the on-premises Adaptiva server. For example: http://adaptivaserver.mydomain.com:9679.

• No Add/Remove Programs Entry: Enabling this setting will prevent Adaptive Client from being added to the Add & Remove Programs/Programs & Features list in Windows. Do not select this option if this information is required. Adds the -noarp switch to the command line.

• No Firewall Entries: Enabling this setting will prevent Windows Firewall entries from being created automatically. Adds the -nofirewall switch to the command line.

• No WoL: Enabling this setting will disable Wake on LAN. Do not select this option if it is desirable for machines to be woken using Wake on LAN magic packets in the event that content is available on the device, but the machine is offline. Adds the -nowol switch to the command line.

• Memory Allocation (in MB): This setting configures the maximum JVM memory allocation for the client. As of Adaptiva Client version 9.1, the default memory allocation is 512MB. Do not set this number below 512. It is recommended to set this value in powers of 2 starting at 512.

NOTE: The Memory value in the CLI Input shows the last value used and may differ from the Memory Allocation selection. Change the Memory Allocation to sync the CLI Input.

• Review the value of the Commandline to ensure that the servername | serverip is correct and that any required or desired command-line switches are present and displaying the correct values.

NOTE: Commandline will always contain the -delay 30 switch on the end. This cannot be overridden.

• Once the command-line has been validated, click Save and Deploy to start the upgrade process.

  

The command line must first be confirmed. Click OK after reviewing the Commandline.

These settings are saved in the database in the table AUTOUPGRADESETTINGS. Once you click Save and Deploy, the latest Adaptiva Client will be published as Adaptiva Content and a hidden schedule, group and content push policy will be created.

When the specified start date/time is reached, the clients will download the content. The content will get unpacked into a local folder on the client %TEMP%\AdaptivaClientUpgrade (normally C:\Windows\TEMP).

To review distribution status, scroll to the Version Coverage dashboard at the top of the page.