Active Backup for Business Agent

Active Backup for Business Agent must be installed on every Windows device, Mac computer, and Linux physical server you want to protect. You can perform a set of administration, including task management and template configuration, in Active Backup for Business console.

Active Backup for Business Agent for Windows

Installation

The installer file of the agent is a .msi file. You can download the 32-bit or 64-bit version, depending on your Windows device. The installer is available for download in the Download Center (under Desktop Utilities).

For the operations in this section, you need to log in to Windows with an account that has administrative privileges.

To install the agent:

Launch the installer on your Windows device. Read through the Terms of Service and start the installation.

To install the agent in batch:

You can install the agent on multiple Windows devices using existing Microsoft Windows Active Directory Service (ADS).

To update the agent:

When there is a newer version of the agent, you can update the agents on source devices by installing the new version. Remotely batch updating the agents on multiple devices can be done in Active Backup for Business console or using Microsoft Windows Active Directory Domain Services.

To uninstall the agent:

On your Windows device, go to Control Panel > Programs > Uninstall a program. Find Synology Active Backup for Business Agent, then click Uninstall and follow the onscreen instructions.

Configuration

Task settings are managed by the package managers in the admin console on DSM. Users with manager privileges can edit settings such as the template name, backup mode, schedule, and retention.

To create a backup template:

You must create backup templates in the admin console on DSM. Open Active Backup for Business and go to Settings > Template to create and edit backup templates. Template settings cannot be changed via the agent, but you can choose to back up your Windows device as a personal computer or physical server at the Summary step of the wizard.

To connect your Windows device to the server:

1. On your device, click Start > All Programs > Synology > Synology Active Backup for Business Agent to launch the agent.
2. Enter the IP address or DDNS of the Synology NAS. Enter your username and password, and click Connect. Keep in mind that spaces count as characters in the text fields.
3. If you are unable to connect to the Synology NAS, click Proxy to open the proxy setting window. Fill in your settings and re-connect to the Synology NAS.
4. You will see the backup summary of this device. All the settings are based on the template or task configured in the console and cannot be changed. However, you can change the backup type of the device. Click OK to finish.

To change the backup type:

You must have the package manager or sufficient permissions to change the backup type. You can choose if you want to back up the Windows device as a personal computer or physical server. The available restoration methods between the two types are different.

1. Click on the backup type (PC/Physical server).
2. Enter the package manager's account and password to continue.
3. Select the type you want and click OK.

To start a backup immediately:

When you create a template in the console, you can decide whether to start a backup right after a source is connected to the server. You will need to tick Back up instantly after the client is connected to your DiskStation for the first time at Settings > Template > Schedule.

However, you cannot start a backup from the agent. Manually starting a backup is only possible in the console.

On Windows notification icon

After you install the agent, it will run in the background until you disconnect it from the server by logging out. You can find the agent icon in both the Windows notification area and the Taskbar from the desktop. Right-click on the tray icon to open the context menu, where you can find all the available actions.

• Backup status: Real-time backup status. If there is an error, click View backup status to open the agent for more details.
• View backup status: Details of the current backup is shown in the agent. You can check other server information and recent activities as well.
• Edit connection: If the server address changes, you need to edit the connection. Otherwise, the agent will be disconnected from the server.
• Log out: Enter the package manager's credentials to log out. If you log out from the agent, your device disconnects from the server. The device's backup task will not be deleted. When you connect to the same server later, the system will perform the missed backups during the time your device was disconnected.
• About: Current version information and links to Terms of Service and Privacy Statement.
• Troubleshooting:
  • Help: This document contains all the agent-centered information and manual.
  • Export logs: If you encounter issues with the agent and need to contact Synology Technical Support, providing the exported logs will help speed up the troubleshooting process.
• Exit: Exiting the application will not terminate the service on the device. You can always go to Start > Synology and run Synology Active Backup for Business Agent to launch the agent interface.

Monitor

The backup agent helps you monitor the device's backups. You can check the overview status, server information, and recent activities.

Backup status

The backup status is shown with icons. The following table explains what each icon stands for. When there are no ongoing tasks, this area displays the previous and next backup time. If there is an error, you can see the error message and the suggested solution here.

	Completed: The previous backup task has been completed. During backup intervals, this area shows the last backup time and the next backup time.
	Backing up: The device is being backed up. The transfer status is shown below the status.
	Idle: The device has not run any backup task yet. If there is a backup schedule, the next backup time will be displayed.
	Canceled: The backup task has been canceled. Backup tasks can only be canceled from the admin console. This area also shows the last backup time and the next backup time, if applicable.
	Partial success: The backup task is only partially successful. You can check detailed warning information by going to Active Backup for Business > Activities > Task History.
	Error: This icon indicates that one or more errors occurred during the backup. A brief error message and a suggested solution will be displayed, while more detailed information can be found at Active Backup for Business >Activities > Task History.

