Page Comparison

 

Usage:
  bamboo (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
  <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>]
  [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--propertyFiledbJar <dbJar>]
  [--propertyFile <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--findReplace <findReplace>]
  [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] (-s|--server)
  <server> (-u|--user) <user> (-p|--password) <password> [--service <service>] [--api <api>] [--cookies <cookies>] [--project
  <project>] [--toProject <toProject>] [--projectName <projectName>] [--build <build>] [--plan <plan>] [--toPlan <toPlan>] [--stage
  <stage>] [--job <job>] [--name <name>] [--description <description>] [--agent <agent>] [--assignment <assignment>] [--artifact
  <artifact>] [--requirement <requirement>] [--type <type>] [--value <value>] [--labels <labels>] [--searchLabels <searchLabels>]
  [--issues <issues>] [--expand <expand>] [--attribute <attribute>] [--comment <comment>] [--revision <revision>] [--location
  <location>] [--copyPattern <copyPattern>] [--repository <repository>] [--after <after>] [--schedule <schedule>] [--taskKey
  <taskKey>] [--repositoryKey <repositoryKey>] [--event <event>] [--recipientType <recipientType>] [--fields <fields>]
  [--ipRestriction <ipRestriction>] [--field1 <field1>] [--field2 <field2>] [--field3 <field3>] [--field4 <field4>] [--field5
  <field5>] [--field6 <field6>] [--field7 <field7>] [--field8 <field8>] [--value1 <value1>] [--value2 <value2>] [--value3 <value3>]
  [--value4 <value4>] [--value5 <value5>] [--value6 <value6>] [--value7 <value7>] [--value6value8 <value6><value8>] [--regex <regex>] [--request
  <request>] [--requestParameters <requestParameters>] [--requestType <requestType>]
  [--acceptType <acceptType>] [--id <id>] [--number
  <number>] [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite]
  [--favorite] [--replace] [--enable] [--disable]
  [--excludeEnabled] [--excludeDisabled] [--manual] [--shared] [--cleanAfter] [--help]


	Provides capability to make requests to a remote server.
	Required parameters: action, server, password.
	Optional parameters: user (likely required for your installation).
	Other required and optional parameters depending on action requested.


  (-a|--action) <action>
        Requested operation to perform. Valid actions are listed at the end.

  [(-f|--file) <file>]
        Path to file based content or result output. Use - for standard input.

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

  [--debug]
        Requests detail debug output. Optional for all actions.

  [-v|--verbose]
        Requests verbose output to help with problem determination. Optional for all actions.

  [--quiet]
        Limit some output messages. Optional for all actions.

  [--outputFormat <outputFormat>]
        Specify output format for an action. (default: 1)

  [--columns <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.

  [--connectionTimeout <connectionTimeout>]
        Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

  [--sql <sql>]
        SQL select statement used to generate a run script.

  [--driver <driver>]
        JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

  [--url <url>]
        Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

  [--host <host>]
        Database host server for SQL actions. Not used if url is provided. (default: localhost)

  [--port <port>]
        Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

  [--database <database>]
        Database name is required for SQL actions.

  [--dbUser <dbUser>]
        Database user name. Defaults to user.

  [--dbPassword <dbPassword>]
        Database user password. Defaults to password.

  [--propertyFiledbJar <propertyFile><dbJar>]
        PropertyBy file with mapping information.

  [--common <common>]
        Common parameter string added to all run actions.

  [--special <special>]
        Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) charactersdefault, 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

  [--propertyFile <propertyFile>]
        Property file with mapping information.

  [--common <common>]
        usedCommon forparameter specializedstring processingadded ofto someall specificrun parametersactions.

  [--dateFormatspecial <dateFormat><special>]
        Ordered Format stringlist of alternate characters for datecomma in( Java, SimpleDateFormat), defaultcolon is( client: date), format.at ( @  [--findReplace <findReplace>]
        Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a ), quote ( ' ), and double quote ( " ) characters
        used for specialized processing of some specific parameters.

  [--dateFormat <dateFormat>]
        Format string for date in Java SimpleDateFormat, default is client date format.

  [--findReplace <findReplace>]
        Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded
        quotes must be doubledescaped.

  [--findReplaceRegex <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 doubledescaped.

  [--list <list>]
        Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled.

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

  [--simulate]
        Simulate running actions. Log the action that would be taken.

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

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

  (-s|--server) <server>
        Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

  (-u|--user) <user>
        User name for remote access. (default: automation)

  (-p|--password) <password>
        User password for remote access.

  [--service <service>]
        Service address extension. (default: /rest/api)

  [--api <api>]
        API version. Some requests produce different results based on the api version used. (default: latest)

  [--cookies <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.

  [--project <project>]
        Project key. Example: XXX

  [--toProject <toProject>]
        Project key to clone to.

  [--projectName <projectName>]
        Project name.

  [--build <build>]
        Build key. Normally used to refer to a specific build (3 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

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

  [--toPlan <toPlan>]
        Plan key to be created. Example: XXX-DEF

  [--stage <stage>]
        Stage name.

  [--job <job>]
        Job key. Example: JOB1

  [--name <name>]
        Name of entity, like plan name.

  [--description <description>]
        Description for entity.

  [--agent <agent>]
        Agent name.

  [--assignment <assignment>]
        Key used to identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to only
        perform builds for all assignments.  Example: XXX, XXX-DEF, XXX-DEF-JOB1

  [--artifact <artifact>]
        Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.

  [--requirement <requirement>]
        Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant.

  [--type <type>]
        Requirement match type. Values: exist, equal, match. Also, content type for renderRequest. (default: exist)

  [--value <value>]
        Requirement match value.

  [--labels <labels>]
        Comma or blank separated list of labels.

  [--searchLabels <searchLabels>]
        Comma or blank separated list of labels used for search.

  [--issues <issues>]
        Comma separated list of JIRA issue keys.

  [--expand <expand>]
        Expanded request information to obtain more detailed data on request.

  [--attribute <attribute>]
        Attribute to list.

  [--comment <comment>]
        Comment for an build.

  [--revision <revision>]
        Revision id or tag.

  [--location <location>]
        Working directory relative path to a source location for an artifact definition or a destination location for an artifact
        dependency.

  [--copyPattern <copyPattern>]
        Copy pattern for an artifact definition.

  [--repository <repository>]
        Name of a repository. In some cases, a comma separated list of repository names.

  [--after <after>]
        Used in orderRepository to name the repository after which the repository will be positioned.

  [--schedule <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.

  [--taskKey <taskKey>]
        Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script

  [--repositoryKey <repositoryKey>]
        Repository key that uniquely identifies the repository type. Example:
        com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg

  [--event <event>]
        Event alias or key. Add-ons provide events identified by key. Example key:
        com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains

  [--recipientType <recipientType>]
        Recipient type alias or key. Add-ons provide recipient types identified by key. Example key:
        com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat

  [--fields <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.

  [--ipRestriction <ipRestriction>]
        Comma separated list of IP addresses to restrict ability to remotely trigger builds.

  [--field1 <field1>]
        Task orConstruct repository specific field or variable name. Value is specified by the value1 parameter.

  [--field2 <field2>]
        Task or repositoryConstruct specific field or variable name. Value is specified by the value2 parameter.

  [--field3 <field3>]
        TaskConstruct or repository specific field or variable name. Value is specified by the value3 parameter.

  [--field4 <field4>]
        TaskConstruct or repository specific field or variable name. Value is specified by the value4 parameter.

  [--field5 <field5>]
        TaskConstruct or repository specific field or variable name. Value is specified by the value5 parameter.

  [--field6 <field6>]
        TaskConstruct or repository specific field or variable name. Value is specified by the value6 parameter.

  [--value1field7 <value1><field7>]
        Construct specific field or variable name. Value is correspondingspecified toby the field1value7 parameter name.

  [--value2field8 <value2><field8>]
        Construct specific field or variable name. Value correspondingis specified toby the field2value8 parameter name.

  [--value3value1 <value3><value1>]
        Value corresponding to the field3field1 parameter name.

  [--value4value2 <value4><value2>]
        Value corresponding to the field4field2 parameter name.

  [--value5value3 <value5><value3>]
        Value corresponding to the field5field3 parameter name.

  [--value6value4 <value6><value4>]
        Value corresponding to the field6field4 parameter name.

  [--regexvalue5 <regex><value5>]
        RegularValue expressioncorresponding forto listthe filteringfield5 andparameter similarname.
Also
for pattern match labelling.

  [--requestvalue6 <request><value6>]
        Value corresponding URLto fragmentthe forfield6 aparameter requestname.

  [--requestParametersvalue7 <requestParameters><value7>]
        Value corresponding to URLthe field7 requestparameter parametersname.

  [--requestTypevalue8 <requestType><value8>]
        TypeValue ofcorresponding ato renderthe requestfield8 likeparameter GETname.
or
POST (default: GET)
 [--regex <regex>]
  [--acceptType <acceptType>]     Regular expression for list Contentfiltering typeand tosimilar. acceptAlso for renderRequestpattern if different than typematch labelling.

  [--idrequest <id><request>]
        StageURL fragment orfor taska idrequest.

  [--numberrequestParameters <number><requestParameters>]
        BuildURL number. Defaults to latest. (default: 0)request parameters

   [--timeoutrequestType <timeout><requestType>]
        WaitType timeoutof ina seconds.render Userequest -1like toGET waitor forever.POST (default: -1GET)

  [--limitacceptType <limit><acceptType>]
        MaximumContent numbertype ofto entriesaccept to return. (default: 2147483647)for renderRequest if different than type.

  [--waitid <id>]
        WaitStage foror actiontask to completeid.

  [--favouritenumber <number>]
        SubsetBuild number. Defaults to favouriteslatest. Same as favorite.(default: 0)

  [--favoritetimeout <timeout>]
        SubsetWait timeout toin favoritesseconds. Same as favourite.

  [--replace]Use -1 to wait forever. (default: -1)

  [--limit <limit>]
        Maximum number of Replaceentries existingto entityreturn. (default: 2147483647)

[  [--enablewait]
        EnableWait anfor entityaction whento updatingcomplete.

  [--disablefavourite]
        DisableSubset anto entityfavourites. forSame those entities like plans, stages, jobs, and tasksas favorite.

  [--manualfavorite]
        IndicateSubset thatto afavorites. stageSame beas run manuallyfavourite.

  [--sharedreplace]
        For an artifact definition, makes the artifact available for other buildsReplace existing entity.

  [--enable]
        Enable an entity when updating.

  [--cleanAfterdisable]
        CleanDisable working directory after each job completes. Use on setJobOptionsan entity for those entities like plans, stages, jobs, and tasks.

  [--helpexcludeEnabled]
        Prints this help message.Filter out entries that are enabled.

  Valid[--excludeDisabled]
actions (case insensitive):  run - Run actions fromFilter aout fileentries orthat standardare inputdisabled.
	
Required parameters: file or standard input
	 Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input
	 Required parameters: sql or file or standard input
	 Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file [--manual]
        Indicate that a stage be run manually.

  [--shared]
        For an artifact definition, makes the artifact available for other builds.

  [--cleanAfter]
        Clean working directory after each job completes. Use on setJobOptions.

  [--help]
        Prints this help message.


Valid actions (case insensitive):

run - Run actions from a file or standard input.
	 Required parameters: file or standard input
	 Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromListrunFromSql - Run actions generated forby eachSQL entryprovided inby athe list.sql 	parameter, Whena file, isor provided,standard eachinput
action	 inRequired theparameters: filesql augmentedor byfile theor commonstandard parameter will be run for each entry.
	 Otherwise, just the action specified by the common parameter will be run.
	 Available replacement variable is entryinput
	 Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
	 Required parameters: listfile
	 Optional parameters: filecommon, commonpropertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInforunFromList - GetRun actions informationfor abouteach theentry thisin clienta toollist.
	 OptionalWhen parameters:file outputFormat,is fileprovided, append,each encodingaction 	in Outputthe formats:file 1augmented -by basic,the 2common -parameter JVMwill getServerInfobe -run Getfor information about the Bamboo servereach entry.
	 Optional parameters: outputFormatOtherwise, dateFormat,just file,the append,action encodingspecified 	by Outputthe formats:common 1parameter -will basic,be 2run.
-	 detailAvailable validateLicensereplacement -variable Validatesis theentry.
CLI	 ConnectorRequired isparameters: enabledlist
and	 licensedOptional on the server.
renderRequest - Render url based request. The response data modified by findReplace processing is returned.
	 Required parameters: requestparameters: file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInfo - Get information about the this client tool.
	 Optional parameters: requestParametersoutputFormat, requestTypefile, typeappend, acceptType, build, file, encoding, findReplace, findReplaceRegex
runFromProjectList - Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName.
	 Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromPlanList - Run actions for each plan with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. Available replacement variables are project, projectName, plan, and planName.
 encoding
	 Output formats: 1 - basic, 2 - JVM
getServerInfo - Get information about the Bamboo server.
	 Optional parameters: outputFormat, dateFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - detail, 3 - state
validateLicense - Validates the CLI Connector is enabled and licensed on the server.
renderRequest - Render url based request. The response data modified by findReplace processing is returned.
	 Required parameters: projectrequest
	 Optional parameters: favoriterequestParameters, regexrequestType, commontype, continueacceptType, simulate, clearFileBeforeAppendbuild, file, encoding, findReplace, findReplaceRegex
runFromStageListrunFromProjectList - Run actions for each stageproject with regex filtering on project stagekey or name. Available replacement variables are project, projectName, plan, planName, stageId, and stageNameprojectName.
	 Required parameters: plan
	 Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromJobListrunFromPlanList - Run actions for each jobplan with regex filtering on jobplan key or name. RestrictUse to@all afor specificproject stageto orget leavea stagelist blank to get jobsof plans across all stagesprojects. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobNameplanName.
	 Required parameters: planproject
	 Optional parameters: stagefavorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromRepositoryListrunFromStageList - Run actions for each repositorystage with regex filtering on repositorystage name. Available replacement variables are repository project, projectName, plan, planName, stageId, and repositoryId.stageName.
	 Required parameters: plan
	 Optional parameters: planstage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromAgentListrunFromJobList - Run actions for each agentjob with regex filtering on agentjob key or name. AvailableRestrict replacementto variablesa arespecific agentstage andor agentId.leave 	stage Optionalblank parameters:to regex,get common,jobs continue,across simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
getProjectList - Get a list of projects. Projects are selected based on regex filtering on project key or name. Legacy list support is deprecated and will be removed in the near future.
	 Optional parameters: regex, file, append, encoding, columns
getPlanList - Get a list of plans for a projectall stages. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobName.
	 Required parameters: plan
	 Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromRepositoryList - Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId.
	 Optional parameters: plan, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromAgentList - Run actions for each agent with regex filtering on plan key oragent name. UseAvailable @allreplacement forvariables projectare toagent get a list of plans across all projectsand agentId.
	 RequiredOptional parameters: projectregex, 	 Optional parameters: favoritecommon, continue, regexsimulate, columnsclearFileBeforeAppend, file, appendencoding, encoding
getRepositoryListfindReplace, findReplaceRegex
getProjectList - Get a list of projects. globalProjects orare planselected repositoriesbased withon regex filtering on repositoryproject key or name.
	 Optional parameters: plan, regex, file, append, encoding, columns
getNotificationListgetPlanList - EAP (subject to change). Get a list of planplans notifications.for 	a Optionalproject parameters:with plan,regex file,filtering append,on encodingplan getVariableListkey -or Getname. aUse list@all offor globalproject orto planget variablesa basedlist onof regexplans filteringacross ofall variable namesprojects.
	 OptionalRequired parameters: plan, project
	 Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, columns, file, append, encoding
getArtifactDefinitionList - getBuildListExperimental - only those available to be artifact dependencies in the last job! Get a list of builds. Default limit is 25 shared artifact definitions for a plan with regex filtering on artifact name.
	 Required parameters: plan
	 Optional parameters: limit, favoriteregex, labels, issues, columns, file, append, encoding
	getRepositoryList Output- formats:Get 1a -list basic,of 2global -or testplan informationrepositories getBuildQueueListwith -regex Getfiltering aon list of builds waiting in the build queue. Subset by project or build.
repository name.
	 Optional parameters: projectplan, buildregex, file, append, encoding, columns
getLabelList -
getNotificationList - EAP (subject to change). Get a list of labels for a buildplan notifications.
	 Required parameters: build
	 Optional parameters: numberplan, file, append, encoding,
columns
getCommentListgetVariableList - Get a list of comments for a build.
	 Required parameters: buildglobal or plan variables based on regex filtering of variable names.
	 Optional parameters: numberplan, regex, file, append, encoding,
columns
getStageListgetBuildList - Get a list of stagesbuilds. forDefault alimit plan with regex filtering on stage nameis 25.
	 Required parameters: plan
	 Optional parameters: regex limit, favorite, labels, issues, columns, file, attributeappend, columns
getJobList - Get a list of jobs for a plan with regex filtering on job key or nameencoding
	 Output formats: 1 - basic, 2 - test information
getBuildQueueList - Get a list of builds waiting in the build queue. Subset by stageproject ifor desiredbuild.
	 RequiredOptional parameters: planproject, 	 Optional parameters: stagebuild, file, regexappend, fileencoding, attribute, columns
getAgentListgetLabelList - Get a list of agentslabels basedfor ona regexbuild.
filtering	 ofRequired agent names..parameters: build
	 Optional parameters: regexnumber, file, append, encoding, columns
	getCommentList Output- formats:Get 1a -list basic,of 2comments -for detaila queueBuildbuild.
-	 QueueRequired aparameters: build
to	 run.Optional Ifparameters: waitnumber, isfile, specifiedappend, theencoding, actioncolumns
willgetStageList not- completeGet untila thelist queuedof buildstages completesfor or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parametersa plan with regex filtering on stage name.
	 Required parameters: plan
	 Optional parameters: regex, file, attribute, columns
getJobList - Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.
	 Required parameters: plan
	 Optional parameters: revisionstage, waitregex, continuefile, timeoutattribute, fields,columns
field1,getAgentList value1,- field2,Get value2,a field3,list value3,of field4,agents value4,based field5,on value5,regex field6,filtering value6of addComment - Add a comment to a buildagent names..
	 RequiredOptional parameters: build regex, file, append, encoding, commentcolumns
	 OptionalOutput parametersformats: 1 number,- findReplacebasic, findReplaceRegex,2 file,- encodingdetail
addLabelsqueueBuild - AddQueue a commabuild separatedto listrun. ofIf labels to a build.
	 Required parameters: build, labels
	 Optional parameters: number
removeLabels - Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided
	 Required parameters: labels
	 Optional parameters: build, number, searchLabels, issues, favorite
deleteProject - Delete project and all project planswait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters.
	 Required parameters: projectplan
	 Optional parameters: filerevision, enableProjectwait, -continue, Enabletimeout, allfields, project plans.
	 Required parameters: project
disableProject - Disable all project plans.
	 Required parameters: project
cloneProject - Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectNamefield1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addComment - Add a comment to a build.
	 Required parameters: build, comment
	 Optional parameters: number, findReplace, findReplaceRegex, file, encoding
addLabels - Add a comma separated list of labels to a build.
	 Required parameters: projectbuild, toProject, projectName, disable
createPlan - Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Server instances only. labels
	 Optional parameters: number
removeLabels - Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided
	 Required parameters: planlabels
	 Optional parameters: namebuild, number, projectNamesearchLabels, descriptionissues, disablefavorite
getPlandeleteProject - Get plan information Delete project and all project plans.
	 Required parameters: plan
clonePlan - Clone a plan.
project
	 RequiredOptional parameters: plan, toPlan, name
	 Optional parameters: description, projectName, disable
deletePlan - Delete a planfile
enableProject - Enable all project plans.
	 Required parameters: planproject
enablePlandisableProject - EnableDisable aall planproject to runplans.
	 Required parameters: planproject
disablePlancloneProject - Disable Clone each plan in a project planto fromanother runningproject. 	If toProject Requiredis parameters:not planprovided, addStagethe -plans Addwill abe stagecloned to the asame planproject. 	If Requiredthe parameters:toProject plan, stagedoes not exist, it will be created with name provided by projectName.
	 OptionalRequired parameters: descriptionproject, toProject, manualprojectName, disable
removeStagecreatePlan - RemoveCreate a stage from anew plan. UseProvide ida = 2-1part toplan removekey allwhere stages.the Usefirst continuepart tois ignorethe notproject found errorskey. 	If Requiredthe parameters:project plan,key stagedoes ornot idexist, 	it Optionalwill parameters:be continuecreated addJobwith -the Add a job to a stageprovided project name. Server instances only. Use continue to ignore the request if the plan already exists.
	 Required parameters: plan,
stage, job
	 Optional parameters: name, projectName, description, disable, continue
enableJobcreateOrUpdatePlan - Enable a job to run.
	 Required parameters: plan, job
disableJob - Disable a job from runningSame as createPlan when plan does not exist. However, it will update an existing plan's name and description. Server instances only.
	 Required parameters: plan,
job	 setJobOptionsOptional -parameters: Setname, miscellaneousprojectName, optiondescription, fordisable
aupdatePlan job.- TheUpdate followinga optionsplans arename specificallyor supported:description. cleanProvide workinga directory2-part afterplan jobkey completeswhere (cleanAfterthe switch)first andpart patternis matchingthe labelingproject (regexkey.
and	 labelsRequired parameters).: Useplan
the	 fieldOptional and value parameters: forname, additionaldescription
settingsgetPlan with- valuesGet determinedplan frominformation.
the	 screen.Required Someparameters: previousplan
settingsclonePlan may- beClone lost if not specifically requesteda plan.
	 Required parameters: plan, jobtoPlan, name
	 Optional parameters: cleanAfterdescription, regexprojectName, labelsdisable
getArtifactdeletePlan - DownloadDelete a copy of a build artifact into a fileplan.
	 Required parameters: plan
enablePlan - Enable a plan to run.
	 Required parameters: build, artifact, file plan
disablePlan - Disable a plan from running.
	 OptionalRequired parameters: numberplan
getBuildaddStage - Get build result Add a stage to a plan.
	 Required parameters: plan, buildstage
	 Optional parameters: numberdescription, expandmanual, filedisable
verifyBuildremoveStage - VerifyRemove builda wasstage successful.from 	a Requiredplan. parameters:Use buildid 	 Optional parameters: number
getLatestBuildNumber - Get the number of the last completed build for this plan= -1 to remove all stages. Use continue to ignore not found errors.
	 Required parameters: plan
addArtifact - Add an artifact definition to, stage or id
	 Optional parameters: continue
addJob - Add a job. Serverto instancesa onlystage.
	 Required parameters: plan, jobstage, artifact,job
copyPattern
	 Optional parameters: locationname, description, shareddisable
removeArtifactenableJob - RemoveEnable ana artifactjob definitionto from a job. Server instances only.
run.
	 Required parameters: plan, job,
artifactdisableJob addArtifactDependency - Add an artifact dependency Disable a job. Artifact must be a shared artifact from another jobrunning.
	 Required parameters: plan, job,
artifact, location
addTask setJobOptions - AddSet amiscellaneous taskoption tofor a plan job. The Afollowing validoptions taskare keyspecifically orsupported: aliasclean isworking required.directory Validafter aliasesjob are: ANT, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCRIPTcompletes (cleanAfter switch) and pattern matching labeling (regex and labels parameters). Use the field and value parameters for additional settings with values determined from the screen. Some previous settings may be lost if not specifically requested.
	 Required parameters: plan, job
	 Optional parameters: cleanAfter, regex, labels
getArtifact - Download a copy of a build artifact into a file.
	 Required parameters: build, artifact, file
	 Optional parameters: number
getBuild - Get build result.
	 Required parameters: build
	 Optional parameters: number, expand, file
verifyBuild - Verify build was successful.
	 Required parameters: build
	 Optional parameters: number
getLatestBuildNumber - Get the number of the last completed build for this plan.
	 Required parameters: plan
addArtifact - Add an artifact definition to a job. Server instances only.
	 Required parameters: plan, job, artifact, copyPattern
	 Optional parameters: location, shared
removeArtifact - Remove an artifact definition from a job. Server instances only.
	 Required parameters: plan, job, artifact
addArtifactDependency - Add an artifact dependency to a job. Artifact must be a shared artifact from another job.
	 Required parameters: plan, job, artifact, location
addTask - Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, ARTIFACT_DOWNLOAD, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCRIPT
	 Required parameters: plan, job, taskKey
	 Optional parameters: disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateTask - Update a task in a plan job. You must provide the same parameters as if you were creating the task.
	 Required parameters: plan, job, id
	 Optional parameters: enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeTask - Remove a task from a plan job. Use id = -1 to remove all tasks.
	 Required parameters: plan, job, id
addRepository - Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION
	 Required parameters: plan,repository job,or taskKeyname
	 Optional parameters: disableplan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateTask - Update a task in a plan job. You must provide the same parameters as if you were creating the task, field7, value7, field8, value8
updateRepository - Update a global or plan repository.
	 Required parameters: plan,repository job,or id
	 Optional parameters: enable, disableplan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, removeTask - Remove a task from a plan job. Use id = -1 to remove all tasks.
	 Required parameters: plan, job, id
addRepository - Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, CVS, GIT, GITHUB, MERCURIAL, PERFORCE, STASH, SUBVERSION
	 Required parameters: repository or name
	 Optional parameters: plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateRepository - Update a global or plan repository.
	 Required parameters: repository or id
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeRepository - Remove global or plan repository. Use @all to remove all repositoriesfield7, value7, field8, value8
removeRepository - Remove global or plan repository. Use @all to remove all repositories.
	 Required parameters: repository or id
	 Optional parameters: plan, continue
getRepository - Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.
	 Required parameters: repository
	 Optional parameters: plan
orderRepository - Order repository in the list of repositories for a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository name.
	 Required parameters: plan, repository
	 Optional parameters: after
addRequirement - Add requirement to a plan job.
	 Required parameters: repositoryplan, orjob, idrequirement
	 Optional parameters: plantype, continuevalue
getRepositoryupdateRequirement - GetUpdate details of a global or plan repositoryrequirement.
Sets	 theRequired repositoryparameters: andplan, repositoryIdjob, replacementid
variables.
	 RequiredOptional parameters: repository
	 Optional parameters: type, value
removeRequirement - Remove a plan orderRepositoryrequirement.
-	 OrderRequired repositoryparameters: inplan, thejob, listid
ofaddNotification repositories- forAdd a plan notification. There Defaultsare to2 moveparts theto repositorya tonotification the- topan toevent makethat ittriggers the defaultnotification repository.and Otherwisea specifyrecipient thetype afterthat respositorydetermines name.the 	notification Requiredprotocol. parameters:There plan, repository
	 Optional parameters: after
addRequirement - Add requirement to a plan job.
	 Required parameters: plan, job, requirement
	 Optional parameters: type, value
updateRequirement - Update a plan requirementare built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.
	 Required parameters: plan, jobevent, idrecipientType
	 Optional parameters: typefields, valuefield1, removeRequirementvalue1, -field2, Removevalue2, afield3, plan requirement.
	 Required parameters: plan, job, id
addNotification - Add a plan notification. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.
	 Required parameters: plan, event, recipientTypevalue3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeNotification - Remove a plan notification. Use id of -1 to remove all notifications for a plan.
	 Required parameters: plan, id
addVariables - Add global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values,
	 Optional parameters: plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeNotification - Remove a, field7, value7, field8, value8
updateVariables - Update existing global or plan notificationvariables. Use id of -1Defaults to removeglobal allvariables notifications forunless a plan is specified. Use 	the Requiredfield parameters: plan, id
addVariables - Add global or plan variables. for the variable name and the corresponding value parameters for the variable values,
	 Optional parameters: plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
updateVariables, field7, value7, field8, value8
removeVariables - Update existingRemove global or plan variables. Specify the variable names using the field parameters.
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6
removeVariables - Remove global or plan variables
	 Optional parameters: plan, fieldsfield7, field1value7, field2field8, field3, field4, field5, field6
value8
addTrigger - Add a trigger to a plan. Pre-defined types are: polling, remote, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories. Pre-defined types are available for server instances only. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Alias types are: stashTrigger.
	 Required parameters: plan, name, type
	 Optional parameters: repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeTrigger - Remove a trigger from a plan. Use id = -1 to remove all triggers. Server instances only.
	 Required parameters: plan, id
addAgent - Add a local agent.
	 Required parameters: agent
	 Optional parameters: description
removeAgent - Remove an agent.
	 Required parameters: agent
enableAgent - Enable an agent.
	 Required parameters: agent
disableAgent - Disable an agent.
	 Required parameters: agent
addAgentAssignment - Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error.
	 Required parameters: agent, assignment
	 Optional parameters: continue
removeAgentAssignment - Remove an assignment from a specific agent. Use continue to ignore not found error.
	 Required parameters: agent, assignment
	 Optional parameters: continue