Chat now with support
Chat with Support

Metalogix Backup for SharePoint 6.5.1 - User Guide

Product Overview Getting Started Configuring Metalogix Backup for SharePoint Reviewing backup status Backing up and restoring farm components Restoring granular objects

Backing up SharePoint farms

Metalogix Backup for SharePoint can be used to back up SharePoint 2010, 2013 and 2016 farms. Microsoft Volume Shadow Copy Service (VSS) is used to collect data from SharePoint components as they work. Because it uses VSS, Metalogix Backup for SharePoint can back up the components that make up your SharePoint farm while your farm is in use.

To use Metalogix Backup for SharePoint, you must have your farm configured to use VSS. If VSS is not enabled, Metalogix Backup for SharePoint will not be able to back up your SharePoint 2010, 2013 and 2016 farms.

VSS is included in Windows Server 2003 and later versions of Windows. For information about how VSS works, please consult your Windows Server documentation, or the Microsoft article Volume Shadow Copy Service Overview at http://msdn.microsoft.com/en-us/library/aa384649(VS.85).aspx.

Only SharePoint 2010, 2013 and 2016 farms can use Farm Backup/Restore.

See the following topics for more information:

·Reviewing farm backup status

·Configuring farm backups

·Viewing scheduled farm backups

·Viewing farm backup alerts

·Reviewing the SharePoint farm objects to back up

·Specifying the farm backup options

·Specifying the Mount Options

·Specifying the Target SQL Server Location

·Reviewing the Backup Summary
 

Reviewing farm backup status

The Overview tab of the farm backup/restore view lets you review the status of your farm backups. The tab always includes a list of the backup and restore operations in the most recent seven days. You can see the name of the backup set, the type of operation, the operation progress, and other information.

The Operation Queue tab of the Farm Backup/Restore view lets you review upcoming operations. You can see the name of the backup set, the type of operation, the operation progress, and other information.

You can optionally see the details of any operation that you select in the Overview tab or the Operation Queue tab.
Operation_Queue_Backup_Full

What actions can I perform in the Overview tab?

You perform the following actions in the Overview tab:

View or hide details

You can view or hide the Operation Details pane by selecting Details. The Operation Details pane includes additional information about the selected operation. For more information, see What information does the details pane include?
clip0162

Group operations

You can choose to group operations in the status field by selecting Group Operations. When you group operations, differential backups are attached to the related full backups.
clip0163

Refresh the status

You can manually refresh the operation status field by selecting Refresh.
clip0164

Restore

When you select a backup operation in the status area, you can click Restore to restore the backed-up data.
clip0165

Run the backup again

When you select a backup operation in the status area, you can click Rerun Backup to run the backup operation again.
clip0166

Stop a running operation

When you select a running operation, you can click Cancel Operation to stop the operation.
clip0168

Delete an operation from the status list

When you select an operation, you can click Delete Operation to delete the operation from the status list.
clip0169

View the farm configuration

When you select a backup operation that includes the SharePoint config database, you can click View Farm Configuration to explore the XML configuration files in the backup.

info

NOTE: If this option is disabled, then clear the Do not execute scripts to report on the farm's configuration at time of backup check box from the Backup Wizard.

clip0170

Filter data in the status field

You can select or clear the check boxes in the Filter area, or provide a date range, in order to control the items that appear in the status field.
clip0171

What actions can I perform in the Operation Queue tab?

You perform the following actions in the Operation Queue tab:

View or hide details

You can view or hide the Operation Details pane. The details pane includes additional information about the selected operation. For more information, see What information does the details pane include?
clip0172

Refresh the status

You can manually refresh the operation status field.
clip0173

Cancel a queued operation

When you select a queued operation, you can click Cancel Operation to stop the operation.
clip0174

How do I show or hide the operation details?

When the details are visible, they appear below the Backup/Restore Operation Status field.
clip0062

To show or hide the operation details

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0176

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0177

3.In the right pane, click Overview.
clip0178

4.In the ribbon, click Details to show or hide the Operation Details pane.
clip0179

What information does the Operation Details pane include?

The details pane includes the following information:

Server operations

