Parameters - 8.8.0

 

Parameter

Short

Value

Multiple Use Allowed

Description

1

acceptType

 

 

Content type to accept for renderRequest if different than type.

2

accessKey

 

 

Secret access key for AWS credentials.

3

accessKeyId

 

 

Access key id for AWS credentials.

4

action

a

 

Requested operation to perform. Valid actions are listed at the end.

5

after

 

 

Used in orderRepository to name the repository after which the repository will be positioned. Similarly for moveTask where it represent the name or id of the task. Similarly for moveStage where it represent the name of the stage.

6

afterSql

 

 

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

7

agent

 

 

Agent name.

8

app

 

 

App key.

9

append

 

 

 

Append to existing varaibles on updateVariables. For some actions using the file parameter, append will append output to the existing file.

10

artifact

 

 

Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.

11

assignment

 

 

Key used to identify a project, plan, job, deployment proejct, or environment to be assigned to a specific agent. This makes the agent dedicated to only perform builds for all assignments. Examples: XXX, XXX-DEF, XXX-DEF-JOB1, Deployment for XXX-DEF, Deployment for XXX-DEF:QA, 77857004-77955436

12

automatic

 

 

 

Indicate that a stage be run automatically.

13

before

 

 

Before task name or id.

14

branch

 

 

Plan branch name normally. In the context of a repository it can reference a repository branch.

15

build

 

 

Build key. Normally used to refer to a specific build (3 or 4 part name). However, it was also an older terminology for a plan and some action continue to accept the older terminology. Example: XXX-DEF or XXX-DEF-1

16

capability

 

 

Capability name (label) or key.

17

childPlans

 

 

Comma separated list of plan keys that represent child plan dependencies.

18

cleanAfter

 

 

 

Clean working directory after each job completes. Use on setJobOptions.

19

clearFileBeforeAppend

 

 

 

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

20

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.

21

comment

 

 

Comment text.

22

common

 

 

Common parameter string added to all run actions.

23

connectionTimeout

 

 

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

24

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.

25

cookies

 

 

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.

26

copyPattern

 

 

Copy pattern for an artifact definition.

27

credentials

 

 

Credentials name or id.

28

database

 

 

Database name is required for SQL actions.

29

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.

30

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.

31

dbCreateTable

 

 

 

Database table needs to be created before adding rows.

32

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-42.1.4.jar or

https://jdbc.postgresql.org/download/postgresql-42.1.4.jar

33

dbPassword

 

 

Database user password. Defaults to password.

34

dbTable

 

 

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

35

dbTableKeys

 

 

Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.

36

dbUser

 

 

Database user name. Defaults to user.

37

debug

 

 

 

Requests detail debug output. Optional for all actions.

38

deploymentProject

 

 

Deployment project name or id.

39

description

 

 

Description for entity.

40

disable

 

 

 

Disable an entity for those entities like plans, stages, jobs, and tasks.

41

driver

 

 

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

42

enable

 

 

 

Enable an entity when updating.

43

encoding

 

 

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

44

environment

 

 

Deployment environment name or id.

45

event

 

 

Event alias or key. Alias values are: After X Build Failures, All Builds Completed, All Jobs Completed, Change of Build Status, Change of Job Status, Change of Responsibilities, Comment Added, Failed Builds And First Successful, Failed Jobs And First Successful, First Failed Job For Plan, Job Error, Job Hung, Job Queue Timeout, Job Queued Without Capable Agents, Notify After X Consecutive Failures, Notify on All Build Errors. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains.

46

excludeDisabled

 

 

 

Filter out entries that are disabled.

47

excludeEnabled

 

 

 

Filter out entries that are enabled.

48

expand

 

 

Deprecated. Not used.

49

favorite

 

 

 

Subset to favorites. Same as favourite.

50

favourite

 

 

 

Subset to favourites. Same as favorite.

51

field

 

Use to set construct specific fields or variables using field=value syntax. The first equal sign (=) delineates the field name from it's value. This provides a more convenient and expandable way to set fields as an alternative to the fields and numbered field parameters. Values are trimmed unless single quoted and single quoted strings will have single quotes removed.

52

field1

 

 

Construct specific field or variable name. Value is specified by the value1 parameter.

53

field2

 

 

Construct specific field or variable name. Value is specified by the value2 parameter.

54

field3

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

55

field4

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

56

field5

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

57

field6

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

58

field7

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

59

field8

 

 

Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.

60

fields

 

 

Use to specify task or repository specific fields or variables and their values. A comma separated list of key:value pairs. Single quote the key:value pair if it contains a comma (,) or line breaks.

61

file

f

 

Path to file based content or result output. Use - for standard input. Use + for getting lines from 'input' parameters.

62

final

 

 

 

Make a final task.

63

findReplace

 

 

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

64

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.

65

group

 

 

Group name. In the case of addUser, a comma separated list of group names.

66

help

 

 

 

Prints this help message.

67

host

 

 

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

68

id

 

 

Stage or task id.

69

input

i

Line of input used in place of file data for run actions. One or more input parameters are used as lines instead of using the file parameter. In some cases requiring a file parameter, it may be necessary to use a special value of + to indicate to use the input parameters instead.

