Skip to main content
Druva Documentation

Manage content rules

Phoenix Editions: File:/tick.png Business File:/cross.png Enterprise File:/tick.png Elite

This topic describes the following sections:

Overview

Content rules define the data to be backed up. You can create a custom rule and attach it to one or more servers. After you assign the servers to backup sets, data from these servers is backed up according to the content rule and backup policy defined in the backup set. 

Phoenix creates a default content rule for your setup. The default content rule is configured to back up all folders excluding a few system folders.  The default content rule also excludes Image, Audio, video, and executable file types from backups. You can assign the default content rule to one or more servers. You can also update or delete this content rule.

Note: The Manage Content Rules page do not list the custom content.

Best practices to create content rule

  • Create a content rule when you have multiple backup sets on different servers, which need to backup the same content. 
  • Save the content rule based on its backup content. For example, you can save the content rule that backs up files at the C:/Docs and D:/ locations, as C_docs_D.
  • Do not apply overlapping backup content to different backup sets of the same server. This will unnecessarily back up the same content as a part of the different backup sets.

Add a content rule

You can create a content rule for a File server. You cannot configure a server with multiple backup sets having the same backup content.

Before you begin

Before adding a content rule for File servers, ensure you have read:

Procedure

  1. Log in to the Phoenix Management Console. 
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list. In the menu bar, click Protect > Windows/Linux Servers.
  3. In the left pane, click Content Rules
  4. Click Create Content Rule. This brings up the Create Content Rule window. 
  5. In the Overview section, in the Name field, enter a name for this content rule.
  6. Under the Backup Content section, perform the following tasks:
    Create Content Rule - Backup Content section.png
Field Description
Backup All Folders Select this option if you want to backup all files and folders, including hidden files and folders. The folders under Subfolder Exclusions are excluded from backups.
Backup Specific Folders

Select this option to backup specific folders. Type the absolute path (including the root directory) of the folder in the corresponding box and press Enter. You can also click Add <entered folder path> to add the folder.

Use the following formats while entering absolute paths:

  • Windows: Drive:\Folder
  • Linux: /dir/subdir
Subfolder Exclusions

Phoenix excludes a few folders from backup by default. For more information on the folders excluded by default in Windows and Linux, see Folders excluded from File server backup.

The subfolder exclusions apply whether you choose to backup all folders or specific folders. To exclude more subfolders, type their absolute or relative path, and press Enter. To remove a subfolder from this list, click the cross icon next to the path.

Sub-folder exclusions support the following wildcard patterns:

Wildcards without existing paths

  • Prefix (*abc): It excludes all the folders that end with abc.
  • Infix (*abc*): It excludes all the folders that contain the substring “abc”.
  • Postfix (abc*): It excludes all the folders that begin with abc.

Wildcards with existing paths

  • Prefix (Test/XYZ/*abc): This pattern excludes all folders whose names end with "abc" in the Test/XYZ folder. This pattern only applies to the specified folder path. If the path does not exist on the backup drive, the backup ignores this wildcard exclusion.
  • Infix (Test/XYZ/*abc*): This pattern excludes all folders whose names contain the string abc in the Test/XYZ folder. This pattern only applies to the specified folder path. If the path does not exist on the backup drive, the backup ignores this wildcard exclusion.
  • Postfix (Test/XYZ/abc*): This pattern excludes all folders whose names begin with abc in the Test/XYZ folder. This pattern only applies to the specified folder path. If the path does not exist on the backup drive, the backup ignores this wildcard exclusion.

The file extension is considered as part of the filename.

 

 

Note: If you are configuring Linux servers, exclude cgroups from the backup. 

Specify File Exclusions or Inclusions

If this option isn’t selected all file types, file extensions, and file patterns in the folders selected under Backup Content are backed up.

Exclude the following files from backup Exclude the specified file types and file patterns from the folders selected above.
Include only the following files in the backup Include the specified file types and file patterns from the folders selected above.
File Types Select file types to exclude/include
Select predefined file types that must be excluded from or included in the backup of folders specified under Backup Content.

Enter the extensions to exclude/include

This field displays the file extensions associated with the selected file types. You can enter custom extensions if you do not find your extensions under any predefined file types.

  • Enter file extensions in format extension, and then press Enter. You can also click Add <entered extension> to add the extension. Enter extensions without using * or . at the beginning of the extension. For example, to backup text files, enter txt and press Enter. Extensions in the format ext1.ext2 are acceptable.

Note: *extension or *.extension or .extension are unsupported formats. 

  • If the entered extension is associated with a predefined file type, that file type is populated automatically under the File Types field.
  • You can remove extensions from the list of extensions. If the removed extension is associated with a file type for which other extensions are still present, the file type is visible with an [-] icon next to it. You can view the removed file extension by hovering over this icon.
  • If all extensions associated with a file type are removed, the file type is removed from the list of File Types as well.
File Name Patterns

Enter file patterns that must be excluded from or included in the backup of folders specified under Backup Content. File patterns start with a * and can contain * *.string* or *.*string in the pattern string. Enter patterns like *.ext in the format ext in the file extension field under File Types.

Note: The filename patterns File* and File*.extension are unsupported. For example, do not use a filename pattern like img* to include/exclude all files that start with img. Use *img* instead. Do not use a filename pattern like img*.jpg to include/exclude all files that end with the extension jpg. Enter the file extension jpg under File Types instead.
For more information see File Server Known issues.

Ignore case sensitive file/folder name match for Linux servers

By default, this option is deselected. With this option deselected, the file and folder names entered in the Backup Specific Folders, Subfolder Exclusions, File extensions, and File Patterns fields are accepted as is, in whatever case you enter them. For Linux servers, this means that the entered text is case-sensitive. If this option is selected, Phoenix ignores the case of the files and folder names in these fields. For Linux servers, this means that the entered text becomes case-insensitive.

Note: This option applies to Linux servers since file and folder names are case-insensitive in Windows servers.

  1. Click Save.  

Note: The Save button is disabled if:

  • You select Specify Custom Content and then Backup Specific Folders but don't enter any absolute folder paths.

  • You don't enter a content rule name.

  • You enter an unsupported file extension or file pattern.

Correct the error and then click Save.

The created content rule now appears on the Content Rules page.

View content rule

To view the list of content rules created for the Windows/Linux servers, perform the following tasks:

  1. Log in to the Phoenix Management Console. 
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. On the menu bar click Protect > Windows/Linux servers. In the left pane, click Content Rules. The right pane displays the available content rules.  Hovering over the values under the Backup Content column displays the list of all folders excluded from or included in the backup for the corresponding content rule. It also displays the included or excluded file types, and file patterns.

    View Content Rules.png
  4. Click the content rule to view its details. The content rule details page provides the summary and server details of the content rule.

    Content Rule Details- Summary.png

For more information about the details, see Manage Content Rules details page.

Edit a content rule

When you edit a content rule, the updated configurations apply to all backup sets associated with that content rule. The updates are effective from the next backup of the corresponding backup sets. However, you can edit custom content applied to a certain server, and the updated configurations apply only to the associated backup set. The updates are effective from the next backup of the backup set.

  1. Log in to the Phoenix Management Console. 
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. On the menu bar click Protect > Windows/Linux servers. In the left pane, click Content Rules. The right pane displays the available content rules.
  4. Click the content rule that you want to modify.  
  5. In the Content Rules details page, click Edit.

    Edit Content Rule.png
     
  6. In the Edit Content Rule dialog box, you can edit the content rule name, backup content, and file inclusions or exclusions. You can also choose to either select or deselect the Ignore case sensitive file/folder name match for linux servers option.  For detailed field descriptions, see Add a content rule.


    Edit Content Rule wizard.png
  7. Click Save

Note: The Save button is disabled if:

  • You select Specify Custom Content and then Backup Specific Folders but don't enter any absolute folder paths.
  • You don't enter a content rule name.

  • You enter an unsupported file extension or file pattern.

Correct the error and then click Save.

Delete a content rule

You can delete a File server content rule that you no longer need. You cannot delete a content rule mapped to one or more backup sets. 

Note: You can delete a content rule only after 7 days of the deletion of the last backup set mapped to the rule.

Procedure

  1. Log in to Phoenix Management Console. 
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. In the menu bar click Protect > Windows/Linux servers. In the left pane, click Content Rules
  4. Click the content rule that you want to delete.  
  5. In the Content Rules details page, click Delete.


Delete a content rule.png

Note: A content rule mapped to one or more servers cannot be deleted. To see which servers are associated with the content rule, click the Servers tab on the Content Rules details page. Associate these servers with other content rules, and then delete the content rule. To change the content rule for the servers, from the Servers tab, click the server name. From the server details page, select the backup set, click more options, and select Change Content Rule. For more information, see Change Content Rule.
Change Content Rule from FS details.png

Change Content Rule 

Phoenix allows you to apply the same content rule to backup sets of multiple servers. However, one content rule can only apply to one backup set on a server.

  1. Log in to Phoenix Management Console. 
  2. On the menu bar, click All Organizations, and select the required organization from the drop-down list.
  3. In the menu bar click Protect > Windows/Linux servers. In the left pane, click File Backup Sets.
  4. In the right pane, select one or more backup sets for whom you want to change the content rule. Click Change Content Rule.

    Change Content Rule from File Backup Sets.png
  5. In the Change Content Rule dialog box, select the content rule that needs to be associated with all the selected backup sets. The Content Rule Details section in the Change Content Rule window,  displays a summary of all the included and excluded content. Verify the content, and click Save.

    Change Content Rule with rule details.png

Note: Modifying the content rule initiates a full scan in the next backup. The full scan may exceed your backup window. Use Backup Now to run a manual backup of all the selected backup sets that will be modified as a result of this change.