Server information

This area displays the server your Windows device is connected to and the user account you are signed in with. If the server's address changes, you can modify the connection. However, you cannot change the account you sign in with when you edit the connection.

Recent activities

All backup details are listed in the table in chronological order.

Restore

You can restore individual files and folders by launching the Recovery Portal from the agent. As long as you have the right permissions (package managers, operators with restore privilege, or permitted users), you can browse, restore, and download files and folders in the Recovery Portal.

Disconnect from the server

Right-click on the agent icon from the Windows tray menu, then click Log out. You need to enter the credentials of the package manager account to authorize the action.

This will not remove your device from the backup task or template, but your device will not be backed up after you disconnect it.

Active Backup for Business Agent for macOS

Installation

The installer file of the agent is a .dmg file. You can download the installer from the Download Center.

For the operations in this section, you need to log in to macOS with an account that has administrator privileges.

To install the agent:

Confirm that you have enabled the kernel extensions (kexts) before the installation.

Launch the installer on your Mac. Read through the Terms of Service and start the installation.

To update the agent:

When there is a newer version of the agent, you can update the agents on source devices by installing the new version. Remotely batch updating the agents on multiple Mac computers can be done in Active Backup for Business console.

To uninstall the agent:

1. Open Finder, then click Applications from the sidebar.
2. Control-click on Synology Active Backup for Business Agent and select Show Package Contents.
3. Open the "Contents" folder. Double click Uninstall Synology Active Backup for Business Agent to uninstall the agent.

Configuration

Task settings are managed by the package managers in Active Backup for Business console on DSM. Users with manager privileges can edit settings such as the template name, backup mode, schedule, and retention.

To create a backup template:

You must create backup templates in the admin console on DSM. Open Active Backup for Business and go to Settings > Template to create and edit backup templates. Template settings cannot be changed via the agent.

To connect your Mac to the server:

1. On your Mac, click Finder > Application > Synology Active Backup for Business Agent to launch the agent.
2. Enter the IP address or DDNS of the Synology NAS. Enter your username and password, and click Connect. Keep in mind that spaces count as characters in the text fields.
3. If you are unable to connect to the Synology NAS, click Proxy to open the proxy setting window. Fill in your settings and re-connect to the Synology NAS.
4. You will see the backup summary of this computer. All the settings are based on the template or task configured in the console. Click OK to finish.

To start a backup immediately:

When you create a template in the console, you can decide whether to start a backup right after a source is connected to the server. You will need to tick Back up instantly after the client is connected to your DiskStation for the first time at Settings > Template > Schedule.

However, you cannot start a backup from the agent. Manually starting a backup is only possible in the console.

On macOS notification icon

After you install the agent, it will run in the background until you disconnect it from the server by logging out. You can find the agent icon on the menu bar that runs along the top of the screen on your Mac. Click on the icon to open the context menu, where you can find all the available actions.

• Backup status: Real-time backup status. If there is an error, click View backup status to open the agent for more details.
• View backup status: Details of the current backup is shown in the agent. You can check other server information and recent activities as well.
• Edit connection: If the server address changes, you need to edit the connection. Otherwise, the agent will be disconnected from the server.
• Log out: Enter the package manager's credentials to log out. If you log out from the agent, your device disconnects from the server. The device's backup task will not be deleted. When you connect to the same server later, the system will perform the missed backups during the time your device was disconnected.
• About: Current version information and links to Terms of Service and Privacy Statement.
• Troubleshooting:
  • Help: This document contains all the agent-centered information and manual.
  • Export logs: If you encounter issues with the agent and need to contact Synology Technical Support, providing the exported logs will help speed up the troubleshooting process.
• Exit: Exiting the application will not terminate the service on the device. You can always find it in Finder > Application. Click Synology Active Backup for Business Agent to launch the agent.

Monitor

The backup agent helps you monitor the device's backups. You can check the overview status, server information, and recent activities.

Backup Status

The backup status is shown with icons. The following table explains what each icon stands for. When there are no ongoing tasks, this area displays the previous and next backup time. When there is an error, you can see the error message and the suggested solution here.

	Completed: The previous backup task has been completed. During backup intervals, this area shows the last backup time and the next backup time.
	Backing up: The device is being backed up. The transfer status is shown below the status.
	Idle: The device has not run any backup task yet. If there is a backup schedule, the next backup time will be displayed.
	Canceled: The backup task has been canceled. Backup tasks can only be canceled from the admin console. This area also shows the last backup time and the next backup time, if applicable.
	Partial success: The backup task is only partially successful. You can check detailed warning information by going to Active Backup for Business > Activities > Task History.
	Error: This icon indicates that one or more errors occurred during the backup. A brief error message and a suggested solution will be displayed, while more detailed information can be found at Active Backup for Business >Activities > Task History.

