| Parameter | Short | Value | Description |
---|
1 | action | a | | |
2 | afterSql | | | SQL to run after a successful action. Limited to specific actions at this time. |
3 | append | | | For some actions using the file parameter, append will append output to the existing file. |
4 | bambooServer | | | Server parameter for Bamboo actions. |
5 | bitbucketServer Anchor |
---|
| bitbucketServer |
---|
| bitbucketServer |
---|
|
| | | Server parameter for Bitbucket actions. |
6 | clearFileBeforeAppend Anchor |
---|
| clearFileBeforeAppend |
---|
| clearFileBeforeAppend |
---|
|
| | | For run actions, this option will automatically clear an existing file on the first append requested. |
7 | 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. |
8 | comment | | | Comment text. |
9 | common | | | Common parameter string added to all run actions. |
10 | confluenceServer Anchor |
---|
| confluenceServer |
---|
| confluenceServer |
---|
|
| | | Server parameter for Confluence actions. |
11 | connectionTimeout Anchor |
---|
| connectionTimeout |
---|
| connectionTimeout |
---|
|
| | | Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. |
12 | 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. |
13 | database | | | Database name is required for SQL actions. |
14 | 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. |
15 | 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. |
16 | dbCreateTable Anchor |
---|
| dbCreateTable |
---|
| dbCreateTable |
---|
|
| | | Database table needs to be created before adding rows. |
17 | dbJar | | | By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar |
18 | dbPassword | | | Database user password. Defaults to password. |
19 | dbTable | | | Database table name when creating or updating a database from list output. |
20 | dbTableKeys | | | Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table. |
21 | dbUser | | | Database user name. Defaults to user. |
22 | debug | | | Requests detail debug output. Optional for all actions. |
23 | driver | | | JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. |
24 | encoding | | | Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. |
25 | file | f | | Path to file based content or result output. Use - for standard input. |
26 | findReplace | | | Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. |
27 | findReplaceRegex Anchor |
---|
| findReplaceRegex |
---|
| findReplaceRegex |
---|
|
| | | Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. |
28 | help | | | Prints this help message. |
29 | hipchatServer Anchor |
---|
| hipchatServer |
---|
| hipchatServer |
---|
|
| | | Server parameter for HipChat actions. |
30 | host | | | Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided. |
31 | jiraServer | | | Server parameter for JIRA actions. |
32 | list | | | Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. |
33 | list2 | | | Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. |
34 | options | | | Comma separated list of support, experimental, or other client or action specific options. |
35 | outputFormat | | | Specify output format for an action. (default: 1) |
36 | parameters | | | Client specific parameters. |
37 | password | p | | User password for remote access. |
38 | port | | | Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. |
39 | propertyFile | | | Property file with database parameters, field mappings, or client specific information. |
40 | quiet | | | Limit some output messages. Optional for all actions. |
41 | reference | | | Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key. |
42 | replace | | | Replace existing entity on add, create, or similar actions. |
43 | servicedeskServer Anchor |
---|
| servicedeskServer |
---|
| servicedeskServer |
---|
|
| | | Server parameter for Service Desk actions. |
44 | simulate | | | Simulate running actions. Log the action that would be taken. |
45 | special | | | Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. |
46 | sql | | | SQL select statement used to generate a run script. |
47 | upmServer | | | Server parameter for UPM actions. |
48 | url | | | Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. |
49 | user | u | | User name for remote access. |
50 | verbose | v | | Requests verbose output to help with problem determination. Optional for all actions. |