Overview
An auto-configuration rule is a set of backup configuration settings(e.g. storage, backup policy, administrative groups, proxy pools etc)— and categories of Nutanix AHV virtual machines. Categories act as metadata tags that classify VMs. When a new or existing unconfigured VM matching the defined category in the rule is discovered, the system automatically applies the associated backup settings.
This eliminates the need for manual VM configuration, ensuring that all VMs are consistently protected. It also reduces operational overhead and provides scalability by applying standardized backup policies across large Nutanix environments.
Administrators can still refine, update, or override these rules when exceptions are required, giving both automation and flexibility in managing VM data protection.
📝 Notes:
Auto configuration is supported only for Prism Centrals.
Categories are case-sensitive key-value pairs that act as metadata to help identify your virtual machines.
Based on the auto-configuration rule, any VM that is not configured gets automatically configured as per the rule definition. The filtering for backup is based on the categories that are added in the rules.
The auto-configuration rules are only applicable for VMs that are unconfigured. Previously configured VMs do not qualify for auto-configuration. Once a rule is applied to a VM, that VM moves to the configured state.
Create a new Auto Configuration Rule
Log in to the Management Console.
On the console, from the top menu, select Organization.
Select Protect > Nutanix AHV.
On the Prism page, Select the Prism Central whose VMs need to be backed up.
In the left navigation pane, click Auto Configuration Rules.
On the Auto Configuration Rules page, click New Auto Configuration Rule.
On the New Auto Configuration Rule page, in the Overview section, enter the following details and click Next.
Rule Name: Name of the rule. It should be unique.
Description: A brief description about the rule (optional)
On the Resource Selection Rules tab, do the following and click Next:
Provide categories to include: For more information, see Add Categories to include.
Provide categories to be excluded. For more information. See Add categories to exclude.
Matching Resources: This field displays the number of resources that match the categories to be included, the number of configured VMs included in said category, and the number of VMs that will be configured with this rule.
On the Backup Settings tab, perform the following actions
Select or create a new backup policy.
Select the Administrative Group.
Select the Storage. Once selected, it cannot be modified later, so select the storage carefully.
Local Storage (Optional): If you wish to use CloudCache as local storage, select Map to CloudCache.
📝Note:
Nutanix AHV supports CloudCache R3. If you do not have any device with CloudCache R3, this option will be disabled. In that case, go to Manage CloudCache by following the link on the screen and configure a new CloudCache R3 device.If you select Map to CloudCache, you will see two new dropdowns:
CloudCache - Select the CloudCache device you want to use. Note that this CloudCache device should be on the same local area network and have CloudCache R3.
Retain backups for - Select the days you want to retain the local backup on the CloudCache device.
Select the Backup Proxy Pool. You can only select the proxy pool which has at least one updated proxy that supports auto configuration. and click Finish. For more information, see Create backup policy.
The auto configuration rule gets created and is displayed on the Auto Configuration Rules listings page.
Once the rule is listed here, you can click on Apply All Rules to apply one or more rules.
To view the details of a rule, click the respective rule from the listings page. You can then delete or edit the rule.
Add Categories to include
On the Resource Selection Rules tab, you can add categories to be included. This determines the virtual machines that need to be included for backup. To create a new rule, on the create new auto configuration rule wizard, perform the following steps:
On the Auto Configuration Rules page, click New Auto Configuration Rule.
On the New Auto Configuration Rule page, in the Overview section, enter the required details and click Next.
On the Resource Selection Rules tab, in the Add Categories to include section, click Add.
In the add categories to include wizard, enter the match criteria and click Save.The resources can be filtered based on Categories. To enter a category, type the “key:value” pair.
📝 Notes:
Categories are case-sensitive.
One category can be included in only one auto-config rule. Once it is added to a rule, you cannot add it to another rule in the Include rule.
Once categories are included, the matching resources section gets updated. The matching resources section displays total matching resources, highlighting those already configured for backup (either manual or auto config) and those that will be configured for the first time.
Add Categories to Exclude
On the Resource Selection Rules tab, you can add categories to be excluded. This determines the virtual machines that need to be excluded from backup. To create a new rule, on the create new auto configuration rule wizard, perform the following steps:
On the Auto Configuration Rules page, click New Auto Configuration Rule.
On the New Auto Configuration Rule page, in the Overview section, enter the required details and click Next.
On the Resource Selection Rules tab, in the Add Categories to exclude section, click Add.
In the add categories to exclude wizard, enter the match criteria and click Save. The resources can be filtered based on Categories. To enter a category, type the “key:value” pair.
📝 Notes:
Categories are case-sensitive.
One category can be included in only one auto-config rule. Once it is added to a rule, you cannot add it to another rule in the Include rule.
Once categories are included, the matching resources section gets updated. The matching resources section displays total matching resources, highlighting those already configured for backup (either manual or autoconfig) and those that will be configured for the first time.
Considerations
The autoconfig rule that gets first associated with the resource remains associated with the resource until the rule is deleted or changed.
Within an auto config rule, excluded categories take precedence over included categories. If a VM has both an included and an excluded category, it will be excluded from auto-configuration for that rule. However, if the VM meets the criteria of another rule, it can still be auto-configured under that rule.
You can update the auto config rule at any point of time, the previously configured resources will continue to be backed up as per the previous configuration.
When an auto-configuration rule is deleted, the existing VMs that were configured using this rule will not be disabled. They will continue to be backed up with their current configuration.
Auto-Configuration Rules Scenarios
Nutanix AHV virtual machines can have Categories, and if a user creates multiple auto-configuration rules based on these categories, there are chances that a conflicting scenario might occur.
For example, consider a scenario wherein a Nutanix AHV virtual machine has two categories, C1 and C2; and the user configures two auto-config rules, R1 with category C1 and R2 with category C2. You will need to manually resolve the conflict on the management console by updating the rule to ensure that the VM gets protected, or you can change the VM category on the Nutanix console.
Let’s consider some scenarios and the corresponding behavior of auto config rules.
Scenario | Example | Auto config rule behavior |
A VM is configured by an auto config rule and then the rule is deleted. | VM1 is filtered by an auto config rule R1 and then R1 is deleted. | The VM will not be disabled. It will continue to be backed up with the existing configuration. |
A VM is filtered by multiple auto config rules. | VM1 is filtered by auto config rules R1 and R2. | You will need to manually resolve the conflict on the management console to ensure that the VM gets protected, or you can change the VM category on the Nutanix console. |
A VM is included both in an include and exclude rule. | VM1 is categorized under 2 categories, C1 and C2. In rule R1, category C1 is added to “categories to include”. In the same rule, R1, category C2 is added to “categories to exclude”. | Exclude rule takes precedence and VM1 gets excluded and is not protected. |
A VM is disabled after configuration. |
| Backups for the VM will be disabled. |
Deleting an Auto-Configuration Rule
Deleting a rule will stop the automatic configuration of new VMs that match its criteria. Existing backups for VMs configured by the rule will remain intact.
Navigate to the Auto Configuration tab.
Select the checkbox next to the rule(s) you want to delete.
Click the Delete button.
A confirmation dialog will appear. Click Yes, Delete Rule to proceed.
A success message will confirm the deletion. You may also receive an email notification confirming the deletion.