Registering workloads manually

In addition to registering a workload in the Cyber Protection service during the agent installation, you can also register it by using the command line interface. You might need to do so if you have installed the agent but the automatic registration failed, for example, or if you want to register an existing workload under a new account.

To register a workload

To register a workload by using a user name and password, run the following command.

In Windows

Command for registering a workload under the current account:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -s mms -t cloud --update

Command template for registering a workload under another account:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a <service address> -u <user name> -p <password>

Command example:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a https://cloud.company.com -u johndoe -p johnspassword

In Linux

Command for registering a workload under the current account:

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o register -s mms -t cloud --update

Command template for registering a workload under another account:

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a <service address> -u <user name> -p <password>

Command example:

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a https://cloud.company.com -u johndoe -p johnspassword

In macOS

Command for registering a workload under the current account:

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o register -s mms -t cloud --update

Command template for registering a workload under another account:

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a <service address> -u <user name> -p <password>

Command example:

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a https://cloud.company.com -u johndoe -p johnspassword

Use the user name and password for the specific account under which the agent will be registered. This cannot be a partner administrator account.
The service address is the URL that you use to log in to the Cyber Protection service. For example, https://cloud.company.com:

Alternatively, you can register a workload by using a registration token. To do so, run the following command.

In Windows

Command template:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a <service address> --token <token>

Command example:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a https://au1-cloud.company.com --token 3B4C-E967-4FBD

In Linux

Command template:

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a <service address> --token <token>

Command example:

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a https://eu2-cloud.company.com --token 34F6-8C39-4A5C

In macOS

Command template:

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a <service address> --token <token>

Command example:

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o register -t cloud -a https://us5-cloud.company.com --token 9DBF-3DA9-4DAB

When you use a registration token, you must specify the exact datacenter address. This is the URL that you see once you are logged in to the Cyber Protection service. For example, https://eu2-cloud.company.com.

Do not use https://cloud.company.com here.
The registration token is a series of 12 characters, separated by hyphens in three segments. For more information on how to generate one, refer to "Deploying agents through Group Policy".

To unregister a workload

Run the following command:

In Windows

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o unregister

In Linux

sudo "/usr/lib/Acronis/RegisterAgentTool/RegisterAgent" -o unregister

In macOS

sudo "/Library/Application Support/BackupClient/Acronis/RegisterAgentTool/RegisterAgent" -o unregister

Passwords with special characters or blank spaces

If your password contains special characters or blank spaces, enclose it in quotation marks when you type it on the command line.

For example, in Windows, run this command.

Command template:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a <service address> -u <user name> -p <"password">

Command example:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a https://cloud.company.com -u johndoe -p "johns password"

If you still receive an error:

Encode your password into base64 format at https://www.base64encode.org/.
On the command line, specify the encoded password by using the -b or --base64 parameter.

For example, in Windows, run this command.

Command template:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a <service address> -u <user name> -b -p <encoded password>

Command example:

"%ProgramFiles%\BackupClient\RegisterAgentTool\register_agent.exe" -o register -t cloud -a https://cloud.company.com -u johndoe -b -p am9obnNwYXNzd29yZA==