Server information

This area displays the server your Mac is connected to and the user account you sign in with. If the server's address changes, you can modify the connection. However, you cannot change the account you sign in with when you edit the connection.

Recent activities

All backup details are listed in the table in chronological order.

Restore

You can restore individual files and folders by launching the Recovery Portal from the agent. As long as you have the right permissions (package managers, operators with restore privilege, or permitted users), you can browse, restore, and download files and folders in the Recovery Portal.

Disconnect from the server

Click on the agent icon from the menu bar on the desktop, then click Log out. You need to enter the credentials of the package manager account to authorize the action.

This will not remove your device from the backup task or template, but your device will not be backed up after you disconnect it.

Active Backup for Business Agent for Linux

Installation

The installer file of the agent is a .zip file. You can download the installer from the Download Center.

For the operations in this section, your Linux user account must have administrative privileges.

To install the agent:

1. Make sure that you download the correct installer for your Linux physical server.
   • deb: Ubuntu and Debian distributions
   • rpm: CentOS, RHEL, and Fedora distributions
2. After extracting the downloaded file, follow the steps in the README file and execute sudo ./install.run to install the snapshot driver and agent on your Linux device.

To update the agent:

The agent can be updated by installing a newer installer directly on the device. Remotely batch updating the agents on multiple Linux physical servers can be done in Active Backup for Business console

To uninstall the agent:

You need to uninstall the backup service first before uninstalling the snapshot driver. Follow the steps below according to the file type of the installer on your device.

• For the deb installer:
  1. Enter the following command to uninstall the backup service.
     apt remove synology-active-backup-business-linux-service
  2. Enter the following command to uninstall the driver.
     apt remove synosnap
• For the rpm installer:
  1. Enter the following command to uninstall the backup service.
     yum remove synology-active-backup-business-linux-service
  2. Enter the following command to uninstall the driver.
     yum remove synosnap

Configuration

Task settings are managed by the package managers in the admin console on DSM. Users with manager privileges can edit settings such as the template name, backup mode, schedule, and retention.

To connect your Linux device to the server:

Use the commands to connect your physical servers to the Active Backup for Business server. When the device is successfully connected, you will see the backup summary of this physical server.

• abb-cli: the name of Active Backup for Business Agent in the command line
• Command

  Command	Description
  -c example: abb-cli -c [Connection Options]	Connect to the Synology NAS.
  -r example: abb-cli -r [Connection Options]	Reconnect to the Synology NAS or edit the connection.
  -l example: abb-cli -l [Connection Options]	Disconnect from the Synology NAS. You must have the package managers privileges to disconnect the device from the server.
  -s example: abb-cli -s [Connection Options]	Show the recent status of the backup service and connection between your device and Synology NAS. The link to the Recovery Portal will also be available.
  -h example: abb-cli -h	View available control options.
  -v example: abb-cli -v	Check the current version of the agent.
  -q example: abb-cli -q	Change the notification settings to only send out prompt and error notifications.

Note:

• One device can only connect to one Synology NAS.
• Options

  Options	Description
  -a, --address	Server address
  -u, --user	Username
  -p, --password	User password
  --proxy-ip	The IP address of the proxy server
  --proxy-port	The port of the proxy server
  --proxy-user	Proxy username
  --proxy-password	Proxy user password

Note:

• You can connect to the server via the IP address or DDNS.
• If you are using a proxy server, you can also use the commands above to connect to the Synology NAS.

To create a backup template:

You must create backup templates in the admin console on DSM. Open Active Backup for Business and go to Settings > Template to create and edit backup templates.

To start a backup immediately:

When you create a template in the console, you can decide whether to start a backup right after a source is connected to the server. You will need to tick Back up instantly after the client is connected to your DiskStation for the first time at Settings > Template > Schedule.

However, you cannot start a backup from the agent. Manually starting a backup is only possible in the console.

To view more information about backups:

Enter the command abb-cli -s. You will see the current connection status, logged-in account, backup destination, last backup time, and next backup time.

Restore

You can restore individual files and folders by launching the Recovery Portal from the agent. As long as you have the right permissions (package managers, operators with restore privilege, or permitted users), you can browse, restore, and download files and folders in the Recovery Portal.

Physical servers can be restored to other virtual platforms (VMware and Hyper-V) and Virtual Machine Manager. For more information on different restoration methods, refer to this article.