| Div | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
On this page
|
Related information for 4.3.0
- Atlassian CLI Examples - 4.3.0
- Atlassian CLI Help text - 4.3.0
- Variable replacementsReplacements
- Action Reference (all clients)
Actions
| P | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
csv
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Action, Category, Description, Required parameters, Optional parameters, Output formats
"[#bamboo] {anchor: bamboo}", , "Use the Bamboo CLI client to run an action.", "[#common]", ,
"[#confluence] {anchor: confluence}", , "Use the Confluence CLI client to run an action.", "[#common]", ,
"[#crucible] {anchor: crucible}", , "Use the Crucible CLI client to run an action.", "[#common]", ,
"[#fisheye] {anchor: fisheye}", , "Use the FishEye CLI client to run an action.", "[#common]", ,
"[#getClientInfo] {anchor: getClientInfo}", "Info", "Get information about the this client tool.", , "[#outputFormat], [#file], [#append], [#encoding]", "1 - basic\\ 2 - JVM"
"[#hipchat] {anchor: hipchat}", , "Use the HipChat CLI client to run an action.", "[#common]", ,
"[#jira] {anchor: jira}", , "Use the JIRA CLI client to run an action.", "[#common]", ,
"[#runFromCsv] {anchor: runFromCsv}", "Run", "Run actions generated from a CSV file.", "[#file]", "[#common], [#propertyFile], [#continue], [#quiet], [#simulate], [#clearFileBeforeAppend], [#encoding], [#findReplace], [#findReplaceRegex]",
"[#runFromList] {anchor: 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 variable is entry.", "[#list]", "[#file], [#common], [#continue], [#quiet], [#simulate], [#clearFileBeforeAppend], [#encoding], [#findReplace], [#findReplaceRegex]",
"[#runFromSql] {anchor: 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]",
"[#run] {anchor: run}", "Run", "Run actions from a file or standard input.", "[#file] or standard input", "[#common], [#continue], [#simulate], [#clearFileBeforeAppend], [#encoding], [#findReplace], [#findReplaceRegex]",
"[#stash] {anchor: stash}", , "Use the Stash CLI client to run an action.", "[#common]", ,
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Include Page | ACLI:Shared - tips for documentation | ACLI:Shared - tips for documentation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Csv | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter, Short, Value, Description
"action {anchor:action}", "a", "(/)",
"append {anchor:append}", , "(x)", "For some actions using the file parameter, append will append output to the existing file."
"clearFileBeforeAppend {anchor:clearFileBeforeAppend}", , "(x)", "For run actions, this option will automatically clear an existing file on the first append requested."
"columns {anchor: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 {anchor:common}", , "(/)", "Common parameter string added to all run actions."
"connectionTimeout {anchor:connectionTimeout}", , "(/)", "Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite."
"continue {anchor:continue}", , "(x)", "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."
"database {anchor:database}", , "(/)", "Database name is required for SQL actions."
"dateFormat {anchor:dateFormat}", , "(/)", "Format string for date in Java SimpleDateFormat, default is client date format."
"dbPassword {anchor:dbPassword}", , "(/)", "Database user password. Defaults to password."
"dbUser {anchor:dbUser}", , "(/)", "Database user name. Defaults to user."
"debug {anchor:debug}", , "(x)", "Requests detail debug output. Optional for all actions."
"driver {anchor:driver}", , "(/)", "JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions."
"encoding {anchor:encoding}", , "(/)", "Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform."
"file {anchor:file}", "f", "(/)", "Path to file based content or result output. Use - for standard input."
"findReplace {anchor:findReplace}", , "(/)", "Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled."
"findReplaceRegex {anchor: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."
"help {anchor:help}", , "(x)", "Prints this help message."
"host {anchor:host}", , "(/)", "Database host server for SQL actions. Not used if url is provided. (default: localhost)"
"list {anchor:list}", , "(/)", "Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled."
"outputFormat {anchor:outputFormat}", , "(/)", "Specify output format for an action. (default: 1)"
"parameters {anchor:parameters}", , "(/)", "Client specific parameters"
"password {anchor:password}", "p", "(/)", "User password for remote access."
"port {anchor:port}", , "(/)", "Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided."
"propertyFile {anchor:propertyFile}", , "(/)", "Property file with mapping information."
"quiet {anchor:quiet}", , "(x)", "Limit some output messages. Optional for all actions."
"simulate {anchor:simulate}", , "(x)", "Simulate running actions. Log the action that would be taken."
"special {anchor:special}", , "(/)", "Ordered list of alternate characters for comma ( , ), colon ( : ), at ( \@ ), quote ( ' ), and double quote ( "" ) characters used for specialized processing of some specific parameters."
"sql {anchor:sql}", , "(/)", "SQL select statement used to generate a run script."
"url {anchor:url}", , "(/)", "Action specific setting. Example: Database access url for SQL actions. Optional when host is provided."
"user {anchor:user}", "u", "(/)", "User name for remote access."
"verbose {anchor:verbose}", "v", "(x)", "Requests verbose output to help with problem determination. Optional for all actions."
Parameter Tips
Parameters |
Parameter | Short | Value | Description | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 1 | action
| a | |
| ||||||
| 2 | append
|
| | For some actions using the file parameter, append will append output to the existing file. | ||||||
| 3 | clearFileBeforeAppend
|
| | For run actions, this option will automatically clear an existing file on the first append requested. | ||||||
| 4 | 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. | ||||||
| 5 | common
|
| | Common parameter string added to all run actions. | ||||||
| 6 | connectionTimeout
|
| | Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. | ||||||
| 7 | 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. | ||||||
| 8 | database
|
| | Database name is required for SQL actions. | ||||||
| 9 | dateFormat
|
| | Format string for date in Java SimpleDateFormat, default is client date format. | ||||||
| 10 | dbPassword
|
| | Database user password. Defaults to password. | ||||||
| 11 | dbUser
|
| | Database user name. Defaults to user. | ||||||
| 12 | debug
|
| | Requests detail debug output. Optional for all actions. | ||||||
| 13 | driver
|
| | JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. | ||||||
| 14 | encoding
|
| | Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. | ||||||
| 15 | file
| f | | Path to file based content or result output. Use - for standard input. | ||||||
| 16 | findReplace
|
| | Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
| 17 | 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. | ||||||
| 18 | help
|
| | Prints this help message. | ||||||
| 19 | host
|
| | Database host server for SQL actions. Not used if url is provided. (default: localhost) | ||||||
| 20 | list
|
| | Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled. | ||||||
| 21 | outputFormat
|
| | Specify output format for an action. (default: 1) | ||||||
| 22 | parameters
|
| | Client specific parameters | ||||||
| 23 | password
| p | | User password for remote access. | ||||||
| 24 | port
|
| | Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. | ||||||
| 25 | propertyFile
|
| | Property file with mapping information. | ||||||
| 26 | quiet
|
| | Limit some output messages. Optional for all actions. | ||||||
| 27 | simulate
|
| | Simulate running actions. Log the action that would be taken. | ||||||
| 28 | special
|
| | Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. | ||||||
| 29 | sql
|
| | SQL select statement used to generate a run script. | ||||||
| 30 | url
|
| | Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. | ||||||
| 31 | user
| u | | User name for remote access. | ||||||
| 32 | verbose
| v | | Requests verbose output to help with problem determination. Optional for all actions. |
| P |
|---|