User Tools

Site Tools


public:module:microsoft_sql_database:requirements

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
public:module:microsoft_sql_database:requirements [2019/09/17 16:06]
ronnie.chan
public:module:microsoft_sql_database:requirements [2021/04/19 11:41] (current)
ronnie.chan
Line 1: Line 1:
 ====== Requirements ====== ====== Requirements ======
 +
 You are strongly recommended to configure or check all the requirements below before you proceed with the MS SQL server backup and restoration. You are strongly recommended to configure or check all the requirements below before you proceed with the MS SQL server backup and restoration.
  
-CloudBacko Pro supports 2 backup modes when creating a backup set for MS SQL server, VSS mode and ODBC mode.+===== Hardware Requirement =====
  
-----+Refer to the here for the list of hardware requirements:​ [[public:​edition:​cloudbacko_pro:​hardware_requirement]] 
 + 
 +===== Software Requirement ===== 
 + 
 +Refer to the [[public:​edition:​cloudbacko_pro:​supported_platforms|list of compatible operating systems]] and [[public:​edition:​cloudbacko_pro:​supported_applications|application versions]]. 
 + 
 +===== CloudBacko Pro Installation ===== 
 + 
 +Make sure the latest version of CloudBacko Pro is installed directly on the machine where the MSSQL Server database(s) are hosted.
  
-===== VSS Backup Mode ===== 
-The VSS-based backup utilizing the Microsoft SQL Server VSS Writer to obtain a consistent snapshot of the MS SQL databases, no spooling / staging of database file(s) is required during the backup process. 
 <WRAP indent> <WRAP indent>
 +Backup and restore of MS SQL Server database(s) running on a remote machine is not supported.
 +</​WRAP>​
  
-=== CloudBacko Pro Installation ​=== +===== Java Heap Size =====
-Make sure the latest version of CloudBacko Pro has been installed on the MS SQL server.+
  
-=== SQL Add-On Module === +The default Java heap size setting on CloudBacko Pro is 2048MB. For MS SQL Server backup ​it is highly recommended to increase the Java heap size setting to be at least 4096MB to improve backup and restore performance. The actual heap size is dependent on the amount of free memory available on your MS SQL serverSee: [[public:​edition:​cloudbacko_pro:​faq:​how_to_increase_java_heap_size]]
-Make sure the Microsoft ​SQL Server backup ​module has been purchased for your CloudBacko Pro license+
  
