Quantum ESXPRESS 3.6 User Manual

Page 1

Quantum esXpress

“X” Commands

Product

Date

esXpress Backup for VMware has the ability to run backup related commands from within the VI3 or vSphere client by appending [x] commands to the VM Display Names or by including the commands within the VM Notes. Once the esXpress back-end daemon runs the command, it is removed from the VM Display Name.

When adding any commands to the VM Notes section, they must be added to a new line. Do not include the command on the same line as the esXpress messages or they will be removed the next time esXpress records a log message in the VM Notes.

esXpress

February 2010

6-66897-01, Rev A, February 2010

Copyright 2010 by Quantum Corporation. All rights reserved. Your right to copy this manual is limited by copyright law. Making copies or adaptations without prior written authorization of Quantum Corporation is prohibited by law and constitutes a punishable violation of the law.

TRADEMARK STATEMENT

Quantum, the Quantum logo and StorNext are registered trademarks of Quantum Corporation and its affiliates. DXi is a trademark of Quantum Corporation. esXpress is a trademark of PHD Virtual Technologies, Inc. All other trademarks are the property of their respective owners.

Page 2

esXpress “X” Commands

6-66897-01 Rev A

February 2010

Table1 Full/DeltaBackupCommands

[X] Command Description

[xFULL] Make a Full backup of the VM now. Runs the phd-FULL

command.

[xINDEX], [xDELTA], [xBACKUP] Make a Delta backup of the VM now, runs phd-INDEX

command.

[xNOW] Run a backup for the VM.

[xSPECIAL],[xONE] Makes a special backup of the VM now.

[xFULLSPECIAL],[xFULLONE] Makes a Full Special Backup of the VM.

[xAll] Run Delta backups of all VMs on the host.

[aALLFULL], [xFULLALL] Run Full backups of all VMs on the host.

[xFLB] Run a File Level Backup for the VM.

[xFLBALL] Run a File Level Backup for all VMs.

[xWIPE] Wipes the index of the VM.

[xWIPEALL],[xALLWIPE] Wipes the indexes of all the VMs on the host.

[xRETRY],[xRETRYFULL] Automatically retry a failed backup

[xSTOPALL] Stop all running backups, set Stop Lock.

[xABORTALL] Aborts all running backups, sets the Abort Lock.

[xABORT],[xSTOP] Stops the backups of the VM.

[xCLEARLOCKS],[xNOLOCKS],[xLOCKS],[xCLEAR] Clears Locks.

[xTEST] Runs a test backup, gathering performance information

and testing the configuration without actually doing the backup.

[xNOTES] Clears the Notes field of the VM of any esXpress

information.

[xALLNOTES] Clears the Notes fields for All VMs of any esXpress

information.

Schedule-related commands can be used to instruct esXpress to backup individual VMs a certain number of times in addition to the daily automatic backup, to exclude a VM from the daily backup, or to set the order in which a VM should be backed up. To use these commands, add them to either the VM display name or to the VM Notes. These commands will remain as part of the VM display name (they are not removed) so if you do not want your backup files to contain the command as part of the name, add them to the VM Notes, only. When adding commands to the VM Notes section, they must be added to a new line, do not include the command on the same line as the esXpress messages, or they will be removed.

Page 3

esXpress “X” Commands

6-66897-01 Rev A

February 2010

Table2 BackupSchedulingCommands

[X] Command Description

[x0] Backup ‘0’ times. This excludes a VM from the automatic backups.

[x1] -> [x9] Backup an additional 1 – 9 times a day.

[x0][x10] -> [x0][x23] Exclude from automatic backup and instead backup at a specific time each

night. [x0][x22] would backup a VM at 22:00 hours (10PM).

[o1] -> [o99] Specifies the order a VM is backed up. [o1] is the first machine to backup

nightly. [o1] can be used with multiple VMs.



To enable the [x] commands you have to enable the following esXpress configuration option:

Allow [x] Command from VI3 (Yes/No/SingleVM) – When the phd_daemon is enabled, you can issue commands to esXpress from within the VI3 client by updating the VM display name.

• Yes – All the [x] commands are enabled.

• No – None of the [x] commands are enabled.

• SingleVM – Only commands that affect a single VM will be allowed. Commands including

[xALL] will not be processed.

Figure1:Issue[x]CommandfromVI3

Change this:

To this: