Estimation and Backup Plugin Parameters

vm=<name-label>

specifies a guest VM name to backup. All guest VMs with a name-label provided will be selected for backup. Multiple vm=... parameters may be provided. If a guest VM with <name-label> can not be found, then a single job error will be generated and the backup will proceed to the next VM unless abort_on_error is set which will cause the backup job to be aborted. This parameter is optional.

uuid=<uuid>

specifies a guest VM UUID to backup. Multiple uuid=... parameters may be provided. If a guest VM with <uuid> can not be found, then a single job error will be generated and the backup will proceed to the next VM unless abort_on_error is set which will cause the backup job to be aborted. This parameter is optional.

include=<name-label-regex>

specifies list of a guest VM names to backup using regular expression syntax. All guest VMs which match the name-label-regex provided will be selected for backup. Multiple include=... parameters may be provided. If no guest VMs match the <name-label-regex> provided, the backup will proceed to the next VM parameters or finish successfully without backing up any VMs. The abort_on_error parameter will not abort the job when no guest VMs are found using a <name-label-regex>. This parameter is optional.

exclude=<name-label-regex>

specifies list of a guest VMs names which will be excluded from backup using regular expression syntax. All guest VMs which match the name-label-regex provided and were selected for backup using include=... parameters will be excluded. This parameter does not affect any guest VMs selected to backup with vm=... or uuid=... parameters. Multiple exclude=... parameters may be provided. This parameter is optional.

quiesce[=<0 or 1>]

specifies if the guest VM snapshot should be created using a quiesce method or not. The quiesce method is supported by XenServer for Windows OS with Guest-Tools installed only. This is a limitation of the XenServer itself. If the guest VM snapshot with quiesce cannot be created, the whole backup job will be aborted. In this case you should repeat a backup without the quiesce parameter.

If none of the parameters vm=..., uuid=..., include and exclude are specified, all available guest VMs hosted on the XenServer hypervisor will be backed up.

See also

Previous articles:

Next articles:

Go back to: Xen Plugin: Configuration.