run
Runs a configuration script.
run
<script file>
{-Vkey=value}
{-Pvalue}
[-E | --include-environment]
[-F | --fail-on-undefined-variable]Overview
Use this command to run a configuration script.
Options
| Option | Optional or Required | Default Value | Description |
|---|---|---|---|
|
Required | none | The name of the script to be executed. |
|
Optional | none | A script variable. Note the priority order described in the Variables section. This argument can be specified multiple times with different keys. Rightmost values take precedence over leftmost values. |
| Optional | none | A property file with variables. Must be created using the UTF-8 character encoding. The file must be formatted according to the format described in the Javadoc for java.util.Properties.
Note the priority order described in the Variables section.This argument can be specified multiple times with different keys. Variables defined in rightmost files take precedence of variables defined in leftmost files. |
|
Optional | none | When set, all environment variables are included and can be used as script variables. Note the priority order described in the Variables section. |
|
Optional | none | When set, the command fails if an undefined variable is found. |
Script Syntax
The script file must be created using the UTF-8 character encoding. Each line must contain the name of a command and its arguments. Arguments may be quoted using either single or double quotes. Lines beginning with a hash character (#) are regarded as comments and have no effect. Lines ending with a backslash character (\) are continued on the next line with the backslash character removed before parsing.
The special script command "echo" can be used to echo messages to the console. See Script language.
Variables
Variables can be specified in multiple ways: as part of the script itself (using the SET command), as command line arguments, in property files (given as command line arguments), or as environment variables. If a variable is specified multiple times, then the following priority is used:
- Command line arguments (for example,
-Vexample=value). Rightmost variables take precedence of leftmost variables. - Environment variables (if
--include-environmentis specified). - Variables from property files. Variables defined in rightmost files take precedence of variables defined in leftmost files.
- Script variables (for example,
SET example = value). - Variable undefined. The script execution fails if
--fail-on-undefined-variableis specified.