Parameters
Parameters
These tell the CLI the specific details needed to perform an action. Some actions work without any additional details, but most require one or more parameters and accept additional optional parameters to perform its task. In fact, the CLI requires at least one special parameter named action (that tells what action to perform), without which CLI simply displays help with some example actions. Parameters do not have prefixes like actions and are often very specific to the app for the action.
Consider an example action getServerInfo that requires details about the app (or server) from which the information is retrieved. This is accomplished using the server parameter. The getServerInfo action also accepts optional parameters such as outputFormat, dateFormat, file, append, and encoding.
Parameter | Short | Value | Multiple Use Allowed | Description |
---|---|---|---|---|
--acceptType |
|
| Content type to accept for renderRequest if different than contentType. | |
--action | a |
| Requested operation to perform. Valid actions are listed separately. | |
--afterSql |
|
| SQL to run after a successful action. Limited to specific actions at this time. | |
--append |
|
| For some actions using the file parameter, append will append output to an existing file. | |
--augments |
|
| Comma separated list of augments to data rows. | |
--clearFileBeforeAppend |
|
| For run actions, this option will automatically clear an existing file on the first append requested. | |
--columns |
|
| Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored. | |
--comment |
|
| Comment text. | |
--common |
|
| Common parameter string added to all actions in the run script. | |
--connectionTimeout |
|
| Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | |
--contentType |
|
| Content type for post data for a web request. Any suitable value can be specified. We have defines some special values for commonly used types: JSON, HTML, XML, URL_ENCODED, FORM_URL_ENCODED. | |
--continue |
|
| Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions and already exists errors on add actions. | |
--data |
|
| JSON data for runFromJson. Post data for renderRequest. Action specific definition in some cases. | |
--database |
|
| Database name or reference to a ACLI configuration entry when proceeded with an @ symbol. When referencing a configuration entry, the entry should contain appropriate parameters for for defining access to the database including url and, when necessary, dbUser and dbPassword authentication parameters. | |
--dateFormat |
|
| Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format. | |
--dateFormat2 |
|
| Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd. | |
--dbCreateTable |
|
| Automatically create the database table before adding rows. | |
--dbJar |
|
| CLI has built-in support for Postgres and by default loads database drivers found in the CLI installation's lib/jdbc directory. Otherwise you can specify a specific file or URL reference for the database driver jar. Examples /jdbcDrivers/postgresql-42.2.19.jar or https://jdbc.postgresql.org/download/postgresql-42.2.19.jar | |
--dbPassword |
|
| Database user password. Defaults to password. | |
--dbTable |
|
| Database table name when creating or updating a database from list output. | |
--dbTableKeys |
|
| Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table. CLI automatically defaults unique keys specific for the action. | |
--dbUser |
|
| Database user name. Defaults to the same as the user parameter. | |
--debug |
|
| Requests detail debug output especially useful for Support. Optional for all actions. Recommend first using verbose logging for problem determination. | |
--driver |
|
| JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, db2, or db2400. Normally automatically determined for many databases based on url parameter. | |
--encoding |
|
| Character encoding (character set) for text based file content - must be an encoding supported by your Java platform. | |
--field |
| true | Use to set client and construct specific fields or variables using name=value syntax. The first equal sign (=) delineates the name from it's value. This provides a more convenient and expandable alternative for setting fields or variables and is the recommended approach. Values are trimmed unless single quoted and single quoted strings will have single quotes removed. | |
--file | f |
| Path to file based content or result output. For some action it may be a directory path. Use - for standard input. Use + for getting lines from 'input' parameters (deprecated). | |
--findReplace |
| true | Successively find and replace matching text with the find and replace values specified using find:replace syntax. The first colon (:) delineates the find value from the replace value. Single quote values containing a colon and then escape embedded quotes. Legacy support for a comma separated list deprecated in 9.0 has been removed in 9.3. You must now always use multiple parameters. | |
--findReplaceRegex |
| true | Successively find and replace matching text with the find and replace values specified using find:replace syntax. The first colon (:) delineates the find value from the replace value. Single quote values containing a colon and then escape embedded quotes. The find value must be a valid regular regular expression and the replace value can contain replacement variables for capture groups like $1, $2, and so on. For some command shells, the $ may need to be escaped. Legacy support for a comma separated list deprecated in 9.0 has been removed in 9.3. You must now always use multiple parameters. | |
--findReplaceScope |
|
| Option for setting where to apply the find replace logic. Options are: 'file' (default), or 'header-cells', or 'data-cells'. | |
--header |
| true | Custom request header added to remote requests. Allows for unique headers required in some environments or needed for specific requests. Header values may be sensitive like for authentication headers, so header values are masked in debug data similar to passwords and tokens. | |
--headingAugments |
|
| Comma separated list of augments to heading rows. | |
--help |
|
| Shows a help message. | |
--host |
|
| Deprecated. Not needed when using the url parameter. Database host server for SQL actions. Defaults to localhost. | |
--input | i | true | Line of input used in place of file data for run actions. One or more input parameters are used as lines instead of using the file parameter. In some cases requiring a file parameter, it may be necessary to use a special value of + to indicate to use the input parameters instead. | |
--limit |
|
| Maximum number of list entries to return. Some actions or environments may impose a smaller default limit. | |
--list |
|
| Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a comma. Embedded quotes must be escaped. | |
--list2 |
|
| Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a comma. Embedded quotes must be escaped. | |
--name |
|
| Name of an item or entity. | |
--options |
| true | Client or action specific advanced options. Use multiple times for multiple option settings or a comma separated list. | |
--outputFormat |
|
| Specify output format for a list actions. Output format determines what columns are retrieved for the list. More columns usually take longer to retrieve. | |
--outputType |
|
| CSV output from get list actions and pretty print output from get actions can optionally be converted to plain text, HTML, or json based on the value of this parameter. Get actions also support the variables output type to set replacement variables for use in a CLI run script. Valid values are: text, table, html, json, variables. | |
--port |
|
| Deprecated. Not needed when using the url parameter. Database host port for SQL actions. Defaults to database default. | |
--pretty |
|
| Format JSON output in a more readable form. | |
--propertyFile |
|
| Property file with database parameters, field mappings, or client specific information. | |
--quiet |
|
| Limit some output messages. Optional for all actions. | |
--reference |
|
| Reference to a replacement key value used to remember an action specific value like issue key, entity id, or similar so it can be referenced later. Each action that allows this parameter will specify that the reference parameter is valid for the action and the first entry listed for available replacement variables help text will be the value set. If you need access to a different replacement variable in your script, you will need to use setReplacementVariable action after the action to set a new replacement variable of your choosing to one of the other available replacement variables. | |
--regex |
|
| Regular expression for condition matching or list filtering. | |
--replace |
|
| Replace existing entity on add, create, or similar actions. | |
--requestParameters |
|
| Additional url request parameters append to the url for the renderRequest action. Use the data parameter for request post data for POST and PUT requests. | |
--requestType |
|
| Type of a render request like GET, POST, PUT, DELETE, PATCH, HEAD. | |
--select |
| true | Used for row selection by column value on list actions. The first colon (:) in the parameter value delineates the column name or number from a regex selection pattern. Each row's column value is used with the regex pattern to determined row inclusion in the final result. By default, row is included if the regex pattern is found in the column value. The options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value (not just a find!), negative - to reverse the condition so a match means exclude the row. Row selection takes place after all other action specific filtering conditions including the limit determination and so generally should not be used with the limit parameter. | |
--simulate |
|
| Simulate running actions. Log the action that would be taken. | |
--sourceFile |
|
| Source CSV file. | |
--special |
|
| Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. | |
--sql |
|
| SQL select statement used to generate a run script. | |
--type |
|
| Content type for renderRequest. | |
--url |
|
| Action specific setting. URL or partial URL for renderRequest. Database access URL for SQL related actions. URL for application link related actions. | |
--value |
|
| Field value or condition value for matching. | |
--verbose | v |
| Requests verbose output to help with problem determination. Optional for all actions. |