...
Related information for
...
6.
...
6.0
Help Text
No Format |
---|
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>] [--dbJar <dbJar>] [--dbTableafterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--comment <comment>] [--replace] [--propertyFile <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--dateFormat2 <dateFormat2>] [--reference <reference>] [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--list2 <list2>] [--options <options>] [--continue] [--simulate] [--append] [--clearFileBeforeAppend] (-s|--server) <server> (-u|--user) <user> (-p|--password) <password> [--serviceapi <service><api>] [--apiservice <api><service>] [--cookies <cookies>] [--project <project>] [--toProject <toProject>] [--projectName <projectName>] [--deploymentProject <deploymentProject>] [--environment <environment>] [--version <version>] [--build <build>] [--plan <plan>] [--toPlan <toPlan>] [--stage <stage>] [--job <job>] [--task <task>] [--jobbranch <job><branch>] [--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>] [--recipient <recipient>] [--childPlans <childPlans>] [--ipRestriction <ipRestriction>] [--fields <fields>] [--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>] [--value8 <value8>] [--after <after>] [--before <before>] [--final] [--regex <regex>] [--request <request>] <request>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType <acceptType>] [--id <id>] [--number <number>] <number>] [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite] [--favorite] [--enable] [--disable] [--excludeEnabled] [--excludeDisabled] [--manual] [--automatic] [--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. Defaults to localhost if not provided. [--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. [--dbJar <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-9.3-1102.jdbc41.jar or https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar [--dbTableafterSql <dbTable><afterSql>] Experimental. Database table name when creating or updating a database from list outputSQL to run after a successful action. Limited to specific actions at this time. [--dbTableKeysdbTable <dbTableKeys>]<dbTable>] Database table name when creating or Experimental. updating a database from list output. [--dbTableKeys <dbTableKeys>] Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for key set for the table. [--dbCreateTable] Experimental. Database table needs to be created before adding rows. [--comment <comment>] Comment text. [--replace] Replace existing entity on add, create, or similar actions. [--propertyFile <propertyFile>] Property file with mapping database parameters, field mappings, or client specific 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 ( " ) characters used for specialized processing of some specific parameters. [--dateFormat <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. [--dateFormat2 <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. [--findReplacereference <findReplace><reference>] FindReference andto replacea text.replacement Commakey separatedvalue listused ofto colonremember separatedan pairs. Single quote values containing a delimiter. Embedded quotes must be escapedaction 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. [--findReplaceRegexfindReplace <findReplaceRegex><findReplace>] Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded containing a delimiter. Embedded quotes must be escaped. [--listfindReplaceRegex <list><findReplaceRegex>] Find and replace text with a regular expression. Comma separated list of colon entriesseparated pairs. Single quote values containing a containing a delimiter. Embedded quotes must be doubled. [--continuelist <list>] ContinueComma processingseparated evenlist afterof errorsentries areto encounteredpopulate forthe runentry actions.replacement Alsovariable usedon forrunFromList. someSingle actionquote tovalues ignorecontaining certaina errors delimiter. likeEmbedded notquotes foundmust errors on remove actionsbe doubled. [--simulatelist2 <list2>] Comma separated list Simulateof runningentries actions.to Logpopulate the actionentry2 thatreplacement wouldvariable beon takenrunFromList. Single quote values [--append]containing a For somedelimiter. actionsEmbedded usingquotes themust file parameter, append will append output to the existing filebe doubled. [--clearFileBeforeAppendoptions <options>] ForComma runseparated actions,list thisof optionsupport, willexperimental, automaticallyor clearother anclient existingor fileaction on the first append requestedspecific options. ([-s|--server) <server>-continue] Continue Serverprocessing URL.even Normallyafter theerrors baseare URLencountered offor therun serveractions. andAlso theused samefor assome howaction theto serverignore iscertain accessederrors from a browser. (-u|--user) <user> like not found errors on remove actions. [--simulate] User name for remote access. (default: automation)Simulate running actions. (-p|--password) <password> Log the action that would be taken. [--append] User password for remote access. [--service <service>] Service address extension. (default: /rest/api)For some actions using the file parameter, append will append output to the existing file. [--api <api>]clearFileBeforeAppend] For run actions, APIthis version.option Somewill requestsautomatically produceclear differentan resultsexisting basedfile on the apifirst versionappend usedrequested. (default: latest-s|--server) <server> [--cookies <cookies>] Server URL. Normally the Namebase URL of the fileserver toand restorethe andsame persistas cookieshow acrossthe invocationsserver ofis CLIaccessed actions.from Cana bebrowser. used to provide Data Center session (-u|--user) <user> User affinityname for actionsremote using REST APIs.access. (default: automation) [(-p|--project <project>]password) <password> User Projectpassword key.for Example:remote XXXaccess. [--toProjectapi <toProject>]<api>] API version. Some requests produce different Project key to clone to. results based on the api version used. (default: latest) [--projectNameservice <projectName><service>] Service Projectaddress nameextension. (default: /rest/api) [--buildcookies <build><cookies>] BuildName key.of Normallyfile used to referrestore toand apersist specificcookies buildacross (3invocations orof 4 part name)CLI actions. However,Can itbe wasused alsoto anprovide olderData terminologyCenter forsession a affinity planfor andactions someusing action continue to accept the older terminologyREST APIs. Example: XXX-DEF or XXX-DEF-1 [--planproject <plan><project>] PlanProject key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF [--toPlantoProject <toPlan><toProject>] PlanProject key to beclone created. Example: XXX-DEFto. [--stageprojectName <stage><projectName>] StageProject name. [--jobdeploymentProject <job><deploymentProject>] Deployment Jobproject key.name Example:or JOB1id. [--nameenvironment <name><environment>] NameDeployment ofenvironment entity,name likeor plan nameid. [--descriptionversion <description><version>] Version Descriptionname for entitydeployment. [--agentbuild <agent><build>] AgentBuild namekey. Normally used to [--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-JOB1refer 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 [--artifactplan <artifact><plan>] Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF [--requirementtoPlan <requirement><toPlan>] Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant.key to be created. Example: XXX-DEF [--stage <stage>] Stage name. [--typejob <type><job>] RequirementJob match typekey. ValuesExample: JOB1 exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger. (default: ) [--value <value>] [--task <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 Requirementfirst match value in the ordered task list. [--labelsbranch <labels><branch>] Comma or blank separated list of labelsBranch name. [--searchLabelsname <searchLabels><name>] Comma or blank separated listName of labelsentity, usedlike forplan searchname. [--issuesdescription <issues><description>] CommaDescription separated list of JIRA issue keysfor entity. [--expandagent <expand><agent>] Expanded request information to obtain more detailed data on requestAgent name. [--attributeassignment <attribute><assignment>] AttributeKey used to list. [--comment <comment>] Comment for an build. [--revision <revision>] Revision id or tag. 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 [--locationartifact <location><artifact>] Working directory relative path toBuild artifact name. May be extended by a sourcepath locationname for locating files within an artifact definition orrepresenting a destinationdirctory. location for an artifact [--requirement <requirement>] dependency. Plan requirement [--copyPattern <copyPattern>] Copy pattern for an artifact definitionkey, either a custom key or a system capability key like: system.builder.ant.Ant. [--repositorytype <repository><type>] NameRequirement ofmatch a repositorytype. InValues: someexist cases(default), aequal, commamatch. separatedAlso, listcontent oftype repositoryfor names.renderRequest and trigger type for [--after <after>] addTrigger. Used in orderRepository to name the repository after which the repository will be positioned(default: ) [--value <value>] Requirement match value. [--schedulelabels <schedule><labels>] Comma Cron,or dailyblank time,separated orlist periodicof schedulelabels. 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[--searchLabels <searchLabels>] Comma or blank separated list of labels used for search. [--issues <issues>] Comma separated list of JIRA issue keys. [--taskKeyexpand <taskKey><expand>] TaskExpanded key.request Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier information to obtain more detailed data on request. [--attribute <attribute>] and less error prone.Attribute See addTask for the to list. [--repositoryKeyrevision <repositoryKey><revision>] Revision Repositoryid keyor thattag. uniquely identifies the repository type. Example:[--location <location>] com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg [--event <event>] Event alias or key. Add-ons provide events identified by key. Example key:Working directory relative path to a source location for an artifact definition or a destination location for an artifact com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChainsdependency. [--recipientTypecopyPattern <recipientType><copyPattern>] Copy Recipientpattern typefor aliasan orartifact keydefinition. Add[--onsrepository provide<repository>] recipient types identified by key. Example key: Name of a repository. In some com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchatcases, a comma separated list of repository names. [--childPlansschedule <childPlans><schedule>] CommaCron, separateddaily listtime, ofor planperiodic keysschedule. thatA representcron childschedule planmust dependencies.be valid cron expresssions [--ipRestriction <ipRestriction>] Comma separated list of IP addresses to restrict ability to remotely trigger builds. [--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 breaksand 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.An alias can also be used to make it easier and less error prone. See addTask for the list. [--field1repositoryKey <field1><repositoryKey>] Repository Constructkey that specificuniquely fieldidentifies orthe variablerepository nametype. ValueExample: is specified by the value1 parameter. com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg [--field2event <field2><event>] Construct specific field or variable name. Value is specified by the value2 parameter.Event alias or key. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains [--field3recipientType <field3><recipientType>] ConstructRecipient specifictype fieldalias or variable namekey. ValueAdd-ons isprovide specifiedrecipient bytypes theidentified value3by parameterkey. Example key: [--field4 <field4>] Construct specific field or variable name. Value is specified by the value4 parameter.com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat [--field5recipient <field5><recipient>] ConstructRecipient specificvalue fieldfor oradd variablenotifications. name.Many Valuerecipient istypes specifiedneed bya theprimary value5recipient parametervalue. This parameter can [--field6 <field6>]be used Constructinstead specificof fieldsetting ora variablerecipient name.type Valuespecific isfield specified by the value6 parameterand value. [--field7childPlans <field7><childPlans>] ConstructComma specificseparated fieldlist orof variableplan name.keys Valuethat isrepresent specifiedchild by the value7 parameterplan dependencies. [--field8ipRestriction <field8><ipRestriction>] ConstructComma specificseparated fieldlist orof variableIP name.addresses Valueto isrestrict specifiedability byto theremotely value8trigger parameterbuilds. [--value1fields <value1><fields>] Value correspondingUse to thespecify field1task parameteror name.repository specific fields or [--value2 <value2>] Value corresponding to the field2 parameter name. [--value3 <value3>] Value corresponding to the field3 parameter name. [--value4 <value4>] Value corresponding to the field4 parameter namevariables 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. [--field1 <field1>] Construct specific field or variable name. Value is specified by the value1 parameter. [--value5field2 <value5>]<field2>] Construct specific field or variable name. Value correspondingis specified toby the field5value2 parameter name. [--value6field3 <value6><field3>] Construct specific field or variable name. Value is correspondingspecified toby the field6value3 parameter name. [--value7field4 <value7><field4>] Construct specific field or variable name. Value is correspondingspecified toby the field7value4 parameter name. [--value8field5 <value8><field5>] Construct specific field or variable name. Value is correspondingspecified toby the field8value5 parameter name. [--regexfield6 <regex><field6>] RegularConstruct specific expressionfield foror listvariable filteringname. andValue similar.is Alsospecified forby patternthe matchvalue6 labellingparameter. [--requestfield7 <request><field7>] URL fragment for a requestConstruct specific field or variable name. Value is specified by the value7 parameter. [--requestParametersfield8 <requestParameters><field8>] URLConstruct requestspecific parametersfield or post data variable name. Value is specified by the value8 parameter. [--requestTypevalue1 <requestType><value1>] TypeValue ofcorresponding ato renderthe requestfield1 likeparameter GETname. or POST (default: GET) [--acceptTypevalue2 <acceptType><value2>] ContentValue typecorresponding to acceptthe forfield2 renderRequest if different than typeparameter name. [--idvalue3 <id><value3>] Value corresponding Stageto the orfield3 taskparameter idname. [--numbervalue4 <number><value4>] BuildValue number.corresponding Defaultsto tothe latest. (default: 0)field4 parameter name. [--timeoutvalue5 <timeout><value5>] WaitValue timeoutcorresponding into seconds.the Usefield5 -1 to wait foreverparameter name. (default: -1) [--limitvalue6 <limit><value6>] Value Maximumcorresponding numberto ofthe entriesfield6 toparameter return. (default: 2147483647)name. [--waitvalue7 <value7>] Wait for action to completeValue corresponding to the field7 parameter name. [--favouritevalue8 <value8>] Value Subsetcorresponding to favourites.the Samefield8 asparameter favoritename. [--favoriteafter <after>] Used in SubsetorderRepository to favorites. Same as favourite. [--enable] name the repository after which the repository will be positioned. Similarly for moveTask where it represent Enablethe anid entityof whenthe updatingtask. [--disablebefore <before>] DisableBefore an entity for those entities like plans, stages, jobs, and taskstask id. [--excludeEnabledfinal] FilterMake outa entries that are enabledfinal task. [--excludeDisabled]regex <regex>] Regular expression for list filtering and Filtersimilar. outAlso entriesfor thatpattern arematch disabledlabelling. [--manualrequest <request>] URL Indicatefragment thatfor a stage be run manuallyrequest. [--sharedrequestParameters <requestParameters>] ForURL anrequest artifactparameters definition,or makes the artifact available for other buildspost data. [--cleanAfterrequestType <requestType>] CleanType workingof directorya afterrender request eachlike jobGET completes.or UsePOST on setJobOptions.(default: GET) [--helpacceptType <acceptType>] Content Printstype thisto helpaccept message.for renderRequest if Validdifferent actionsthan (case insensitive):type. run [--id Run<id>] actions from a file or standard input. RequiredStage parameters:or filetask orid. 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. Required parameters: file Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex runFromList - 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. Required parameters: list Optional parameters: file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex getClientInfo - Get information about the this client tool. Optional parameters: outputFormat, file, append, 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: request Optional parameters: requestParameters, requestType, type, 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[--number <number>] Build number. Defaults to latest. (default: 0) [--timeout <timeout>] Wait timeout in seconds. Use -1 to wait forever. (default: -1) [--limit <limit>] Maximum number of entries to return. (default: 2147483647) [--wait] Wait for action to complete. [--favourite] Subset to favourites. Same as favorite. [--favorite] Subset to favorites. Same as favourite. [--enable] Enable an entity when updating. [--disable] Disable an entity for those entities like plans, stages, jobs, and tasks. [--excludeEnabled] Filter out entries that are enabled. [--excludeDisabled] Filter out entries that are disabled. [--manual] Indicate that a stage be run manually. [--automatic] Indicate that a stage be run automatically. [--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: project file or standard input Optional parameters: favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromStageListrunFromSql - Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName. Required parameters: plan Optional parameters: stage, regex, commongenerated 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, file, encoding, findReplace, findReplaceRegex runFromJobListrunFromCsv - Run actions forgenerated eachfrom joba with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all stages. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobName. CSV file. Required parameters: planfile Optional parameters: stagecommon, regexpropertyFile, commoncontinue, continuequiet, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromRepositoryListrunFromList - Run actions for each repositoryentry within regexa filteringlist. on repositoryWhen name.file Availableis replacementprovided, variableseach areaction repositoryin andthe repositoryId.file augmented Optional parameters: plan, regex,by the common, continue,parameter simulate,will clearFileBeforeAppend,be file,run encoding,for findReplace,each findReplaceRegexentry. runFromAgentList -Otherwise, Runjust actionsthe foraction eachspecified agentby withthe regexcommon filteringparameter onwill agentbe namerun. Available replacement variables are agent and agentId.entry, entry2. Required parameters: list Optional parameters: regexlist2, file, common, continue, quiet, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex getProjectListgetClientInfo - Get ainformation listabout ofthe projects.this Projectsclient aretool. selected basedOptional onparameters: regexoutputFormat, filteringfile, onappend, projectencoding key orOutput name.formats: 1 Optional parameters: regex- basic, file,2 append,- encodingJVM, columns getPlanList11 - Getaction a list, of12 plans- forparameter alist projectgetServerInfo with- regexGet filteringinformation onabout planthe key or name. Use @all for project to get a list of plans across all projectsBamboo server. Required parameters: project Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding Output formats: 1 - planbasic, 9992 - detail, last3 build- resultsstate getArtifactDefinitionListvalidateLicense - ExperimentalValidates -the onlyCLI thoseConnector availableis toenabled beand artifactlicensed dependencies inon the lastserver. job!renderRequest Get- aRender listurl ofbased sharedrequest. artifactThe definitionsresponse fordata amodified planby withfindReplace regexprocessing filtering on artifact nameis returned. Required parameters: planrequest Optional parameters: requestParameters, limitrequestType, regextype, columnsacceptType, filebuild, appendfile, encoding, getRepositoryListfindReplace, -findReplaceRegex GetrunFromProjectList a- listRun ofactions globalfor oreach plan repositoriesproject with regex filtering on project repositorykey or name. Available Optional replacement variables are project and projectName. Optional parameters: planregex, regexcommon, filecontinue, appendsimulate, encodingclearFileBeforeAppend, getNotificationListfile, -encoding, EAPfindReplace, (subjectfindReplaceRegex torunFromPlanList change).- GetRun aactions listfor ofeach plan notifications.with regex Optionalfiltering parameters:on plan, file, append, encoding getVariableList - Get key or name. Use @all for project to get a list of global or planplans across all projects. Available replacement variables basedare onproject, regexprojectName, filteringplan, ofand variable namesplanName. OptionalRequired parameters: plan, regex, file, append, encoding getBuildList - Get a list of build reults. Build results can be filtered by using fields and values. Supported fields are state and started. For example, include only successful results by using: --field1 state --value SUCCESSFUL, or include only builds started after a specific date use: --field2 started --value2 2016-04-30 --dateFormat yyyy-MM-dd. Default limit is 25. Required parameters: plan Optional parameters: limit, favorite, labels, issues, columns, file, append, encoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 Output formats: 1 - basic, 2 - test information getArtifactList - Get a list of build result artifacts. When the build does not include a job portion, only shared artifacts are provided. Use @all for the job parameter to get both sharted and non-shared artifacts for all plan jobs. Required parameters: plan or build Optional parameters: job, number, limit, regex, file, append, encoding getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or buildproject Optional parameters: favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromStageList - Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName. Required parameters: plan Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromJobList - Run actions for each job with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all 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 agent name. Available replacement variables are agent and agentId. Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromDeploymentProjectList - Experimental. Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables are deploymentProject and deploymentProjectId. Optional parameters: projectregex, common, continue, simulate, buildclearFileBeforeAppend, file, appendencoding, encodingfindReplace, columnsfindReplaceRegex getLabelListrunFromEnvironmentList - Get a list of labels Experimental. Run actions for each environment defined for a build. Required parameters: build deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId. Optional parameters: number regex, common, continue, simulate, clearFileBeforeAppend, file, appendencoding, encodingfindReplace, columnsfindReplaceRegex getCommentListgetProjectList - Get a list of comments for a build. Required parameters: build projects. Projects are selected based on regex filtering on project key or name. Optional parameters: numberregex, file, append, encoding, columns getStageListgetPlanList - Get a list of stagesplans for a planproject with regex filtering on plan key stageor name. Use @all for project to get a list of plans across all projects. Required parameters: planproject Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, attribute, columns getJobList encoding Output formats: 1 - plan, 999 - last build results getBranchList - Get a list of jobsbranches for a plan with regex filtering on jobbranch keyname or name. Subset by stage if desiredshort name. Required parameters: plan Optional parameters: stagelimit, regex, columns, file, attributeappend, columnsencoding getAgentListgetArtifactDefinitionList - Get a list of agents based on artifact definitions for a plan with regex filtering ofon agentartifact names..name. Required parameters: plan Optional parameters: limit, regex, columns, file, append, encoding, columnsgetRepositoryList - OutputGet formats:a 1list -of basic,global 2or -plan detailrepositories queueBuildwith -regex Queuefiltering aon buildrepository to runname. If waitOptional isparameters: specifiedplan, theregex, actionfile, willappend, notencoding completegetNotificationList until- theGet queueda buildlist completesof orplan thenotifications. timeout periodOptional 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. Conditional queueing is supported - see the documentation for details. parameters: plan, file, append, encoding getVariableList - Get a list of global or plan variables based on regex filtering of variable names. Optional parameters: plan, regex, file, append, encoding getBuildList - Get a list of build reults. Build results can be filtered by using fields and values. Supported fields are state, notState, and started. For example, include only successful results by using: --field1 state --value SUCCESSFUL, or include only builds started after a specific date use: --field2 started --value2 2016-04-30 --dateFormat yyyy-MM-dd. Default limit is 25. Required parameters: plan Optional parameters: revision limit, favorite, labels, issues, waitcolumns, continuefile, timeoutappend, dateFormatencoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 queueBuildFromList -Output Queueformats: multiple1 builds- tobasic, run2 and- waittest forinformation results.getArtifactList The- actionGet willa notlist completeof untilbuild allresult queuedartifacts. buildsWhen completethe orbuild timesdoes out.not Ifinclude continuea isjob specifiedportion, buildsonly willshared continueartifacts to be queued even after an attempt to queue a build fails. The action will fail if any build fails or times out. Conditional queueing is supported - see the documentation for detailsare provided. Use @all for the job parameter to get both sharted and non-shared artifacts for all plan jobs. Required parameters: projectplan or listbuild Optional parameters: regexjob, limitnumber, continuelimit, timeoutregex, dateFormatfile, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 stopBuild - Request to stop a queued or running build. Use continue to ignore errors finding a build to stop or failed results. The wait parameter will cause processing to wait for completion or timeout before returningappend, encoding getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build. Optional parameters: project, build, file, append, encoding, columns getLabelList - Get a list of labels for a build. Required parameters: build Optional parameters: number, file, append, encoding, columns getCommentList - Get a list of comments for a build. Required parameters: planbuild Optional parameters: waitnumber, file, append, timeoutencoding, continuecolumns restartBuildgetStageList - RestartGet a buildlist thatof failedstages orfor wasa stopped.plan Usewith continueregex tofiltering ignoreon errors finding a build to restart or failed resultsstage name. Required parameters: plan Optional parameters: waitregex, file, timeoutattribute, continuecolumns addCommentgetJobList - AddGet a comment tolist of jobs for a build.plan with Requiredregex parameters:filtering build, comment on job key or name. Subset by stage if desired. Required parameters: plan Optional parameters: numberstage, findReplaceregex, findReplaceRegexfile, fileattribute, encodingcolumns addLabelsgetTaskList - AddGet a comma separated list of labelstasks tofor a build job with regex filtering on task name. Required parameters: buildplan, labelsjob Optional parameters: number removeLabels - Remove labels fromlimit, regex, file, columns getAgentList - Get a build.list Labelsof canagents bebased aon commaregex separatedfiltering listof oragent regexnames. Either buildOptional orparameters: search terms (searchLabelsregex, file, issues) must be providedappend, encoding, columns RequiredOutput parametersformats: labels1 - Optionalbasic, parameters:2 build,- number,detail searchLabels,getDeploymentProjectList issues,- favoriteExperimental. deleteProjectGet -a Deletelist projectof anddeployment allprojects projectbased plans.on regex Requiredfiltering parameters:of project names. Optional parameters: regex, file enableProject, append, encoding, columns getEnvironmentList - Enable all project plans. Required parameters: project disableProject - Disable all project plans Experimental. Get a list of environments for a deployment project based on regex filtering of environment names. Required parameters: projectdeploymentProject cloneProject -Optional Cloneparameters: eachregex, planfile, inappend, aencoding, projectcolumns togetTaskTypeList another- project.Get Ifa toProjectlist isof nottask provided,types theavailable planswith willregex befiltering clonedon totype thename sameand projectdescription. If theRequired toProject does not exist, it will be created with name provided by projectName. Requiredparameters: plan, job Optional parameters: projectlimit, toProjectregex, projectNamefile, disablecolumns createPlanpauseServer - CreatePause athe newserver plan.to Provideprevent abuilds 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. Use continue to ignore the request if the plan already exists. Required parameters: plan Optional parameters: name, projectName, description, disable, continue createOrUpdatePlan - Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. Server instances onlyfrom starting. resumeServer - Resume server to allow builds to be started. queueBuild - Queue a build to run. If wait 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. Conditional queueing is supported - see the documentation for details. Required parameters: plan Optional parameters: namebranch, projectNamerevision, descriptionwait, disablecontinue, updatePlantimeout, -dateFormat, Updatefields, afield1, plansvalue1, namefield2, or description. Provide a 2-part plan key where the first part is the project key. Required parameters: plan Optional parameters: name, description getPlan - Get plan information. Required parameters: plan clonePlan - Clone a plan. Required parameters: plan, toPlan, name Optional parameters: description, projectName, disable deletePlan - Delete a plan. Required parameters: plan enablePlan - Enable a plan to run. Required parameters: plan disablePlan - Disable a plan from runningvalue2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 queueBuildFromList - Queue multiple builds to run and wait for results. The action will not complete until all queued builds complete or times out. If continue is specified, builds will continue to be queued even after an attempt to queue a build fails. The action will fail if any build fails or times out. Conditional queueing is supported - see the documentation for details. Required parameters: planproject addStageor -list Add aOptional stageparameters: toregex, a plan. Required parameters: plan, stage Optional parameters: description, manual removeStage - Remove a stage from a plan. Use id = -1 to remove all stages. Use limit, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 stopBuild - Request to stop a queued or running build. Use continue to ignore errors notfinding founda errors.build to Requiredstop parameters:or plan,failed stageresults. orThe idwait parameter Optionalwill parameters:cause continueprocessing addJobto -wait Addfor acompletion jobor totimeout abefore stagereturning. Required parameters: plan, stage, job Optional parameters: namewait, descriptiontimeout, disablecontinue enableJobrestartBuild - EnableRestart a job to run. Required parameters: plan, job disableJob - Disable a job from running build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results. Required parameters: plan, job setJobOptions - Set miscellaneous option forOptional parameters: wait, timeout, continue addComment - Add a comment to a jobbuild. The following options are specifically supported: clean working directory after job completes (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: build, comment Optional parameters: number, findReplace, findReplaceRegex, file, encoding addLabels - Add a comma separated list of 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: plan, joblabels Optional parameters: cleanAfterbuild, regexnumber, labelssearchLabels, getArtifactissues, -favorite DownloaddeleteProject a- copyDelete ofproject aand buildall artifact into a fileproject plans. Required parameters: project Uses sameOptional parameters: andfile logicenableProject as- getArtifactListEnable forall identifyingproject buildplans. result artifactsRequired toparameters: search.project FordisableProject artifacts- thatDisable representall aproject directory (not a file), use the artifact name plus the path to the file in the artifact. Optional parameters: plan or build, artifact, file Output formats: job, number, replace, encoding getBuild - Get build resultplans. 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 projectName. Required parameters: build Optional parameters: numberproject, toProject, expandprojectName, filedisable verifyBuildcreatePlan - VerifyCreate builda wasnew successfulplan. Provide 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 onlya 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. Use continue to ignore the request if the plan already exists. Required parameters: plan, job, artifact, copyPattern Optional parameters: name, locationprojectName, shareddescription, removeArtifactdisable, -continue RemovecreateOrUpdatePlan an- artifactSame definitionas fromcreatePlan a job. Server instances onlywhen plan does not exist. However, it will update an existing plan's name and description. Required parameters: plan Optional parameters: name, projectName, jobdescription, artifactdisable addArtifactDependencyupdatePlan - Update a Addplans anname artifactor dependencydescription. toProvide a job. Artifact must be a shared artifact from another job 2-part plan key where the first part is the project key. Required parameters: plan, job, artifact, location setDependencyOptions Optional parameters: name, description getPlan - Experimental.Get Set child dependencies and other related optionsplan information. Required parameters: plan clonePlan - Clone a plan. OptionalRequired parameters: childrenplan, fieldstoPlan, field1,name value1, field2, value2, field3Optional parameters: description, value3projectName, field4,disable value4,deletePlan field5,- value5,Delete field6, value6, field7, value7, field8, value8 addTaska plan. Required parameters: plan enablePlan - AddEnable a taskplan 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, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACErun. Required parameters: plan disablePlan - Disable a plan from running. Required parameters: plan setFavoritePlan - Set the plan as a favorite. Required parameters: plan unsetFavoritePlan - Remove the plan from the favorite list. Required parameters: plan exportPlan - Experimental. Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher). Required parameters: plan Optional parameters: type, file, encoding, dateFormat movePlans - Move one or more plans from one project to another project (existing or new). Specifying a plan will move that plan. If plan is not specified, plans from the source project, with filtering like for getPlanList, will be moved. Plan key and name can be changed on the move by specifying toPlan and name respectively. When toPlan or name are provided for multiple plan moves, they must contain <at:var at:name="plan" /> or <at:var at:name="planName" /> replacement variables. Before the move takes place, the server state will be checked and paused if necessary and, if paused, resumed after the end of the operation. Required parameters: project or plan, toProject Optional parameters: toPlan, name, excludeEnabled, excludeDisabled, limit, regex addBranch - Add a branch to a plan. The plan branch will be disabled by default. For add, the branch parameter refers to the repository branch. An optional name for the plan branch can be specified, otherwise the repository branch name will be used. Required parameters: plan, branch Optional parameters: name, description, enable removeBranch - Removes a branch from a plan. Use --branch @all to remove all branches from a plan. Required parameters: plan, branch getBranch - Get information for a branch to a plan. Branch can be either the short or long name of the branch. Required parameters: plan, branch Optional parameters: file, encoding addStage - Add a stage to a plan. Required parameters: plan, stage Optional parameters: description, manual getStage - Get plan stage information. Required parameters: plan, stage updateStage - Update stage details. Required parameters: plan, stage Optional parameters: name, description, manual, automatic removeStage - Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors. Required parameters: plan, stage or id Optional parameters: continue addJob - Add a job to a stage. Required parameters: plan, stage, job Optional parameters: name, description, disable enableJob - Enable a job to run. Required parameters: plan, job disableJob - Disable a job from running. Required parameters: plan, job setJobOptions - Set miscellaneous option for a job. The following options are specifically supported: clean working directory after job completes (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: Uses same parameters and logic as getArtifactList for identifying build result artifacts to search. For artifacts that represent a directory (not a file), use the artifact name plus the path to the file in the artifact. Optional parameters: plan or build, artifact, file Output formats: job, number, replace, encoding getBuild - Get build result. Required parameters: build Optional parameters: number, expand, file, encoding 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. Required parameters: plan, job, artifact, copyPattern Optional parameters: location, shared removeArtifact - Remove an artifact definition from a job. 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 setDependencyOptions - Set child dependencies and other related options. Required parameters: plan Optional parameters: children, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 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_BITBUCKET, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_SERVICE_DESK, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE Required parameters: plan, job, taskKey Optional parameters: disable, final, 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, task or 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 --task @all to remove all tasks. Required parameters: plan, job, task or id moveTask - Move a task to before or after another task. Use final to make a task final. Final tasks must follow all non final tasks. If neither before or after are specified, the task will be moved to the last position respecting the final parameter. Required parameters: plan, job, task or id Optional parameters: after or before, final getTask - Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job. Required parameters: plan, job, task or 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, BITBUCKET_CLOUD, BITBUCKET_SERVER, STASH, BCVS, GIT, GITHUB, MERCURIAL, PERFORCE, SUBVERSION Required parameters: repository or name Optional parameters: plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 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, field7, 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: plan, job, taskKey repository 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 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: plan, job, idrequirement Optional parameters: enabletype, disable,value fields,updateRequirement field1,- value1,Update field2,a value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeTaskplan requirement. Required parameters: plan, job, id Optional parameters: type, value removeRequirement - Remove a task from a plan job. Use id = -1 to remove all tasksrequirement. Required parameters: plan, job, id addRepositoryaddNotification - Add a plan notification. globalThere orare plan2 repository.parts Forto 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 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: repositoryplan, orevent, namerecipientType Optional parameters: plan, repositoryKeyrecipient, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 updateRepository - Update a global or plan repository. Required parameters: repository or id, 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, field7, value7, field8, value8 removeRepositoryupdateVariables - Update Removeexisting global or plan repositoryvariables. Use @allDefaults 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. Requiredglobal 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, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeVariables - Remove global or plan variables. Specify the variable names using the field parameters. Optional parameters: plan, jobfields, requirementfield1, value1, Optional parameters: type, value updateRequirement - Update a plan requirement. Required parameters: plan, job, id Optional parameters: type, value removeRequirement - Remove a 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 availablefield2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, 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. Polling triggers default to all plan repositories or use repository @all. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Use of the name parameter is deprecated - description should be used instead. Required parameters: plan, event, recipientTypetype Optional parameters: description, repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeNotificationremoveTrigger - Remove a plan notificationtrigger from a plan. Use id of= -1 to remove all notifications for a plantriggers. Required parameters: plan, id addVariablesaddAgent - 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, field7, value7, field8, value8 updateVariables - Update existing 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, 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: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeVariables - Remove 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, field7, value7, field8, 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. 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 continue createDeploymentProject - Experimental. Create a deployment project for a plan. Required parameters: plan, name Optional parameters: description, branch getDeploymentProject - Experimental. Get information for a deployment project by name or id. Required parameters: deploymentProject deleteDeploymentProject - Experimental. Delete a deployment project by name or id. Required parameters: deploymentProject Optional parameters: continue addEnvironment - Experimental. Add an environment to deployment project. Required parameters: deploymentProject, name Optional parameters: description getEnvironment - Experimental. Get information for an environment from a deployment project by name or id. Required parameters: deploymentProject, environment Optional parameters: file, encoding removeEnvironment - Experimental. Remove an environment from a deployment project by name or id. Required parameters: plandeploymentProject, name, typeenvironment 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 continue deployEnvironment - Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace. Required parameters: deploymentProject, environment, version Optional parameters: build, number, replace addEnvironmentTask - Experimental. Add a task to a deployment environment. Required parameters: deploymentProject, environment, taskKey Optional parameters: description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 addEnvironmentTrigger - Experimental. Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage. One or more repositories can be specified for pre-defined type triggers based on repositories. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Required parameters: deploymentProject, agentname, assignmenttype Optional parameters: continuerepository, removeAgentAssignmentschedule, -ipRestriction, Removefields, anfield1, assignmentvalue1, fromfield2, avalue2, specific agent. Use continue to ignore not found error. Required parameters: agent, assignment Optional parameters: continuefield3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |