Overview
The SolarWinds Platform Installer for SQL Sentry improves upon the Enhanced Platform installer (EPI) for SQL Sentry by allowing you to deploy, manage, and upgrade SQL Sentry components through a command line interface from a single location. The SolarWinds Platform Installer for SQL Sentry further increases the speed and simplicity of installing and upgrading SQL Sentry implementations with multiple Monitoring Services and Clients without having to manually run through the installer on each machine. Install the single WebApi Central Service on a central location, install a SolarWinds Platform Installer Agent on each machine that will house a SQL Sentry Monitoring Service or SQL Sentry Portal, and install the SolarWinds Platform Installer Launchpad on each machine that will house a SQL Sentry Client. Use the Command Line interface to push package installations, upgrades, or removals all from the Central Service WebApi location.
Use Cases
| Use Case | Steps Summary |
|---|---|
First time SQL Sentry multi Monitoring Service and Client Installation: |
|
| Upgrading a SQL Sentry multi Monitoring Service and Client Installation: |
|
Additional Information: For information about upgrading a Setup Wizard Installation or Enhanced Platform Installer installation to the SolarWinds Platform Installer for SQL Sentry, see the Upgrading article.
Architecture
The SolarWinds Platform Installer for SQL Sentry consists of these major components:
| SolarWinds Platform Installer Component | Description |
|---|---|
Central Service | The SolarWinds Platform Installer Central Service is a Web API that is installed in a singular command location. All of the actions available with the SolarWinds Platform Installer are communicated to installed agents through this Web API. |
| Command Line Interface | The SolarWinds Platform Installer Command Line Interface is used to communicate commands to the Central Service. |
| Agent | The SolarWinds Platform Installer Agent is a service that manipulates ( stops, starts, installs, uninstalls ) components. It may delete and create directories, delete files and copy files from packages to locations defined by package metadata, run scripts embedded in packages, and validate packages. The Agent should be installed on all machines that will receive SQL Sentry Monitoring Services and Clients. |
| Launchpad | The SolarWinds Platform Installer launchpad provides non-technical users with an easy to use interface to install the SQL Sentry Client. Users will select the available configuration from the launchpad, and the launchpad will install the SQL Sentry Client on the machine. The launchpad can be used to open the SQL Sentry Client, and will also notify you when the Client needs to be upgraded. |
| Packages | SolarWinds Platform Installer independent packages are used to install, upgrade, or remove SQL Sentry Clients and SQL Sentry Monitoring Services from machines where an Agent is installed. |
Getting Started
Warning: The account(s) used for the Central Service and any installed agent(s) must be Administrator accounts.
Run as Administrator
Command Prompt must use the Run as administrator option for all commands.
Case-Sensitivity
The parameters used in commands are case-sensitive.
This means that --agentname will not work for --agentName.
Parameters & Examples
The instructions include commands with placeholders for parameters specific to your SQL Sentry environment. This section describes all of the placeholders used in the SolarWinds Platform Installer for SQL Sentry instructions.
For example, you will use the following command to install an agent:
swepi system install agent --username <username> --password <password> --agentName <agentName> --serviceURL <serviceURL>
When you run it with your parameter values, it might look like this:
swepi system install agent --username <JesseRemoteAgentUser> --password <MyPasswordHere> --agentName <localhostagent> --serviceURL <http://localhost>
Upgrading from another installation method
If you are upgrading from a previous installation type to the SolarWinds Platform Installer for SQL Sentry, see the Upgrading article.
Command Line Interface Commands
Important: All SolarWinds Platform Installer commands must be run by an Administrator through an Administrator Command Prompt window.
These instructions include commands with placeholders for parameters specific to your SQL Sentry environment. This section describes all of the placeholders used in the SQL Sentry Platform Installer instructions.
Warning: Command parameters that include a space in the parameter name must be enclosed by quotation marks " " to parse correctly. For example, in the command below, the optional parameter Monitor Portal is enclosed in quotation marks.
swepi agent enable --packageName sqlsentry --componentName "Monitor Portal" --agentName LHP85RemoteAgent
The following commands are available for the SQL Sentry Platform Installer Command Line Interface:
General Commands
| Command | Description |
|---|---|
| Swepi help | Displays the available commands. Note: Some commands may not be available if you are not connected to the central web service. |
| Swepi version | Displays the version of the installed Central web service. |
| Swepi connect --url <WebServiceUrl> | Connect to the central web service, used for routing commands. |
| Swepi agent help | Displays the list of all available commands for agents. |
| Swepi package help | Displays the list of all available commands for packages. |
| Swepi system help | Displays the list of all available commands for SolarWinds EPI system management. |
Agent Commands
The following agent commands are available for the SQL Sentry Platform Installer Command Line Interface:
| Agent Command | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Swepi agent list | Displays a list of all installed agents with their enabled components. The following parameters are configurable. Optional Parameters:
| ||||||||||
| Swepi agent help | Displays a list of all available commands for agents. | ||||||||||
| Swepi agent enable -- packageName <packageName> --componentName <componentName> --agentName <agentName> | Enables an agent to run with a specific package. The following parameters are configurable. Required Parameters:
| ||||||||||
| Swepi agent disable --packageName <packageName> --componentName <componentName> --agentName <agentName> | Disables an agent running with a specific package. The following parameters are configurable. Required Parameters:
| ||||||||||
| swepi agent update credentials | Updates the credential set that an agent uses to install a given service. If you don't include a username or password this command defaults to the agent using it's own credential set to install services. The following parameters are configurable. Required Parameters:
|
Package Commands
The following agent commands are available for the SQL Sentry Platform Installer Command Line Interface:
| Command | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| swepi package list | Displays a list of all configured packages. | ||||||||||||||
| swepi package help | Displays a list of all available commands for packages. | ||||||||||||||
| swepi package add -- packageFilePath <packageFilePath> | Adds a package to the Central Web Service. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package remove --packageName <packageName> --version <version> | Removes a package from the Central Web Service. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package upgrade --packageName <packageName> | Upgrades a package to the specified version. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package config list --packageName <packageName> | Displays a list of available configurations for a package. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package config --packageName <packageName> --key <key> --value <value> | Configures the required package values. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package push config --packageName <packageName> --agentName <agentName> | Pushes config values from the central service to agents running services in the package. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package initialize --packageName <packageName> | Initializes the database components of a package. The following parameters are configurable. Required Parameters:
| ||||||||||||||
| swepi package config ConnectionString --packageName <packageName> --dataSource <dataSource> --initialCatalog <initialCatalog> --userID <userID> --password <password> --integratedAuth <integratedAuth> --pushUpdatedConfig <pushUpdatedConfig> | Command for explicitly configuring a connection string with a package. The following parameters are configurable. Required Parameters:
|
System Commands
| Command | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| swepi system list | Displays a list of all the SolarWinds Platform Installer installables that are currently on the Central Service. | ||||||||
| swepi system help | Displays a list of all the available command for the SolarWinds Platform Installer system management. | ||||||||
| swepi system add --componentFilePath <componentFilePath> | Adds a system component to the Central Service. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system install agent --username <username> --password <password> --agentName <agentName> --serviceURL <serviceURL> | Installs a SolarWinds Platform Installer agent on your local machine. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system install launchpad | Installs the client launchpad on your local machine, or the machine you specify with the --serviceURL parameter. The following parameters are configurable. Optional Parameters:
| ||||||||
| swepi system uninstall all agents | Uninstalls all agents that are connected to the Central Service. | ||||||||
| swepi system uninstall agent --agentName <agentName> | Uninstall the specified agent from the machine. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system uninstall launchpad | Uninstalls the Client Launchpad from the machine where the command is executed. | ||||||||
| swepi system upgrade --componentName <componentName> --targetName <targetName> | Initiates an upgrade of active SolarWinds Platform Installer systems to use the latest system component stored on the Central Service. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system user add --username <username> | Adds an authorized user account. Note: This command adds a user that can run SolarWinds Platform Installer Commands. This command does not add a user in SQL Sentry. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system user remove --username <username> | Removes an account from the list of authorized users. Note: This command removes a user that can run SolarWinds Platform Installer Commands. This command does not remove a user in SQL Sentry. The following parameters are configurable. Required Parameters:
| ||||||||
| swepi system user list | Displays a list of all the authorized users accounts. |
Summary of Installation
Warning: The account(s) used for the Central Service and any installed agent(s) must be Administrator accounts.
The SolarWinds Platform Installer for SQL Sentry helps users with large SQL Sentry Installations (multiple Monitoring Services and Clients across varying machines) install and upgrade their installations without going through a manual process to install or upgrade for each instance. Installing the SolarWinds Platform Installer on your environment should be completed in the following steps:
- Install the Central Service and CLI on your central location.
- Connect to the Central Service through the CLI and add your users.
- Install and register Remote Agent(s) on your machines that will have a SQL Sentry Monitoring Service or SQL Sentry Portal.
- Install the Launchpad on your machines that will have a SQL Sentry Client.
- Download the SQL Sentry Installation package and add it to the Central Service.
- Install the SQL Sentry Database on your desired machine(s) through the Command Line Interface.
- Install the SQL Sentry Monitoring Service on your desired machine(s) through the Command Line Interface.
- Install the SQL Sentry Client on your desired machine(s) through the Launchpad.
- Establish your SQL Sentry Client connection(s).
Initial Installation
Additional Information: Before installing the SolarWinds Platform Installer for SQL Sentry on your installation(s), take a look at the Installation recommendations and make sure your machine(s) meets the System Requirements.
Installing the CLI and Central Service
Warning: You need an Admin account on your system to execute the SolarWinds Platform Installer System Setup. An Admin account is required to run the Command Line Interface and interact with the Central Service.
Important: Executing the SolarWinds Platform Installer system setup will add your entered system admin account as an admin user in the SolarWinds Platform Installer Command Line Interface. An Admin in the SolarWinds Platform Installer Command Line Interface account allows users to issue commands to the Central Service. You can add additional users using the swepi system user add --username <username> command through the Command Line Interface.
The SolarWinds Platform Installer for SQL Sentry should be installed on the central location for your SQL Server environment. Install the SolarWinds Platform Installer for SQL Sentry by completing the following steps:
1. Download and execute the SolarWinds Platform Installer for SQL Sentry. Select Next to Continue.
2. Select the checkbox to agree to the terms in the License Agreement, and then select Next to Continue.
3. Select how the Central Service will be installed, and then select Next to continue.
4. Review the installation location, and then select Next to continue. 
Note: Select Change to choose a different installation location.
5. Enter the username and password for the service account. Select Test to validate the user credentials. Select Next to continue.
Important: The Account used to run the Central Service must be an Administrator account.
6. Enter the address and port that will host the Central Service. Select Test to validate the address and port. Select Next to continue. Note: The port is set to 80 by default. In this example, we are using port 3600, but you can enter the port of your choosing.
Warning: In the example above, we are connecting to localhost from the local machine. If you are setting up a SolarWinds Platform Installer for SQL Sentry Central Web Service that needs to be accessed from one or more remote machines in your network, you must enter the server name or IP address of the server where the Central Web Service will run so that it will be accessible by all of the separate machines across your network (for example, command line interfaces, agents, launchpads, and web browsers).
7. Select Install to begin the installation.
8. Select Finish to exit the setup wizard.
Important: You can use the CTRL C command to stop the Web API.
Connecting to the Central Service and Adding Users with the CLI
Important: During the setup for SolarWinds Platform Installer Central Service and CLI, you add a administrator user account that is used to run the Central Service. You must add additional users through the CLI while using this account.
After successfully installing the CLI and Central Service with the SolarWinds Platform Installer System Setup Wizard, you can connect to the Central Service using the command line interface (CLI), and add any users that will issue commands, interact with the Remote Agent, or interact with the Client Launchpad. Add your users through the CLI by completing the following steps:
1. Open an administrator Command prompt window and connect to the SolarWinds.Platform.Installer.CLI file location. Note: The SolarWinds.Platform.Installer.CLI file location is C:\Program Files\SolarWinds Platform Installer\CLI by default.
swepi connect --url http://localhost:802. Add administrator accounts that will use the SolarWinds Platform Installer Central Service, Remote Agent, or Client Launchpad. Repeat this step as necessary.
swepi system user add --username <localhost\tom.swepiuser>
Installing the Remote Agent with the CLI
SolarWinds Platform Installer Agents should be installed on all machines that will receive SQL Sentry Monitoring Services and Clients. Install and register an Agent through the Command line interface:
1. Open an administrator Command prompt window and connect to the SolarWinds.Platform.Installer.CLI file location. Note: The SolarWinds.Platform.Installer.CLI file location is C:\Program Files\SolarWinds Platform Installer\CLI by default.
swepi connect --url http://localhost:3600
2. Execute the swepi system install agent command to install the remote agent on your system:
swepi system install agent --username LHP85-0519-817B\JesseRemoteAgentUser --password Rocket231!! --agentName LHP85RemoteAgent --serviceURL http://localhost:3600
Warning: The account(s) used for the agent service must be Administrator accounts.
Success: You have installed the SolarWinds Platform Installer Remote Agent on your system.
Note: You can also install the Remote Agent through its Installer. See Installing the Remote Agent with the installer below for more information.
Installing the LaunchPad with the CLI
The SolarWinds Platform Installer Launchpad will be used to launch the SQL Sentry Client and Initiate upgrades in an easy to use UI format. Install the Launchpad on your system with the CLI:
1. Open an administrator Command prompt window and connect to the SolarWinds.Platform.Installer.CLI file location. Note: The SolarWinds.Platform.Installer.CLI file location is C:\Program Files\SolarWinds Platform Installer\CLI by default.
swepi connect --url http://localhost:3600
2. Execute the swepi install launchpad command:
swepi system install launchpad
Success: You have installed the SolarWinds Platform Installer Launchpad on your system.
Note: You can also install the Launchpad through its Installer. See Installing the Launchpad with the installer below for more information.
Installing SQL Sentry Components via Packages
Requirements
Before installing SQL Sentry, review the following articles:
Installation Packages
You can add SQL Sentry Installation and Upgrade packages to the SolarWinds Platform Installer Central Service, and then push installations and upgrades to Remote Agents or Launchpads across your environment. Get started with installation packages by completing the following steps:
Important: The SentryOne Monitoring Service and SQL Sentry Portal can only be installed to machines that have a SolarWinds Platform Installer Remote Agent installed.
Starting with Versions 2022.4, the --packageName value will always start with sqlsentry.
1. Download the SolarWinds Platform Installer Installation Package, and then place the Installation package in a location that is accessible by the Central Service.
2. Open an administrator Command prompt window and connect to the SolarWinds.Platform.Installer.CLI file location. Note: The SolarWinds.Platform.Installer.CLI file location is C:\Program Files\SolarWinds Platform Installer\CLI by default.
swepi connect --url http://localhost:3600
3. Add the installation package to the Central Service:
swepi package add --packageFilePath "C:\Program Files\Swepi Package\SolarWinds-SQLSentry-SWEPI-Package-2022.3.0.34556.zip"
4. Accept the End User License Agreement to upload the package.
5. Verify the package has been uploaded to the Central Service:
swepi package list
6. Configure the connection string for the SentryOne Database:
swepi package config ConnectionString --packageName sqlsentry --dataSource localhost --initialCatalog SWEPI_DEMO_DB --userID LHP85-0519-817B\JesseRemoteAgentUser --integratedAuth y
7. Create the SentryOne Database on your machine:
swepi package initialize --packageName sqlsentry
Important: You can verify that the Database has been created in SSMS.
8. Instruct your Remote Agent to install the Monitoring Service:
swepi agent enable --packageName sqlsentry --componentName MonitoringService --agentName LHP85RemoteAgent
You can verify that the Monitoring Service has been installed in System Services.
9. Instruct your Remote Agent to install the SQL Sentry Portal:
swepi agent enable --packageName sqlsentry --componentName "Monitor Portal" --agentName LHP85RemoteAgent
Warning: You can only configure your SQL Sentry Portal connection with the Portal Configuration Utility. After installing the SQL Sentry Portal with the SolarWinds Platform installer for SQL Sentry, you can access the Portal Configuration Utility at the following location:
C:\Program Files\SolarWinds Platform Installer\Agent\sqlsentry_Monitor Portal_SentryOneMonitorPortal\pcu\SentryOne.Monitor.WebClient.ConfigurationUtility
10. Open the Client Launchpad, and select Install to install the SQL Sentry Client on your machine.
 |  |
