ESCWA Command Line Options

Syntax:

escwa.exe [OPTION]...

Options

Options with arguments can be supplied as 'OPTION=ARG' or 'OPTION ARG':

-c , --config=<file>

Configuration file to use instead of commonwebadmin.json.

-h, --help

Displays the parameter list.

-s, --service

If and only if you are running ESCWA as a service, set this option. Mandatory for running ESCWA as a service.

Note: This option is for Windows only.

-V, --version

Displays the version of ESCWA being used.

-w, --write[=<bool>]

Write configuration changes made in ESCWA to the configuration file.

If neither --config or --<ConfigNode> are set and this is unsupplied, this is implicitly true.

If either --config or --<ConfigNode> are set and this is unsupplied, this is implicitly false. 'TRUE', 'true', 'YES', 'yes' and '1' are all interpreted as true; all other arguments are interpreted as false.

The default value is true.

-u, --vault[=<bool>]

Enable or disable use of the secrets vault. If 'true', the value of BasicConfig.VaultSpecification is used if valid. 'TRUE', 'true', 'YES', 'yes' and '1' are all interpreted as true; all other arguments are interpreted as false.

The default value is true.

-p, --shutdown [<user> [<password>]]

Shut down a running ESCWA instance. If multiple ESCWA instances are running specify which one by the configuration file location. If ESCWA is restricted then a user must be specified with execute permissions on the control resource in the Common Web Administration class. ESCWA cannot be shut down by this command if it is running as a Windows service.

--<ConfigNode>[<.<ConfigNode>>...]=<value>

Override the specified node in the configuration file with the specified value. The configuration file is JSON and the format of the option reflects that structure: it is a period ('.') separated list of nodes in the configuration file, with the first node being one of the root nodes, and each subsequent node being a child of the node preceding it. For example --TraceConfig.TraceEnabled corresponds to the setting TraceEnabled in the root node TraceConfig.

Elements in an array can be accessed using an integer as the node. JSON arrays are 0-indexed. For example --MfdsList.1.MfdsHost corresponds to the setting MfdsHost in the 2nd item of the array MfdsList, which is also a root node.

The final specified node does not need to be a leaf node of the file; entire JSON objects and arrays can be overridden. Elements can be appended to an array using '+' as a child node. For example --MfdsList.+ will append a supplied element to MfdsList.

Arguments can be numbers, strings, boolean, JSON arrays, or JSON objects depending on the specified setting. For boolean, 'TRUE', 'true', 'YES', 'yes' and '1' are all interpreted as true; all other values are interpreted as false. If overriding a JSON object or array, the specified JSON object or array must be correct and complete JSON, structurally identical to the original (arrays may have a differing number of items, including 0. For example --MfdsList=[]), and escaped with respect to the command line. Items not enclosed in quotes do not need to be escaped. Escaping requirements will vary according to platform. For example:

--TraceConfig="{\"TraceEnabled\":false,\"TraceLevel\":0,\"TraceFileName\":\"\/home\/user\/trace file\", ... }"

Optional configuration blocks (for example K8sConfig) can be added by passing in an appropriate and valid JSON object as the argument, or removed by passing in 'null' as the argument. See commonwebadmin.json file for possible settings and their values.