SolarWinds Platform 2024.1 Installation Guide
SolarWinds Platform 2024.1 Installation Guide
SolarWinds Platform
Version 2024.1
This document may not be reproduced by any means nor modified, decompiled, disassembled,
published or distributed, in whole or in part, or translated to any electronic medium or other means
without the prior written consent of SolarWinds. All right, title, and interest in and to the software,
services, and documentation are and shall remain the exclusive property of SolarWinds, its affiliates,
and/or its respective licensors.
The SolarWinds, SolarWinds & Design, Orion, and THWACK trademarks are the exclusive property of
SolarWinds Worldwide, LLC or its affiliates, are registered with the U.S. Patent and Trademark Office,
and may be registered or pending registration in other countries. All other SolarWinds trademarks,
service marks, and logos may be common law marks or are registered or pending registration. All
other trademarks mentioned herein are used for identification purposes only and are trademarks of
(and may be registered trademarks) of their respective companies.
To enable the primary SolarWinds Platform server to reach your scalability engines, do
not stop the SolarWinds Administration Service on your scalability engines before the
upgrade.
Installation overview
The following image provides an overview of the installation or upgrade process.
Next steps
Use the information in the following topics to install or upgrade SolarWinds Platform products and
scalability engines.
Install your first SolarWinds Platform Install SolarWinds Platform products in a new
products environment
Install a new scalability engine Install an additional polling engine, additional web
server, or HA server
For new SolarWinds Platform product installations in Amazon Web Services in a virtual
private cloud (VPC), see Deploy SolarWinds Platform products to Amazon Web Services.
For new SolarWinds Platform product installations in Microsoft Azure in an Azure Virtual
Network (VNet), see Deploy SolarWinds Platform products to Microsoft Azure.
You can deploy Orion Platform 2019.4 and later products using Azure Marketplace. For
details, see Install SolarWinds Platform products using Azure Marketplace.
SolarWinds strongly recommends that you install the SolarWinds Platform on a server
that is neither public, nor internet-facing. To learn about best practices for configuring
your SolarWinds Platform installation securely, see Secure Configuration for the
SolarWinds Platform.
Use the following links and the multi-module environments guidelines to make sure your
environment has all of the required hardware and software.
l DPAIM Current version | Previous versions
l EOC Current version | Previous versions
l Hybrid Cloud Observability Current version | Previous versions
l IPAM Current version | Previous versions
l LA (formerly Log Manager) Current version | Previous versions
l NCM Current version | Previous versions
l NPM Current version | Previous versions
l NTA Current version | Previous versions
l SAM Current version | Previous versions
l SCM Current version | Previous versions
l SolarWinds Platform and Orion Platform Current version | Previous versions
l SRM Current version | Previous versions
l UDT Current version | Previous versions
l VMAN Current version | Previous versions
l VNQM Current version | Previous versions
l WPM Current version | Previous versions
Review your product licenses and maintenance status and determine if you need to make any
changes. You can download license keys for your new SolarWinds Platform products through
the Customer Portal. Discuss license upgrades with your SolarWinds account manager or
contact SolarWinds.
Gather credentials.
Make sure you have all account credentials, SolarWinds Platform database credentials, your
SolarWinds account, and local admin server credentials.
Migrating adds time to your upgrade, but upgrades provide a good opportunity to update your
environment. See the Migration Guide for more information.
Be aware that having an out-of-maintenance product can prevent you from upgrading products that
are currently under maintenance. This occurs when the out-of-maintenance product is not
compatible with the latest version of the SolarWinds Platform.
Example: You have IPAM out of maintenance. You want to upgrade NPM. Upgrading NPM would
also upgrade the platform to a version that is incompatible with your version of IPAM. The installer
reports the issue and suggests resolutions, but it does not allow you to upgrade NPM until the issue
is resolved.
Recommendations:
l Renew. SolarWinds highly recommends renewing. Products under maintenance have
access to technical support and all the latest upgrades.
l Uninstall the product that restricts your upgrade.
l Move the out-of-maintenance product to a different server. See the Migration Guide for
details.
Set up the maintenance window, preferably during off-peak hours. Depending on the number
of products, size of the databases, and size of the environment, you might need several hours
to complete your installation.
When you upgrade an Orion Platform 2019.2 or later in an online environment, you can
save time during the upgrade by pre-staging the installation files.
Back up your SolarWinds Platform database. If you need help, check your vendor's site for
instructions.
If your SolarWinds Platform server is on a virtual machine, create a snapshot or copy of your
VM.
Before installation, check for and run any Windows updates on all servers. If a Windows
update runs during the installation, your system might reboot. The installation cannot
complete if your system is waiting to reboot.
Open the ports required by your products and any additional features you have enabled. For
example, SolarWinds high availability has additional port requirements beyond product
needs. The SolarWinds Platform uses these ports to issue management commands and to
send and receive data.
Next steps
l If you do not already have SolarWinds Platform products installed, see Install SolarWinds
Platform products in a new environment.
l To upgrade products in an existing deployment, see Upgrade an existing deployment.
l To install a new scalability engine, see Install an Additional polling engine, Additional web
server, or HA server in a SolarWinds Platform deployment.
l To install hotfixes or additional products for evaluation without upgrading, see Install a new
SolarWinds Platform product in an existing deployment.
If you're installing EOC, it must be installed on its own server. To install EOC, download the
appropriate installer and run it, as described in the following sections. The installer
automatically installs only EOC.
SolarWinds strongly recommends that you install the SolarWinds Platform on a server that is
neither public, nor internet-facing. To learn about best practices for configuring your
SolarWinds Platform installation securely, see Secure Configuration for the SolarWinds
Platform.
If you are a SolarWinds customer, download the SolarWinds Installer from the Customer Portal:
You need to download only one product module, even if you plan to install multiple
products.
To minimize the time required to run the SolarWinds Installer, install .NET 4.8 on your primary
SolarWinds Platform servers and all scalability engines before you run the installer.
1. Run the installer .exe file on your primary SolarWinds Platform server as Administrator.
2. On the Welcome page, click Start.
3. On the Installation Type page, click Standard Platform. Then click Next.
To install a scalability engine, see Install an additional polling engine, additional web
server, or SolarWinds Platform high availability server.
4. On the License Agreement page, review the EULA. If you agree, select the checkbox, and then
click Next.
5. On the Installation Options page:
a. Under SQL Server, select one of the following:
l For a standard installation (for example, in a production environment), select Use
SQL Server.
A dedicated, separate SQL Server Standard or Enterprise database (physical or
virtual machine) must be available on the SolarWinds Platform database server.
For the requirements for the SolarWinds Platform database, see the SolarWinds
Platform System Requirements. For Microsoft SQL Server installation instructions,
see the SQL Server Installation Guide.
l For a lightweight installation, select Install SQL Server Express.
SQL Server Express is approved only for evaluations. This option installs SQL
Server Express locally and then installs SolarWinds Platform products as quickly as
possible using global settings. You select only the installation location and your
preferred product language.
SQL Server Express has a 10 GB storage limit, which is not sufficient for many
SolarWinds Platform deployments. If you later require a larger database, you must
migrate to a SQL Server Standard or Enterprise database.
b. Choose the language.
c. (Optional) If you do not want to install SolarWinds Platform products in the default
location, browse to the desired location and select it.
d. Click Next.
The installer performs a system check to ensure that your environment meets the
minimum requirements and to look for any potential problems. The results of the system
check are displayed on the Installation Report page.
b. If any issues were found, click the to see detailed information about the issue.
c. If there are issues that prevent installation, resolve them and click Retest to run the
system check again.
d. Click Install to start the installation.
When the installation is complete, a confirmation message is displayed.
If you intend to use Windows authentication for the SolarWinds Platform, remember to
exempt that user account from any password change policies. An expired password will
cause the SolarWinds Platform to stop data collection and interrupt SolarWinds
Platform Web Console access.
4. On the Database Settings page, select your existing SolarWinds Platform database, or create a
new database for a new installation, and click Next.
5. On the Database Account page, create an account or specify an existing account that the
polling engine and SolarWinds Platform Web Console will use to access the database. The
account can be a Windows or SQL Server account.
If you specify any port other than 80, include that port in the URL used to access
the SolarWinds Platform Web Console.
c. To configure SSL, click Enable HTTPS and select your SSL certificate.
If a certificate is not available, select the option to Generate Self-Signed Certificate. The
Configuration Wizard automatically generates a self-signed certificate issued to the
hostname or FQDN and adds it to the trusted certificate store.
If you select Skip website binding, the Configuration wizard does not make
changes within the website configuration in your IIS. This option prevents IP
address, port, and SSL certificate options.
If the SolarWinds Platform Web Console doesn't open automatically (for example, if it
times out before opening), do one of the following to open it manually:
l Click Start > All Programs > SolarWinds > SolarWinds Platform Web Console.
l Open a web browser on your SolarWinds Platform server and enter
http://ipAddress or http://hostname, where ipAddress is the IP address of
your server and hostname is the host name of your server. Enter https:// if you
selected SSL.
12. Log in with user name admin. Enter a password for the admin account, confirm the password,
and then click Save & Login.
Get the license key for your product from the Customer Portal. You might need multiple licenses:
one for each product, HA backup server, additional polling engine, and additional web server.
Add and activate the license key using the web-based License Manager in the SolarWinds Platform
Web Console.
Additional polling engines (APEs) or an additional web server can be used to increase the
monitoring capacity of your SolarWinds Platform deployment. SolarWinds Platform High Availability
(HA) provides a backup server to protect your main SolarWinds Platform server.
l For more information about options to scale your SolarWinds implementation, see
Scalability Engine Guidelines for SolarWinds Platform products.
l For details about implementing SolarWinds Platform High Availability, see the full HA
documentation.
l License stacking does not require installing a scalability engine. License stacking
increases polling capacity by assigning multiple licenses to a polling engine.
Install the primary SolarWinds Platform server first. Then install each APE.
When you install an APE or Additional web server, verify the port requirements.
If you are going to install a backup server for SolarWinds Platform High Availability , review
the SolarWinds Platform High Availability requirements.
Acquire a user name and password with administrative privileges to the SolarWinds
Platform Web Console on your primary SolarWinds Platform server.
Be sure the APE uses the same SolarWinds Platform database as the primary SolarWinds
Platform server.
Verify the latency between your SolarWinds Platform database server and the APE.
Performance degradation can begin around 200 ms. Ping the SolarWinds Platform database
server to find the current latency.
If you have an alert with a Send Email action that runs against a node monitored by an APE,
confirm that the APE can access your SMTP server.
Add the IP address of your APE to Windows Servers on the Security tab.
1. Run the installer .exe file on your scalability engine server as Administrator.
The Welcome screen is displayed.
2. Click Start.
You cannot install on a remote mapped drive, read-only drive, compressed drive, or
compressed HDD.
The installer performs a system check to ensure that your environment meets the minimum
requirements and to look for any potential problems. The results of the system check are
displayed on the Installation Report page.
8. On the Installation Report page:
a. Review the results of the system check. If any issues were found, the installer displays
one or more messages:
l Informational and warning messages recommend actions and best practices to
optimize performance. These do not block the installation.
l Critical issues describe changes that are required to support the products. These
block the installation until they are resolved.
b. If any issues were found, click the to see detailed information about the issue.
c. If there are issues that prevent installation, resolve them and click Retest to run the
system check again.
d. Click Install to start the installation.
When the installation is complete, a confirmation message is displayed.
Centralized upgrades
If you have Orion Platform 2019.2 or later, you can save time by performing a centralized upgrade to
upgrade your SolarWinds Platform server and all scalability engines.
1. To minimize the time required to upgrade, you can pre-stage the installation files on your
SolarWinds Platform server and all of your scalability engines. The installer downloads the
required files to all reachable servers before you start the upgrade.
2. When you start the upgrade, the SolarWinds Installer contacts all reachable scalability engines
and checks for any issues.
If you did not pre-stage the files, they are downloaded to all reachable scalability engines when
you start the upgrade.
3. The installer upgrades the SolarWinds Platform server and all reachable scalability engines in
parallel. You can track the progress of all upgrades from the SolarWinds Platform Web
Console.
For more information about performing a centralized upgrade, see this topic.
Individual upgrades
If centralized upgrades are not available to you, perform the following tasks to upgrade one or more
scalability engines individually. For example, if a scalability engine is not reachable during a
centralized upgrade, you can upgrade it individually after the issue is resolved.
To upgrade a scalability engine, the online installer does not require Internet access.
If you experience issues using the SolarWinds Platform Web Console after an upgrade, clear
your browser cache.
If you do not have an existing deployment, see Install SolarWinds Platform products in a new
environment
o Versions earlier than 2020.2.1: First upgrade to version 2020.2.6, and then upgrade to the
latest version. Before upgrading, see Considerations for upgrading from the Orion
Platform to the SolarWinds Platform.
Version 2024.1 is the last release that will support a direct upgrade from 2020.2.1 or
2020.2.4. If choose to stay on 2020.2.1 or 2020.2.4, you will be required to upgrade to 2024.1
before you can upgrade to a later release.
1. Download an installer for an Orion Platform 2020.2.6 product from the Customer Portal, and
use it to upgrade to Orion Platform 2020.2.6.
2. Follow these instructions to upgrade to SolarWinds Platform 2024.1.
Upgrading from the Orion Platform to SolarWinds Platform 2024.1 removes your
existing on-premises Orion deployment. Any custom files that are not backed up will be
unavailable after the upgrade.
l SolarWinds Platform 2022.3 or later requires SQL Server 2016 SP1 or later. SQL Server 2012
and SQL Server 2014 are not supported for the SolarWinds Platform database. (For all
requirements, see the system requirements.)
l In addition to the SolarWinds Platform database, the SolarWinds Platform requires a both an
NTA Flow Storage database and a Log and Event database. If your Orion deployment did not
include Network Traffic Analyzer and Log Analyzer, one or both of these databases are created
during the upgrade. Before upgrading from Orion Platform 2020.2.6 and earlier to SolarWinds
Platform 2024.1, make sure the database user you use to connect to your SQL Server has the
DB create privilege. Without this privilege, the upgrade will not complete.
l Legacy syslog and trap functionality is not included in SolarWinds Platform 2024.1. During the
upgrade, legacy syslog and trap rules are migrated to SolarWinds Platform. The current
version supports almost all legacy syslog and trap functionality. A report lists any rules that
include unsupported functionality and could not be fully imported.
l Make sure all your legacy reports are migrated. You won't be able to access legacy reports and
related tools after the upgrade. To migrate reports, use the Legacy Report Migration Tool.
l The implementation of time series widgets required changes to the SolarWinds Platform
database. If you have custom reports or alerts that use custom poller statistics or multicast
routing, they could be affected by these changes.
SolarWinds recommends using API calls instead of database queries to collect data for
custom reports and alerts.
l If you are using CAC Authentication, you will need to adjust the CAC Authentication setup after
the upgrade to Hybrid Cloud Observability 2022.2 or later. See Enable Smart Card (CAC/PKI)
user authentication for Orion Web Console and complete Step 2: Secure the Site for Smart
Card Authentication Access.
l You can also prepare for an upgrade by using Orion Insights to perform a check on your
current deployment environment and notify you of any issues.
l Go to the Upgrade Resource Center for detailed information to help you plan and
implement your upgrade.
If any scalability engines are unavailable, a message tells you which server cannot be
reached. The systems check can provide additional information about the issue.
The option to pre-stage files is available only if you run the installer on your primary
SolarWinds Platform server and it detects one or more scalability engines.
3. Under Upgrade Type, select Download installation files, and click Next.
Installation files are downloaded to your main polling engine.
4. Click Launch.
5. On the Updates tab, click Download files.
The Upgrade Wizard connects to any scalability engines to verify that they are reachable.
If any scalability engines are unavailable, a message tells you which server cannot be
reached. The systems check can provide additional information about the issue.
Do not modify the VIP, IP address, or virtual host settings for the servers.
Task 2: Stop services on all additional polling engines and web servers
If the required SolarWinds services are not stopped on APEs and AWSs before the upgrade, the
SolarWinds Installer attempts to stop them. To ensure a smooth upgrade, SolarWinds recommends
that you stop the required services before upgrading.
1. In the SolarWinds Platform Web Console, click Settings > All Settings.
2. Under Product Specific Settings, click Service Manager.
Alternatively, open the stand-alone Service Manager. To do so, open the Windows Start
menu, and click SolarWinds Platform > SolarWinds Platform Service Manager.
3. Stop all services listed in the SolarWinds Platform Service Manager on all additional polling
engines and all web servers.
If you use the Windows Control Panel to stop services, do not stop the SolarWinds
Administration Service on your scalability engines. If you stop the SolarWinds Administration
Service, the installer cannot reach the scalability engines to upgrade them in parallel.
Some third-party software, such as .NET 4.8, is required. If it is not found on the server, it is
downloaded and installed when you run the installer.
To minimize the time required to run the SolarWinds Installer, install .NET 4.8 on your primary
SolarWinds Platform servers and all scalability engines before you run the installer.
If your main polling engine is not on the latest version and your scalability engines are on an
even earlier version, you have two options:
l You can update the scalability engines to the version that the main polling engine is
running.
l You can update your entire deployment (main polling engine and scalability engines) to
the latest version.
3. Click Update.
The installer verifies that all servers can be reached, and reports any issues. When you are
ready to start the upgrade, click Next.
4. Review the EULA. If you agree, click the checkbox, and then click Next.
5. Click Next to start the systems check.
The Installation Report page asks you to confirm that you backed up your database.
6. Under System Confirmation, if you have backed up your database, click the button and then
click Confirm.
If not, you should back up now. New products and versions can modify your database
tables. Click here for information about SolarWinds Backup.
7. On the Installation Report page, review the information under System Check.
The installer runs a series of checks per product to verify that your servers meet system
requirements and recommendations. If your environment does not meet specifications, the
installer displays one or more messages:
l Informational and warning messages recommend actions and best practices to optimize
performance. These do not block the installation.
l Critical issues describe changes that are required to support the products. These block
the installation until they are resolved.
8. Investigate and resolve any issues:
l Click the details link to display additional information and suggested resolutions.
l Optionally, to print the list of issues, click Print results.
l After resolving any blocking issues, click Re-check.
9. Click Next to start the installation.
If you pre-staged the installation files, the installer verifies that you have the most recent
versions. If an updated version is available, the installer notifies you. SolarWinds recommends
downloading the latest version. To minimize the download time, the installer downloads only
the updated files, not everything.
After the installer is downloaded to all servers, they are upgraded in parallel. Your primary
SolarWinds Platform server is down while it is being upgraded, and so the SolarWinds Platform
Web Console is not available. You are redirected to a Web page where you can monitor the
progress of the upgrade.
When the primary SolarWinds Platform server has been upgraded, you are returned to your
SolarWinds Platform Web Console.
10. When the upgrade is complete, click Finish.
The upgrades take some time to complete but do not require any actions. Agents are upgraded at a
throttled number of 10 at a time to limit the impact on the polling engine. As soon as one agent
upgrade is complete, another agent takes its place so there are always 10 active threads until all
agents are upgraded.
On operating systems that support .NET Framework 4.8, all Windows Agent Plugins are
migrated to .NET 4.8. For more information, see ".NET Framework support" in the agent
requirements.
1. Open the Manage Agents page. Orion Agents requiring upgrades display the message Update
Required.
2. Select all agents needing updates and click More Actions > Update. The agents are upgraded
in the background.
1. In the SolarWinds Platform Web Console, click Settings > All Settings > High Availability
Deployment Summary.
2. Select the pool you want to enable.
3. Toggle High Availability to On.
The SolarWinds Platform Web Console verifies all SolarWinds product versions match across the
HA pair before enabling. If you receive errors, check your product versions.
If you upgraded to the latest version of the SolarWinds Platform, but antivirus software
continues to detect an affected SolarWinds.Orion.Core.BusinessLayer.dll as being
present on your SolarWinds Platform server, see this article for more information and a
resolution.
If your products run in an offline environment, you must download the offline installer
from the Customer Portal.
For more information about the SolarWinds Installer and other installation or upgrade
options, see About installing or upgrading SolarWinds Platform products and scalability
engines.
1. In the SolarWinds Platform Web Console, click Settings > All Settings.
2. Under Details, click License Manager.
The License Manager page lists your licensed products and any evaluations (both active and
expired). The right pane lists other SolarWinds Platform products that you can choose to
install for evaluation.
The evaluation version of a product is a full version of the product, functional for 30
days. After the evaluation period, you can convert your evaluation license to a
production license by obtaining and applying a license key. Contact SolarWinds sales to
purchase a full license. To activate the license, see Activate licenses.
3. To view the entire list of products, click See all n available products.
4. Select the check box next to each product you want to evaluate.
The evaluation products are activated. They are added to the list of products on the License
Manager page.
The evaluation version of a product is a full version of the product, functional for 30
days. After the evaluation period, you can convert your evaluation license to a
production license by obtaining and applying a license key. Contact SolarWinds sales to
purchase a full license. To activate the license, see Activate licenses.
4. If you are installing additional products, select the products to install from the Available
Evaluations section.
5. Click Next.
6. Follow the onscreen instructions to complete the installation.
7. When the installation is complete, click Finish.
l Use Orion Insights to perform a check on your current deployment environment and notify you
of any issues.
Connection issues
If your SolarWinds Platform server has problems connecting to scalability engines during a
centralized upgrade:
l Perform a ping test (or use another method) to verify that the scalability engine server is up
and can be reached from the SolarWinds Platform server.
l Verify that port 17777 is open for both inbound and outbound traffic.
See SolarWinds Platform requirements for a complete list of SolarWinds Platform server
port requirements.
l If both of those conditions are met, see Troubleshoot connection issues during centralized
upgrade for additional tips.
Upgrade issues
l If your network has very little bandwidth or extremely high latency between the main polling
engine and the scalability engine servers, centralized upgrades might fail. In this situation, you
can manually copy the installer file to the scalability engine servers, and then run the
centralized upgrade.
l You canceled an upgrade, and then you receive the following error when you try to run the
upgrade later:
Another Installation Session is still Active. You have to disable it first.
l If your views are not loaded when you first open the SolarWinds Platform Web Console, run the
Configuration wizard again.