Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 6.4.0-SNAPSHOT
Div
idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Related information for 6.4.0-SNAPSHOT

Actions

Div

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

disableAddon

Anchor
disableAddon
disableAddon

Add-ons

Disable an add-on.

addon

 

 

2

enableAddon

Anchor
enableAddon
enableAddon

Add-ons

Enable an add-on.

addon

 

 

3

getAddonList

Anchor
getAddonList
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

Anchor
getAddon
getAddon

Add-ons

Get information for an installed add-on.

addon

 

 

5

getClientInfo

Anchor
getClientInfo
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

Anchor
installAddon
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

Anchor
runFromCsv
runFromCsv

CSV

Run actions generated from a CSV file.

file

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

 

8

runFromList

Anchor
runFromList
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

Anchor
runFromSql
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

Anchor
run
run

Run

Run actions from a file or standard input.

file or standard input

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

 

11

uninstallAddon

Anchor
uninstallAddon
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

Include Page
ACLI:Shared - tips for documentation
ACLI:Shared - tips for documentation

Parameters

Div

Parameter

Short

Value

Description

1

action

Anchor
action
action

a

(tick)

 

2

addon

Anchor
addon
addon

 

(tick)

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

3

afterSql

Anchor
afterSql
afterSql

 

(tick)

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

4

api

Anchor
api
api

 

(tick)

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

5

append

Anchor
append
append

 

(error)

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

6

clearFileBeforeAppend

Anchor
clearFileBeforeAppend
clearFileBeforeAppend

 

(error)

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

7

columns

Anchor
columns
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

Anchor
comment
comment

 

(tick)

Comment text.

9

common

Anchor
common
common

 

(tick)

Common parameter string added to all run actions.

10

connectionTimeout

Anchor
connectionTimeout
connectionTimeout

 

(tick)

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

11

continue

Anchor
continue
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

Anchor
cookies
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

Anchor
database
database

 

(tick)

Database name is required for SQL actions.

14

dateFormat

Anchor
dateFormat
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

Anchor
dateFormat2
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

Anchor
dbCreateTable
dbCreateTable

 

(error)

Database table needs to be created before adding rows.

17

dbJar

Anchor
dbJar
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

Anchor
dbPassword
dbPassword

 

(tick)

Database user password. Defaults to password.

19

dbTable

Anchor
dbTable
dbTable

 

(tick)

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

20

dbTableKeys

Anchor
dbTableKeys
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

Anchor
dbUser
dbUser

 

(tick)

Database user name. Defaults to user.

22

debug

Anchor
debug
debug

 

(error)

Requests detail debug output. Optional for all actions.

23

driver

Anchor
driver
driver

 

(tick)

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

24

encoding

Anchor
encoding
encoding

 

(tick)

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

25

file

Anchor
file
file

f

(tick)

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

26

findReplace

Anchor
findReplace
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

Anchor
findReplaceRegex
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

Anchor
help
help

 

(error)

Prints this help message.

29

host

Anchor
host
host

 

(tick)

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

30

includeDisabled

Anchor
includeDisabled
includeDisabled

 

(error)

To include disabled add-ons in list.

31

includeSystem

Anchor
includeSystem
includeSystem

 

(error)

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

32

limit

Anchor
limit
limit

 

(tick)

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

33

list

Anchor
list
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

Anchor
list2
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

Anchor
options
options

 

(tick)

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

36

outputFormat

Anchor
outputFormat
outputFormat

 

(tick)

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

37

password

Anchor
password
password

p

(tick)

User password for remote access.

38

port

Anchor
port
port

 

(tick)

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

39

propertyFile

Anchor
propertyFile
propertyFile

 

(tick)

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

40

quiet

Anchor
quiet
quiet

 

(error)

Limit some output messages. Optional for all actions.

41

reference

Anchor
reference
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

Anchor
regex
regex

 

(tick)

Regular expression for including matching content.

43

replace

Anchor
replace
replace

 

(error)

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

44

server

Anchor
server
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

Anchor
service
service

 

(tick)

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

46

simulate

Anchor
simulate
simulate

 

(error)

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

47

special

Anchor
special
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

Anchor
sql
sql

 

(tick)

SQL select statement used to generate a run script.

49

url

Anchor
url
url

 

(tick)

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

50

user

Anchor
user
user

u

(tick)

User name for remote access. (default: automation)

51

verbose

Anchor
verbose
verbose

v

(error)

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

52

wait

Anchor
wait
wait

 

(error)

Wait for operation to finish processing before completing action.