11. Select Start to open the SQL Sentry Client, and then go through the onboarding wizard to configure your connection.
 |  |
Upgrade Packages
Get started with upgrade packages for your SolarWinds Platform Installer SQL Sentry Installation by completing the following steps:
Important: The SentryOne Monitoring Service and SQL Sentry Portal can only be installed to machines that have a SolarWinds Platform Installer Remote Agent installed.
Starting with Versions 2022.4, the --packageName value will always start with sqlsentry.
1. Download the SolarWinds Platform Installer Upgrade Package, and then place the Upgrade package in a location that is accessible by the Central Service.
2. Open an administrator Command prompt window and connect to the SolarWinds.Platform.Installer.CLI file location. Note: The SolarWinds.Platform.Installer.CLI file location is C:\Program Files\SolarWinds Platform Installer\CLI by default.
swepi connect --url http://localhost:3600
3. Add the upgrade package to the Central Service:
swepi package add --packageFilePath "C:\Program Files\Downloads\SolarWinds-SQLSentry-SWEPI-Package-2023.1.3.zip"4. Enter Y to accept the End User License Agreement to upload the package.
5. Verify the package has been uploaded to the Central Service:
swepi package list
6. Open all Client Launchpads before enabling the upgrade.
7. Enable the upgrade package for your installation:
swepi package upgrade --packageName sqlsentry
Success: You have successfully enabled the upgrade package.
Installing the Remote Agent with the Installer
Important: You must download and install the SolarWinds Platform Installer Central Service on your central location before you can install the Remote Agent on your system.
1. Execute the SolarWinds.PlatformInstaller.Agent.Setup file to begin your installation. Select Next to continue.
2. Select the checkbox to agree to the terms in the License Agreement, and then select Next to Continue.
3. Review the installation location and select Next to continue.
Note: Select Change to choose a different installation location.
4. Enter the username and password for the service account. Select Test to validate the user credentials. Select Next to continue.
5. Enter the central web service address and port. Select Test to validate the connection. Select Next to continue.
6. Enter a name for the SolarWinds Platform Installer Remote Agent. Select Next to continue. 
7. Select Install to begin the Remote Agent Installation.
8. Select Finish to close the Agent Setup Wizard.
Installing the Launchpad with the Installer
Important: You must download and install the SolarWinds Platform Installer Central Service on your central location before you can install the Launchpad on your system.
1. Execute the SolarWinds.PlatformInstaller.ClientLaunchpad.Setup file to begin your installation. Select Next to continue. 
2. Select the checkbox to agree to the terms in the License Agreement, and then select Next to Continue.
3. Review the installation location and select Next to continue.
4. Enter the central web service address and port. Select Test to validate the connection. Select Next to continue.
5. Select Install to begin the Launchpad Installation.
6. Select Finish to close the Agent Setup Wizard.
Upgrading the Central Service
For information about upgrading the SolarWinds Platform Installer Central Service, see the Upgrading article.
