Page tree
Skip to end of metadata
Go to start of metadata

On this page

Related information for 6.4.0-SNAPSHOT

Actions

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

disableAddon

Add-ons

Disable an add-on.

addon

 

 

2

enableAddon

Add-ons

Enable an add-on.

addon

 

 

3

getAddonList

Add-ons

Get a list of installed add-ons with regex filtering on name or key. By default, only enabled, user installed add-ons are included.

addon

includeDisabled, includeSystem, regex, limit

1 - basic
2 - license

4

getAddon

Add-ons

Get information for an installed add-on.

addon

 

 

5

getClientInfo

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

1 - basic
2 - JVM
11 - action list
12 - parameter list

6

installAddon

Add-ons

Install an add-on using a url or file. If @default is used for the file parameter, an attempt will be made to find an obr or jar file within the current directory hierarchy.

url or file

wait

 

7

runFromCsv

CSV

Run actions generated from a CSV file.

file

common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

8

runFromList

Run

Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variables are entry, entry2.

list

list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

9

runFromSql

Run

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file or standard input

common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

10

run

Run

Run actions from a file or standard input.

file or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

11

uninstallAddon

Add-ons

Uninstall the add-on. If @default is specified, an attempt will be made to find an appropriate value by looking for an Atlassian add-on descriptor file with the value specified.

addon

continue

 

Parameter Tips

Common parameters

A few common parameters are available that are not specifically listed for each action: verbose, debug, quiet.

Tips

  • Use single dash for single letter parameters - example: -v
  • Use double dash for multi-letter parameters - example: --help
  • When parameters are specified, most need a value - example: --action addPage
  • Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
  • Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
  • Some parameters become required once a specific action is chosen. This is indicated in the help text for each action.
  • Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same
  • Some parameters have default values, if so, they are indicated in the help text - example: (default: automation)
  • Some parameters are required - indicated by (...) in the help text - example: (-a|--action) <action>
  • Some parameters are optional - indicated by [...] in the help text - example: [(-f|--file) <file>]
  • Values that have more than one word must be enclosed by double quotes - example: --title "this is my title"
  • Quoting rules in commands can vary by environment (sad), here are the techniques that may work in your environment:
    • Many environments: embedded double quotes within a double quoted string can be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
    • Some environments may need different escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common "-a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
    • Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
    • A single quote sometimes can used in place of a double quote - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
  • Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
  • Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"
  • To get help for a specific action (release 5.5 and above), type the action followed by --help - example: --action getProjectList --help

Special parameter

Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command line handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.

PositionCharacterCharacter nameSuggested alternateUsage
1,comma Some parameters use comma separated lists.
2:colon#Some parameters use colon separated values.
3@at sign  
4'single quote Used in separated lists to cover cases where content contains separator.
5"double quote~Parameters containing blanks.

A blank in any position is ignored (no alternate provided).

Example: –special " #  ~" provides alternates for colon and double quote. 
         --common "--findReplace ~something to find containing a : (colon)#replacement~"  

Character Set

User and password values should be in the ISO-8859-1 character set. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.

 

Parameters

Parameter

Short

Value

Description

1

action

a

(tick)

 

2

addon

 

(tick)

Add-on key. In some cases, add-on name can be used as well.

3

afterSql

 

(tick)

SQL to run after a successful action. Limited to specific actions at this time.

4

api

 

(tick)

API version. Some requests produce different results based on the api version used. (default: latest)

5

append

 

(error)

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

6

clearFileBeforeAppend

 

(error)

For run actions, this option will automatically clear an existing file on the first append requested.

7

columns

 

(tick)

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

 

(tick)

Comment text.

9

common

 

(tick)

Common parameter string added to all run actions.

10

connectionTimeout

 

(tick)

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

11

continue

 

(error)

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.

12

cookies

 

(tick)

Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.

13

database

 

(tick)

Database name is required for SQL actions.

14

dateFormat

 

(tick)

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

 

(tick)

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

 

(error)

Database table needs to be created before adding rows.

17

dbJar

 

(tick)

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

 

(tick)

Database user password. Defaults to password.

19

dbTable

 

(tick)

Database table name when creating or updating a database from list output.

20

dbTableKeys

 

(tick)

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

 

(tick)

Database user name. Defaults to user.

22

debug

 

(error)

Requests detail debug output. Optional for all actions.

23

driver

 

(tick)

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

24

encoding

 

(tick)

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

25

file

f

(tick)

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

26

findReplace

 

(tick)

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

27

findReplaceRegex

 

(tick)

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

 

(error)

Prints this help message.

29

host

 

(tick)

Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

30

includeDisabled

 

(error)

To include disabled add-ons in list.

31

includeSystem

 

(error)

To include system add-ons in add-on list.

32

limit

 

(tick)

Maximum number of entries to return. (default: 2147483647)

33

list

 

(tick)

Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

34

list2

 

(tick)

Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

35

options

 

(tick)

Comma separated list of support, experimental, or other client or action specific options.

36

outputFormat

 

(tick)

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

37

password

p

(tick)

User password for remote access.

38

port

 

(tick)

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

39

propertyFile

 

(tick)

Property file with database parameters, field mappings, or client specific information.

40

quiet

 

(error)

Limit some output messages. Optional for all actions.

41

reference

 

(tick)

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

regex

 

(tick)

Regular expression for including matching content.

43

replace

 

(error)

Replace existing entity on add, create, or similar actions.

44

server

s

(tick)

Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

45

service

 

(tick)

Service address extension. (default: /rest/plugins/1.0)

46

simulate

 

(error)

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

47

special

 

(tick)

Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.

48

sql

 

(tick)

SQL select statement used to generate a run script.

49

url

 

(tick)

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

50

user

u

(tick)

User name for remote access. (default: automation)

51

verbose

v

(error)

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

52

wait

 

(error)

Wait for operation to finish processing before completing action.

  • No labels