70

ipRestriction

 

 

Comma separated list of IP addresses to restrict ability to remotely trigger builds.

71

issues

 

 

Comma separated list of Jira issue keys.

72

job

 

 

Job key. Example: JOB1

73

labels

 

 

Comma or blank separated list of labels. When used for filtering, any label will satify the filter condition.

74

limit

 

 

Maximum number of list entries to return. Some actions or environments may impose a more smaller default limit.

75

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.

76

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.

77

location

 

 

Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency.

78

manual

 

 

 

Indicate that a stage be run manually.

79

name

 

 

Name of entity, like plan name.

80

number

 

 

Build number. Defaults to latest.

81

options

 

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

82

outputFormat

 

 

Specify output format for a list actions. Output format determines what columns are retrieved for the list. More columns usually take longer to retrieve.

83

outputType

 

 

CSV output from get list actions and pretty print output from get actions can optionally be converted to plain text, HTML, or json based on the value of this parameter. Valid values are: text, table, html, json.

84

password

p

 

User password for remote access. This is a required parameter for most actions.

85

plan

 

 

Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF

86

port

 

 

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

87

project

 

 

Project key. Example: XXX

88

projectName

 

 

Project name.

89

propertyFile

 

 

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

90

quiet

 

 

 

Limit some output messages. Optional for all actions.

91

recipient

 

 

Recipient value for add notifications. Many recipient types need a primary recipient value. This parameter can be used instead of setting a recipient type specific field and value.

92

recipientType

 

 

Recipient type alias or key. Alias values are: CLI, Committers - Users who have committed to the build, Email Address, Group, IM Address, Responsible Users, User, users who are responsible for the current failure, users who have committed to the build, users who have marked this build as their favourite, Watchers - Users who have marked this plan as their favourite. Add-ons provide recipient types are identified by key. Example key: com.atlassian.bamboo.plugins.bamboo-slcak:recipient.slack.

93

reference

 

 

Reference to a replacement key value used to remember an action specific value like issue key, entity id, or similar so it can be referenced later. Each action that allows this parameter will specify that the reference parameter is valid for the action.

94

regex

 

 

Regular expression for condition matching or list filtering.

95

replace

 

 

 

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

96

repository

 

 

Name of a repository. In some cases, a comma separated list of repository names.

97

repositoryKey

 

 

Repository key that uniquely identifies the repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg

98

request

 

 

URL fragment for a request.

99

requestParameters

 

 

URL request parameters or post data.

100

requestType

 

 

Type of a render request like GET or POST

101

requirement

 

 

Plan requirement key, either a custom key or a system capability key or name like system.builder.ant.Ant or Ant.

102

revision

 

 

Revision id or tag.

103

schedule

 

 

Cron, daily time, or periodic schedule. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily time is a 24 hour format (HH:mm) value. A periodic schedule is a numeric value in seconds and defaults to 180.

104

server

s

 

Server URL. Normally the same URL used when using a browser to access the server. This is a required parameter for most actions.

105

shared

 

 

 

For an artifact definition, makes the artifact available for other builds.

106

simulate

 

 

 

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

107

special

 

 

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

108

sql

 

 

SQL select statement used to generate a run script.

109

sshParaphrase

 

 

Paraphrase for SSH credentials.

110

stage

 

 

Stage name.

111

successfulPlans

 

 

Comma separated list of keys that represent plans that must be successful before a build is triggered.

112

targetPassword

 

 

Target server user password. Defaults to password parameter.

113

targetServer

 

 

Target server URL. Meaning is action specific. For addRepository, used to access Bitbucket Server information.

114

targetUser

 

 

Target server user. Defaults to user parameter.

115

task

 

 

Task id, name, or description. Task ids are unique, but names and descriptions are not. Name and description lookup is done by finding the first match in the ordered task list.

116

taskKey

 

 

Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier and less error prone. See addTask for the list.

117

timeout

 

 

Wait timeout in seconds. Use -1 to wait forever.

118

toPlan

 

 

Plan key to be created. Example: XXX-DEF

119

toProject

 

 

Project key to clone to.

120

triggeringEnvironment

 

 

Deployment environment name or id.

121

type

 

 

Capability type like Executable, Custom, or JDK.Also requirement match type with values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger.

122

url

 

 

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

123

user

u

 

User name for remote access.

124

userEmail

 

 

User email for user management actions.

125

userFullName

 

 

User name for user management actions.

126

userId

 

 

User id for user credentials and user management.

127

userPassword

 

 

User password for user credentials and user manaagement.

128

value

 

 

Field value or condition value for matching.

129

value1

 

 

Value corresponding to the field1 parameter name.

130

value2

 

 

Value corresponding to the field2 parameter name.

131

value3

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

132

value4

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

133

value5

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

134

value6

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

135

value7

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

136

value8

 

 

Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.

137

verbose

 

 

 

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

138

version

 

 

Version name for deployment or app.

139

wait

 

 

 

Wait for action to complete.

Log a request with our support team.

Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.