SQL Clone 5

Installing an Agent to create an Image

Installing SQL Clone agents

Once you have installed SQL Clone Server, you will need to install one or more SQL Clone agents. You will need to install an agent on every machine with SQL Servers that hosts databases you wish to make a copy of. 

Note: If creating an image from a backup, the version of the SQL Server instance on the Agent machine should be the same or higher than the backed up database.

The SQL Clone agent installed can be downloaded from the home page of the server's web app. You will need to download a separate agent installer file for every agent (SingleUseSqlCloneAgentInstaller.exe), as each executable file contains a unique key that can only be used once.

The agent installer requires a username and password for the agent service. These credentials will also be used to connect to databases if you choose "windows authentication" within the tool.

See Requirements for more information about what permissions the agent user requires.

The agent must be able to connect to SQL Clone Server on port 14146.

Silent install

SQL Clone agents can also be installed silently. This installation method is suitable for use via command line or with automation.

Single-use agent installers can be downloaded directly from:


And then silently installed with:

.\SingleUseSQLCloneAgentInstaller.exe -s SERVICEUSERNAME=<domain\service user> SERVICEPASSWORD=<service user's password>

For example, Powershell can download and silently install an agent as follows:

Invoke-WebRequest http://sql.clone.server:14145/download/agentinstaller -OutFile "SingleUseSQLCloneAgentInstaller.exe" -UseDefaultCredentials
.\SingleUseSQLCloneAgentInstaller.exe -s SERVICEUSERNAME=RED-GATE\jordan.miller SERVICEPASSWORD=hunter2

If anything goes wrong, the installer will write to the application event log.

Troubleshooting the install

Didn't find what you were looking for?