Information about the backup on a per-server basis, including the server name, the progress, the average throughput, the original and compressed data sizes, the compression ratio, and the start time and the duration of the operation. The backup set size on the disk may differ from the size of the backed-up data because the backup set includes information created by Metalogix Backup for SharePoint about the Backup Set itself.
clip0186

Backup content

The farm components included in the selected operation.
clip0185

Result text

The results of the selected operation.
clip0184

Description

The description of the selected operation. The person who creates the operation enters the description.
clip0183

Summary

A summary of the operation, including the type, the status, the backup set name and location, the user who initiated the operation, and the client used.
clip0187

How do I filter the contents of the status field?

You can use the check boxes and the date range drop-down in the Filter area of the ribbon in the Overview tab to control what appears in the Backup/Restore Operation Status field.
clip0188

To filter the contents of the status field

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0189

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0190

3.In the right pane, click Overview.
clip0191

4.In the ribbon, in the Filter area, select the check boxes for items that you want to show in the Backup/Restore Operation Status field. Clear the check boxes for items that you want to hide.
clip0192

5.Click Date Range to specify a time limit for the items in the Backup/Restore Operation Status field.
clip0193

Configuring Farm Backups

The Backup tab of the Farm Backup/Restore view in the Metalogix Backup for SharePoint Management Console lets you create full and differential backups. You can also schedule backups using this view.

You can include only one farm component in a single scheduled farm backup. The scheduled farm backup can be a full backup or a paired full backup and differential backup. You can also include the same component in one or more on-demand full backups.

info

TIP: If a component is part of a scheduled backup, and a user includes the component in an on-demand backup, the next scheduled backup must be a full backup even if a differential backup is scheduled.

When you add the component to the on-demand backup, the Management Console warns you that adding the component alters the scheduled backup and asks you to confirm the change. When you restore a component that is part of a scheduled backup, the next scheduled backup is always a full backup.

What is the difference between a full backup and a differential backup?

A full backup includes current versions of every item in the scope of the backup and is a complete representation of the state of the backed-up components at the time of the backup. Every item in the scope of the backup is copied during every backup.

A differential backup compares the state of the backed-up content in a specified full backup to the actual content in the SharePoint farm. Metalogix Backup for SharePoint then copies only the changed items into the backup set. You must have both the differential backup and the associated full backup to restore content from the backup.

For certain component types, the entire component is always backed-up in both full and differential backups. For example, if you include the SharePoint registry in a farm component backup, the entire registry is included in every backup.

info

TIP: Both full and differential backups that include SharePoint databases include the entire SQL Transaction log for the databases. Metalogix Backup for SharePoint does not truncate the log. You must manage the transaction log size in another tool. If you do not manage the log size, it continues to grow in your backup sets.

Only a full backup can be an on-demand backup.

A differential backup must be a part of a backup schedule. A differential backup will be performed across content databases, the admin database, and the configuration databases only. If any web front end components or service application databases were selected, they will be protected during the scheduled full backups.

How do I select the components to back up?

The Backup tab in the Farm Backup/Restore view allows you to select the components that you want to back up. Only users who are members of the farm administrators group can perform farm backups. For information about the components that you can back up, see Using Metalogix Backup for SharePoint in your disaster recovery plans.

To select the components to back up

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0194

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the right pane, click the Backup tab.
clip0196

4.In the Select farm components to back up field, select the check boxes for the items to include in the backup.
clip0058

·You can also click the Select All, Unselect All, Expand Tree, and Collapse Tree in the top panel in order to locate and select the items to back up.
clip0198

How do I create a full backup?

You use the Backup tab in the Farm Backup/Restore view to create a full backup.

To create a full backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0194

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the right pane, click the Backup tab.
clip0196

4.In the Select farm components to back up field, select the check boxes for the items to include in the backup.
clip0058

5.You can also click the Select All, Unselect All, Expand Tree, and Collapse Tree in the top panel in order to locate and select the items to back up.
clip0198

6.Click Full Backup in the top panel. The Backup Wizard appears.
clip0199

7.On the Welcome to the backup Wizard page, click Next.

