- Print
- DarkLight
- PDF
Connect to Your Machines Locally
- Print
- DarkLight
- PDF
The following article explains how to locally install a ControlUp Agent with MSI. From version 9.0, you can locally install an agent with PowerShell. For machine requirements, see here.
Local Agent Installation
Install the ControlUp Agent locally on a machine using an MSI package if remote installation requirements can't be met in your environment.
To learn more about the MSI deployment, watch our video.
Manual Installation with GUI
Download the Agent MSI package from our Download Center.
Execute the MSI package installation on the machine where the Agent is to be installed.
Launch the Real-Time Console, navigate to Agent Settings, and copy your Agent's Authentication Key. This key connects the Agent to your ControlUp environment
For version 9.0, a new Registration Key is needed for outbound communication, enabling agents to obtain a Personal Access Token (PAT) from our security service. Ignore this key if you don't want to use this feature. To activate outbound later, manually add the key to the agent's registry under
HKLM\SOFTWARE\Smart-X\ControlUp\Agent\Communication
. Key name: RegistrationKeyPaste the authentication key you copied from the Real-Time Console during installation.
Finish the MSI installation process
If the machine is new and not yet part of your ControlUp organization tree, you must add it using one of the following methods:
- In the console, click Add Machines.
- Execute the
Add-CUComputer
cmdlet on any monitor machine. For instructions to use this cmdlet, see here.
Command Line Installation with msiexec
You can install the agent by using the command line. Msiexec.exe allows you to run the installation of the agent in different ways. In this section, we show you some examples of how you can install the agent:
Make sure you download the agent from our Download Center.
From version 9.0
Silently install the 64-bit version agent 9.0 + provided authentication key + use certificate for agent authentication:
msiexec /i ControlUpAgent-RealTimeAgentManager-net6-x64-9.0.0.1616-signed.msi /qn AUTHKEY={enter your AuthKey here} CERTONLY=TRUE
When using CERTONLY=TRUE, you instruct the agent to only accept connections from the console/monitors that are configured to use the Certificate-based agent authentication if the relevant agent-side registry keys aren't configured.
Silently install the 64-bit version agent 9.0 + provided authentication key + registration key (needed for agent outbound communication) + use certificate for agent authentication:
$authkey = "{enter your AuthKey here}"
$registrationKey = "{enter your RegistrationKey here}"
$msiPath = "{path to MSI}"
$arguments = @(
'/i',
"`"$msiPath`"",
'/qb',
"AUTHKEY=$authkey",
"RegistrationKey=$registrationKey"
)
Start-Process -FilePath 'msiexec.exe' -ArgumentList $arguments -Wait -NoNewWindow
Silently install the 64-bit version agent 9.0 from a master image + provided authentication key + registration key + use certificate for agent authentication:
msiexec /i ControlUpAgent-RealTimeAgentManager-net6-x64-9.0.0.1616.msi /qb AUTHKEY={enter your RegistrationKey here}
RegistrationKey={enter your RegistrationKey here} MASTER_IMAGE=true
Lower than version 9.0
Silently install the 64-bit version agent 8.8 + provided authentication key:
msiexec /i ControlUpAgent-net45-x64-8.8-signed.msi /qn AUTHKEY={enter your AuthKey here}
Silently install the 64-bit version agent 8.8 + provided authentication key. No restart after installation + log output:
msiexec.exe /i ControlUpAgent-net45-x64-8.8-signed.msi AUTHKEY={enter your AuthKey here} /quiet /norestart /l*v C:\temp\agentinstallation.log
Silently install the 64-bit version agent 8.8 + provided authentication key. Use a non-standard port and custom installation path:
msiexec.exe /i ControlUpAgent-net45-x64-8.8-signed.msi AUTHKEY={enter your AuthKey here} /qn PORT=40777 APPDIR="enter installation path"
To troubleshoot installing agents, see here.