Backup Parameters

Important

Remember to read the Best Practices chapter common for all of our hypervisor plugins.

Nutanix AHV Backup Parameters
Parameter	Values	Default	Description
include	`<Java Regexp>`		Specifies a list of guest VM names to back up. Uses Java-compatible regular expressions.
exclude	`<Java Regexp>`		Specifies a list of guest VM names to exclude from the backup.
vm	`<guest VM name>`		Specifies the name of a single guest VM to back up, regardless of other include/exclude rules.
protection_domain	`<protection domain name>`		When set, only virtual machines belonging to the specified protection domain are considered for backup. VMs in the domain are still filtered according to `include`, `exclude`, and `vm` parameters. This parameter is optional and is unspecified by default.
application_consistent	`<true\|try\|false>`	`try`	Specifies if the snapshot taken during the backup should be application consistent (`true`), crash consistent (`false`), or try application consistent first and fallback onto crash consistent if it fails (`try`). This parameter is optional.
dat_file	`<String>`	`nutanixAhv.dat`	Specifies the name of the `.dat` file used to track dependencies between snapshots. This argument is optional.

The use of regular expressions in the parameters include= and exclude= must be a Java compatible regular expression.

In order to be backed up the guest VM must match the include=... predicate and not match the exclude=.... A guest VM that matches the vm=... will be backed up regardless of the include/exclude specifications.

By default all guest VMs match the include predicate and not the exclude. Therefore, if none of the parameters vm=..., include=... and exclude=... are provided, all available guest VMs hosted on the Nutanix-AHV hypervisor will be backed up.

On the other hand if the parameter vm=... is specified all guest VM will no longer match the include predicate. This means that if only vm=... parameter is specified no other guest VM will be backed up.

See FileSet Examples for examples of include/exclude/vm setups.