The Windows Backup Agent installer automatically sets default parameters for the configuration. If you want to change the default configuration values, you can do so by using your [Windows Backup Agent Utility|About the Windows Agent Configuration Utility] or Configure Agent Options from the actions menu for the protected machine.
h5. Backup Agent Configuration Options
By default, the Backup Agent configuration file is located in
{{c:\Program Files\Server Backup Agent\conf\}}
!agent_config file_English.png!
|| Parameter || Default Value || Description ||
| *ConfDir* \\ | ..\conf | Configuration directory path. \\
*Notice:* The value for Local Port should match the Remote Port settings for the Backup Agent in the Backup Manager. |
| *LogDir* | ..\log | Logging directory path. |
| *LogFileMaxBytes* | 33554432 | Sets the maximum size in bytes of an Server log file before it is rolled over and a new log file is created. |
| *LogFileMaxFiles* | 10 | LogFilesMaxFiles sets the maximum number of log files the Backup Agent will create before it starts deleting older log files. The value of zero will allow an unlimited number of files. |
| *BindTo* | 0.0.0.0 | Local address the Backup Agent will listen for requests from the Backup Manager on. |
| *LocalPort* | 1167 | The Port the Backup Agent will listen on. |
| *MaximumNetworkConnections* | 32 | MaximumNetworkConnections sets the maximum number of simultaneous network connections the Backup Agent will accept at one time. This is used to limit the amount of system resources the Backup Agent will use to process new connections. |
| *RecoveryMode* | 0 | Disables authentication between the Backup Manager and Backup Agent. Do not do this unless instructed by R1Soft Support.\\ |
{newversion}| *IPAuthentication* | 0 | Parameter that allow to check the filename in {color:blue}user.allow{color} to make sure it matches IP. \\
If set to "1," the Backup Agent looks for a file in the {{server.allow}} directory matching the IP address of an incoming connection before doing RSA Key authentication. "0" means the Backup Agent will only do RSA Key authentication and not check the source IP address of the connecting the Backup Manager. \\
*Tip:* RSA Key authentication is VERY strong and is just like using SSH with RSA or DSA Key authentication (authentication without a password). For added security, you can have the Backup Agent check that the source IP address of the connecting Backup Manager attempting to authenticate is a configured IP address in the {{server.allow}} directory which contains Backup Manager RSA public keys named with the source IP address of the Backup Manager. |{newversion}
h4. Defining Backup Agent Local Port
Follow the instructions below to define Backup Agent Port.
{info:title=Note}To define Backup Agent Port in Free and Advanced Editions, use [Windows Backup Manager Configuration Utility|About Windows Backup Manager Configuration Utility]. See more in [ServerBackup:Access Backup Manager Configuration Utility] and [ServerBackup:Configure Backup Agent port].
{info}
1. Run the Windows Backup Agent Utility. Read more in [Launch Windows Backup Agent Configuration Utility]. *{_}If you are using the Free or Advanced editions{_}*, run the Windows Backup Manager Configuration Utility. Read more in [Access Backup Manager Configuration Utility].
2. The main window of the Windows Backup Agent Utility will open. Make sure the "Agent Configuration" tab is selected.
3. On the "Agent Configuration" you can see Backup Agent-related settings.
* *Backup Agent Port* \- Define a Port to connect to the Backup Agent if different from default value. Default Port is 1167.
{note:title=Notice}The value for "Backup Agent Port" must match the Backup Agent Port settings in the Backup Manager.
{note}
|| Enterprise Edition | !Backup Agent Configuration Utility_Agent Configuration tab_port outlined_English.png! ||
4. Click "Apply."
5. After making changes to the configuration file, you need to restart the Backup Agent. Click "OK."
!Backup Agent configuration_applied_message_English.png!
6. Restart the Backup Agent by selecting Services !arrow-transparent.gif! Restart Server Backup Manager.
!Backup Agent Configuration Utility_Restart Server Backup Agent(Manager)_shortened_English.png!
7. Confirm your request to restart the Backup Agent by clicking "OK."
!Server Backup Agent_Restart the service_English.png!
8. Then you will see the notification that the service has been restarted.
!Server Backup Agent restarted successfully_English.png!
See also:
{excerpt:hidden=true}
Instructions on how to change Windows Backup Agent configuration: configuration directory path, log path, IP address to listen to, TCP port, PID file, lock file, IPAuthentication parameter. Description of the Backup Agent configuration options.
{excerpt}
h5. Backup Agent Configuration Options
By default, the Backup Agent configuration file is located in
{{c:\Program Files\Server Backup Agent\conf\}}
!agent_config file_English.png!
|| Parameter || Default Value || Description ||
| *ConfDir* \\ | ..\conf | Configuration directory path. \\
*Notice:* The value for Local Port should match the Remote Port settings for the Backup Agent in the Backup Manager. |
| *LogDir* | ..\log | Logging directory path. |
| *LogFileMaxBytes* | 33554432 | Sets the maximum size in bytes of an Server log file before it is rolled over and a new log file is created. |
| *LogFileMaxFiles* | 10 | LogFilesMaxFiles sets the maximum number of log files the Backup Agent will create before it starts deleting older log files. The value of zero will allow an unlimited number of files. |
| *BindTo* | 0.0.0.0 | Local address the Backup Agent will listen for requests from the Backup Manager on. |
| *LocalPort* | 1167 | The Port the Backup Agent will listen on. |
| *MaximumNetworkConnections* | 32 | MaximumNetworkConnections sets the maximum number of simultaneous network connections the Backup Agent will accept at one time. This is used to limit the amount of system resources the Backup Agent will use to process new connections. |
| *RecoveryMode* | 0 | Disables authentication between the Backup Manager and Backup Agent. Do not do this unless instructed by R1Soft Support.\\ |
{newversion}| *IPAuthentication* | 0 | Parameter that allow to check the filename in {color:blue}user.allow{color} to make sure it matches IP. \\
If set to "1," the Backup Agent looks for a file in the {{server.allow}} directory matching the IP address of an incoming connection before doing RSA Key authentication. "0" means the Backup Agent will only do RSA Key authentication and not check the source IP address of the connecting the Backup Manager. \\
*Tip:* RSA Key authentication is VERY strong and is just like using SSH with RSA or DSA Key authentication (authentication without a password). For added security, you can have the Backup Agent check that the source IP address of the connecting Backup Manager attempting to authenticate is a configured IP address in the {{server.allow}} directory which contains Backup Manager RSA public keys named with the source IP address of the Backup Manager. |{newversion}
h4. Defining Backup Agent Local Port
Follow the instructions below to define Backup Agent Port.
{info:title=Note}To define Backup Agent Port in Free and Advanced Editions, use [Windows Backup Manager Configuration Utility|About Windows Backup Manager Configuration Utility]. See more in [ServerBackup:Access Backup Manager Configuration Utility] and [ServerBackup:Configure Backup Agent port].
{info}
1. Run the Windows Backup Agent Utility. Read more in [Launch Windows Backup Agent Configuration Utility]. *{_}If you are using the Free or Advanced editions{_}*, run the Windows Backup Manager Configuration Utility. Read more in [Access Backup Manager Configuration Utility].
2. The main window of the Windows Backup Agent Utility will open. Make sure the "Agent Configuration" tab is selected.
3. On the "Agent Configuration" you can see Backup Agent-related settings.
* *Backup Agent Port* \- Define a Port to connect to the Backup Agent if different from default value. Default Port is 1167.
{note:title=Notice}The value for "Backup Agent Port" must match the Backup Agent Port settings in the Backup Manager.
{note}
|| Enterprise Edition | !Backup Agent Configuration Utility_Agent Configuration tab_port outlined_English.png! ||
4. Click "Apply."
5. After making changes to the configuration file, you need to restart the Backup Agent. Click "OK."
!Backup Agent configuration_applied_message_English.png!
6. Restart the Backup Agent by selecting Services !arrow-transparent.gif! Restart Server Backup Manager.
!Backup Agent Configuration Utility_Restart Server Backup Agent(Manager)_shortened_English.png!
7. Confirm your request to restart the Backup Agent by clicking "OK."
!Server Backup Agent_Restart the service_English.png!
8. Then you will see the notification that the service has been restarted.
!Server Backup Agent restarted successfully_English.png!
See also:
{excerpt:hidden=true}
Instructions on how to change Windows Backup Agent configuration: configuration directory path, log path, IP address to listen to, TCP port, PID file, lock file, IPAuthentication parameter. Description of the Backup Agent configuration options.
{excerpt}