action

a

append

For some actions using the file parameter, append will append output to the existing file.

bambooServer

Server parameter for Bamboo actions.

bitbucketServer

Server parameter for Bitbucket actions.

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.

common

Common parameter string added to all run actions.

confluenceServer

Server parameter for Confluence actions.

connectionTimeout

Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

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.

crucibleServer

Server parameter for Crucible actions.

database

Database name is required for SQL actions.

dateFormat

Format string for date in Java SimpleDateFormat, default is client date format.

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

dbPassword

Database user password. Defaults to password.

dbUser

Database user name. Defaults to user.

debug

Requests detail debug output. Optional for all actions.

driver

JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

encoding

Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

file

f

Path to file based content or result output. Use - for standard input.

findReplace

Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.

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 escaped.

fisheyeServer

Server parameter for FishEye actions.

help

Prints this help message.

hipchatServer

Server parameter for HipChat actions.

host

Database host server for SQL actions. Not used if url is provided. (default: localhost)

jiraServer

Server parameter for JIRA actions.

list

Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled.

outputFormat

Specify output format for an action. (default: 1)

parameters

Client specific parameters.

password

p

User password for remote access.

port

Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

propertyFile

Property file with mapping information.

quiet

Limit some output messages. Optional for all actions.

servicedeskServer

Server parameter for Service Desk actions.

simulate

Simulate running actions. Log the action that would be taken.

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.

url

Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

user

u

User name for remote access.

verbose

v

Requests verbose output to help with problem determination. Optional for all actions.