\Adaptiva\AdaptivaServer\bin\AdaptivaServerService.exe`
**Windows Client Service**
* `C:\Program Files\Adaptiva\AdaptivaClient\bin\AdaptivaClientService.exe`
* `C:\Program Files\Adaptiva\AdaptivaServer\bin\AdaptivaUserPortal.exe`
* `C:\Program Files\Adaptiva\AdaptivaClient\bin\OneSiteClient.exe`
* `C:\Program Files\Adaptiva\AdaptivaClient\bin\OneSiteClient64.exe`
* `C:\Program Files\Adaptiva\AdaptivaClient\bin\amd64\OneSiteDownloader.exe`
**Linux and Mac Client Daemon**
* `/opt/adaptiva/adaptivaclient/bin/adaptivaclientd`
**MacOS-Only Client Daemon**
* `/opt/adaptiva/adaptivaclient/bin/adaptivauserd`
**ConfigMgr Client Service**
If using Adaptiva OneSite with ConfigMgr, ensure that the exclusions listed below are already in place. The following paths are included here for reference and completeness:
* `%windir%\CCM\CCMExec.exe`
* `%windir%\CCM\CMRCService.exe`
## Supported Browsers
Adaptiva OneSite supports the following browsers:
* Google Chrome
* Microsoft Edge
* Safari
* Mozilla Firefox \*
{% hint style="warning" %}
Do not use Microsoft Internet Explorer.
{% endhint %}
\* If you receive an Admin Portal login error when using Mozilla Firefox, see [Resolve the Mozilla Firefox Active Directory Login Issue](https://support.adaptiva.com/hc/en-us/articles/37109022499341-Resolve-the-Mozilla-Firefox-Active-Directory-Login-Issue) KB article.
## Adaptiva Client
The Adaptiva Client is an integral component of the Adaptiva OneSite Platform and must be installed on the Adaptiva Server for the OneSite Platform to function as expected. Install additional Adaptiva Clients on managed devices on the same subnet to share the content load.
### Adaptiva Client Requirements
The information in the table below details the minimum requirements for the Adaptiva Client installation.
| Component | Minimum Requirement |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Operating System | Many Windows, Linux, and MacOS operating systems are supported. See [Supported Operating Systems](/platform-install/overview/supported-systems#operating-systems). |
| Processor | 1 gigahertz (GHz) or faster, with 2 or more cores on a compatible 64-bit processor. |
| RAM | 4 GB minimum.
Allocate 256 - 512 megabytes (MB) to the Adaptiva Client Service (average 256 MB reserved, peaking to 512 MB under a full scan).
|
| Storage | 64 GB or larger storage device. |
### Adaptiva Client Installation Best Practices
Use the following best practices when installing the Adaptiva Client:
* Install the Adaptiva Client on the Adaptiva Server.
* Install the Adaptiva Client on all managed devices.
* Install additional Adaptiva Clients on the same subnet or Office as the Adaptiva Server to support content load sharing.
### Adaptiva Client Installation Options
When setting up the Adaptiva Client, you have the following installation options:
* Manually [install the Adaptiva Client](https://github.com/AdaptivaDocs/docs/tree/main/platform/install-guide/client-install.md) on the Adaptiva Server using the Adaptiva Client Installer. The Adaptiva Server Installer automatically launches the Adaptiva Client Installer dialog after installing the server.
* [Deploy the Adaptiva Client](https://github.com/AdaptivaDocs/docs/tree/main/platform/install-guide/deploy-clients.md) using an existing Software Distribution mechanism like Group Policy, Microsoft Intune, Jamf, WorkSpace ONE, or Microsoft ConfigMgr.
#### Identify the Adaptiva Client Installation Path
The Adaptiva Client installation uses the following default location:
`C:\Program Files\Adaptiva\AdaptivaClient`
You may also choose your own installation path.
{% hint style="info" %}
When installing the Adaptiva Client on the Adaptiva Server, use the same parent folder you used for the Adaptiva Server.
{% endhint %}
Record the installation path.
#### Record the Client Count
Determine the number of clients that will be connecting to the OneSite Platform and record the total count for licensing and sizing purposes.
## Admin Portal Communication
If another service is using port 443, a different port must be used during installation. Use `NETSTAT -nabo` to return a list of currently used ports. Adaptiva recommends using port 9678, which you can use if the default port is unavailable. Record this port to log in to the Admin Portal.
# Plan for ConfigMgr integration
Whether your ConfigMgr hierarchy includes a CAS with multiple child primary site servers, or a single, standalone primary site server, Adaptiva OneSite provides integration options during and after installation. Adaptiva recommends installing Adaptiva Server on a Primary Site Server or on a server within close network proximity of the Primary Site Server. The server installation location varies based on how your organization has designed the ConfigMgr environment.
## ConfigMgr Integration Best Practices
Use the following best practices when preparing to install the Adaptiva Server with your ConfigMgr hierarchy:
* Adequate disk space is available for Adaptiva and to store Adaptiva content.
* If the Adaptiva Server is not co-located with the Adaptiva Server ConfigMgr Site Server, you must grant the Adaptiva Server computer system account for the Adaptiva Server the necessary permissions.
* Use the NTLM V2 Authentication protocol when the ConfigMgr and Adaptiva databases are hosted on the same SQL Server. Or, if these databases are hosted on separate SQL Servers or need additional security, use Kerberos Authentication.
## ConfigMgr Integration Options
Based on the ConfigMgr hierarchy at your site, decide which of the Adaptiva Server installation locations works best for your organization. The placement of the Adaptiva Server services may vary based on the design and configuration of the ConfigMgr environment. Review the following integration options when choosing the installation location for the Adaptiva Server:
* Where can I install the Adaptiva Server?
* Adaptiva Server on the Primary Site Server
* Adaptiva Server on the ConfigMgr CAS only
* Adaptiva Server on the ConfigMgr CAS and each child Primary Site Server
* Adaptiva Server on a stand-alone server
* Where can I host the Adaptiva database?
* Adaptiva database on the Adaptiva Server
* Adaptiva database on the same SQL Server as the ConfigMgr database
* Adaptiva database on a dedicated SQL Server
### Adaptiva Server on the Primary Site Server
Integrating Adaptiva OneSite and a single ConfigMgr Primary Site is the simplest configuration. In this scenario, the Adaptiva Server is installed on the same server that hosts the ConfigMgr Primary Site Server and the SQL database.
### Adaptiva Server on the ConfigMgr CAS only
In this configuration, the Adaptiva Server is only installed on the CAS Site Server and not the Primary Site servers. ConfigMgr clients report to their Primary sites and Adaptiva Clients on these devices report to the Adaptiva Server on the CAS. All content and deployments must be sourced at the CAS level to function properly. Adaptiva will not detect any content or deployments originating from the Primary Site servers.
> **Note**
>
> The Adaptiva OneSite Policy Bandwidth Management feature cannot detect any applicable policy changes when the Adaptiva Server is installed on the CAS only.
### Adaptiva Server on the ConfigMgr CAS and each child Primary Site Server
In this scenario, the Adaptiva Server is installed on the CAS and each Primary site server. Installing Adaptiva on the CAS provides visibility into policies and published content originating on the CAS. Installing Adaptiva on each Primary Site Server provides visibility for content published on the Primary as well as the ability to notify clients of policy changes. This configuration is necessary when sourcing content or deployments from any of the Primary Site servers.
Depending on how your company uses Adaptiva, the administrative overhead for this configuration may be higher than other options, because there is no hierarchy in the OneSite Platform.
### Adaptiva Server Separate from the ConfigMgr
Another option is to install Adaptiva OneSite separately from the ConfigMgr Site server with SQL Server. This option is often used when there is a security requirement to isolate applications. For example, when integrating the Adaptiva Server with ConfigMgr High Availability.
Carefully consider the placement of your database. For instance, if the SQL Server is separate, you must set up the SPNs, Kerberos, and Linked servers. See [Database Considerations](/platform-install/planning-guides/onesite-platform-planning#database-considerations).
### Additional Database Considerations - Linked Servers
Because the Adaptiva Server uses a separate database, a link between the ConfigMgr database and the Adaptiva database must be created to enable cross-database reporting. The Adaptiva Server setup creates the necessary links in only one of the two scenarios below.
#### Adaptiva and ConfigMgr databases Share Same SQL Server but use Separate Instances
The Adaptiva Client setup creates two links, one in each instance linking to the other instance. The links are named using the FQDN of the SQL Server system hosting the default instance or the instance name for a named instance.
For example, if the FQDN of the server is `SQL-123.MyOrg.MyDomain.com`, and the default instance is used, then the link in the other instance is named `SQL-123.MyOrg.MyDomain.com`. If the database is in an instance named `Instance1` on the SQL-123 server, then the link in the other instance is named `SQL-123.MyOrg.MyDomain.com\Instance1`.
#### Adaptiva and ConfigMgr databases Hosted by Separate SQL Servers
Before installing the Adaptiva Server, you must manually create links in each instance of SQL Server. The linked server name on Server A must be the FQDN (including the instance name, if used) of the other SQL Server. During setup, the server checks for the existence of the link and verifies the appropriate permissions to ensure a successful installation. For additional information, see [Create linked servers (SQL Server Database Engine) (Microsoft)](https://docs.microsoft.com/en-us/sql/relational-databases/linked-servers/create-linked-servers-sql-server-database-engine?view=sql-server-ver15).
### ConfigMgr Security Settings
The Adaptiva Server requires the necessary permissions, including Site System, Content Library, Inboxes, and SQL Server, to communicate with the ConfigMgr server. No changes are required when installing the Adaptiva Server on the ConfigMgr server, and the Local System account is used.
#### Account Options
When installing the Adaptiva Server, you have the following account options to access ConfigMgr:
* Grant the Adaptiva Server access to ConfigMgr with its system account (default).
* Grant the Adaptiva Server access to ConfigMgr with a domain account.
It is not recommended to grant any accounts or groups the Full Administrator role. See the following minimum permissions:
* Download and import the custom Security role from the following location: `https://adaptiva.com/hubfs/Docs/Adaptiva%20Administrator.xml`
> **Tip**
>
> You can also create a custom Security Role named **Adaptiva Administrator** based on the **Read-Only Analyst** Built-in role and modify with the permissions found in the table below.
* Add the Administrative User that was chosen to be used.
* Add the Administrative User to the Adaptiva Administrator role.
* If using custom Security Scopes, select all instances of the objects that are related to the assigned security roles.
* Add the chosen account to the Local Administrators group on the Site Server, any Server hosting the SMS Provider role and the server hosting the ConfigMgr Content Library.
#### ConfigMgr Database Account Permissions
When installing the Adaptiva Server, you have the account options below to access ConfigMgr database on the SQL Server.
**Installation Account**
The account performing the installation on the Adaptiva Server must be granted the sysadmin role on the SQL Server where the ConfigMgr database is hosted or `db_owner` on the ConfigMgr database. These permissions can be reduced after installation. See the Adaptiva OneSite Platform Installation User Guide for more information.
**Database Access Account**
The Adaptiva Server installation defaults to using the Local System account. You can change this to a local account or a domain account. A SQL account could also be used. When you integrate with ConfigMgr, you must grant the selected account the sysadmin role on the SQL Server where the ConfigMgr database is hosted or `db_owner` on the ConfigMgr database. These permissions can be reduced after installation. See the Adaptiva OneSite Platform Installation User Guide for more information.
#### Other Account Permissions
**Reporting Services Point**
The Installation will create SQL Server Reporting Services (SSRS) reports on the ConfigMgr Reporting Server if it is already configured. The ConfigMgr Reporting Services Point Account must be granted `db_datareader` to the Adaptiva database so that reports can be executed.
**Child Site ConfigMgr Database**
When using PXE, the service account that the CAS SQL database server uses requires access to the child Primary Site databases.
ConfigMgr Database Security User Mapping minimum permissions (after installation):
* `db_datareader`
* `db_datawriter`
* `db_executer`
**File Systems**
The Adaptiva Server service will require access to the ConfigMgr Content Library and Inboxes defined by the ConfigMgr Site Servers. Add the chosen account to the Local Administrators group on the respective ConfigMgr Site Server.
#### Account Permission Details
The table below lists the permissions required for any service account running the Adaptiva Server service. Follow the instructions to make these changes in SQL Management Studio.
| Server | Account | Permissions |
| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ConfigMgr Site Server | Adaptiva Server System account or Optional Service account | Local Administrators group |
| SQL Server hosting ConfigMgr database | Installation account or Optional Service account | During installation, assign either Sysadmin or db\_owner to the installation account for the ConfigMgr database.
ConfigMgr Database Security User Mapping (optional service account) minimum permissions (after installation):
db\_datareader
db\_datawriter
db\_ddladmin
db\_executer
|
| SQL Server hosting Adaptivadatabase | ConfigMgr Reporting Services Point account | Adaptiva database Security User Mapping:
db\_datareader
|
| In a CAS SQL Server hosting a child Primary database | Adaptiva Server System account or Optional Service account | When using PXE, the service account that the CAS SQL database server uses requires access to the child Primary Site databases.
ConfigMgr Database Security User Mapping minimum permissions (after installation):
db\_datareader
db\_datawriter
db\_executer
|
| ConfigMgr Security | Adaptiva Server System account or Optional Service account | Adaptiva recommends granting the following minimum permissions:
\* Import the attached Security role or create a Custom Security role with the name AdaptivaAdministrator. This name is based on the default Read-Only Analyst role.For more information, see Configure role-based administration for Configuration Manager (Microsoft).
You can also use the Adaptiva Administrator.xml file to upload the permissions.
\* Add the following permissions:
- Application: Create, Delete, Modify, Modify Report
- Boot Image Package: Create, Delete, Modify
- Collection: Create, Delete, Delete Resource, Modify, Modify Collection Setting, Modify Resource
- Driver Package: Create, Delete, Modify
- Operating System Image: Create, Delete, Modify
- Operating System Upgrade Package: Create, Delete, Modify
- Package: Create, Delete, Modify, Modify Report
- Query: Create, Delete, Modify
- Site: Modify, Modify Report
- Software Updates: Modify Report
- Status Messages: Create, Delete, Modify Report
- Task Sequence Package: Modify Report
|
| Inboxes (SMS\_ share location) | Adaptiva Server System account or Optional Service account | If this account is not in the Local Administrators group, grant Full Control to the following path:
\\\\SMS\_\\inboxes
|
| Content Library | Adaptiva Server System account or Optional Service account | If this account is not in the Local Administrators group, grant read-only permissions to the Content Library.
The db\_executer role is created in each database using the following SQL command:
CREATE ROLE db\_executer
GRANT EXECUTE TO db\_executer
|
#### Record the Integration Details
When integrating the Adaptiva Server with an existing ConfigMgr Site, you must provide the necessary details to successfully connect the ConfigMgr Site Server during the Adaptiva Server installation. This integration also requires access to the SMS Provider, ConfigMgr database, Site Server inboxes, and the Content Library file system hosted by the ConfigMgr Site Server.
The Adaptiva Server installation may require configuration details such as the following:
* Collect the ConfigMgr Site Server FQDN.
* Collect the ConfigMgr three-character site code.
* Account chosen with access to the ConfigMgr Site Server components when not using Local System username and password. Domain name should be entered as Netbios name, not FQDN.
* Collect the ConfigMgr SQL Server FQDN.
* Collect the ConfigMgr Database Name.
* **Instance Name:** The default or `AdaptivaSQL` for SQL Server Express Edition.
* **SQL Server Port:** Defaults to 1433.
* Encryption status of the SQL database
* Account chosen that can access the ConfigMgr Database when not using Local System username and password. Domain name must be entered as Netbios name, not FQDN.
# Plan for Workspace ONE integration
Whether your Workspace ONE configuration includes the Adaptiva Server and AirWatch Cloud Connector (ACC) installed on the same server, two separate servers, or each component completely isolated, Adaptiva OneSite provides integration options at installation. Workspace ONE uses the ACC to contact the Adaptiva Server.
Adaptiva recommends installing the Adaptiva Server and ACC on the same server. The SQL Server is also installed on this server. This ensures platform performance and security as there is no outside network access to the Adaptiva Server with all components installed on one server.
## AirWatch Cloud Connector
Workspace ONE uses the ACC as a proxy to securely contact the Adaptiva Server by calling the Adaptiva APIs. The ACC must be installed before installing the Adaptiva Server. Install the correct version of the ACC. For more information, see [Enable AirWatch Cloud Connector from the Workspace ONE console (Omnissa)](https://docs.omnissa.com/bundle/AirWatchCloudConnectorVSaaS/page/EnableAirWatchCloudConnectorfromtheWorkspaceONEUEMconsole.html).
## ACC Account and Permissions
Grant Adaptiva the ACC permissions to integrate the Adaptiva Server with Workforce ONE during the server installation.
| Permissions | Account | Permission |
| ----------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ACC | AirWatch Service Account | Local Administrators group
Minimum permissions:
Registry Full Control access to the following paths:
- HKLM\Software\Adaptiva
- HKLM\Software\Microsoft\SystemCertificates
File System Read access for the following Adaptiva DLLs file path:
- C:\Program Files\Adaptiva
|
## ACC Integration Options
Based on the security requirements for your site configuration, decide which of the integration options below works best for your organization. In all cases, Workspace ONE requires the ACC installed on a server to communicate with the Adaptiva Server.
* Adaptiva Server, the ACC, and the Adaptiva Server on the same server.
* Adaptiva Server is separate from the ACC.
* Adaptiva Server, the ACC, and the SQL Server are each on separate servers.
### Adaptiva Server and the ACC on the same server
In this example, integrating the ACC and the Adaptiva Server on the same server is the simplest configuration and eliminates any network communications between the components.
### Adaptiva Server separate from the ACC
In this example, the Adaptiva Server and the ACC are installed on different servers. This configuration is often with SQL Server Express installed with Adaptiva.
### Adaptiva Server, the ACC, and the SQL Server each on separate servers
In this example, the `AdaptivaServerSetup.exe`, SQL Server, and ACC are completely separated, with each component installed on a different server. This enables the database administration team to maintain all databases on managed servers. This also provides for the use of Always On Availability Groups to cluster the SQL servers.
## Setting up the ACC
Enable the ACC in the Workspace ONE console, and then download the VSEC certificate to a designated installation path.
### Install the ACC
1. If the ACC is already installed, navigate to the following file path to open the log file **CloudConnect.log**:
`%InstallPath%\Airwatch\Logs\CloudConnector`
2. Search for **Starting CloudConnector**. The ACC must be version **19.7.0.0** or later.
3. If the ACC is not installed or if the ACC version is older than 19.7.0.0, open the Workspace ONE UEM console and navigate to **Groups & Settings | All Settings | System | Enterprise Integration | Cloud Connector**.
4. Select **Download AirWatch Cloud Connector Installer**.
5. Select **Open File** after the download has completed to start the installation.
6. In the UEM console, select **Test Connection** to verify if the ACC is active.
### Download the vSEC Certificate
1. Open the Workspace ONE UEM console, and navigate to **Groups & Settings | All Settings | System | Enterprise Integration | Peer Distribution | Adaptiva**.
2. Select the **Download vSEC Certificate** link to download the certificate to a location on your computer. This will be used later.
### Adaptiva Certificate for Workspace ONE Installation
After the Adaptiva Server setup is complete, you must return to the Workspace ONE UEM console to upload the Certificate on the **Adaptiva Peer Distribution Software Setup** page. Adaptiva automatically generates the `AdaptivaServer.cer` file and downloads it to a location on your computer during the Adaptiva Server installation.
### Adaptiva APIs
The ACC communicates with the Adaptiva Server by calling the **Adaptiva APIs**. The ACC requires access to the Adaptiva DLLs to call the Adaptiva APIs. The `.dlls` act as a shared library of content that allows multiple components simultaneous access. Adaptiva recommends installing the `.dlls` on the server hosting the ACC.
#### Install the DLLs
1. Locate the Adaptiva installation files from downloaded `.zip` file.
2. Copy the file `AdaptivaWorkspaceONEACCInstaller.exe` from Installers or Windows to the ACC.
3. Right-click on the `AdaptivaWorkspaceONEACCInstaller.exe`, select **Run as an administrator**, and then select **Yes** (if prompted).
4. This opens the **Installs Adaptiva DLLs To The Workspace ONE AirWatch Cloud Connector (ACC)** dialog. The current installation status appears on the dialog.
5. Select **Install**, and then select **Yes** on the **Are You Sure You Wish To Install Adaptiva DLLs?** dialog.
6. Select **OK** on the **Installation Was Successful** dialog.
You are now ready to install the Adaptiva Server and integrate it with Workspace ONE.
#### Record the Location Details
* Record either the FQDN or the internal IP address of the Adaptiva Server.
* Record the location of the downloaded vSec certificate.
* Record the location of the Adaptiva Server certificate, which defaults to the following path:
`\Adaptiva\Adaptiva Server\data\security`
# OneSite platform installation
Intro page for OneSite platform
This guide explains how to install the Adaptiva Platform components, which includes the Adaptiva server service and the Adaptiva Client agent. The installation is the same for all Adaptiva products (like OneSite Patch) since they are built upon the Adaptiva Platform. The server setup process installs components shared between OneSite Anywhere, OneSite for ConfigMgr, OneSite for Intune, OneSite for Workspace ONE, OneSite Patch, OneSite Health, and OneSite Wake. You can enable these products simply by adding the appropriate license key in the Admin Portal.
## Install the OneSite Platform
The Adaptiva Server will be installed first (which will include the Adaptiva Client on the server), followed by the workbench and finally, the endpoint devices.
* [Prerequisites](/platform-install/server-install/install-platform-prerequisites)
* [Install the OneSite Platform](/platform-install/server-install/install-platform)
* [Client installation](/platform-install/client-install-and-uninstall/client-install)
### Additional configuration
Some additional configuration may be required depending on your network topology or SQL configuration.
* [Network and connectivity requirements](/platform-install/additional-configuration/platform-communication-ports)
* [SPNs and Delegation](/platform-install/additional-configuration/platform-spns-delegation)
* [Optional Answer File](/platform-install/server-install/install-platform/install-platform-answer-file)
### Uninstall the OneSite Platform
The products also uninstall cleanly and leave no files or database entries behind.
* [Uninstall the Adaptiva Server](https://github.com/AdaptivaDocs/docs/blob/main/platform/install-guide/uninstall-adaptiva-server.md)
* [Uninstall client](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-uninstall)
# Platform pre-requisites
Installation pre-requisites
Review the [Planning Guide](https://docs.adaptiva.com/platform-install/planning-guides/onesite-platform-planning) prior to installation.
The OneSite Platform installation requires two files from the **Installer\Windows** folder:
`adaptiva-server--windows.exe`
`adaptiva-client--windows.exe`
The server needs to install the server and client files in order to communicate effectively with client devices. However, the client installed on the server does not operate in the same way as a client installer on a client device and does not participate in peer-to-peer sharing.
{% hint style="info" %}
The `` placeholder refers to the downloaded version of the executable.
All components require local administrator privileges to install.
{% endhint %}
## Verify connectivity
Please refer to the [communication port requirements](/platform-install/additional-configuration/platform-communication-ports) and ensure your server has proper communication with cloud services.
In the case of a SQL Server Express Edition installation, your server will need to connect to **.adaptivacdn.cloud** to download SQL Express.
## Verify user permissions
When using an existing SQL Server installation, the user performing the server installation **MUST** have **sysadmin** permissions in the SQL Server that will host the Adaptiva database.
When integrating with Configuration Manager, the user must have permission to the Configuration Manager Site and file server, as well as sysadmin permissions in the SQL Server hosting the ConfigMgr database.
These permissions are only required for the setup and can be reduced after successful installation. You can review the [Account Permissions](/platform-install/planning-guides/onesite-platform-planning#account-permissions) section of the Planning guide for additional information.
## Database Reporting Account
Starting in Build 8.3, you will need to create a database reporting account to ensure that the Adaptiva Server is operating at the highest level of security for your SQL Server environment. All data providers in the Adaptiva Server will use this account to query the Adaptiva database. The account will only be granted `db_datareader` permissions, ensuring that the account cannot change any data in the Adaptiva database or any other database hosted on the database server.
> NOTE: A domain account is recommended for use as the database reporting account.
> IMPORTANT: When SQL Server is remote from the Adaptiva Server, the installation will only be able to use a domain account. If a SQL account is required, open a support ticket.
When you install Adaptiva Server, the install will automatically grant permissions to the specified account.
## SQL Express
If selecting SQL Express Edition during installation, see the following pre-requisites
### Internet Access
If selecting SQL Express Edition during installation, the server must be able to connect to the internet to download Microsoft SQL Server Express Edition. This is only required if Express Edition will be installed during the Adaptiva Server installation.
If using the Cloud Edition, the Adaptiva Server must also be able to reach `http(s)://services.adaptiva.cloud`.
### SQL Express pre-installed
If SQL Express has been installed beforehand, make sure the following configuration changes have been made.
#### TCP/IP connections must be enabled
1. Open SQL Server Configuration Manager.
2. Expand **SQL Server Network Configuration** (not 32-bit), and select **Protocols for MSSQLSERVER** or the Instance name used.
3. Enable **TCP/IP** if not already.
4. Enable **Shared Memory** but Named Pipes can stay Disabled.
#### Enable SQL Server Browser
1. Select **SQL Server Services**.
2. Right-click **SQL Server Browser** and select **Properties**.
3. Confirm the Log on as setting is for **Local Service**.
4. Click **Start**.
#### Grant Local System account Sysadmin role
You can reduce account permissions after installation.
1. Install SQL Server Management Studio.
2. If the account does not exist under **Security | Logins** run the following T-SQL command:
```sql
CREATE LOGIN [NT AUTHORITY\SYSTEM] FROM WINDOWS WITH DEFAULT_DATABASE=[master], DEFAULT_LANGUAGE=[us_english];GO
ALTER SERVER ROLE [sysadmin] ADD MEMBER [NT AUTHORITY\SYSTEM];GO
```
## SQL permissions
If SQL Express Edition will NOT be used, then prior to installing the Adaptiva Server, the installation account (and service account, if planned to use) and the Adaptiva Server SYSTEM account must be granted sysadmin permissions in SQL, to allow the creation of the Adaptiva database and the connections to the ConfigMgr database if that is being used. Once the installation is complete, these permissions can be reduced for day-to-day operations if required.
### Pre-Install Instructions
1. In **SQL Management Studio** object explorer, expand the **Security** folder, right-click the **Logins** folder and select **New Login...**
2. Click on **Search...**, then ensure the Location is set to the domain and enter the username of the account performing the installation or will be the service account, click on **Check Names**, then **OK**
3. Select the **Server Roles** page and check the box for the **sysadmin** role.
4. Click **OK** to add the login.
### Additional prerequisites for ConfigMgr
1. Using **SQL Management Studio**, expand the **Security** folder and select **Properties** for the installation and/or service account
2. Select the **User Mapping** page, in the **Users mapped to this login** section, check the box next to the name of the ConfigMgr database and in the Database role membership section, check the box for the **db\_owner** role
3. Click **OK**
## Workspace ONE
The following steps must be completed before starting the Adaptiva Server installation. There are also post-installation steps that will need to be completed.
### Install/Update the Cloud Connector
The AirWatch Cloud Connector (ACC) component must be installed before installing the Adaptiva Server. Make sure it is the proper version. For instructions on this, see the [omnissa Workspace ONE documentation library](https://docs.omnissa.com/bundle/AirWatchCloudConnectorVSaaS/page/EnableAirWatchCloudConnectorfromtheWorkspaceONEUEMconsole.html).
1. If the ACC is already installed, open the log file **CloudConnect.log** in *%InstallPath%\Airwatch\Logs\CloudConnector*.
2. Search for *Starting CloudConnector*. The version should be **19.7.0.0** or later.
3. If it is not 19.7.0.0 or later, open the Workspace ONE UEM console and navigate to: **Groups & Settings** | **All Settings** | **System** | **Enterprise Integration** | **Cloud Connector**. Select **Download AirWatch Cloud Connector Installer** and install.
4. Click on **Test Connection** and validate the **AirWatch Cloud Connector is active**.
### Download the Certificate
Download the vSEC certificate for the current instance of Workspace ONE.
1. Open the Workspace ONE UEM console and navigate to: **Groups & Settings** | **All Settings** | **System** | **Enterprise Integration** | **Peer Distribution** | **Adaptiva**
2. Click the link to **Download vSEC Certificate** and store it in a convenient location as it will be needed later. Return to this page after the installation of Adaptiva to upload the Adaptiva certificate and provide the name or IP address of the Adaptiva server.
### Installing the Adaptiva APIs
The ACC will require access to Adaptiva DLLs in order to call the APIs provided by Adaptiva. To install these on the server hosting the ACC follow these steps:
1. Navigate to the Adaptiva Installation source folder
2. Run the **AdaptivaWorkspaceONEACCInstaller.exe** as an administrator and click Yes if prompted
3. On the **End-User License Agreement** screen click **Accept**
4. The dialog will show current installation status, click **Install**
5. When prompted: **Are You Sure you Wish To Install Adaptiva DLLs?**, click **Yes**
6. When prompted that the **Installation Was Successful**, click **OK**
# Platform install
Guidance on how to install the OneSite Platform.
These instructions are for On-Premises installations. Please see our [OneSite Cloud Portal](https://docs.adaptiva.com/cloud), for more information regarding our SaaS solution.
Adaptiva provides the installation files in a compressed (.zip) file. The latest version can be downloaded from the [Support Portal](https://support.adaptiva.com/hc/en-us).
The Zip file is password protected, please see instructions on the build page for more information.
The compressed file includes three folders.
* **Documentation** - Includes links to our docs site and a .pdf of Cumulative Release Notes.
* **Installers** - Server installer for the Platform in addition to client installers for both Windows and cross-platform.
* **Tools** - This folder contains tools used to troubleshoot issues under the advisement of our Support team.
## Installation Types
| | | | | |
|---|
| :rocket: | Quick Install | This is the best option for most environments. Quick Install will automatically download and configure SQL Server 2022 Express Edition and then install the Adaptiva Server with default options and a self-signed certificate. | | | /pages/3dMQc0HSPRRspXrG8AvS |
| :cubes: | Advanced Install | If you are using an existing SQL Server Standard / Enterprise Edition or need to use a CA-based certificate, then perform an advanced install. This will allow you to customize all server installation settings.
You will also need to pre-create an account used for reporting access on the Adaptiva SQL database. | | | /pages/aPLrZnBWhTUVeAE5bewl |
| :plug: | (Optional) Answer File | An answer file can be created to automate the installation of the OneSite Platform server. The executable must be run with administrative privileges. The answer file can only be created when the Adaptiva Server has not been previously installed. | | | /pages/EapUPcjCADcNKjH5HhFD |
# Quick Install
The Quick Install option will install the Adaptiva Server using default settings and *SQL Server Express Edition*. Configure your installation settings and add your license key to begin the OneSite Platform server installation.
{% hint style="warning" %}
Do not install Adaptiva Server on the Operating System (OS) C: drive. The OneSite product log files and the Adaptiva Content Library installed with the Adaptiva Server grow over time, which impacts storage and performance on the OS C: drive. The installer will prompt you to change the destination drive if you continue to install on the boot drive.
{% endhint %}
## Installation Wizard
1. Right click `adaptiva-server--windows.exe`, and then select **Run as administrator**.
2. Click **Browse** to navigate to and select the installation folder to a drive other than the C drive.
* If you continue with installation on the C: drive, you will see a warning dialog. Click **Yes** to ignore this warning if you still want to install on the C drive.
3. Configure your **Superadmin Login ID and Password**.
* **Use Windows Login**: This option will use either your current logged in account or one that you specify with your Windows credentials.
* **Use Custom Login**: This option allows you to supply an email address and password to create a server login. The email address is a username and does not need to be a valid email address.
4. Enter one or more license keys, separated by semicolons.
5. The following items are checked by default:
* **Create an Add/Remove Programs Entry**: The Adaptiva Server Installer will create an entry for OneSite Platform in **Windows Settings > Apps & Features**.
* **Add a Windows Firewall Exception for Server Application**: The Adaptiva Server Installer will add local exceptions in the Windows firewall for the default server ports (See [Communication Ports](https://adaptiva.com/hubfs/Docs/OneSite-Port-Detail.pdf)).
* **IMPORTANT**: Review any existing domain-based group policies (GPO) that configure or restrict Windows firewall rules or rule creation as they can prevent or override these Adaptiva-created firewall exceptions.
6. Click **Quick Install**.
7. Read the Quick Install Behavior prompt and click **Proceed**.
* The wizard will download and install SQL Server 2022 Express Edition. SQL Express will be installed and configured to use a SQL native reporting account. The Adaptiva Server will then be installed with default options using port *443* and a self-signed certificate for access to the Admin Portal.
8. When the installation is completed, click **Next**.
The wizard will perform a series of Post-Installation Verifications to validate the installation. The installation will skip some checks when not integrated with Microsoft Configuration Manager.
9. Click **Done**.
After the installation of the OneSite Platform server, you must install the Adaptiva client on this machine as well. Continue with [Client Installation on the Server](/platform-install/server-install/install-platform/install-platform-server-client-install).
# Advanced Install
How to install the Adaptiva Server with Advanced Install settings.
The advanced install option will allow you to customize the installation options for OneSite Platform, including using an existing SQL Server instance.
{% hint style="warning" %}
Do not install Adaptiva Server on the Operating System (OS) C: drive. The OneSite product log files and the Adaptiva Content Library installed with the Adaptiva Server grow over time, which impacts storage and performance on the OS C: drive. The installer will prompt you to change the destination drive if you continue to install on the boot drive.
This also applies to the SQL Server 2022 Express Edition installation.
{% endhint %}
## Configure Installation settings
Configure your installation settings and add your license key to begin the Adaptiva Server setup process.
1. Right click `adaptiva-server--windows.exe`, and then select **Run as administrator**.
2. Click **Browse** to navigate to and select the installation folder to a drive other than the C drive.
* If you continue with installation on the C: drive, you will see a warning dialog. Click **Yes** to ignore this warning if you still want to install on the C drive.
3. Configure your **Superadmin Login ID and Password**.
* **Use Windows Login**: This option will use either your current logged in account or one that you specify with your Windows credentials.
* **Use Custom Login**: This option allows you to supply an email address and password to create a server login. The email address is a username and does not need to be a valid email address.
4. Enter one or more license keys, separated by semicolons.
5. The following items are checked by default:
* **Create an Add/Remove Programs Entry**: The Adaptiva Server Installer will create an entry for OneSite Platform in **Windows Settings > Apps & Features**.
* **Add a Windows Firewall Exception for Server Application**: The Adaptiva Server Installer will add local exceptions in the Windows firewall for the default server ports (See [Communication Ports](https://adaptiva.com/hubfs/Docs/OneSite-Port-Detail.pdf)).
* **IMPORTANT**: Review any existing domain-based group policies (GPO) that configure or restrict Windows firewall rules or rule creation as they can prevent or override these Adaptiva-created firewall exceptions.
6. Click **Advanced Install**.
### Configure TLS Security Settings
TLS Security Settings will be used to secure the Admin Portal. The [Deployment Planning Installation Guide](https://docs.adaptiva.com/platform-install/planning-guides/onesite-platform-planning#security-certificate-options) provides details about Certificates.
1. Select one of the following **TLS security Settings**:
* **TLS Using A Certificate Authority (CA)**: use a certificate you exported from a Certificate Authority:
1. Click to select **Install A CA-Issued X.509 Certificate**.
2. Click **Browse** and navigate to the location of the exported **Certificate PEM File**.
3. Click **Browse** and navigate to the location of the exported **Private Key PEM File**.
* **TLS Using Self-signed Certificate** (default): use a self-signed certificate.
1. Click to select **Create A Self-signed X.509 Certificate**.
2. Enter the **names or IP address** associated with the Adaptiva server that will host the Adaptiva Admin Portal. Include any server details for NETBIOS, FQDN, DNS Alias or IP Address. Separate each entry with a comma.
2. Set the **Web UI Port** used by the Admin Portal. This defaults to port *443*, but if other services are using that port, we suggest that you use port **9678**.
* **IMPORTANT**: Be sure to share this port with all OneSite Administrators. It is required to access the Admin Portal.
#### Optional: Configure HTTP Proxy Configuration
If you are using an HTTP Proxy to route internet traffic, click **HTTP Proxy Configuration**.
1. Select your proxy configuration.
* **Don't Use an HTTP Proxy**: no proxy settings will be configured.
* **Prefer User Proxy Configured on the System**: a locally configured proxy will be configured.
* **User a Proxy Auto-Configuration (PAC) File**: supply the URL to your PAC file.
* **Use an HTTP Proxy Server**: supply the protocol, FQDN/IP of the proxy server, the port configured and a bypass list of semi-colon separated host names or IP addresses.
2. Click **OK**.
### Expected Client Count
1. Set the expected Adaptiva Client Count. Use the number determined from the Design Planning. The **Expected Total Number Of Adaptiva Clients** defaults to **5000**, which automatically sets the **Maximum Data Memory Buffer Size** to **2048 MB**.
2. Click **Next**.
### (Optional) Integrate 3rd party products
This installation dialog box provides third-party integration options for Microsoft ConfigMgr and Omnissa Workspace ONE.
* If you select **Integrate an Existing Microsoft ConfigMgr Site**, continue with [Integrate with ConfigMgr](/platform-install/server-install/install-platform/install-platform-advanced-install/install-platform-advanced-integrate-configmgr).
* If you select **Integrate With Workspace One**, continue with [Integrate with Workspace ONE](/platform-install/server-install/install-platform/install-platform-advanced-install/install-platform-advanced-integrate-workspaceone).
If you do **NOT** select an integration, continue with the Configure the SQL Database steps below.
### Configure the SQL Database
You can choose to install the SQL database on a new instance of SQL Express or an existing instance on a SQL 2017 or later server.
* If you select **Download and install free Microsoft SQL Express and auto-create database**, continue with [Option 1: SQL Express Installation](#option-1-sql-express-installation).
* If you select either **Create the database in ana existing SQL Server Instance** or **Create the database in the same SQL instance as ConfigMgr Site Database**, click [Option 2: Existing SQL Instance](#option-2-existing-sql-instance).
#### Option 1: SQL Express Installation
1. Select **Download And Install Free Microsoft SQL Express And Auto-create Database** and click **Next**.
2. Click **Next**.
3. At the SQL Express Settings screen enter where the SQL Server Express installer should be downloaded to and where SQL Server Express will be installed
* **Download Folder:** the folder where the SQLExpr\_x64\_ENU.exe will be downloaded.
* You can pre-download SQLExpr\_x64\_ENU.exe. Click Browse and navigate to the executable.
* **Installation Folder:** the folder where SQL Server 2022 Express Edition will be installed. Change the drive letter of the **Installation Folder** to a drive other than C.
4. Click **Next**.
5. Continue with [**Read-Only SQL Login For Reporting**](#read-only-sql-login-for-adaptiva-reporting).
#### Option 2: Existing SQL Instance
1. Select either **Create The Adaptiva Database In An Existing SQL Server Instance** or **Create the Database in the same SQL Instance as ConfigMgr Site Database** and click **Next**.
2. You will be prompted to confirm that your system meets the SQL Server pre-requisites:
3. Click **Continue**.
4. On the **Database Information** page, enter your SQL Server information.
#### Database Information
1. Select **SQL Instance Is Encrypted** if the SQL Server Instance is using encryption s.
2. If the **Default SQL Instance** is not used, uncheck the box and enter the **SQL Instance name**.
3. If the **Default SQL Port** is not used, uncheck the box and enter the **SQL Port**.
#### SQL Login
1. Enter the **SQL Server Machine Name** FQDN.
2. Select or enter a SQL account.
* (Recommended) Select **Use Adaptiva Server's Local System Account**.
* If you choose not to use the Local System Account, enter the NETBIOS Domain name, User Name and Password of the account with sysadmin permission in the SQL Server that will host the Adaptiva database.
* If the account specified is a SQL account, uncheck **Use Windows Authentication**.
3. Click **Next**.
4. If the account specified is different from the login account used for the service SQL Server (*MSSQLSERVER | InstanceName*) a dialog box will prompt you to verify the account used by the SQL Service.
5. Click **Yes** if the settings are correct, otherwise, click **No** and update the settings.
6. At the Windows Authentication Protocol for SQL dialog, select the authentication method that will be used to connect to the SQL database.
* **NTLM v2** is selected by default.
* If you require extended protection with SQL, you can select **Kerberos (Requires SQL SPN)**. To support Kerberos authentication, Service Principal Names (SPNs) must be created and delegated properly in Active Directory. For more information, please see our [SPNs and delegation](https://docs.adaptiva.com/platform-install/additional-configuration/platform-spns-delegation) page on how to create SPNs and delegate Kerberos authentication.
7. Click **OK**.
8. When the SQL Server hosting the Adaptiva database is different from the SQL Server hosting the ConfigMgr database, a message will be displayed.
* Be sure the Linked Servers are created before continuing and then click **OK**. For more information see [Create the Linked Servers](/platform-install/additional-configuration/platform-spns-delegation#create-the-linked-servers).
### Read-Only SQL Login For Adaptiva Reporting
Provide a SQL login for reporting.
1. Enter the account information to be used for reporting:
* **Use Windows Authentication** -- This box will be checked and greyed out Windows Authentication mode has been specified in the local 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 created for use as the reporting account.
* **Password** -- Enter the password for the reporting account.
* **Confirm Password** -- Confirm the password that you entered above.
* **IMPORTANT**: When SQL Server is remote from the Adaptiva Server, the installation will only be able to use Windows authentication. New Installations using SQL Express that did not use Quick Install will also be required to create an account and use Windows Authentication.
2. Click **Next**.
### Completing the Installation
1. The installation will begin.
2. When the installation is complete, click **Next**.
* The wizard performs a series of Post-Installation Verifications to validate the installation. The installation will skip some checks when not integrated with Microsoft Configuration Manager.
* **NOTE:** 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.
3. Click **Done**.
After the installation of the OneSite Platform server, you must also install the Adaptiva client agent onto this machine.
For instructions on how to install the client on the sever machine, please see our [Client Installation on the Server](/platform-install/server-install/install-platform/install-platform-server-client-install) page.
### Server Installation Logs
In the case where an administrator needs to troubleshoot an Adaptiva Server installation, the following table contains the installation log locations. Other logs exist in the installation folder.
| Function | Log Location and Name |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
| Server Installation Logs | %windir%\AdaptivaSetupLogs\Server\AdaptivaServerSetup.log
%install\_path%:\Adaptiva\AdaptivaServer\logs\Adaptiva\*.log
|
| Client Installation Log | %windir%\AdaptivaSetupLogs\Client\AdaptivaClientSetup.log
%install\_path%:\Adaptiva\AdaptivaClient\logs\*.log
|
Access Server logs by navigating to **Settings** > **Logs** in the Admin Portal, or by navigating to the following location:
`\Adaptiva\Adaptiva Server\Logs`
{% hint style="info" %}
OneSite Patch SaaS tenant logs can only be accessed by navigating to **Settings** > **Logs** in the Admin Portal.
{% endhint %}
The following options are available on the **Logs** page:
* **Download All Server Logs:** Downloads all Server logs, including component and workflow logs.
* **Download Server Error Logs:** Downloads Adaptiva Server error logs.
* **Clear Web Logs:** Clears all Admin Portal runtime information and errors recorded by the browser session.
* **Download Web Logs:** Downloads all Admin Portal runtime information and errors recorded by the browser session.
# Integrate Configuration Manager
(Optional)
On the Site Server Information screen, provide the information for the ConfigMgr Site Server that will integrate with the Adaptiva Server. This integration requires access to the SMS Provider, ConfigMgr database, Site Server inboxes, and the Content Library file system hosted by the Site Server.
1. Click to select **Integration with an existing Microsoft ConfigMgr Site** and click **Next**.
2. Enter the Site Server details using the information gathered during Deployment Planning:
3. Enter the **Machine Name** (FQDN) and 3-character **Site Code** of the ConfigMgr site server.
4. Enter the ConfigMgr Site Login details gathered during Deployment Planning.
We recommend using the default **Use Adaptiva Server's Local System Account** login. This is the simplest method of authentication of an Adaptiva Server connection with ConfigMgr.
> **Note**: If the Adaptiva Server is not co-located with the ConfigMgr Site Server you must grant the Adaptiva Server's computer object the necessary permissions in Configuration Manager.
If you choose not to use the Local System Account, enter the **Domain** (NETBIOS Domain name), **User Name** and **Password** for the domain account that has been granted the necessary permissions in Configuration Manager
5. Click **Next**.
**ConfigMgr Site Database Information**
On the Site Database information screen, provide the database information for the ConfigMgr Site Server that will integrate with the Adaptiva Server.
1. The Site Database fields will auto-populate from the settings obtained by the logged in user's permissions to the ConfigMgr Site Server. You can update the SQL Login information that you gathered during Deployment Planning.
2. Review the Site Database details and configure any additional settings:
**Machine Name:** the FQDN of the ConfigMgr SQL Server.
**Database Name:** the ConfigMgr database name.
If the SQL Server Instance is using encryption, click to select **SQL Instance Is Encrypted**.
**SQL Instance Name**: the SQL instance name.
**SQL Port**: the SQL port.
3. Review the SQL Login details and configure any additional settings:
**Reuse Login Settings That Were Specified For Site Server Login** is selected by default.
If you choose not to use the Local System Account, uncheck this box and uncheck **Use Adaptiva Server's Local System Account**.
Enter the **Domain** (NETBIOS Domain name), **User Name** and **Password** for the domain account that has been granted the sysadmin permissions in SQL Server hosting the ConfigMgr database.
If the account specified is a SQL account, uncheck **Use Windows Authentication**.
4. Click **Next**.
If the account specified is different from the login account used for the service SQL Server (MSSQLSERVER | InstanceName) a warning will be displayed showing the account used by the SQL Service.
5. Review the warning and if the settings are correct, click **Yes**, otherwise, click No and update the settings.
6. At the SQL Authentication Protocols dialog, select the authentication method that will be used to connect to the ConfigMgr Site database.
**NTLM v2** is selected by default when the ConfigMgr and Adaptiva databases are hosted on the same SQL server.
Select **Kerberos (Requires SQL SPN)** when the ConfigMgr and Adaptiva databases are hosted on different SQL servers or additional security is required. To support Kerberos authentication, Service Principal Names (SPNs) must be created and delegated properly in Active Directory. See Appendix B in this document.
7. Click **OK**.
**Specify Login Information for Accessing Site Server Files**
The **Login Information For Access To the Site Server's File System** screen allows you to specify an account that has the necessary permissions to access the Site Server's file system. Specifically, this account must be able to access the inboxes and the Content Library. Review the table of permissions required in the Deployment Planning Guide for ConfigMgr for potential actions required for this account.
1. At the **Login Information** screen, enter information to access the ConfigMgr file system.
**Reuse Login Settings That Were Specified For Site Server Login** is the default. Uncheck this box to specify an account.
If you choose not to use the Local System Account, enter the **Domain** (NETBIOS Domain name), **User Name** and **Password** for the domain account that has been granted the necessary permissions in Configuration Manager.
2. Click **Next**.
3. Continue with [Configure the SQL Database](/platform-install/server-install/install-platform/install-platform-advanced-install#configure-the-sql-database).
# Integrate Workspace ONE
1. Click to select **Integrate with Workspace ONE** and click **Next**.
2. At the **Please** **Specify Workspace ONE Settings** screen complete the following information:
**Certificate Location**: enter the path or browse to the location of the downloaded ACC certificate.
3. Record the location where the **Adaptiva Server Certificate For Workspace ONE** will be located after a successful installation: By default, this is **%*****InstallPath*****%\Adaptiva\AdaptivaServer\data\security**. The file will be called **AdaptivaServer.cer**.
4. Click **Next**.
# Install Client on Server
1. After the Adaptiva Server is installed, the Adaptiva Client must be installed on the server. At the **Launch Adaptiva Client Installer** dialog, the Client Installer Path will be displayed based on the relative path the server component was installed from.
2. Click **Launch** to begin the Client installation.
3. At the **Adaptiva Client Installer** dialog, complete the following
**Adaptiva Install Path:** Update the path as required. We recommend installing the Adaptiva client in the same parent folder as the Adaptiva Server (**%drive%:\Program Files\Adaptiva\AdaptivaClient**).
The installer will auto-populate the **Server Host Name or IP Address** and **Server GUID** fields.
4. Click **Install**.
5. When the installation is completed, the Client Validation Checks application will confirm the connectivity requirements for the Adaptiva client.
The **Client to Client** and **Cloud Relay Connection** check is not applicable for a server installation.
6. Click **OK**.
# Add a License
Add A License Key
{% hint style="info" %}
During installation you have the option to add license keys from the installer wizard. However, if you skipped that step or want to add additional keys, you can follow the steps below to add them from the Adaptiva Admin Portal
{% endhint %}
After the Adaptiva Server setup is complete, enable one of the evaluation licenses or install your Adaptiva-provided license key to enable the product. This will activate the product and prepare to license clients. License keys can only be added via the Adaptiva Admin Portal.
1. In a web browser, enter the Adaptiva Server Admin Portal URL: `https://AdaptivaServerFQDN[:Port]`.
2. At the Adaptiva Web Portal, click **Log in with Active Directory**. If an Adaptiva login account was created, enter the email address and password created during installation and click **Log in**.
* If you are using Mozilla Firefox, see Resolve the [Mozilla Firefox Active Directory Login Issue](https://support.adaptiva.com/hc/en-us/articles/37109022499341-Resolve-the-Mozilla-Firefox-Active-Directory-Login-Issue) KB article.
3. After logging in, the Adaptiva Web Portal will be displayed. A license must be added to activate the features of that product in the Adaptiva Web Portal.
4. Click **Manage Licenses**.
5. Click **Add Key**, enter your license key, and click **OK**.
6. Optionally, click **Start Free Trial**, select the product you wish to preview and click **OK**.
7. You will be prompted to Accept an End User License Agreement. Click **Accept**.
8. Your Adaptiva products will be listed on the left, with license details in the right pane.
9. Select an Adaptiva product to review the current license status.
* Notice the **License Count**, **Expiration Date** and specific **Licensed Collections** of devices targeted to receive the license.
## Target Clients for Licensing
1. In the Target Collections pane, target which clients will receive this license.
2. Toggle **Use All Clients**. In the confirmation window, click **OK**.
3. Optionally, click **Browse** and select a collection or group of clients, then click **OK**.
## Server Activation (OneSite Anywhere only)
Once you receive an activation code from Adaptiva continue with the next steps below. If you have not requested an activation code, see the section Server Activation in the [Installation Prerequisites](/platform-install/server-install/install-platform-prerequisites#server-activation-onesite-anywhere-only).
1. In a web browser connect to the Admin Portal -- `http://AdaptivaServerFQDN[:port]`.
2. Enter the appropriate credentials or click on **Login with Active Directory**.
3. Click on the  with the drop-down on the far right and select **Settings | Server Activation**.
4. On the Server Activation page, click **Activate Server**.
5. Enter the activation code provided by Adaptiva Support and click **OK**.
6. The Adaptiva Server Service will attempt to contact the Adaptiva Cloud Relay Server at [http://services.adaptiva.cloud](http://services.adaptiva.cloud/).
* If it cannot reach the service using port 80 you will the following error:
* If it successfully registers with the Adaptiva Cloud Relay Service, the Server activated slider will be slid to the right
Note the other information available in the Cloud Connect Adaptiva Server settings screen:
* **Customer name**: This is initially the FQDN of the Adaptiva server. After activation, it will display the name that was entered at the Cloud Relay Server.
* **Global ID**: Unique ID of the Adaptiva Server assigned at registration time
* **Tenant ID**: Unique ID of the Adaptiva Server. Also, part of the certificate issued to the server and make up the server's identity
* **Server GUID**: This uniquely identifies your Adaptiva Server and can be used for client installations. It is required if the client is being installed without connectivity to the Adaptiva Server, requiring the client to validate through the Adaptiva Cloud Relay Service.
# Optional - Answer File
Create a Silent Installation Answer file
An answer file can be created to automate the installation of the OneSite Platform server. The executable must be run with administrative privileges. The answer file can only be created when the Adaptiva Server has not been previously installed.
1. Right click `adaptiva-server--windows.exe`, and then select **Run as administrator**.
2. Configure your **Superadmin Login ID and Password**.
* **Use Windows Login**: This option will use either your current logged in account or one that you specify with your Windows credentials.
* **Use Custom Login**: This option allows you to supply an email address and password to create a server login. The email address is a username and does not need to be a valid email address.
3. Enter one or more license keys, separated by semicolons.
4. The following items are checked by default:
* **Create an Add/Remove Programs Entry**: The Adaptiva Server Installer will create an entry for OneSite Platform in **Windows Settings > Apps & Features**.
* **Add a Windows Firewall Exception for Server Application**: The Adaptiva Server Installer will add local exceptions in the Windows firewall for the default server ports (See [Communication Ports](https://adaptiva.com/hubfs/Docs/OneSite-Port-Detail.pdf)).
* \***IMPORTANT**: Review any existing domain-based group policies (GPO) that configure or restrict Windows firewall rules or rule creation as they can prevent or override these Adaptiva-created firewall exceptions.
5. Click **Answer File**.
6. At the Generate Installation Answer File dialog, enter or **Browse** to a location where the file will be created. Click **OK**. The answer file will be named *AdaptivaAnswerFile.txt* in the folder selected.
* The installation screens will proceed as described in the Server Installation section. Each answer will be saved in the Answer file. The installation will NOT install the product. Use the Server Installation section below to learn about each screen during the installation process.
7. When all the prompting screens are complete the answer file is created. Click **OK**.
* **NOTE**: If passwords were entered for the SuperAdmin ID or Service accounts, these passwords will be stored in clear text in the Answer File. Delete or secure the answer file after the installation has been completed.
## Install using the Answer File
If you have created an answer file, follow these steps to use the answer file to install the Adaptiva OneSite Server.
1. Open a Command Prompt as Administrator.
2. Navigate to the installation source folder.
3. Enter the following command:
`adaptiva-server--windows.exe -InstallOrUpgrade %path%:\\`
4. There is no progress bar during the installation. The installation can be monitored using the Task Manager, monitoring the *adaptiva-server.exe* process and by monitoring the log file **C:\Windows\AdaptivaSetupLogs\Server\AdaptivaServerSetup.log**.
5. Upon successful installation the `adaptiva-server--windows.exe` process will be replaced with *AdaptivaServerService* and the *AdaptivaServerSetup.log* will show:
`~performSilentServerInstall(): 2C58: Line: 160: Server installation was successful`
{% hint style="info" %}
The server installation normally launches **adaptiva-client-\-windows.exe** to install the Adaptiva Client. The silent installation does not do this. Be sure to install the Adaptiva Client on the server as well.
{% endhint %}
# Post installation
Post-installation tasks for configuring the OneSite Platform.
## Add certificate to the root store
If a self-signed certificate was selected, you should import the certificate into the Trusted Root Certification Authorities container on every device where the Adaptiva Admin Portal will be accessed. Each OneSite Administrator who will use the Admin Portal from a remote device will need to import the certificate. Alternatively, the certificate can be deployed using a GPO or Intune policy.
### Download and install the certificate
1. In your browser, navigate to your Adaptiva Server name with optional *:port* - `https://[:port]`.
Example: `https://adaptivaserver:9678`
2. You will see the message **Your connection isn't private**.
3. Click on the text **Not secure** next to the Address URL.
4. Click on **Your connection to this site isn't secure**.
5. Click on the certificate icon to view the certificate.
6. Select the **Details** tab.
7. Click on **Export**.
8. Select a destination (your **Downloads** folder) - leave the default filename of `.crt`.
9. Close your browser.
10. In File Explorer, browse to the saved certificate and double-click it.
11. Select **Install Certificate...**.
12. Select **Local Machine (recommended)** and click **Next**.
13. Select **Place all certificates in the following store**.
14. Click **Browse**, select **Trusted Root Certification Authorities** and click **OK**.
15. Click **Next** and then click **Finish**.
#### Alternatively
1. The certificate is stored in the registry at `HKLM\SOFTWARE\Adaptiva\server\certificates.cloudui_public_cert`
2. The data can be saved into a UTF-8 formatted text file with a .crt extension.
3. You can then run the following command to import the certificate:
`Certutil.exe -addstore root "\.crt"`
#### Test the certificate
1. In your browser, enter the Adaptiva Server name with optional *:port* - `https://[:port]`.
2. You will now see the Admin Portal login page.
3. There will now be a lock icon next to the URL
### Content Library Location
The Content Library will default to Adaptiva Server installation folder **%Path%\Adaptiva\AdaptivaServer\Data\ContentLibrary**.
Consider moving the Content Library to a dedicated drive that can be backed up or replicated. It is not supported to use a UNC path. Review this [How-To article](https://support.adaptiva.com/hc/en-us/articles/203736410-How-To-Change-the-location-of-the-content-library-) for instructions on moving the Content Library location.
> **IMPORTANT**: Ensure this drive is backed up or replicated.
### Configure SQL Database Best Practices
By default, the installation account is assigned as the owner of the Adaptiva database. SQL best practice is to set the SA account to the owner.
1. In **SQL Management Studio**, right-click on the **adaptiva** database and select **Properties**.
2. Select the **Files** page. Change the Owner to **SA**.
3. Select the **Options** page. Verify the Recovery model is set to **Simple**.
> **NOTE**: If the Adaptiva database will be part of a SQL Always On Availability Group, the Recovery model should be set to Full.
### Finalize the Workspace ONE Integration
This is only applicable if the Workspace ONE integration was selected.
After a successful installation, return to the Workspace ONE UEM console to complete the integration of the two platforms.
1. Navigate to the Adaptiva settings page (**Groups & Settings | All Settings | System | Enterprise Integration | Peer Distribution | Adaptiva**) and enter either the name or the internal IP address of the Adaptiva server. This will allow the ACC to communicate with the Adaptiva server on the internal network.
2. Upload the Adaptiva Server certificate so the authentication between the ACC and Adaptiva services is secure. Recall the certificate was saved here: ***%InstallPath%*****\Program Files\Adaptiva\AdaptivaServer\data\security\AdaptivaServer.cer**.
3. Click **Save**. The system will save the settings and immediately perform a health check to validate communications and then initiate publication of application metadata to the Adaptiva Server.
#### (Optional) Reduce SQL permissions
To remove SQL sysadmin access from the account
1. Stop the **AdaptivaServer** service.
2. In **SQL Management Studio**, select the ConfigMgr database and click **New Query**, enter the following command:
```sql
CREATE ROLE db_executer\
GRANT EXECUTE TO db_executer
```
3. Click **Execute**.
4. Repeat the above step against the Adaptiva database.
5. Expand **Security | Logins** folder, right-click the account used for installation and select **Properties**.
6. Select the **Server Roles** page and uncheck the server role: **sysadmin**.
7. Select **User Mapping**.
8. In the **Users mapped to this login** section, select the **adaptiva** database, and under the database role membership, select the following roles:
```sql
db_datareader
db_datawriter
db_ddladmin
db_executer
```
9. In the **Users mapped to this login** section, select the **ConfigMgr** database, and under the database role membership, de-select the `db_owner` role, and select the following roles:
```sql
db_datareader
db_datawriter
db_ddladmin
db_executer
```
10. Click **OK** when complete.
11. Start the **AdaptivaServer** service.
## Additional configuration
After you have completed the installation of the OneSite platform, you may choose to apply additional configurations to optimize your environment. These optional steps vary depending on the solution you’ve implemented and the size and complexity of your organization.
* [Create your network topology](https://docs.adaptiva.com/platform-guide/network-topology.md)
* [Configure security and access control](https://docs.adaptiva.com/platform-guide/security.md)
* [Configure SMTP settings](https://docs.adaptiva.com/platform-guide/additional-settings/smtp-settings.md)
## Administration and troubleshooting
* [Perform administrative tasks on Adaptiva clients with the Adaptiva Administration Tool (AAT)](https://support.adaptiva.com/hc/en-us/articles/360028239692-Administration-Adaptiva-Administration-Tool-AAT)
* [Troubleshoot client connectivity](https://docs.adaptiva.com/platform-guide/client-validator)
# Uninstall the Adaptiva Server
You can completely remove the Adaptiva Server by re-running the setup executable and select the **Uninstall** option. You should uninstall the OneSite Platform from the bottom-up, starting with the clients and then finishing with the Adaptiva Server.
To run the uninstallation silently, run the `adaptiva-server--windows.exe` executable fom the command line with the `-uninstall` switch.
We recommend opening a ticket with Adaptiva Support for assistance in removing the Adaptiva Server components. Uninstallation will delete the registry, the content library, and the Adaptiva Server folder contents. It will also delete the Adaptiva database and remove the Adaptiva tables, views, and triggers from the ConfigMgr database.
### Uninstall Adaptiva Workbench
Run the following command to uninstall the Adaptiva Workbench:
`adaptivaWorkbenchSetup.exe -uninstall`
# Platform upgrade
Instructions for upgrading OneSite Platform
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--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--windows.exe` and select the **Upgrade** option.
* Unattended - `adaptiva-client--windows.exe -installorupgrade -servername `
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](https://support.adaptiva.com/hc/en-us/articles/115001545992-Create-OneSite-Boot-Image-PowerShell-Script-with-updated-read-Me). 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](/platform-install/server-install/install-platform-prerequisites#sql-permissions)
### New Antivirus Exclusions
For information about new required antivirus exclusions, see [Antivirus Exceptions](https://docs.adaptiva.com/platform-install/planning-guides/onesite-platform-planning#antivirus-exceptions).
### 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--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](/platform-install/server-install/install-platform#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](https://docs.adaptiva.com/platform-guide/license-solution)
### Automatic Client Upgrade
After you upgrade the Adaptiva Server, you can use the [Client Upgrade](https://docs.adaptiva.com/platform-guide/client-management/client-auto-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) -- ` 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](https://support.adaptiva.com/hc/en-us/articles/206503713-How-To-Redirect-OneSite-client-to-a-different-Adaptiva-server)
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 ` 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.
# Client install
Adaptiva Client installation guide for the OneSite Platform.
The Adaptiva Client must be installed on every device that will be managed. The Adaptiva Client supports a manual installation or a silent unattended installation. For complete coverage, the client agent setup can be added to a GPO-enforced startup script, the OS deployment process, and deployed using the peer-to-peer MSI.
Platform specific install guides:
* [Install Windows Client](/platform-install/client-install-and-uninstall/client-install/client-install-windows)
* [Install Linux and macOS Client](/platform-install/client-install-and-uninstall/client-install/client-install-linux-macos)
* [Install SaaS](/platform-install/client-install-and-uninstall/client-install/client-install-saas)
* [Uninstall Client](/platform-install/client-install-and-uninstall/client-uninstall)
## Client Installation Files
You can find the Adaptiva Client installation media in the *Installers* folder of the compressed build files. For more information on the supported operating systems, see [Supported Systems](/platform-install/overview/supported-systems).
{% hint style="info" %}
The `` is a placeholder for the build version number, which changes with each release.
{% endhint %}
### Windows installers
| Package Name | Architecture | Descriptions |
| ------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `adaptiva-client--windows.exe` | x64 | Windows client full installer |
| `adaptiva-client-p2p--windows.msi` | x64 | Windows Installer-based application. The P2P Installer first attempts to find the Windows client installer on the local subnet, then downloads from the specified location. |
### Cross-platform installers
#### Linux
**Version 10.1.972 and later**
| Package Name | Architecture | Distributions |
| ---------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------- |
| `adaptiva-client--amd64.deb` | x86\_64 | Debian & Ubuntu |
| `adaptiva-client--arm64.deb` | ARM64 | Debian & Ubuntu |
| `adaptiva-client--1.x86_64.rpm` | x86\_64 | AlmaLinux, Amazon Linux, CentOS Stream, Fedora Linux, Oracle Linux, Red Hat Enterprise Linux, Rocky Linux |
| `adaptiva-client--1.aarch64.rpm` | ARM64 | AlmaLinux, Amazon Linux, CentOS Stream, Fedora Linux, Oracle Linux, Red Hat Enterprise Linux, Rocky Linux |
| `adaptiva-client--1.suse.x86_64.rpm` | x86\_64 | openSUSE Leap, SUSE Linux Enterprise |
| `adaptiva-client--1.suse.aarch64.rpm` | ARM64 | openSUSE Leap, SUSE Linux Enterprise |
**Version 10.1.971 and below**
| Package Name | Architecture | Distributions |
| --------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------ |
| `adaptiva-client--amd64.deb` | x86\_64 | Debian and Ubuntu |
| `adaptiva-client--1.el8.x86_64.rpm` | x86\_64 | AlmaLinux 8, Oracle Linux 8, Red Hat Enterprise Linux 8 and Rocky Linux 8 |
| `adaptiva-client--1.el9.x86_64.rpm` | x86\_64 | AlmaLinux 9, CentOS Stream 9, Oracle Linux 9, Red Hat Enterprise Linux 9, and Rocky Linux 9 |
| `adaptiva-client--1.el10.x86_64.rpm` | x86\_64 | AlmaLinux 10, CentOS Stream 10, Oracle Linux 10, Red Hat Enterprise Linux 10, and Rocky Linux 10 |
#### macOS
| Package Name | Architecture | Versions |
| ------------------------------------- | ------------ | -------------------------------------------------------------------------------------- |
| `adaptiva-client--macOS.pkg` | ARMx64 | Please see [Supported Systems macOS](/platform-install/overview/supported-systems#mac) |
# Install Windows Client
How to install Adaptiva Clients on Windows devices.
Windows clients can either by installed with the manual full installer, or with the peer-to-peer MSI installer.
## Manual full Windows client installation
Use this method on a one-off basis during testing, initial rollout or to supplement automatic deployment.
1. Run the `adaptiva-client--windows.exe` as Administrator, found in the installation source folder.
2. In the Adaptiva Client Installer dialog, verify or change the following installation options.
```
* **Client Install Path**
* Directory where the client will be installed.
* **Server Host Name or IP Address**
* The fully qualified domain name or IP address of the Adaptiva Server.
* **Use Cloud Relay Service to connect when off-premises**
* Check this box if clients will be on the internet or split-tunnel networks
* **Use Password for installation (optional)**
* Check this box and enter the password provided by your OneSite Administrator. You can find the password in the Admin Portal under **Settings > Client Authorization**.
* **Server’s GUID (optional)**
* Enter the Server GUID provided by your OneSite Administrator. You can find the Server GUID in the Admin Portal under **Settings | Server Activation**.
* **Enable Wake On LAN**
* Allows the client to be woken up using peer-to-peer WOL.
* **Add/Remove Programs Entry**
* Adds an entry allowing for uninstallation of the client agent from the Control Panel.
* **Add Windows Firewall Exception**
* Adds exceptions to the local Windows Firewall for the default client ports, see [Platform Communication Ports](platform-communication-ports.md) for a list of these ports.
* **Memory**
* Sets the memory allowance for the client, in increments of 128 MB, with a minimum of 256 MB.
* **MSP Tenant Installation**
* Only check this box if you are using a Managed Service Provider license and supply the Tenant GUID.
```
1. Click **Install**.
### Adaptiva Client Validator
The Adaptiva Client Validator verifies the connectivity requirements for the client and will run after installation.
If all checks pass (or are not applicable), then the client is fully online and ready to be managed. If any of the checks fail, you can make the appropriate firewall or network configurations and then rerun the Client Validator tool from the Adaptiva client installation location (%ADAPTIVACLIENT%\bin\AdaptivaClientValidator.exe).
#### Validation check detail
The following describes the validation checks being performed:
* HTTP Connection - Verifies the client can connect with cloud services.
* Cloud Relay Connection - Verifies the client can connect to the cloud relay system. The Adaptiva Server must be activated for this check to pass.
* Client-Server Messaging - Verifies the client can send and receive messages to the Adaptiva Server.
* Client-Server Handshake - Verifies the client can successfully perform a handshake with the Adaptiva Server and has obtained a Client ID.
* Client to Client - Checks if the client has peers in the office and verifies connectivity with those clients.
Content Download - Verifies that the client can download a sample package of 8 bytes.
### Unattended Installation EXE Command Line Parameters
In some cases, an administrator may want to use an unattended method to install the Adaptiva Client. The table below describes the command line parameters available for the **Windows client installer**.
| Parameter | Usage |
| ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Required** | |
| -cleaninstall, -installorupgrade, or -uninstall | -cleaninstall uninstalls the existing client installation and cleanly installs a new copy of the client.
-installorupgrade installs the client or upgrades the existing client.
-uninstall uninstalls the client.
|
| -upgrade | All previously used settings will be retained; no other parameters should be entered. |
| -servername `` or -serverIP `` | FQDN or IP Address of the Adaptiva Server. |
| -serverguid `` | The GUID of the Adaptiva Server can be provided by the OneSite administrator. This property is required when specifying the -cloudrelay. |
| -cloudrelay | This property is required for Adaptiva Server installations. It enables the client to use the Cloud Relay Service to connect when off-premises. |
| **Optional** | |
| -custompacurl `` | The installer will access the PAC file to gather the proxy information. |
| -customproxy `::` | The installer will use the information to access the proxy when trying to contact Cloud Services.
E.g. -customproxy 10.10.10.1:9000:http
|
| -customproxybypass `;;` | When -customproxy is used the servers included in the custom proxy bypass list will be excluded from using the proxy. |
| -delay `` | Delays the starting of the installation executable. This is useful during a client self-upgrade using content push allowing workflows to complete before the Patch Client service is stopped. |
| -folder `` | The desired installation path.By default, the Patch Client is installed under: `%ProgramFiles%\Adaptiva\AdaptivaClient` |
| -mem `` | Maximum Java heap size, in MB (defaults to 256). |
| -noarp | The installer will not create an entry in Add/Remove Programs. |
| -nocachedel | This parameter can be used with the *-uninstall* or *-cleaninstall*. If this parameter is used the Adaptiva cache will not be deleted. |
| -nofirewall | The installer will not create Windows Firewall rules for the Patch Client. |
| -nomif | The installer will not send ConfigMgr MIF status in the case of any errors found during installation. |
| -nowol | Specify this option to disable Wake on LAN. By default, the Patch Client enables Windows Wake on LAN settings on all the network cards installed in the machine. |
| -password `` | Provides additional security. Enter the password that was created on the Adaptiva Server. |
| -preferuserproxy `true / false` | When *-preferuserproxy* is `true` the proxy settings will be obtained from the Internet Explorer settings. Defaults to `false`. |
| -serverurl `` | Tells the client to communicate to the Adaptiva Server with HTTP instead of using UDP. |
| -tenantguid `` | Use this to access the Managed Services Provider (MSP) functionality and create and maintain multi-tenant environments. The Tenant GUID can be provided by the OneSite Administrator. |
## Peer-to-Peer (P2P) MSI
The Adaptiva Client P2P MSI installer reduces the bandwidth required for the distribution of the Adaptiva agent. Using the Adaptiva Client P2P MSI installer, the Adaptiva Client can be pushed using a group policy, a startup script, `SysInternals psexec`, or any other remote execution method available.
Once executed, the Adaptiva P2P Client MSI installs the full Adaptiva Client. The MSI does not contain the full client installation. Instead, the MSI -- which is specific to a particular version of the Adaptiva Client agent -- first looks for the Adaptiva Client on a peer system in the same subnet with the correct version. If a device is found with the correct version, it retrieves the setup executable `adaptiva-client--windows.exe` from that local client and installs the Adaptiva Client from that executable. If a peer is not found with the correct version, the MSI retrieves the executable `adaptiva-client--windows.exe` from a UNC or URL path specified on the command line. If multiple systems run the MSI simultaneously and none of them find the correct version of the client locally, an election takes place among those clients. Only the winner of the election downloads the executable from UNC or URL path, and it then makes the executable available to the other client systems.
{% hint style="info" %}
Ensure that the installation account executing the MSI has read and execute access at the destination UNC path.
{% endhint %}
The Adaptiva P2P Client MSI can be used interactively or as a silent installer with no user interaction.
The P2P installer is named `adaptiva-client-p2p--windows.msi` and is in the compressed `.zip` product download source.
{% hint style="info" %}
The SaaS tenant provides a pre-configured Windows installer script. This script contains the necessary information to connect to the Adaptiva Tenant. When using the p2p installer for a self-hosted environment, use one of the following methods.
{% endhint %}
### Manual Peer-to-Peer (P2P) client installation
1. Locate the `adaptiva-client-p2p--windows.msi` executable file on your machine and double-click it to execute.
2. Select **Next** to initiate the setup.
3. Select **Install or Upgrade**.
4. Select **Install or Upgrade**, and then select **Finish** to exit the installer setup wizard.
The other options perform the following tasks:
* Update - Upgrades the existing client to the version of the p2p client installer.
* Clean - Uninstalls the existing client, and then installs the Windows client.
* Uninstall - Uninstalls the Windows client.
### Unattended Installation MSI Command Line Parameters
The table below contains the MSI properties valid for the P2P client installer.
{% hint style="info" %}
Be sure to enter these properties on the command line as `=`.
{% endhint %}
| Property | Value | Description |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Required** | | |
| SERVERIP / SERVERNAME | IP address of server or server name. | The Adaptiva Server to which this client will report. SERVERIP takes precedence over SERVERNAME if both are specified. |
| SOURCEUNCPATH / SOURCEURLS | `\adaptiva-client--windows.exe` or URL address of `adaptiva-client--windows.exe` | SOURCEUNCPATH: The location to download the client installer from if it cannot be found in the local office.
The account executing the installation must have at least read access to the UNC path.
SOURCEURLS: The list of Source CDN URLs (where each SOURCE URL is separated by '<' character) from where the P2P installer downloads the adaptiva-client-\-windows.exe by HTTP protocol in case it is not available in the local office.
|
| CLOUDRELAY | 1: Use the cloud relay feature
0: Do not use the cloud relay feature (default)
| When enabled, allows the client to communicate with the Adaptiva Cloud Relay server. Include the SERVERGUID property. |
| SERVERGUID | GUID of the Adaptiva Server | The GUID of the Adaptiva can be provided by the Adaptiva Admin. Required when the client is on the internet. This property can only be used if CLOUDRELAY=1. |
| **Optional** | | |
| ARPSYSTEMCOMPONENT | 1: suppresses creation
0: does not suppress creation (default)
| Suppresses the creation of an Add/Remove Program entry for the actual Adaptiva Client. The P2P MSI creates a hidden Add/Remove Program entry for itself named Adaptiva Peer to Peer Client Installer. |
| CLEANINSTALL | 1: performs a clean installation
0: perform an InstallOrUpgrade installation (default)
| Uninstalls the existing client installation and cleanly installs a new copy of the client. If not specified, the `InstallorUpgrade` option is used by default. |
| MEM | `` | The amount of memory in MB to be used by the Adaptiva Client. Defaults to 256 MB. |
| CUSTOMPACURL | `` | The installer will access the PAC file to gather the proxy information. |
| CUSTOMPROXY | `::` | The installer will use the information to access the proxy when trying to contact Adaptiva Cloud Services.E.g. -customproxy 10.10.10.1:9000:http |
| CUSTOMPROXYBYPASS | `;;` | When -customproxy is used the servers included in the custom proxy bypass list will be excluded from using the proxy. |
| NOCACHEDEL | 1: cache is preserved
0: cache is deleted during uninstallation (default)
| Preserves the Adaptiva Client cache after uninstallation. This property is only valid when used in conjunction with the UNINSTALL property. |
| NOFIREWALL | 1: does not create any firewall exceptions
0: creates firewall exception (default)
| Disables creating exceptions in the Windows Firewall for the Adaptiva Client Installer. |
| NOLOGGING | 1: only FATAL errors are logged, but no other logging is done
0: normal INFO logging (default)
| Controls the logging level during the client install. Only logging fatal errors is helpful if the client system uses shared storage and to minimize logging. |
| NOWOL | 1: disables WoL
0: enables WoL (default)
| Disabled Wake-on-LAN |
| PASSWORD | Password provided by Adaptiva Admin | The password is entered by Adaptiva Admin in the workbench to ensure only authorized connections. This property can only be used if CLOUDRELAY=1. |
| PREFERUSERPROXY | `true` / `false` | When `preferuserproxy` is true the proxy settings will be obtained from the internet explorer settingsDefaults to false. |
| SERVERURL | Server FQDN URL:port | Tells the client to communicate to the Adaptiva Server with HTTP, instead of using UDP. |
| TARGETDIR | `` | The installation folder of the Adaptiva Client. Defaults to `%SystemDrive\Program Files\Adaptiva` or `%SystemDrive%\Program Files (x86)\Adaptiva`. |
| TENANTGUID | Tenant GUID provided by the Adaptiva administrator | Use this to access the Managed Services Provider (MSP) functionality and create and maintain multi-tenant environments. |
| UNINSTALL | 1: performs an uninstallation
0: performs an installation (default)
| Ignores all other properties and performs an uninstallation of the Adaptiva Client. |
| WAITFORCOMPLETION | 1: the MSI installer waits for the client installation to finish
0: the MSI will not wait for the Adaptiva Client installation to be completed (default)
| Specifies whether the AdaptivaP2P Client Installer MSI will wait until the installation completes. |
| WANBYTESPERSECOND | X: bytes per second
0: Unlimited (default)
| The maximum download speed that will be used while downloading the Adaptiva Client Installer exe over the WAN from the SOURCEUNCPATH. |
### Installation command line examples
To deploy the Adaptiva P2P Client Installer, the only file needed for the package source is `adaptiva-client-p2p--windows.msi` which can be found in the Adaptiva installation source. The `adaptiva-client--windows.exe` must be accessible from a Share or a URL.
#### Silent Install UNC file share
This command silently installs the Adaptiva client on a Windows machine and tells it how to connect to your environment.
* Install with Server Share Source:
```cmd
msiexec.exe /I adaptiva-client-p2p--windows.msi /qn SERVERNAME=AdaptivaServer.domain.com SOURCEUNCPATH=\\ServerFQDN\AdaptivaClient\adaptiva-client--windows.exe WAITFORCOMPLETION=1
```
#### Silent Install cloud/relay-based
Silently installs the Adaptive client, but is configured for a cloud/relay-based setup instead of UNC file share.
* Install with Cloud and Internet Source:
```cmd
msiexec.exe /I Adaptiva-client-p2p--windows.msi /qn SERVERNAME=AdaptivaServer.domain.com SOURCEURLS=https://tiny.url/abcdefg CLOUDRELAY=1 SERVERGUID=abcdefgh-abcd-1234-efgh-abcdefghijkl WAITFORCOMPLETION=1
```
Include the following switches as required if the Cloud Relay service or if HTTP client communications will be used:
* Cloud Relay service: `CLOUDRELAY=1`, `SERVERGUID=`, `PASSWORD=`
* HTTP communications: `SERVERURL=`
{% hint style="info" %}
You Server GUID can be found in the Admin Portal under **Settings | Server Activation**. You can also find it in the Adaptiva server registry, under `HKLM\Software\Adaptiva\server\client_data_manager.server_guid`
{% endhint %}
## Windows client setup logs
In the case where an administrator needs to troubleshoot an Adaptiva Client installation, the table below contains the installation log locations. Other logs exist in the installation folder.
* Standard client installation: **%windir%\AdaptivaSetupLogs\Client\AdaptivaClientSetup.log**
* P2P MSI client installation: **%windir%\AdaptivaSetupLogs\Client\AdaptivaP2PClientSetup.log**
* Client logs: `%ADAPTIVACLIENT\logs\*\*.log`
# Install Cross-Platform Client
How to install the Adaptiva Client on cross-platform devices.
You can install the Adaptiva Client on Linux and MacOS by installing the appropriate package and running the `adaptivactl` setup command. The setup command will install the OneSite client, configure firewall rules, and run post-installation checks to ensure functionality. The setup progress will print to the terminal and exit with a `0` exit-code if successful. If the client setup fails for any reason, it will exit with a non-zero exit-code.
The adaptivactl setup command checks for port availability before client setup. If a firewall is detected, setup will create firewall rules using the appropriate application: *ufw* with the DEB package, *firewalld* with the RPM package, and *socketfilterfw* with the MacOS package.
The client will now run post-setup checks to confirm connectivity with the server and other services. The setup will wait for these checks to be completed. You can skip these checks using the `--skip-connection-checks` flag.
There are several different installation packages provided for cross-platform device installations. Be sure to use the correct one for your operating system. Locate the installers\cross-platform folder in the downloaded .zip file.
{% hint style="info" %}
When installing the cross-platform client for the Adaptiva Cloud tenant, see [SaaS Client Installation](/platform-install/client-install-and-uninstall/client-install/client-install-saas) for more information.
{% endhint %}
## Linux Installation
### Adaptiva RPM signing key
With the inclusion of openSUSE and SUSE Linux support in version 10.1.972, you will need to import the Adaptiva RPM signing key on each SUSE-based Linux machine during prior to installation. This will allow these distributions to verify the signature of the RPM package.
The following distributions apply:
* Required
* SUSE-based (openSUSE, SUSE Linux Enterprise)
* Optional - (Good practice to install the RPM signing key, but not necessary.)
* Other RPM-based Linux distributions (Rocky Linux, Fedora, RHEL, etc.)
* Does not apply
* DEB-based (Debian and Ubuntu)
1. Open a terminal window and run the following command to import the Adaptiva RPM signing key:
```bash
sudo rpm --import https://adaptiva-releases.adaptivacdn.cloud/client/RPM-GPG-KEY-Adaptiva
```
{% hint style="info" %}
If you do not install the RPM signing key you will see the following message when trying to install the RPM:
*Signature verification failed \[4-Signatures public key is not available]*
{% endhint %}
### Install the package
* Run the following command to execute the package (replace `` with the appropriate version of the Adaptiva client your are trying to install and `` with the specific architecture):
* DNF package manager
```bash
sudo dnf install ./adaptiva-client--1..rpm
```
* APT package manager
```bash
sudo apt install ./adaptiva-client--1..deb
```
* Zypper package manager
```bash
sudo zypper install adaptiva-client--1.suse..rpm
```
{% hint style="info" %}
When running the apt install interactively, the following message may be returned: `N: Download is performed unsandboxed as root as file ‘/’ couldn’t be accessed by user ‘_apt’. – pkgAcquire::Run (13: Permission denied) 109` You may ignore this error.
{% endhint %}
### Configure the client
1. Run the following `adaptivactl` command in setup mode to configure the client:
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup
```
Only the `--server` flag is required. See the table below for the available parameters.
**Example:**
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup --server adaptivaserver.corp.example
```
2. Once the client installation is completed, the client will perform a series of connection checks.
```bash
[info] Running connection checks…
[info] The connection check ‘HTTP Connection’ has started
[info] The connection check ‘HTTP Connection’ has passed
…
```
* If installing a SUSE-based distribution, these checks will not be run.
3. When the connection checks are completed, the Patch Client is fully online and ready to be managed.
### Linux logs
Run the following command to view the client service log:
```bash
sudo journalctl -u adaptivaclientd.service > .\AdaptivaClientdService.log
```
* Client logs: **/opt/adaptiva/adaptivaclient/logs**
## MacOS Installation
1. Open a Command terminal window, then run the following command to execute the package:
```zsh
sudo installer -tgt / -pkg ./adaptiva-client--macOS.pkg
```
1. Run the following `adaptivactl` command in setup mode to configure the client:
```zsh
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup
```
Only the `--server` flag is required. See the table below for the available parameters.
1. Once the client installation is completed, the client will perform a series of connection checks.
```bash
[info] Running connection checks…
[info] The connection check ‘HTTP Connection’ has started
[info] The connection check ‘HTTP Connection’ has passed
…
```
## Mac adaptiva log
* Client installation log: **/opt/adaptivaclient/logs/adaptiva.log**
* Client logs: **/opt/adaptiva/adaptivaclient/logs**
### adaptivactl command line parameters
A list of the command line parameters for the adaptivactl, both required and optional. Known flags can also be printed by running:
```bash
/opt/adaptiva/adaptivaclient/bin/adaptivactl setup --help
```
| Flag | Value |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| **Required** | |
| `--server / / url:port` | IP Address, hostname, or URL of the Patch Server to which the client reports to. |
| **Optional** | |
| `--auth-secret ` | The client authentication secret to use to authenticate with the server. If absent, no authentication will be performed with the server. |
| `--proxy ://:` | The HTTP proxy to use. Has the format `://:`. If absent, the system-wide proxy will be used if configured. |
| `--server-guid ` | The Server GUID for your Adaptiva Server. You can find this in the Admin Portal under Settings, Server Activation. |
| `--tenant-guid ` | The Tenant GUID used in multi-tenant environments. |
| `--cloud-tenant-id ` | The ID of the cloud tenant in cloud-hosted environments. |
| `--system-config =` | A system config value to set during setup, and has the following format: `=` This flag may be repeated multiple times. |
| `--skip-firewall-rules` | Skip the creation of firewall rules. |
| `--skip-connection-checks` | Skip the post-setup connection checks. |
**Examples**:
Direct server using an IP address, an HTTP proxy, and a custom system config:
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup --server 198.50.100.241 --server-guid 1cb07a9e-a88c-4db2-8fe3-2eb7748545d6 --proxy http://198.50.100.3:8080 --system-config onesite.server_message_retry_interval=60
```
Server using cloud relay, hostname, client authentication:
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup --server adaptivaserver.corp.example --server-guid 1cb07a9e-a88c-4db2-8fe3-2eb7748545d6 --auth-secret 'P@ssw0rd123!'
```
### Restart the Adaptiva client
Use the following command to restart the Adaptiva Client Daemon.
Linux:
```bash
sudo systemctl restart adaptivaclientd
```
macOS:
```zsh
sudo launchctl kickstart -k system/com.adaptiva.clientd
```
### Modify system configuration on Linux or MacOS
The adaptivactl command can also be used to read and write system config values using the config operation.
The following command reads the value of a system config property:
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl config get
```
The following command sets the value of a system config property:
```bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl config set
```
## Client upgrade
If you need to upgrade existing cross-platform clients to a newer version manually, perform package upgrades using the commands below. For more information on the supported operating systems, see [Supported Systems](/platform-install/overview/supported-systems). (Replace `` with the appropriate version of the Adaptiva client your are trying to install and `` with the specific architecture)
### Version 10.1.972 and later
Debian / Ubuntu:
```bash
sudo apt install ./adaptiva-client--.deb
```
AlmaLinux, Amazon Linux, CentOS Stream, Fedora Linux, Oracle Linux, Red Hat Enterprise Linux, Rocky Linux:
```bash
sudo dnf upgrade ./adaptiva-client--1..rpm
```
SUSE-Based:
```bash
sudo zypper install ./adaptiva-client--1.suse..rpm
```
macOS:
```zsh
sudo installer -tgt / -pkg ./adaptiva-client--macOS.pkg
```
* Use the following command in macOS to restart the Adaptiva Client Daemon:
```zsh
sudo launchctl kickstart -k system/com.adaptiva.clientd
```
### Version 10.1.971 and below
Debian / Ubuntu:
```bash
sudo apt install ./adaptiva-client--1..deb
```
AlmaLinux, CentOS Stream, Oracle, RHEL, Rocky:
```bash
sudo dnf upgrade ./adaptiva-client--1.el<#>..rpm
```
macOS:
```zsh
sudo installer -tgt / -pkg ./adaptiva-client--macOS.pkg
```
* Use the following command in macOS to restart the Adaptiva Client Daemon:
```zsh
sudo launchctl kickstart -k system/com.adaptiva.clientd
```
{% hint style="info" %}
Due to an issue in the 9.2.967 RPM packages, upgrading from 9.2.967 to 9.3.968 or later requires the following commands: `sudo dnf upgrade ./adaptiva-client-9.3.968.19-1.el9.x86_64.rpm` `sudo systemctl enable --now adaptivaclientd.service`
{% endhint %}
# Install SaaS Client
How to install Adaptiva SaaS Clients on Windows, macOS, and Linux devices.
## Download the SaaS Client
You'll want to first download the Adaptiva SaaS client from the Cloud Portal.
1. Log in to `https://.adaptiva.cloud` and click **Go to OneSite Patch**.
2. In the left-hand navigation, click **Asset Management > Client Installers**.
3. In the details pane, under **Client Installer Download Links**, click the download button () next to the desired OS option.
Follow the steps below to install SaaS clients on Windows, Linux, and macOS.
## Install the Windows SaaS Client
The Adaptiva Windows Client is installed using the P2P installer with all the needed configuration parameters in an `.msi` file.
1. Select the Windows Client from the dropdown menu.
2. Select  to download the installer to your machine.
3. Run the downloaded `.msi` file, and then the client will be installed.
## Install the Cross Platform SaaS Client
The Cross Platform Adaptiva Client is installed using a shell script.
1. Select the appropriate Linux or macOS Client from the dropdown menus.
2. Select  to download the `.sh shell script` to your machine.
3. Open a Command terminal window, then run the command below to execute the package. This command automatically downloads the appropriate package and installs the client.
```bash
sudo bash adaptiva-client--install-unix-.sh
```
{% hint style="info" %}
When running the shell script interactively on systems that use apt, the system may return the following message: `N: Download is performed unsandboxed as root as file ‘/’ couldn’t be accessed by user ‘_apt’. – pkgAcquire::Run (13: Permission denied) 109` You may ignore this error.
{% endhint %}
# Deploy clients
Learn how to deploy the Adaptiva client to your devices.
You can deploy the Adaptiva client to your devices using most application deployment methodologies. These articles walk you through how to install the client using:
* [Group Policy](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-grouppolicy)
* [Microsoft Intune](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-intune)
* [Microsoft Configuration Manager](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-configmgr)
## General Deployment Guidance
You can use many methods to deploy the Adaptiva Client, but the same general process is used in each.
### 1. Access the Adaptiva Client
We recommend you deploy the Peer-to-Peer MSI `adaptiva-client-p2p-windows.msi` in order to minimize network utilization through peer-sharing.
* **On-premises**: You can access the Adaptiva Client installer from the **Installers** folder in the downloaded installation media.
* **SaaS**: You can access the Adaptiva Client installer from **Settings > Client Downloads** in the Admin Portal.
### 2. Share the full installer if necessary
{% hint style="info" icon="cloud" %}
Not required for SaaS.
{% endhint %}
If the client installer cannot access the full .exe client on the local subnet, it will default to the URL or UNC path defined in the installation command line.
### 3. Build your command line
{% hint style="info" icon="cloud" %}
For SaaS clients, all parameters are included in the msi.
{% endhint %}
* [EXE command line parameters](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-install/client-install-windows#unattended-installation-exe-command-line-parameters)
* [P2P command line parameters](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-install/client-install-windows#unattended-installation-msi-command-line-parameters)
* [adaptivactl command line parameters (Linux/MacOS installer package)](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-install/client-install-linux-macos#adaptivactl-command-line-parameters)
### 4. Deploy the client
* Choose your deployment tool
* Build you deployment package
* Install using a System/sudo account
* Add an uninstall command - [uninstall commands](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-uninstall)
* Target clients and monitor your deployment
### 5. Validate installation
* Navigate to the Adaptiva Admin Portal and go to **Assets > Devices** to confirm that devices appear in the dashboard.
* You can also confirm the functionality of the Adaptiva Client using the [Client Validator](https://docs.adaptiva.com/platform-guide/client-management/client-validator) tool when interactively installing.
# Deploy clients with Group Policy
Client Installation using ConfigMgr
Deploying software through Group Policy cannot use the standard command line syntax. The properties that are set via the command must be set in a Windows Installer transform file. A variety of tools are available that can be used for this task. [Orca](https://learn.microsoft.com/en-us/windows/win32/msi/orca-exe) is a free tool available from Microsoft and is part of the Windows SDK.
## Create a Transform File (MST)
Download and install the latest [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/).
Follow these steps to create a Windows Installer transform file (MST) using Orca.
1. Open Orca, select **File > Open** and select the `adaptiva-client-p2p--windows.msi`.
2. In the menu bar, select **Transform > New Transform** to create a new transform file.
3. Select the Property table in the Tables list on the left.
4. In the Property table, modify the following values:
* **SOURCEUNCPATH** = ``
* **SERVERNAME** or **SERVERIP** = `` or `` of the Adaptiva Server
If you are using the Cloud Relay service, set the following properties:
* **CLOUDRELAY**=`1`
* **SERVERGUID**=``
* **PASSWORD**=``
If you are using HTTP for client communications, set the following properties:
* **SERVERURL**=``
5. Click **Transform > Generate Transform** and save the MST file.
6. Close the Orca tool.
## Create a File Share
1. Create a content source folder as follows:
`:\Adaptiva\Client`
2. Copy the Adaptiva Client MSI and MST files into the Client folder.
3. Share this folder on the server as **AdaptivaClient** with the following permissions:
Share permissions: **Everyone: READ**
NTFS permissions: **Domain Computers: Read and Execute, List, Read**
## Create a Group Policy Object
1. Open Group Policy Management and create a new or edit an existing GPO.
2. In the Group Policy Management Editor, expand **Computer Configuration > Policies > Software Settings**.
3. Right-click **Software installation** and select **New > Package**.
4. In the **Open** dialog, navigate to the Adaptvia Client share location and select the `adaptiva-client-p2p--windows.msi`.
5. In the **Deploy Software** dialog, select **Advanced** and then click **OK**.
6. In the Adaptiva Peer to Peer Client Installer Properties dialog, select the **Modifications** tab, and click **Add**.
7. Navigate to to the Adaptvia Client share location, select the MST file, and click **Open**.
8. Click **OK** and close the policy.
9. Target the group policy appropriately. Devices will install the Adaptiva Client at the next system restart.
# Deploy clients with Intune
Deploy the Adaptiva client using Intune
You can create a Windows app (Win32) in Intune to install the Adaptiva Client using one or both of the methods below:
* (Recommended) [Distribute the Peer-to-Peer (P2P) installer](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-intune/deploy-clients-intune-p2p) by publishing the `adaptiva-client-p2p--windows.msi` installer.
* [Distribute the full client installer](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-intune/deploy-clients-intune-full) by publishing the `adaptiva-client--windows.exe` installer.
You can also create a [macOS app](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-intune/deploy-clients-intune-macos) in Intune to install the Adaptiva Client to macOS machines in your company.
## Access the Adaptiva Client
The Adaptiva Client is available from the Installation folder of the installation media. You can download the latest release from the [Product Releases](https://support.adaptiva.com/hc/en-us/sections/201965326-Product-Releases) section of the Adaptiva Support Portal.
**For users of the SaaS platform**, you can access the P2P installer or cross-platform installation scripts from your tenant. Click the **settings gear > Settings > Client Downloads.**
# Distribute P2P installer
P2P Windows Client Installation using Intune (recommended)
## Overview
You can create a Windows app (Win32) in Intune to install the Adaptiva Client by publishing the `adaptiva-client-p2p--windows.msi` installer. Clients will download the 1MB P2P MSI and then use peer-based distribution to source the full installation files.
## Prerequisites
You will need to download and install the [Microsoft Win32 Content Prep Tool](https://github.com/microsoft/Microsoft-Win32-Content-Prep-Tool) to complete these steps.
## Access the Adaptiva Client
The Adaptiva Client is available from the Installation folder of the installation media. You can download the latest release from the [Product Releases](https://support.adaptiva.com/hc/en-us/sections/201965326-Product-Releases) section of the Adaptiva Support Portal.
**For users of OneSite Patch SaaS**, you can access the P2P installer or cross-platform installation scripts from the Cloud Admin Portal.
## Deploy the P2P Installer
You need to install the Adaptiva client using the SYSTEM account, so you need to use a Windows (Win32) App rather than a Line-of-Business app. To install the app in the Device content, you must create an `.intunewin` file and configure a Win32 App in Intune to install the app correctly.
When you distribute the Win32 App, devices will download and run the 1MB `adaptiva-client-p2p--windows.msi` from Intune. The device will then look for a peer on the local subnet to access the full client installer. If not found, the installer will download full installer either from a server share or an internet accessible location.
For any Intune clients on the internet, you need to host the full client install (`adaptiva-client--windows.exe`) in a cloud storage container or CDN accessible to clients over the internet. Clients that are on-premises will download the client from a peer.
### Share the Full Installer
* **Create a local network share**
Create a network share for on-premises users to access the Adaptiva Client Installer.
1. Create a content source folder as follows:
`:\\Adaptiva\FullClient`
2. Copy the **adaptiva-client--windows.exe** from the Adaptiva installer files in \Adaptiva\AdaptivaClient\Bin.
3. Share this folder on the server as **AdaptivaClient** with the following permissions:
Share permissions: **Everyone: Read**
NTFS permissions: **Domain Computers: Read & Execute, List folder contents, Read**
* **Create an internet-accessible share**
Create an internet accessible share using any cloud storage or CDN provider. Copy the full `adaptiva-client--windows.exe` installer to this cloud storage container and ensure that you provide an appropriate access policy or token to allow clients to access it.
### Create Intunewin File for P2P Installer
Download and install the [Microsoft Win32 Content Prep Tool](https://github.com/microsoft/Microsoft-Win32-Content-Prep-Tool).
1. Create a content source folder as follows:
`:\\\Adaptiva\P2PClient`
2. Copy the `adaptiva-client-p2p--windows.msi` from the installation source into the P2PClient folder.
3. Open Notepad and create an install.cmd command for your appropriate installer:
Choose the appropriate command for your environment.
* For the OneSite Patch SaaS installer:
`%windir%\system32\msiexec.exe /I adaptiva-client-p2p--windows.msi /qn WAITFORCOMPLETION=1`
* On-premises with a share:
`%windir%\system32\msiexec.exe /I adaptiva-client-p2p--windows.msi /qn WAITFORCOMPLETION=1 CLOUDRELAY=1 SERVERNAME=%1 SERVERGUID=%2 SOURCEUNCPATH=%3 %4 %5`
* On-premises with a URL:
`%windir%\system32\msiexec.exe /I adaptiva-client-p2p--windows.msi /qn WAITFORCOMPLETION=1 CLOUDRELAY=1 SERVERNAME=%1 SERVERGUID=%2 SOURCEURLS=%3 %4 %5`
* Both with share and URL:
`%windir%\system32\msiexec.exe /I adaptiva-client-p2p--windows.msi /qn WAITFORCOMPLETION=1 CLOUDRELAY=1 SERVERNAME=%1 SERVERGUID=%2 SOURCEUNCPATH=%3 SOURCEURLS=%4 %5 %6`
4. Save this file as **Install.cmd** in the P2PClient folder.
5. Open a command prompt at the intunewin tool folder and run the following command:
`IntuneWinAppUtil.exe -c ":\\Adaptiva\P2PClient" -s Install.cmd -o ":\\Adaptiva\P2PClient"`
### Create Intune App for P2P Installer
Perform the following in Microsoft Intune.
{% hint style="info" %}
For more information on distributing line of business apps using Microsoft Intune, see .
{% endhint %}
1. Log into the Microsoft Intune admin center () using the account with the appropriate role assignment.
2. In the left-hand navigation pane, click **Apps**, then click **All Apps**.
3. Click **+ Create**.
4. In the right pane, select the **App type** drop-down.
5. Under **Other**, select **Windows app (Win32)**.
6. Click **Select**.
7. The **Add App** pane appears.
8. Click **Select app package file**.
9. In the right pane, click on the folder icon.
10. Browse to the path with your .intunewin file: `:\\Adaptiva\P2PClient` and select the install.intunewin file. Click **Open**.
11. The right pane will be updated with the package file details. Click **OK**.
12. Under the **App Information** step, update the properties with these and any other values as appropriate. These are user facing values.
* **Name** and **Description**: Update the name and description to user friendly values.
* **Publisher**: Adaptiva
13. Update the other fields as necessary and click **Next**.
14. On the **Program** tab, enter the following:
* **Install command**:
Choose the appropriate command for your environment.
* For the OneSite Patch SaaS installer:
`install.cmd`
* On-premises with a share:
`install.cmd [SERVERNAME] [SERVERGUID] [SOURCEUNCPATH] [optional parameters]`
* On Prem with the URL
`install.cmd [SERVERNAME] [SERVERGUID] [SOURCEURLS] [optional parameters]`
* Both with share and URL:
`install.cmd [SERVERNAME] [SERVERGUID] [SOURCEUNCPATH] [SOURCEURLS] [optional parameters]`
Parameters need to be in the same order as defined in Install.cmd. Be sure to replace with the specific server information.
* **Uninstall command**:
`%windir%\system32\msiexec.exe /i adaptiva-client-p2p--windows.msi UNINSTALL=1`
* **Install behavior**: System
* **Device restart behavior**: No specific action
15. Click **Next**.
16. On the **Requirements** tab, click **Yes. Specify the systems the app can be installed on.**
17. Click to select the **Install on x86 system** and **Install on x64 system** checkboxes.
18. Select the **Minimum operating system**.
19. Complete any additional requirements as needed.
20. Click **Next**
21. On the **Detection Rules** tab, click the **Rules format** drop-down and select **Manually configure detection rules**.
22. Click **+ Add**
23. In the right-hand pane, click the **Rule type** dropdown and select **MSI**.
24. Create the following rule:
* **Key path**: HKEY\_LOCAL\_MACHINE\Software\Adaptiva\Client
* **Value name:** slm.version
* **Detection method**: Value exists
* **Associated with a 32-bit app on 64-bit clients**: No
25. Click **OK**.
26. Click **Next**.
27. On the **Dependencies** tab, click **Next**.
28. On the **Supersedence** and **Scope tags** tabs, click **Next**.
29. On the **Assignments** tab, configure assignments for the following groups. Assignments do not need to be entered right now; they can be entered later.
Add a group to **Required** to force the installation.
Add a group to **Available** for enrolled devices to make the installation optional via the Company Portal app. When adding a group to Available, the group must contain Users, not Devices.
Add a group to **Uninstall** for managed devices to have this app removed.
30. Click **Next**.
31. Review the App information and click **Create**.
# Distribute full installer
Full Windows Client Installation using Intune
{% hint style="info" %}
Adaptiva recommends [deploying the P2P installer](/platform-install/client-install-and-uninstall/deploy-clients/deploy-clients-intune/deploy-clients-intune-p2p) in order to simplify deployment. If you are using a SaaS environment, use the P2P installer.
{% endhint %}
## Overview
You can create a Windows app (Win32) in Intune to install the Adaptiva Client by publishing the `adaptiva-client--windows.exe` installer. This is the full Windows client installer for the Adaptiva Client available with your installation files.
## Prerequisites
You will need to download and install the [Microsoft Win32 Content Prep Tool](https://github.com/microsoft/Microsoft-Win32-Content-Prep-Tool) to complete these steps.
## Access the Adaptiva Client
The Adaptiva Client is available from the Installation folder of the installation media. You can download the latest release from the [Product Releases](https://support.adaptiva.com/hc/en-us/sections/201965326-Product-Releases) section of the Adaptiva Support Portal.
**For users of the SaaS platform**, you can access the P2P installer or cross-platform installation scripts from your tenant. Click the **settings gear > Settings > Client Downloads.**
However, to access the full client installer you will need to download and install the Adaptiva P2P client to gain access to the full Adaptiva client.
1. Follow these [steps to download and install](/platform-install/client-install-and-uninstall/client-install#saas-client-installation) the Adaptiva P2P Client on a device.
2. On the new device, navigate to `C:\` and show hidden folders.
3. Navigate to the hidden `C:\AdaptivaCache\Client` folder and copy `AdaptivaClientSetup.exe` to an accessible location.
## Deploy the Full Client Installer
Microsoft Intune does not support `.exe` distribution, so you must create an `.intunewin` file and configure a Win32 App in Intune.
This process will download the full Adaptiva client (approx. 92MB) using Intune. It is recommended to use the P2P Client Installer method as that will only download 1Mb using Intune.
### Create Intunewin File for Full Client Installation
Download and install the [Microsoft Win32 Content Prep Tool](https://github.com/microsoft/Microsoft-Win32-Content-Prep-Tool).
1. Create a content source folder as follows:
`:\\Adaptiva\FullClient`
2. Copy the `adaptiva-client--windows.exe` from the installation source into the FullClient folder.
3. Open a command prompt at the **intunewin** tool folder and run the following command:
`Intunewinapputil -c ":\\Adaptiva\FullClient\" -s adaptiva-client--windows.exe -o ":\\Adaptiva\FullClient\"`
* The installer name will be **AdaptivaClientSetup.exe** if you sourced it from a SaaS-based client.
4. The `.intunewin` will be created in the FullClient folder.
### Create Intune App for Full Installer
1. Log into the Microsoft Intune admin center () using the account with the appropriate role assignment.
2. In the left-hand navigation pane, click **Apps**, then click **All Apps**.
3. Click **+ Create**.
4. In the right pane, select the **App type** drop-down.
5. Under **Other**, select **Windows app (Win32)**.
6. Click **Select**.
7. The **Add App** pane appears.
8. Click **Select app package file**.
9. In the right pane, click on the folder icon.
10. Browse to the path with the .intunewin file you created using the winapputil tool: `:\\Adaptiva\FullClient` and select the `.intunewin` file. Click **Open**.
11. The right pane will be updated with the package file details. Click **OK**.
12. Under the **App Information** step, update the properties with these and any other values as appropriate. These are user facing values.
* **Name** and **Description**: Update the name and description to user friendly values.
* **Publisher**: Adaptiva
13. Update the other fields as necessary and click **Next**.
14. On the **Program** tab, enter the following:
* **Install command**:
Since you are installing from Intune, you should include the -CloudRelay and -ServerGUID parameters, which enables the client to use the Cloud Relay Service to connect when off-premises. **SaaS customers** will need the -Password parameter, but will not need the -CloudRelay parameter.
`adaptiva-client--windows.exe -InstallorUpgrade -ServerName *AdaptivaServer.FQDN* -CloudRelay -ServerGUID [-Password and other optional parameters]`
* **Uninstall command**: `adaptiva-client--windows.exe -uninstall`
* **Install behavior**: System
* **Device restart behavior**: No specific action.
15. Click **Next**.
16. On the **Requirements** tab, click **Yes. Specify the systems the app can be installed on.**
17. Click to select the **Install on x86 system** and **Install on x64 system** checkboxes.
18. Select the **Minimum operating system** your organization supports.
19. Complete any additional requirements as needed.
20. Click **Next**
21. On the **Detection Rules** tab, click the **Rules format** drop-down and select **Manually configure detection rules**.
22. Click **+ Add**
23. In the right-hand pane, click the **Rule type** dropdown and select **Registry**.
24. Create the following rule:
* **Key path**: HKEY\_LOCAL\_MACHINE\Software\Adaptiva\Client
* **Value name:** slm.version
* **Detection method**: Value comparison
* **Operator**: Less than
* **Value**: 10.1.972.12
* **Associated with a 32-bit app on 64-bit clients**: No
25. Click **OK**.
26. Click **Next**.
27. On the **Dependencies** tab, click **Next**.
28. On the **Supersedence** and **Scope tags** tabs, click **Next**.
29. On the **Assignments** tab, configure assignments for the following groups. Assignments do not need to be entered right now; they can be entered later.
Add a group to **Required** to force the installation.
Add a group to **Available** for enrolled devices to make the installation optional via the Company Portal app. When adding a group to Available, the group must contain Users, not Devices.
Add a group to **Uninstall** for managed devices to have this app removed.
30. Click **Next**.
31. Review the App information and click **Create**.
# Distribute macOS installer
How to deploy the adaptiva macOS client with Microsoft Intune.
## Overview
You can easily add the Adaptiva macOS client installer as a macOS app (PKG) in Microsoft Intune. This will distribute the client to macOS devices and configure their connection to the Adaptiva server.
If you are using a SaaS instance, the installation configuration will differ. Skip to the instructions for a [SaaS client deployment using Intune](#saas-client-deployment-using-intune).
### Access the Adaptiva Client
The Adaptiva Client is available from the Installation folder of the installation media. You can download the latest release from the [Product Releases](https://support.adaptiva.com/hc/en-us/sections/201965326-Product-Releases) section of the Adaptiva Support Portal.
### Create macOS App
1. Log into the Microsoft Intune admin center () using the account with the appropriate role assignment.
2. In the left-hand navigation pane, click **Apps**, then click **All Apps**.
3. Click **+ Add**.
4. In the Select app type pane, click the **App type** drop-down.
5. Under the Other app types, select **macOS app (PKG)**.
6. Click **Select** to open the Add App steps.
### Select the app package file
1. On the **App Information** pane, click **Select app package file**.
2. In the App package file pane, select the **Browse** button. Browse to the path where the installation files were located and select the `adaptiva-client--macOS.pkg` file. Click **Open**. The app details are displayed.
3. Click **OK** on the App package file pane to add the app.
4. On the **App information** page, update the properties with these and any other values as appropriate. These are user facing values.
* **Name** and **Description**: Update the name and description to user friendly values.
* **Publisher**: Adaptiva
5. Complete any addition app information and click **Next**.
6. On the **Program** page, enter the following **Post-install script**:
```bash
#! /bin/bash
sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup -server -server-guid
```
* Update the configuration script with any valid parameters. See the [adaptivactl command line parameters](https://docs.adaptiva.com/platform-install/client-install-and-uninstall/client-install/client-install-linux-macos#adaptivactl-command-line-parameters) reference for details.
7. Click **Next**.
8. Click the Minimum operating system drop-down and select **macOS Ventura 13.0**.
9. Click **Next**.
10. On the **Detection Rules** tab, ensure **Yes** is selected for ignore app version. Update the **App Version** to the version listed in the name of the .pkg file.
11. Click **Next**.
12. On the **Supersedence** and **Scope tags** tabs, click **Next**.
13. On the **Assignments** tab, configure assignments for the following groups. Assignments do not need to be entered right now; they can be entered later.
Add a group to **Required** to force the installation.
Add a group to **Available** for enrolled devices to make the installation optional via the Company Portal app. When adding a group to Available, the group must contain Users, not Devices.
Add a group to **Uninstall** for managed devices to have this app removed.
14. Click **Next**.
15. Review the App information and click **Create**.
## SaaS Client Deployment using Intune
If you are using a SaaS instance, you can access the macOS installation script (`adaptiva-client--install-unix.sh`) from the Cloud Admin Portal.
{% hint style="info" %}
If the Authorization token is updated, you must re-download the installation script and update your macOS script. See these instructions [if the authorization token is updated](#if-authorization-token-updated).
{% endhint %}
1. Log in to your cloud tenant and click the **settings gear > Settings > Client Downloads**. Download the macOS Client installation script to an accessible location.
2. Log into the Microsoft Intune admin center () using the account with the appropriate role assignment.
3. In the left-hand navigation pane, click **Devices**.
4. Under **By platform**, click **macOS**. Then under **Manage devices**, click **Scripts**.
5. Click **+ Add**.
6. On the **Basics** page, enter a **Name** and **Description** for the script policy, then select **Next**.
7. On the **Script settings** page, click the **Browse** button. Browse to the path where the macOS install script is located and select the `adaptiva-client--install-unix.sh` file. Click **Open**. The script details are displayed.
8. Configure the following script settings:
* Run script as signed-in user: **No**
* Hide script notifications on devices: **Not Configured**
* Script frequency: **Not Configured**, this will run the script only 1 time.
* Max number of times to retry if script fails: **Not Configured**.
9. Select **Next**.
10. On the **Scope tags** tab, click **Next**.
11. On the **Assignments** tab, configure assignments for the following groups. Assignments do not need to be entered right now; they can be entered later.
Add a group to **Included groups** to install the client on these devices.
Add a group to **Excluded groups** if necessary.
12. Click **Next**.
13. Review the script information and click **Add**.
### If authorization token updated
1. On the macOS | Scripts page, select the previously created script.
2. Under **Manage**, click **Properties**.
3. In the details pane, next to **Settings**, click **Edit**.
4. Click the **Browse** button, and browse to the updated .sh file. Click **Open**.
5. Click **Review + save**.
6. Review the script information and click **Save**.
# Deploy clients with ConfigMgr
Client Installation using ConfigMgr
You can use ConfigMgr to perform a large-scale, production deployment of the Adaptiva client. As with all Software Distribution in ConfigMgr, the first step is to create the package and program(s). If you are using Operating System Deployment, a package and program will be needed in the task sequence, do not use an application.
The application model can also be used for Adaptiva client deployment outside of a task sequence.
## (SaaS only) Access the Full Adaptiva Client
**For users of OneSite Patch SaaS**, you will need to download and install the Adaptiva P2P client to gain access to the full Adaptiva client.
1. Follow these [steps to download and install](/platform-install/client-install-and-uninstall/client-install#saas-client-installation) the Adaptiva P2P Client on a device.
2. On the new device, navigate to `C:\` and show hidden folders.
3. Navigate to the hidden `C:\AdaptivaCache\Client` folder and copy `AdaptivaClientSetup.exe` to an accessible location.
## Create a Package from the Package Definition File
To facilitate creating a pre-defined ConfigMgr package and program, the Adaptiva server provides a Package Definition File. You can find the **AdaptivaClientSetupSilent.sms** file on the Adaptiva server under `\Program Files\Adaptiva\AdaptivaServer\config`.
1. Create a new folder called **Adaptiva** in the content source file repository.
2. Copy the `adaptiva-client--windows.exe` file from the installation source to the new folder.
3. Rename the client installer to **AdaptivaClientSetup.exe**. *This is an essential step to ensure a successful package configuration.*
4. In the ConfigMgr console, open the **Software Library** workspace.
5. In the navigation pane, expand **Application Management**, then right-click **Packages** and select **Create Package from Definition**.
6. On the **Package Definition** page, click **Browse** and navigate to `\Program Files\Adaptiva\AdaptivaServer\config` folder on the Adaptiva server and select the **AdaptivaClientSetupSilent.SMS** file.
7. Click **Open**. The package name and version will be displayed. Select it and then click **Next**.
8. At the **Source Files** page, select **Always obtain source files from a source folder** and click **Next**.
9. At the **Source Folder** page, enter the UNC path to the **Adaptiva** folder created in step 1 and click **Next**.
10. Complete the **Create Package from Definition Wizard**. This will create a new **AdaptivaClient** package.
11. Click the **Programs** tab under the package details.
The package includes 8 programs for the installation, upgrade, and uninstallation of the Adaptiva client.
| Name | Command Line | Description |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| CleanInstall | `AdaptivaClientSetup.exe -cleaninstall -servername ` | Uninstalls The Adaptiva Client Health And OneSite Client, And Installs It Again |
| CleanInstallInternet | `AdaptivaClientSetup.exe -cleaninstall -servername -serverguid -cloudrelay` | Uninstalls The Adaptiva Client Health And OneSite Client, And Installs It Again - Supports Cloud Relay |
| CleanInstallInternetNoCacheDelete | `AdaptivaClientSetup.exe -cleaninstall -servername -nocachedel -serverguid -cloudrelay -nocachedel` | Uninstalls The Adaptiva Client Health And OneSite Client, And Installs It Again - Supports Cloud Relay |
| CleanInstallNoCacheDelete | `AdaptivaClientSetup.exe -cleaninstall -servername -nocachedel` | Uninstalls The Adaptiva Client Health And OneSite Client, And Installs It Again |
| InstallOrUpgrade | `AdaptivaClientSetup.exe -installorupgrade -servername ` | Installs The Adaptiva Client Health And OneSite Client, Or Upgrades It If Already Installed |
| InstallOrUpgradeInternet | `AdaptivaClientSetup.exe -installorupgrade -servername -serverguid -cloudrelay` | Installs The Adaptiva Client Health And OneSite Client, Or Upgrades It If Already Installed - Supports Cloud Relay |
| Uninstall | `AdaptivaClientSetup.exe -uninstall` | Uninstalls the Adaptiva Client Health And OneSite Client |
| UninstallNoCacheDelete | `AdaptivaClientSetup.exe -uninstall -nocachedel` | Uninstalls the Adaptiva Client Health And OneSite Client |
{% hint style="info" %}
You can find more information on the Adaptiva client installation switches in the [Client Install](/platform-install/client-install-and-uninstall/client-install) documentation.
{% endhint %}
By default, these programs will be set to display notifications to users when deployed unless notifications are suppressed via client policy.
12. To disable notifications, right-click the program and click **Properties**.
13. Click the **Advanced** tab.
14. Check the **Suppress program notifications** checkbox and click **OK**.
You can now deploy the program to collections of devices in your environment.
## Create an Application using the EXE
You can also deploy the Adaptiva client by creating a ConfigMgr application and deployment type using the `adaptiva-client--windows.exe`.
1. Create a new folder called **Adaptiva** in the content source file repository.
2. Copy the `adaptiva-client--windows.exe` file from the installation source to the new folder.
3. In the ConfigMgr console, open the **Software Library** workspace.
4. In the navigation pane, expand **Application Management**, then right-click **Applications** and click **Create Application**. The Create Application Wizard appears.
5. On the General page, select **Manually specify the application information** and click **Next**.
6. On the General Information page, enter the information:
Name: **Adaptiva Client Setup**
Publisher: **Adaptiva**
Software version: ``
Enter the other fields as required by your company's standards.
7. Click **Next**.
8. On the Software Center page enter the information as required by the company's standards and click **Next**.
9. On the Deployment Types page, click **Add...**. The Create Deployment Type Wizard appears.
10. On the General page, click the **Type** drop-down and select **Script Installer**.
11. The **Manually specify the deployment type information** radion button will be automatically selected. Click **Next**.
12. On the General Information page, enter a Name of **Adaptiva Client Setup**, then click **Next**.
13. On the Content page, next to Content location, click **Browse**.
14. Select **Browse...** and enter the UNC path to where the Adaptiva client was copied.
15. Next to Installation program, click Browse and select the `adaptiva-client--windows.exe` file.
16. Add the following switches to the Installation program:
`adaptiva-client--windows.exe -INSTALLORUPGRADE -SERVERNAME | -SERVERIP -CloudRelay`
If you are using the Cloud Relay service or if HTTP client communications will be used, include the following switches:
Cloud Relay service: `-CloudRelay`, `-ServerGUID `, `-Password ` HTTP communications: `-ServerURL `
17. Next to Uninstall program, click Browse and select select the `adaptiva-client--windows.exe` file.
18. Add the following switches to the Uninstall program:
`adaptiva-client--windows.exe -UNINSTALL`
{% hint style="info" %}
You can find more information on the Adaptiva client installation switches in the [Client Install](/platform-install/client-install-and-uninstall/client-install) documentation.
{% endhint %}
19. Click **Next**.
#### Create Detection Method
1. On the Detection Method page, click **Add Clause...**.
2. From the Setting Type drop-down, select **Registry**.
3. Next to Hive, click **Browse...**.
4. Enter the Adaptiva Server computer name and click **Connect**.
5. Expand the Adaptiva server node and navigate to `HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Uninstall\AdaptivaClient`.
6. In the Registry Value pane, select **DisplayName** and click **OK**.
7. Select the **This registry setting must satisfy the following rule to indicate the presence of this application** radio button. The current value will be automatically entered.
8. Click **OK**.
#### Complete the Wizard
1. Click **Next**.
2. On the User Experience page, next to Installation behavior, select **Install for system**.
3. Next to Logon requirement, select **Whether or not a user is logged on**.
4. Next to Installation program visibility, select **Hidden**.
5. Click **Next**.
6. On the **Requirements** page, click **Next**.
7. On the **Dependencies** page, click **Next**.
8. On the **Summary** page, click **Next** and then click **Close** when the wizard has completed successfully.
9. On the Deployment Types page, click **Next**.
10. Click **Next** on the Summary page and then click **Close** when the wizard has completed successfully.
11. Right-click the **Adaptiva Client Setup** application and click **Distribute Content**.
12. Complete the Distribute Content Wizard with the necessary Distribution Point or Distribution Point Group.
## Create an Application using the P2P MSI
You can distribute the Peer-to-peer (P2P) installer using a ConfigMgr application and deployment type.
1. Create a new folder called **Adaptiva** in the content source file repository.
2. Copy the `adaptiva-client-p2p--windows.msi` file from the installation source to the newly created folder.
3. In the ConfigMgr console, open the **Software Library** workspace.
4. In the navigation pane, expand **Application Management**, then right-click **Applications** and click **Create Application**. The Create Application Wizard appears.
5. On the General page, click **Browse...**, enter the UNC path to the content source and select the `adaptiva-client-p2p--windows.msi` file. Click **OK**.
6. Click **Next**.
7. On the **View imported information page**, verify that the application information was successfully imported from the Windows Installer (\*.msi file) and click **Next**.
8. On the **General Information** page, update any information as required. We recommended that you at least add the Publisher and Software version information.
9. Next to Installation program, update the command line using the following switches:
```cmd
msiexec.exe /I adaptiva-client-p2p--windows.msi /qn SERVERNAME= SOURCEUNCPATH=\\\AdaptivaClient\AdaptivaClientSetup.exe WAITFORCOMPLETION=1
```
If you are using the Cloud Relay service or if HTTP client communications will be used, include the following switches:
Cloud Relay service: `-CloudRelay`, `-ServerGUID `, `-Password ` HTTP communications: `-ServerURL `
10. Click **Next**.
11. On the **Summary** page, click **Next** and then click **Close** when the wizard has completed successfully.
12. In the Applications details, select the **Adaptiva Peer To Peer Client Installer** application.
13. Select the **Deployment Types** tab in the application details.
14. Right-click the deployment type and click **Properties**.
15. Select the **Content** tab.
16. Check the **Allow clients to use distribution points from the default site boundary group** box.
17. Next to Deployment options, select **Download content from distribution point and run locally**.
18. Select the **Detection Method** tab.
Notice the detection method. The MSI product code is specific to this version of the Adaptiva Client P2P Installer.
19. Click **OK**.
20. To make this visible in Software Center, right-click the application and click **Properties**.
21. On the General Information and Software Center tabs, update the information as required per the company's standards. Click **OK** when finished.
22. Right-click the application and click **Distribute Content**.
23. Complete the Distribute Content Wizard with the necessary Distribution Point or Distribution Point Group.
# Deploy clients with Jamf
Jamf instructions to deploy clients
You can use Jamf to perform a large-scale, production deployment of the Adaptiva client for macOS. The general shape of this process follows:
1. At the command line, install the package.
2. In Jamf, add a configuration script.
3. In Jamf, configure a policy.
4. At the command line, run the configuration script.
More detail for each of these steps is provided below.
## Install the Package File
The Adaptiva client for Mac is a package file (.pkg) found in the installer zip. You will need to know the version number, so you may want to extract files from the zip before you begin.
1. At the command line, type the following: `sudo installer -tgt / -pkg ./adaptiva-client--macOS.pkg`
2. Open Jamf.
{% hint style="info" %}
You can find more information on Adaptiva client installation and macOS in the [Client Installation on Linux or macOS](https://docs.adaptiva.com/platform-install/client-install/client-install#client-installation-on-linux-or-macos) documentation.
{% endhint %}
## Link the Package File to Jamf
When you get to the script stage of this process, Jamf will need to know how to find the package file. You can set those parameters in a New Package dialog.
1. In Jamf, go to **Settings > Computer Management > Packages**.
2. Click **New Package**.
3. Check to make sure you have selected the **General** tab.
4. In the **Filename** box, browse to the **adaptiva-client-\-macOS.pkg** file or drag the file into the box.
5. In the **Display name** box, type **Adaptiva**.
6. In the **Category** dropdown, select **Utilities**.
## Add a Script to the New Package
For each device, a post-install script runs to configure the Adaptiva client with information like your server name and GUID. You can store the script in Jamf and link it to the package.
1. In Jamf, go to **Settings > Computer Management > Scripts**.
2. Click **New Script**.
3. Check to make sure you have selected the **General** tab.
4. In the **Display name** box, type **Adaptiva**.
5. In the **Category** dropdown, select **Utilities**.
6. Select the **Script** tab.
7. Customize and save the following script: `sudo /opt/adaptiva/adaptivaclient/bin/adaptivactl setup --server --server-guid --no-connection-checks`
## Set a Policy for the Package
**Configure the Policy**
You'll want to configure a new policy that connects the Adaptiva script to policy options, such as triggers and execution frequency. By setting options at the policy level, you gain flexibility and easier management across different environments.
1. In Jamf, go to **Computers > Policies**.
2. Click **New Policy**.
3. Check to make sure you have selected the **Options** tab and **General** settings.
4. In the **Display Name** box, give the policy a meaningful name, such as **PRA install - Checkin with Limited Scope**.
5. In the **Trigger** section, select **Recurring Check-in**.
6. In the **Execution Frequency** dropdown, select **Once per computer**.
7. Set any other optional parameters.
8. When asked for details, add the Adaptiva package.
**Set a Scope for the Initial Deployment**
For the initial deployment, you should limit the scope for a test run.
1. On the **New Policy** screen, check to make sure you have selected the **Scope** tab.
2. In the **Target Computers** dropdown, select **Specific Computers**.
3. In the **Target Users** dropdown, select **Specific Users**.
## Run the Configuration Script
**Prerequisites**
Before you run the configuration script, be sure to have the following pieces in place:
* Jamf policy
* Recurring check-in trigger
* Once-per-computer execution frequency
* Adaptiva package installed
**Run the Script**
1. At the Command Line, launch the policy by typing the following: `sudo jamf policy`
2. You may have to provide your credentials.
3. Jamf will check for policies triggered by **recurring check-in** for your user name.
4. You should see the text **Executing Policy Adaptiva** and a series of automated status reports.
5. A validator runs inside the script to make sure the connections are set up correctly.
## Validate the Deployment
In the Adaptiva Admin Portal, you can see whether Jamf and Adaptiva have communicated successfully with the devices in the Scope you set for this deployment.
1. In the Adaptiva Admin Portal, got to **Platform Features**, and then navigate to **Asset Devices**.
2. Confirm that the Adaptiva client is present.
3. You can also confirm any updates to the OS, client version, or product compliance.
{% hint style="info" %}
You can find more information about the various validation checks available in Adaptiva in the [Client Validator](https://docs.adaptiva.com/platform-guide/client-management/client-validator) documentation.
{% endhint %}
# Uninstall Client
How to uninstall Adaptiva clients on Windows, macOS, and Linux devices.
## Uninstall the Windows client
The experience to uninstall the Adaptiva Client changes slightly between the full Windows installer and the P2P installer.
### Full Windows Installer
Run the `adaptiva-client--windows.exe` and select the **Uninstall** button. To run the uninstallation silently, run the corresponding installation executable with a `-uninstall` switch on the command-line.
For example:
```shell
adaptiva-client--windows.exe -uninstall
```
### Windows P2P Installer
The Peer-to-Peer (P2P) client MSI installer can also be used to perform a client uninstallation. You can run the installer and select the **Uninstall** button or you can run a silent uninstallation from the command-line with the `-uninstall` switch.
For example:
```shell
msiexec.exe /i adaptiva-client-p2p--windows.msi /qn UNINSTALL=1
```
### Uninstall with cached data
This uninstall command removes any version of the Adaptiva Client, whereas the standard Windows Installer parameter (/x) only removes the specific version associated with the MSI, since each MSI is version-specific.
* Uninstall and leave the files in the AdaptivaCache folder:
```shell
msiexec.exe /I adaptiva-client-p2p--windows.msi /q UNINSTALL=1 NOCACHEDEL=1
```
## Uninstall the Linux Client
Open a command shell and run the following command:
```bash
sudo apt remove adaptiva-client
```
or
```bash
sudo dnf remove adaptiva-client
```
or
```bash
sudo zypper remove adaptiva-client
```
## Uninstall the MacOS Client
Open a command shell and run the following command:
```zsh
sudo /opt/adaptiva/adaptivaclient/bin/uninstall
```
# Communication ports
## List of All Adaptiva Ports
[List of All Adaptiva Ports](https://adaptiva.com/hubfs/Docs/OneSite-Port-Detail.pdf).
## Communication Port and Flow Diagrams
[Communication Port and Flow Diagrams](https://adaptiva.com/hubfs/Docs/OneSite-Communications-Port-and-Flow-Diagram.pdf).
## Additional Firewall Rules
### Adaptiva Server Firewall Rule NETSH Commands
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server -- 1\" action=allow dir=in enable=yes profile=domain localport=34545 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server -- 2\" action=allow dir=in enable=yes profile=domain localport=34339 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server -- 3\" action=allow dir=in enable=yes profile=domain localport=34341 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server -- 4\" action=allow dir=in enable=yes profile=domain localport=34331 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server -- 5\" action=allow dir=in enable=yes profile=domain localport=34333 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Server Service\" action=allow dir=in enable=yes profile=domain protocol=any edge=no program=\\\AdaptivaServer\\bin\\AdaptivaServerService.exe
```
### Adaptiva Client Firewall Rule NETSH Commands
Sometimes client VPN solutions or corporate Wi-Fi networks may show as Public or Private profile; therefore, it is often best to add the rule to all profiles for clients. To do this change the **profile=domain** values for each line to **profile=domain,private,public**
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client Service\" action=allow dir=in enable=yes profile=domain,private,public protocol=any edge=no program=\"\\\Adaptiva\\AdaptivaClient\\bin\\AdaptivaClientService.exe\"
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client\" action=allow dir=in enable=yes profile=domain,private,public localport=34760,34750,34546,34335,34337,34343,34345 protocol=udp edge=no
```
The following rules are deprecated:
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 1\" action=allow dir=in enable=yes profile=domain localport=34760 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 2\" action=allow dir=in enable=yes profile=domain localport=34750 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 3\" action=allow dir=in enable=yes profile=domain localport=34546 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 4\" action=allow dir=in enable=yes profile=domain localport=34335 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 5\" action=allow dir=in enable=yes profile=domain localport=34337 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 6\" action=allow dir=in enable=yes profile=domain localport=34343 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client -- 7\" action=allow dir=in enable=yes profile=domain localport=34345 protocol=udp edge=no
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client Service\" action=allow dir=in enable=yes profile=domain protocol=tcp edge=no program=\<*path*\>\\AdaptivaClient\\bin\\AdaptivaClientService.exe
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Client Service\" action=allow dir=in enable=yes profile=domain protocol=udp edge=no program=\<*path*\>\\AdaptivaClient\\bin\\AdaptivaClientService.exe
```
### Adaptiva Workbench Firewall Rule NETSH Commands
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Workbench\" action=allow dir=in enable=yes profile=domain protocol=udp edge=no program=\<*AdaptivaServerInstallPath*\>\\AdaptivaWorkbench\\AdaptivaWorkbench.exe
```
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva Workbench\" action=allow dir=in enable=yes profile=domain protocol=tcp edge=no program=\<*AdaptivaServerInstallPath*\>\\AdaptivaWorkbench\\AdaptivaWorkbench.exe
```
### Adaptiva Server to ACC Firewall Rule NETSH Commands
This should be run on the Adaptiva Server when outbound rules are restricted.
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva to ACC\" action=allow dir=out enable=yes profile=domain protocol=udp remoteport=34320 edge=no \[remoteip=\\]
```
This should be run on the Adaptiva Server when inbound rules are restricted
```netsh
netsh advfirewall firewall add rule name = \"ACC to Adaptiva UDP\" action=allow dir=in enable=yes profile=domain protocol=udp localport=34323 edge=no \[remoteip=\\]
```
```netsh
netsh advfirewall firewall add rule name = \"ACC to Adaptiva HTTPS\" action=allow dir=in enable=yes profile=domain protocol=tcp localport=54322 edge=no \[remoteip=\\]
```
### ACC to Adaptiva Server Firewall Rule NETSH Commands
This should be run on the ACC Server when inbound rules are restricted. The range 192.30.64.0-192.30.79.255 are public IP Addresses for AirWatch servers.
```netsh
netsh advfirewall firewall add rule name = \"Adaptiva to ACC\" action=allow dir=in enable=yes profile=domain protocol=udp localport=34320 edge=no \[remoteip=\\]
```
```netsh
netsh advfirewall firewall add rule name = \"Airwatch\" action=allow dir=in enable=yes profile=domain protocol=tcp localport=443 edge=no \[remoteip=192.30.64.0-192.30.79.255\]
```
This should be run on the ACC Server when outbound rules are restricted.
```netsh
netsh advfirewall firewall add rule name = \"ACC to Adaptiva UDP\" action=allow dir=out enable=yes profile=domain protocol=udp remoteport=34323 edge=no \[remoteip=\\]
```
```netsh
netsh advfirewall firewall add rule name = \"ACC to Adaptiva HTTPS\" action=allow dir=out enable=yes profile=domain protocol=tcp remoteport=54322 edge=no \[remoteip=\\]
```
```netsh
netsh advfirewall firewall add rule name = \"Airwatch\" action=allow dir=out enable=yes profile=domain protocol=tcp remoteport=443 edge=no \[remoteip=192.30.64.0-192.30.79.255\]
```
# SPNs and delegation
In order to support moving to dedicated SQL Servers or SQL Always On Availability Groups, you will need to configure SPNs (Service Principle Name) and Kerberos delegations in your environment. This article is helpful to understand the principles of SQL Server connectivity: .
## Create the SPNs
For Windows 2019 or earlier, we recommend using the Kerberos Configuration Manager utility, which can be downloaded from [Microsoft](https://www.microsoft.com/en-us/download/details.aspx?id=39046). This tools is not supported beyond Windows 2019 and SQL Server 2019.
{% hint style="info" %}
This utility may not work if the SQL Server is in a different domain than the SQL Service accounts or if there are many groups added to the local Administrators group.
{% endhint %}
### Use Kerberos Configuration Manager to set SPN's
*Only supported on Windows 2019 and SQL Server 2019 or earlier.*
Use the following steps in Kerberos Configuration Manager.
1. Log into the SQL Database server using an account in the local Administrators group.
2. Install the Kerberos Configuration Manager utility.
3. Navigate to **C:\Program Files\Microsoft\Kerberos Configuration Manager for SQL Server** and launch **KerberosConfigMgr.exe**.
4. Click **Connect** from the menu and then click **Connect** without entering any info.
5. Select the **SPN** tab.
6. Scroll all the way to the right and notice the Required SPN and Status columns.
{% hint style="info" %}
These next steps must be done with a Domain Admin account. They do not have to be executed on the database server.
{% endhint %}
1. If able to modify the service accounts, click on **Fix All** (or do them individually) otherwise, click **Generate All**, enter a file name and provide that script to an administrator with the appropriate permissions.
2. After the fix script(s) has been run, to confirm the SPNs have been created successfully, click on **Refresh**. Scroll to the right to confirm the status is **Good** for all rows.
### Use setspn command-line tool to set SPN's
Use the `setstpn` command line tool to create the SPN's.
1. Log into the SQL Database server using an account in the local Administrators group.
2. Open an administrative command prompt and type:
```shell
setspn -L \
```
For example, executing this command will return the following:
```shell
C:\Users\administrator>setspn -L \sqlservice
Registered ServicePrincipalNames for CN=SQLService,OU=Accounts,DC=,DC=lab:
MSSQLSvc/SQLSERVER..lab:1433
MSSQLSvc/SQLSERVER..lab
```
{% hint style="info" %}
These next steps must be done with a Domain Admin account. They do not have to be executed on the database server.
{% endhint %}
1. Create the SPNs:
```shell
setspn -S MSSQLSvc/ \
setspn -S MSSQLSvc/