8.On the Backup page, review the items that the backup includes, then click Next.
clip0059

9.On the Options page, you can do the following:

oSpecify a name for the backup set in the Backup Set Name field.
clip0202

oOptionally enter notes about the backup set in the Backup Set Description field.
clip0203

oSelect a location for the backup set from the Backup Set Location drop-down list. You can click Manage Locations to open the Backup Service Preferences dialog box and configure the backup locations. For more information about configuring your Backup Service preferences, see Defining the Backup Service preferences.
clip0204

oSelect Do not execute scripts to report on the farm's configuration at time of backup in order to prevent Metalogix Backup for SharePoint from providing farm's configuration at the time of the backup.

info

NOTE: If this option is deselected, then users will be able to select the "view farm configuration" option for the backup set.

clip2

oSelect the Enable compression check box to compress the backup set.
clip0205

oSelect the Enable encryption check box to encrypt the backup set. If you enable encryption, you must also specify a password for the backup set. You must supply the same password when you restore from the backup.
clip0206

oSelect the Copy Only check box to allow a backup to be taken that does not interfere with the conventional backup/restore sequence of SQL Server backups. This option is normally used if SQL Server backups are already being taken separately from Backup, and Backup should not interfere in the existing process.
BackupWizard_CopyOnly_Warning

10.On the Options page, click Next.

11.On the Mount Options page, select which content database, if any, you would like the backup to mount to. Click Next.
clip0208

12. If you did not choose a content database on which to mount the backup in the previous step, skip to the next step. If you chose a content database on which to mount the backup in the previous step, then you will now see the Target SQL Server page. On this page, enter the information for the server on which you want to mount the backup. Click Next.
clip0209

13.On the Summary page, click Backup to start the backup.

How do I schedule a backup?

You use the Backup tab in the Farm Backup/Restore view to schedule a full backup or a differential backup.

When you schedule a backup, you can choose to perform a full backup every time the scheduled backup runs. You can also choose to perform a full backup the first time the scheduled backup runs, then perform a differential backup on subsequent runs. Full backups and differential backups can have unrelated backup schedules.

If you choose to pair a full backup and differential backups, you can specify when Metalogix Backup for SharePoint should perform a new full backup in place of a differential backup. If the size of the differential backup is more than a percentage of the size of the most recent full backup, Metalogix Backup for SharePoint can perform a full backup instead. You can specify the threshold percentage that triggers the full backup.

To schedule a backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0194

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the right pane, click the Backup tab.
clip0196

4.In the Select farm components to back up field, select the check boxes for the items to include in the backup.
clip0058

5.[Optional] You can also click the Select All, Unselect All, Expand Tree, and Collapse Tree in the top panel in order to locate and select the items to back up.
clip0198

6.Click Schedule a Backup.
clip0210

7.On the Welcome to the Backup Schedule wizard page, click Next.

8.On the Backup page, review the items that the backup includes, then click Next.
clip0059

9.On the Options page, do the following:

oSpecify a name for the backup set in the Backup Set Name field.
clip0202

oOptionally enter notes about the backup set in the Backup Set Description field.
clip0203

oSelect a location for the backup set from the Backup Set Location drop-down list. You can click Manage Locations to open the Backup Service Preferences dialog box and configure the backup locations. For more information about configuring your Backup Service preferences, see Defining the Backup Service preferences.
clip0204

oEnter the user to run the backup as in the Run As field.
clip0212

oIn the Backup Type area, select the type of backup to create. If you click Schedule full and differential backups, you can choose to perform a full backup in place of a differential backup when the differential backup size is larger than a percentage that you specify.
clip0213

oSelect Do not execute scripts to report on the farm's configuration at time of backup in order to prevent Metalogix Backup for SharePoint from providing farm's configuration at the time of the backup.

info

NOTE: Both full and differential backups that include SharePoint databases include the entire SQL Transaction log for the databases. Metalogix Backup for SharePoint does not truncate the log. You must manage the transaction log size in another tool. If you do not manage the log size, it continues to grow in your backup sets.

clip2

oSelect Do not execute scripts to report on the farm's configuration at time of backup in order to prevent Metalogix Backup for SharePoint from providing farm's configuration at the time of the backup.

