Command Path Macros; Context Specific Macros - HP BB118BV - StorageWorks Data Protector Express Package Addendum

42
•
•
•
•
•

Command Path Macros

Macros are classified as two types, global macros, and custom macros which are
contextual to the scenario in which they are used. The syntax for a macro are two dollar
signs around a key, for instance $keyName$. This string will expand to whatever the
defined macro for the key "keyName" is. Key names are not case sensitive, so
$keyname$ and $KEYNAME$ will both expand to the same thing.
For instance, if the user wanted to get the get the name of the product as a parameter in
their script, they could specify a command path as follows:
myBatchFile.bat -$product$
When executed, this command would expand to something like:
myBatchFile.bat –Data Protector Express

Context Specific Macros

The following are all the context specific macros available for use on pre/post commands
on jobs and objects.
All pre/post commands
"jobName" – Name of the job that executed the command
"jobPath" – Path to the job relative to the home folder (home\admin\Backup Job)
Command to execute if job completes with no error: This command will
execute if the job completes with no final error. A job can complete with no
error, even if all hosts are offline. This does not mean that anything was backed
up, it just means that the job was not cancelled, or there wasn't some other major
problem executing the job.
Run command on all hosts selected in job, as well as the Data Protector
Express Backup Server: When checked, processes the command on all
machines selected in job. When unchecked, only runs the command on the Data
Protector Express Backup Server.
Command to execute if job completes with error: This command will execute
if the job completes with an error, such as no specified devices, or operator
cancelled. This does not mean if any of the objects selected by the job fail to be
backed up/restored/ or verified.
Command path: Specifies a full path or relative path, to a shell command,
including command parameters. For instance "cmd.exe /c explorer.exe" or
c:\windows\explorer.exe. A macro syntax is also supported in this field, for many
different uses. See the macro section in this document.
Number of minutes to wait for command completion: This value in minutes
specifies how long the application should wait for the command to return. By
default, it is set to Forever, meaning the application will wait for as long as
possible for the command to complete. If set to something other then Forever,
the application will terminate the command forcefully if it does not return in
time.
Post Execution Commands