Defining Filters for OpenStack

Filters can be configured to exclude instances, images, or volumes from backups. You can define filters on a subclient (only applies to that subclient) or on a backup set (applies to all subclients under the backup set).

For each subclient under a backup set, the filtering specified for the backup set is combined with the filtering for the subclient to determine which content is excluded from backups. Any filtering defined in a backup set is also visible in the subclients under the backup set when the Show Backupset Filters option is selected, and is applied at the subclient level even if backup set filters are not displayed.


If an instance or image is added by browsing and selecting the display name, discovery is performed based on the GUID for the instance or image. If that instance or image is later restored in place from a backup, a new GUID is generated, and that instance or image is no longer filtered from the backup. To filter that instance or image, you must remove the old filter rule, then add a new rule or use a name pattern for the filter.


  1. From the CommCell Browser, expand Client Computers > virtualization_client > Virtual Server > OpenStack > backup_set.

  2. Right-click the backup set or subclient and then click Properties.

  3. Select one of the following:

    • In the Backup Set Property dialog box, click the Instance Filters or Instance Volume Filters tab.

    • In the Subclient Properties dialog box, click the Filters tab.

  4. To define a new filter, you can browse or define a rule:

    • Browse and select objects:

      1. Click Browse.

      2. Select a view from the list at the top left of the Browse dialog box:

      3. Projects: Select a project, region, instance, or image.

      4. Admin: Select images or instances.

        Note: You can only view and select images and instances that are accessible to the keystone user associated with the virtualization client.

      5. Click OK.

    • Define a rule for images or instance:

      1. Click Add in the tab or area for instance filters.

      2. In the Rule Group box, select the rule type from the drop-down list and enter the appropriate information in the box on the right:

        Instance Name/Pattern

        Enter a pattern (for example, Test* to identify instances or images for which the name begins with "Test").

        Guest OS

        Not supported. Do not use this option.

        Guest DNS Hostname

        Not supported. Do not use this option.

        Power State

        Select one of the following options to identify instances:

        • Powered On: Instances that are powered on.

        • Powered Off: Instances that are powered off.

        • Other: Instances with a different power on status, such as Pause or Saved.

        To define multiple rules in a rule group, click + and define another rule. The following options are available for a rule group with multiple rules:

      3. If you define multiple rules in a rule group, you can indicate whether instances or images are selected when they match all of the rules (selected by default), or when they match any of the rules.

        To exclude instances or images based on any of the criteria, you can use the Does Not Equal operator for one or more of the rules in a rule group. (For rule groups with a single rule, the only operator you can use is Equals.)

        For simple rules defined in the Contents of subclient list (not in a rule group), instances or images are selected if they match any of the rules defined for the subclient.

    • Define a rule for volume filters:

      1. Click Add in the tab or area for instance volume filters.

        The Add Disk Filter dialog box appears.

      2. To filter an instance volume, select Volume Name/Pattern and enter the volume name or pattern.

        You can use the following wildcard characters to specify a pattern:

        Wildcard characters



        Represents any number for characters (for example, *vol* to specify all volumes that contain the string "vol").


        Represents a single character (for example, *.?df to specify all volumes with a suffix ending in "df").

        [ ]

        Contains a range of characters to match (for example, [a-m]*.doc).

        [! ] or [^ ]

        Matches strings that do not contain the specified range of characters (for example, [!ei]nsure.doc or [^fg]oo.out).

      3. To filter the operating system disk for an instance created from an image, select Volume Type.

        OS Disk is the only volume type that you can choose.


      4. Filtering the OS disk disables Nova snapshots for the backup of the instance, so that the backup only includes cinder snapshots for attached volumes. To restore the instance, the base image for the instance must be available at the time of the restore.

      5. For instances created from volumes, all volumes are backed up, including the boot volume.

  5. To modify a filter, select the filter and then click Edit.

  6. To remove a filter, select the filter and click Delete; then confirm the deletion request.

  7. Click OK.