info

NOTE: If this option is deselected, then users will be able to select the View farm configuration option for the backup set.

clip2

oSelect the Enable compression check box to compress the backup set.
clip0205

oSelect the Enable encryption check box to encrypt the backup set. If you enable encryption, you must also specify a password for the backup set. You must supply the same password when you restore from the backup.
clip0206

oSelect the Copy Only check box to allow a backup to be taken that does not interfere with the conventional backup/restore sequence of SQL Server backups. This option is normally used if SQL Server backups are already being taken separately from Backup, and Backup should not interfere in the existing process. This option is only available if the Schedule Full Backups option is the backup type chosen.
BackupWizard_CopyOnly_Warning

10.On the Schedule Full page, select when the full backup should take place, then click Next.
clip0214

11.If you chose to perform both Full Backups and Differential Backups, in the Schedule Differential page, specify when the differential backups should take place, then click Next.

info

NOTE: A differential backup will be performed across content databases, the admin database, and the configuration databases only. If any web front end components or service application databases were selected, they will be protected during the scheduled full backups.

12.On the Alerting page, specify the alert settings for the scheduled backup. You can select Use the default alert configuration for this backup schedule or you can select Use the following alert settings for this schedule, then specify the settings to use. Click Next to continue.
clip0216

13.On the Grooming page, specify the grooming settings for the scheduled backup. You can select Use the default grooming settings for this backup schedule or you can select Use the following grooming settings instead of the default grooming settings, then specify the settings to use. Click Next to continue.
clip0217

14.On the Mounting Options page, you can select which content database, if any, you wish to mount the scheduled backups to. You can also specify rules for mounting:
clip0220

oSpecify the Content Database size limit, which will prevent the backup from being mounted if the content database exceeds the specified size. Note that setting a limit of 0MB means that there is no size limit and all backups will be mounted to the selected content databases.
clip0218

oNumber of mounted databases to keep allows you to specify the number of backups sets that are kept mounted. Specifying a value of 1 will keep the latest scheduled backup mounted.
clip0219

15.Click Next on the Mounting Options page to continue.

16.If a Content database was selected for mounting, then the next page will be the Target SQL Server page. On this page, specify the location of the SQL Server where the content database will be mounted, as well as its credentials. Click Next to continue.
clip0221

17.In the Summary page, click Finish.

Viewing scheduled farm backups

The Scheduled Backups tab in the Metalogix Backup for SharePoint Management Console lets you view, edit, delete, enable, and disable scheduled farm backups.

How do I view the scheduled farm backups?

You use the Scheduled Backups tab in the Farm Backup/Restore view to view the existing backup schedules.

To view the scheduled farm backups

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

How do I view the details of a scheduled farm backup?

You use the Scheduled Backups tab in the Farm Backup/Restore view to view the details of a scheduled backup.

To view the details of a scheduled farm backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

4.Click the name of the scheduled backup whose details you want to review.
clip1455

5.If the Scheduled Backup Details do not appear in the bottom of the Scheduled Backups tab, click Details.
clip0225

How do I make changes to a scheduled farm backup?

You use the Scheduled Backups tab in the Farm Backup/Restore view to make changes to a scheduled backup.

To make changes to a scheduled farm backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

4.Click the name of the scheduled backup that you want to edit.
clip0226

5.In the ribbon, click Edit.
clip0227

6.In the Welcome to the Backup Schedule wizard page, click Next.

7.In the Backup page, review the items that the backup includes, then click Next.
clip0059

8.In the Options page, do the following:

oSpecify a name for the backup set in the Backup Set Name field.
clip0202

oOptionally enter notes about the backup set in the Backup Set Description field.
clip0203

oSelect a location for the backup set from the Backup Set Location drop-down list. You can click Manage Locations to open the Backup Service Preferences dialog box and configure the backup locations. For more information about configuring your Backup Service preferences, see Defining the Backup Service preferences.
clip0204

oEnter the user to run the backup as in the Run As field.
clip0212