-=== Continuous Backup Module ​=== +===== MS SQL Server Registry ===== 
-The continuous backup add-on module ​is required if you would like to enable ​the continuous backup feature+ 
-  +Make sure the MS SQL entry is present in the registry key "​HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\Instance Names\SQL"​. 
-=== Java Heap Size === +To access this path, type “regedit” in the command prompt to launch the Registry Editor.  
-The default ​Java heap size setting on CloudBacko Pro is 2048MB. For MS SQL Server backup ​it is highly recommended ​to [[https://forum.cloudbacko.com/​viewtopic.php?f=40&t=1628&p=7639&​hilit=java+heap#​p7639|increase ​the Java heap size setting]] to be at least 4096MB to improve backup and restore performanceThe actual heap size is dependent on amount ​of free memory available on your MS SQL server+ 
 +{{public:​module:​microsoft_sql_database:​cloudbacko_module_sql_005.png?​800}} 
 + 
 +<WRAP info> 
 +Pay extra attention when you are checking configuration in Registry Editor. Any unauthorized changes could cause interruption ​to the Windows operation 
 +</​WRAP>​ 
 + 
 +===== SQL Server Services =====  
 + 
 +Ensure that the following SQL Server Services have been enabled in the Windows Services menu. Launch Services in Windows by clicking Start then typing “Services” in the search box. All MS SQL server related services should be started by default. If in case it is not, turn it on by right clicking the item then selecting Start. 
 + 
 +{{public:​module:​microsoft_sql_database:​cloudbacko_module_sql_003.png?​800}} 
 + 
 +===== Transport Layer Security(TLS) =====  
 + 
 +For MS SQL Server ​2005, 2008, 2012, and 2014 VSS and ODBC backup ​modes, TLS version 1.0 must be enabled as only TLS version 1.0 is supported. 
 + 
 +To check if TLS 1.0 is enabled on the MS SQL machine, launch the registry editor and locate the following path: 
 + 
 +“HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.0\Client” 
 + 
 +The value of registry key should be “1” ​to indicate that TLS 1.0 is enabled. 
 + 
 +| {{public:module:​microsoft_sql_database:​image1019.png?800}} | 
 + 
 +Meanwhile, for MS SQL Server 2016, 2017 and 2019 VSS and ODBC backup modes, TLS version 1.2 must be enabled as only TLS version 1.2 is supported. 
 + 
 +To check if TLS 1.2 is enabled on the MS SQL machine, launch the registry editor and locate the following path: 
 + 
 +“HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Protocols\TLS 1.2\Client” 
 + 
 +The value of registry key should be “1” to indicate that TLS 1.2 is enabled. 
 + 
 +| {{public:​module:​microsoft_sql_database:​image1023.png?800}} | 
 + 
 +===== Upgrade VMware Tools Requirement ===== 
 + 
 +To avoid unexpected ​java crash, if the Windows machine is a guest VM hosted on a VMware Host then it is highly recommended that the VMware tools version installed on the guest VM must be 10.0.5 or above. Below is the warning message that will be displayed if the version ​of the VMware Tools is less than 10.0.5. 
 + 
 +| {{public:​module:​microsoft_sql_database:​image1025.png?​800}} | 
 + 
 +===== VSS Backup Mode ===== 
 + 
 +The VSS-based backup utilizing the Microsoft SQL Server VSS Writer to obtain a consistent snapshot of the MS SQL databases, no spooling / staging of database file(s) is required during the backup process. 
 + 
 +<WRAP indent>
  
 === User Account Privileges === === User Account Privileges ===
 +
 Make sure the operating system account that performs the backup and restore has sufficient permission to access both SQL server and VSS.  Make sure the operating system account that performs the backup and restore has sufficient permission to access both SQL server and VSS. 
  
Line 32: Line 85:
  
 === SQL Server VSS Writer === === SQL Server VSS Writer ===
 +
 Make sure the SqlServerWriter has been installed and running on the SQL server, and the writer state is Stable. This can be verified by running the “vssadmin list writers” command in the Windows Command Prompt. ​ Make sure the SqlServerWriter has been installed and running on the SQL server, and the writer state is Stable. This can be verified by running the “vssadmin list writers” command in the Windows Command Prompt. ​
  
 If you do not find the SqlServerWriter in the result, make sure the SQL Server VSS Writer has been started by following the instructions in Windows Services section below. ​ If you do not find the SqlServerWriter in the result, make sure the SQL Server VSS Writer has been started by following the instructions in Windows Services section below. ​
  
-Example:+**Example:**
 <​code>​ <​code>​
 C:​\Users\Administrator>​vssadmin list writers C:​\Users\Administrator>​vssadmin list writers
Line 110: Line 164:
  
 === MS SQL Server Volumes === === MS SQL Server Volumes ===
 +
 MS SQL Server volumes must use a file system which supports the use of VSS snapshot, for example NTFS. MS SQL Server volumes must use a file system which supports the use of VSS snapshot, for example NTFS.
  
 === Windows Services === === Windows Services ===
 +
 Ensure that the following services have been enabled in the Windows Services menu.  Ensure that the following services have been enabled in the Windows Services menu. 
  
Line 118: Line 174:
  
 <WRAP indent> <WRAP indent>
-1.SQL Server VSS Writer 
  
-{{public:​cloudbacko_module_sql_002.png?​800}} +**SQL Server ​VSS Writer**
-  +
-2. SQL Server ​Services+
  
-{{public:​cloudbacko_module_sql_002.png?​800}} +{{public:​module:​microsoft_sql_database:​cloudbacko_module_sql_002.png?​800}}
-  +
-3. Volume Shadow Copy+
  
-{{public:​cloudbacko_module_sql_002.png?​800}} +**Volume Shadow Copy**
-</​WRAP>​+
  
-=== MS SQL Server Registry === +{{public:​module:​microsoft_sql_database:​cloudbacko_module_sql_004.png?800}}
-Make sure the MS SQL entry is present in the registry key "​HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\Instance Names\SQL"​. +
-To access this path, type “regedit” in the command prompt to launch the Registry Editor+
  
-{{public:​ahsay_wiki_module_microsoft_sql_requirement_5.png?​800}} 
- 
-<WRAP info> 
-Pay extra attention when you are checking configuration in Registry Editor. Any unauthorized changes could cause interruption to the Windows operation. ​ 
 </​WRAP>​ </​WRAP>​
  
 === MS SQL Recovery Model === === MS SQL Recovery Model ===
 +
 VSS backup mode does not support backup of transaction log files, but for databases configured in either Full or Bulk-logging recovery model, this may eventually result in transaction logs filling up the available disk space on the volume of the MS SQL Server. Refer to: [[https://​technet.microsoft.com/​en-us/​library/​cc966520.aspx]] VSS backup mode does not support backup of transaction log files, but for databases configured in either Full or Bulk-logging recovery model, this may eventually result in transaction logs filling up the available disk space on the volume of the MS SQL Server. Refer to: [[https://​technet.microsoft.com/​en-us/​library/​cc966520.aspx]]
  
Line 150: Line 195:
 </​WRAP>​ </​WRAP>​
  
-==== ODBC Backup Mode ====+===== ODBC Backup Mode ====
 By using the ODBC mode for MS SQL backup, databases files are spooled to a temporary directory before being uploaded to the backup destination. By using the ODBC mode for MS SQL backup, databases files are spooled to a temporary directory before being uploaded to the backup destination.
 +
 <WRAP indent> <WRAP indent>
-=== Hardware Requirement === 
-Refer to the following article for the list of hardware requirements for AhsayOBM: FAQ: Ahsay Hardware Requirement List (HRL) for version 8.1 or above 
- 
-=== Software Requirement === 
-Refer to the following article for the list of compatible operating systems and application versions: FAQ: Ahsay Software Compatibility List (SCL) for version 8.1 or above 
- 
-=== AhsayOBM Installation === 
-Make sure the latest version of AhsayOBM has been installed on the MS SQL server. 
- 
-=== AhsayOBM Add-On Module Configuration === 
-Make sure the Microsoft SQL Server feature has been enabled as an add-on module in your AhsayOBM user account. Contact your backup service provider for more details. 
- 
-=== Backup Quota Requirement === 
-Make sure that your AhsayOBM user account has sufficient storage quota assigned to accommodate the storage of MS SQL Server backup set and retention policy. 
- 
-=== Continuous Backup Module === 
-The continuous backup add-on module is required if you would like to enable the continuous backup feature. 
- 
-=== Java Heap Size === 
-The default Java heap size setting on AhsayOBM is 2048MB. For MS SQL Server backup it is highly recommended to increase the Java heap size setting to be at least 4096MB to improve backup and restore performance. The actual heap size is dependent on amount of free memory available on your MS SQL server. ​ 
  
 === Temporary Directory Folder === === Temporary Directory Folder ===
  
-  - The temporary directory folder is used by AhsayOBM ​for storing the database files, incremental/​differential delta files and backup set index files. To ensure optimal backup/​restoration performance,​ it is recommended that the temporary directory folder is set to a local drive. ​+  - The temporary directory folder is used by CloudBacko Pro for storing the database files, incremental/​differential delta files and backup set index files. To ensure optimal backup/​restoration performance,​ it is recommended that the temporary directory folder is set to a local drive. ​
   - The temporary folder should not be located on Windows system partition or the database partition to minimize any potential performance impact on Windows or database. If the temporary directory folder is located on a network drive, make sure the login account has sufficient permission to access the network resources. ​   - The temporary folder should not be located on Windows system partition or the database partition to minimize any potential performance impact on Windows or database. If the temporary directory folder is located on a network drive, make sure the login account has sufficient permission to access the network resources. ​
   - Please refer to the following URL for more details: \\ [[https://​support.microsoft.com/​en-us/​help/​2926557/​sql-server-vdi-backup-and-restore-operations-require-sysadmin-privileg]] \\   - Please refer to the following URL for more details: \\ [[https://​support.microsoft.com/​en-us/​help/​2926557/​sql-server-vdi-backup-and-restore-operations-require-sysadmin-privileg]] \\
Line 182: Line 209:
   - It is recommended that the temporary directory folder should have at least free disk space of 150% of the total database size. The actual free disk space required depends on various factors including the size of the database, number of backup destinations,​ backup frequency, in-file delta settings etc.   - It is recommended that the temporary directory folder should have at least free disk space of 150% of the total database size. The actual free disk space required depends on various factors including the size of the database, number of backup destinations,​ backup frequency, in-file delta settings etc.
   - The SQL Windows service must have read and write permission to the temporary directory.   - The SQL Windows service must have read and write permission to the temporary directory.
- 
-=== Windows Services === 
-Ensure that the following services have been enabled in the Windows Services menu.  
-Launch Services in Windows by clicking Start then typing “Services” in the search box. All MS SQL server related services should be started by default, in case if it is not, turn it on by right clicking the item then selecting Start. 
- 
-1. SQL Server Services \\ {{public:​ahsay_wiki_module_microsoft_sql_requirement_6.png?​800}} 
- 
-2. Volume Shadow Copy \\ {{public:​ahsay_wiki_module_microsoft_sql_requirement_7.png?​800}} 
-  
-=== MS SQL Server Registry === 
- 
-Make sure the MS SQL entry is present in the registry key "​HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Microsoft SQL Server\Instance Names\SQL"​. 
- 
-To access this path, type “regedit” in the command prompt to launch the Registry Editor. ​ 
- 
-{{public:​ahsay_wiki_module_microsoft_sql_requirement_8.png?​800}} 
- 
-<WRAP info> 
-Note: Pay extra attention when you are checking configuration in Registry Editor. Any unauthorized changes could cause interruption to the Windows operation. ​ 
-</​WRAP>​ 
  
 === Maximum Worker Thread === === Maximum Worker Thread ===
 +
 For SQL instance with large number of database (more than 500 databases), consider to increase the “Maximum Worker Thread” setting. Refer to the article below for further details. ​ For SQL instance with large number of database (more than 500 databases), consider to increase the “Maximum Worker Thread” setting. Refer to the article below for further details. ​
 [[https://​docs.microsoft.com/​en-us/​sql/​database-engine/​configure-windows/​configure-the-max-worker-threads-server-configuration-option]] [[https://​docs.microsoft.com/​en-us/​sql/​database-engine/​configure-windows/​configure-the-max-worker-threads-server-configuration-option]]
  
 === MS SQL Recovery Model === === MS SQL Recovery Model ===
 +
 ODBC backup mode supports transaction log backup for database with Full recovery model. ODBC backup mode supports transaction log backup for database with Full recovery model.
  
Line 215: Line 224:
 2. To perform a transaction log backup, please change the recovery model of corresponding databases from Simple to Full. 2. To perform a transaction log backup, please change the recovery model of corresponding databases from Simple to Full.
 [[https://​docs.microsoft.com/​en-us/​sql/​relational-databases/​backup-restore/​view-or-change-the-recovery-model-of-a-database-sql-server]] [[https://​docs.microsoft.com/​en-us/​sql/​relational-databases/​backup-restore/​view-or-change-the-recovery-model-of-a-database-sql-server]]
 +
 +=== ODBC Mode Authentication Methods === 
 +
 +ODBC backup mode supports two types authentication method:
 +
 +== Trusted Authentication ==
 +
 +This is the default authentication method in the MS SQL Server. When using this method, MS SQL Server uses the Windows login account to authenticate the login to the MS SQL Server.
 +
 +== MS SQL Authentication == 
 +
 +When using this method, the username and password are created and stored in the MS SQL Server.
 +
 +For details on how to verify if the login credentials you intend to use to authenticate the MS SQL Server backup job on AhsayOBM has the correct permissions,​ and to determine if the drive for temporary folder has enough disk space to accommodate the spooling of the database(s),​ please refer to Appendix E.
 +
 +<WRAP indent>
 +It is recommended to use the Trusted Authentication method wherever possible as this type of method is tightly integrated with Windows which has an integrated security. MS SQL Server trusts the credentials provided by Windows as Windows authentication uses a series of encrypted messages to authenticate users in the MS SQL Server.
 +</​WRAP>​
 +
 +However, when MS SQL Server logins are used, MS SQL Server login names and encrypted passwords are passed across the network, which makes them less secure.
 </​WRAP>​ </​WRAP>​
  
public/module/microsoft_sql_database/requirements.1568707611.txt.gz · Last modified: 2019/09/17 16:06 by ronnie.chan