oIn the Backup Type area, select the type of backup to create. If you click Schedule full and differential backups, you can choose to perform a full backup in place of a differential backup when the differential backup size is larger than a percentage that you specify.
clip0213

oSelect Do not execute scripts to report on the farm's configuration at time of backup in order to prevent Metalogix Backup for SharePoint from providing farm's configuration at the time of the backup.

info

NOTE: If this option is deselected, then users will be able to select the "view farm configuration" option for the backup set.

clip2

oSelect the Enable compression check box to compress the backup set.
clip0205

oSelect the Enable encryption check box to encrypt the backup set. If you enable encryption, you must also specify a password for the backup set. You must supply the same password when you restore from the backup.
clip0206

oSelect the Copy Only check box to allow a backup to be taken that does not interfere with the conventional backup/restore sequence of SQL Server backups. This option is normally used if SQL Server backups are already being taken separately from Backup, and Backup should not interfere in the existing process. This option is only available if the Schedule Full Backups option is the backup type chosen.
BackupWizard_CopyOnly_Warning

oSelect the Auto include new content databases to schedule, option in order to automatically include all new content databases to the scheduled backup.
clip1477

9.On the Schedule Full page, select when the full backup should take place, then click Next.
clip0214

10.If you chose to perform both Full Backups and Differential Backups, in the Schedule Differential page, specify when the differential backups should take place, then click Next.
clip0215

11.On the Alerting page, specify the alert settings for the scheduled backup. You can select Use the default alert configuration for this backup schedule or you can select Use the following alert settings for this schedule, then specify the settings to use. Click Next to continue.
clip0216

12.On the Grooming page, specify the grooming settings for the scheduled backup. You can select Use the default grooming settings for this backup schedule or you can select Use the following grooming settings instead of the default grooming settings, then specify the settings to use. Click Next to continue.
clip0217

13.On the Mounting Options page, you can select which content database, if any, you wish to mount the scheduled backups to. You can also specify rules for mounting:
clip0220

oSpecify the Content Database size limit, which will prevent the backup from being mounted if the content database exceeds the specified size. Note that setting a limit of 0MB means that there is no size limit and all backups will be mounted to the selected content databases.
clip0218

oNumber of mounted databases to keep allows you to specify the number of backups sets that are kept mounted. Specifying a value of 1 will keep the latest scheduled backup mounted.
clip0219

14.Click Next on the Mounting Options page to continue.

15.If a Content database was selected for mounting, then the next page will be the Target SQL Server page. On this page, specify the location of the SQL Server where the content database will be mounted, as well as its credentials. Click Next to continue.
clip0221

16.In the Summary page, click Finish.

How do I delete a scheduled farm backup?

You use the Scheduled Backups tab in the Farm Backup/Restore view to delete a scheduled backup. When you delete a scheduled backup, you only delete the schedule. You do not delete the existing backups in the backup sets.

To delete a scheduled farm backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

4.Click the name of the scheduled backup that you want to delete.
clip0226

5.In the ribbon, click Delete.
clip0228

6.The Metalogix Backup for SharePoint Management Console prompts you to confirm that you want to delete the Scheduled Backup. Click Yes to delete the scheduled backup.
clip0229

How do I enable and disable a scheduled farm backup?

You use the Scheduled Backups tab in the Farm Backup/Restore view to temporarily disable and enable scheduled backups. When you disable a scheduled backup, the scheduled backup definition stays in Metalogix Backup for SharePoint, but it does not execute. You can disable a scheduled backup when you need to temporarily suspend backups, then later resume them. Disabled scheduled backups have a red icon in the Scheduled Backups field.

To disable a scheduled farm backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

4.Click the name of the scheduled backup that you want to delete.
clip0226

5.In the ribbon, click Disable.
clip0230

To enable a disabled scheduled farm backup

1.In the Metalogix Backup for SharePoint Management Console, in the left pane, click Farm Backup/Restore.
clip0222

2.In the Farm Backup/Restore pane, click any server name or All Servers for any farm.
clip0195

3.In the top right pane, click Scheduled Backups.
clip0223

4.Click the name of the scheduled backup that you want to delete.
clip0231

5.In the ribbon, click Enable.
clip0232

Related Documents