...
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>] [--afterSql <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>] [--builddeploymentProject <build><deploymentProject>] [--planenvironment <plan><environment>] [--toPlanversion <toPlan><version>] [--stage build <build>] [--plan <plan>] [--toPlan <toPlan>] [--stage <stage>] [--job <job>] [--task <task>] [--branch <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>] [--fieldsrecipient <fields><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>] [--regexafter <regex><after>] [--requestbefore <request><before>] [--requestParameters <requestParameters>final] [--requestTyperegex <requestType><regex>] [--acceptType request <request>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType <acceptType>] [--id <id>] [--number <number>] <number>] [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite] [--favorite] [--replaceenable] [--enabledisable] [--disableexcludeEnabled] [--excludeEnabledexcludeDisabled] [--excludeDisabledmanual] [--manualautomatic] [--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: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 [--propertyFileafterSql <propertyFile>]<afterSql>] SQL to run after a successful action. Limited to Propertyspecific fileactions withat mappingthis informationtime. [--commondbTable <common><dbTable>] Database table name Commonwhen creating parameteror stringupdating addeda todatabase allfrom runlist actionsoutput. [--specialdbTableKeys <special><dbTableKeys>] OrderedComma separated list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters column names used to access existing rows for update. Normally this defines a primary key set for the table. [--dbCreateTable] Database usedtable forneeds specializedto processingbe ofcreated somebefore specificadding parametersrows. [--dateFormatcomment <dateFormat><comment>] Format string for date in Java SimpleDateFormat, default is client date formatComment text. [--findReplace <findReplace>replace] FindReplace andexisting replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escapedentity on add, create, or similar actions. [--propertyFile <propertyFile>] Property file with database parameters, field mappings, or client specific information. [--findReplaceRegexcommon <findReplaceRegex><common>] FindCommon andparameter replacestring textadded withto aall regularrun expressionactions. Comma separated list of colon separated pairs. Single quote values[--special <special>] Ordered list of alternate characters containingfor acomma delimiter.( Embedded, quotes), mustcolon be( escaped.: ), at [--list <list>] Comma separated list of entries. Single quote values containing a delimiter. Embedded quotes must be doubled( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. [--continuedateFormat <dateFormat>] ContinueFormat processingstring evenfor afterdates errorsin are encountered for run actions. Also usedJava SimpleDateFormat. Default for someoutput actionis toclient ignoredate certainformat. errorsDefault for date parsing is like not found errors onlenient removestarting actions.with client date format [--simulate]and then some other standard formats based on JSON Simulate running actions. Log the action that would be takendate format. [--appenddateFormat2 <dateFormat2>] ForAlternate someformat actionsstring usingfor thedates filein parameter,Java appendSimpleDateFormat. willUse appendspecific output(may tobe theignored), existingbut file.normally used for date [--clearFileBeforeAppend]only Forfields runto actions,avoid thislonger optiondateFormat willbased automaticallyoutput. clearSome anuses existingdefault file on the first append requestedto yyyy-MM-dd. ([-s|--server) <server>reference <reference>] ServerReference URL.to Normallya thereplacement basekey URLvalue ofused theto serverremember andan theaction samespecific asvalue howlike theissue serverkey isor accessedsimilar fromso ait browser.can be (-u|--user) <user> referenced later.Each action that Userallows namethis forparameter remotewill access. (default: automation) (-p|--password) <password> specify what value is being set for the reference replacement User password for remote accesskey. [--servicefindReplace <service><findReplace>] Find Serviceand addressreplace extensiontext. (default: /rest/api) [--api <api>] API version. Some requests produce different results based on the api version used. (default: latest)Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. [--cookiesfindReplaceRegex <cookies><findReplaceRegex>] Find Nameand ofreplace filetext towith restorea andregular persistexpression. cookiesComma acrossseparated invocationslist of colon CLIseparated actionspairs. CanSingle bequote usedvalues to provide Data Center session containing a delimiter. Embedded quotes affinitymust for actions using REST APIsbe doubled. [--projectlist <project><list>] ProjectComma key.separated Example:list XXXof entries to populate [--toProject <toProject>] Project key to clone to.the entry replacement variable on runFromList. Single quote values containing a [--projectName <projectName>] delimiter. Embedded quotes must Project namebe doubled. [--buildlist2 <build><list2>] BuildComma key.separated Normallylist usedof to referentries to apopulate specificthe buildentry2 (3replacement orvariable 4 part name)on runFromList. However,Single itquote wasvalues alsocontaining ana older terminology for a delimiter. Embedded quotes must planbe anddoubled. 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>] [--options <options>] Comma separated list of support, experimental, or other client or action specific options. [--continue] Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not Planfound keyerrors toon beremove createdactions. Example: XXX-DEF [--stagesimulate] <stage>] Simulate Stagerunning nameactions. Log the action [--job <job>] that would be taken. [--append] Job key. Example: JOB1 For [--name <name>] Name of entity, like plan namesome actions using the file parameter, append will append output to the existing file. [--description <description>clearFileBeforeAppend] DescriptionFor forrun entity.actions, this option will [--agent <agent>] Agent nameautomatically clear an existing file on the first append requested. [(-s|--assignmentserver) <assignment>]<server> KeyServer usedURL. toNormally identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to onlythe base URL of the server and the same as how the server is accessed from a browser. (-u|--user) <user> performUser buildsname for allremote assignments.access. (default: automation) Example: XXX, XXX-DEF, XXX-DEF-JOB1 (-p|--password) <password> [--artifact <artifact>] User password for remote Build artifact nameaccess. 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.[--api <api>] API version. Some requests produce different results based on the api version used. (default: latest) [--typeservice <type><service>] RequirementService match type. Values: exist, equal, match. Also, content type for renderRequestaddress extension. (default: exist/rest/api) [--valuecookies <value><cookies>] RequirementName matchof value.file to restore and [--labels <labels>] Comma or blank separated list of labels. [--searchLabels <searchLabels>] persist cookies across invocations of CLI actions. Can be used to provide Data Center session Comma or blank separatedaffinity listfor ofactions labelsusing usedREST for searchAPIs. [--issuesproject <issues><project>] CommaProject separatedkey. list of JIRA issue keys.Example: XXX [--expandtoProject <expand><toProject>] ExpandedProject request informationkey to obtain more detailed data on requestclone to. [--attributeprojectName <attribute><projectName>] AttributeProject to listname. [--commentdeploymentProject <comment><deploymentProject>] CommentDeployment forproject anname buildor id. [--revisionenvironment <revision><environment>] RevisionDeployment environment idname or tagid. [--locationversion <location><version>] WorkingVersion directoryname relativefor pathdeployment. 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.[--build <build>] Build key. Normally used to refer to a specific build (3 or 4 part name). However, it was also an older terminology for a plan and some action continue to accept the older terminology. Example: XXX-DEF or XXX-DEF-1 [--plan <plan>] Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF [--scheduletoPlan <schedule><toPlan>] Cron,Plan dailykey time,to orbe periodic schedulecreated. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily Example: XXX-DEF [--stage <stage>] Stage name. [--job <job>] time is a 24Job 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>]key. Example: JOB1 [--task <task>] Task id, name, or description. Task ids are unique, but names and descriptions are not. Name and description lookup is done by Repositoryfinding keythe thatfirst uniquelymatch identifiesin the repositoryordered type. Example:task list. [--branch <branch>] Branch com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hgname. [--eventname <event><name>] Event alias or key. Add-ons provide events identified by key. Example key:Name of entity, like plan name. [--description <description>] Description com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChainsfor entity. [--recipientTypeagent <recipientType><agent>] RecipientAgent typename. alias or key. Add[--onsassignment provide<assignment>] recipient types identified by key. Example key: Key used to identify a project, 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>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>] Comma separated list of IP addresses to restrict ability to remotely trigger buildsPlan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant. [--field1type <field1><type>] Requirement Construct specific field or variable name. Value is specified by the value1 parameter. [--field2 <field2>]match type. Values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger. (default: ) Construct specific field or variable name. Value is specified by the value2 parameter [--value <value>] Requirement match value. [--field3labels <field3><labels>] Construct specific fieldComma or variableblank name.separated Valuelist is specified by the value3 parameterof labels. [--field4searchLabels <field4><searchLabels>] Construct specific fieldComma or variableblank name.separated Valuelist isof specifiedlabels byused thefor value4 parametersearch. [--field5issues <field5><issues>] ConstructComma specificseparated fieldlist orof variableJIRA name. Value is specified by the value5 parameterissue keys. [--field6expand <field6><expand>] ConstructExpanded specificrequest fieldinformation orto variableobtain name.more Valuedetailed isdata specified by the value6 parameteron request. [--field7attribute <field7>]<attribute>] Attribute to list. Construct specific field or variable name. Value is specified by the value7 parameter[--revision <revision>] Revision id or tag. [--field8location <field8><location>] ConstructWorking specificdirectory fieldrelative orpath variableto name.a Valuesource islocation specifiedfor byan theartifact value8definition parameter.or a destination location [--value1 <value1>] for an artifact Value corresponding to the field1 parameter name dependency. [--value2copyPattern <value2><copyPattern>] ValueCopy correspondingpattern tofor thean field2artifact parameter namedefinition. [--value3repository <value3><repository>] Name of a repository. In some cases, Valuea correspondingcomma toseparated thelist field3of parameterrepository namenames. [--value4schedule <value4><schedule>] ValueCron, correspondingdaily totime, theor field4periodic parameter nameschedule. A cron schedule [--value5 <value5>] Value corresponding to the field5 parameter name. [--value6 <value6>] Value corresponding to the field6 parameter namemust 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. [--value7taskKey <value7><taskKey>] Value corresponding to the field7 parameter name. [--value8 <value8>] Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier and less Valueerror correspondingprone. toSee theaddTask field8for parameterthe namelist. [--regexrepositoryKey <regex><repositoryKey>] RegularRepository expressionkey forthat listuniquely filteringidentifies andthe similar. Also for pattern match labelling.repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg [--requestevent <request><event>] URLEvent fragmentalias foror a request. [--requestParameters <requestParameters>] key. Add-ons provide events identified by key. Example key: URL request parameters com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains [--requestTyperecipientType <requestType><recipientType>] Recipient type alias or Type of a render request like GET or POST (default: GET)key. Add-ons provide recipient types identified by key. Example key: [--acceptType <acceptType>] com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat [--recipient <recipient>] Content type to accept for renderRequest if different thanRecipient type.value for add [--id <id>] Stage or task id.notifications. Many recipient types need a primary recipient value. This parameter can be used [--number <number>] instead of setting a recipient type Buildspecific number.field Defaultsand to latest. (default: 0)value. [--timeoutchildPlans <timeout><childPlans>] WaitComma timeoutseparated inlist seconds.of Useplan -1keys tothat waitrepresent forever. (default: -1)child plan dependencies. [--limitipRestriction <limit><ipRestriction>] Comma Maximumseparated numberlist of entries IP addresses to restrict ability to return. (default: 2147483647)remotely trigger builds. [--waitfields <fields>] WaitUse forto actionspecify totask complete.or repository specific fields [--favourite]or variables and their values. A comma separated list Subsetof tokey:value favouritespairs. Same as favorite. [--favorite] Single quote the key:value pair if it contains Subseta to favorites. Same as favouritecomma (,) or line breaks. [--replacefield1 <field1>] ReplaceConstruct existingspecific entity.field or variable [--enable] Enable an entity when updatingname. Value is specified by the value1 parameter. [--disablefield2 <field2>] Construct Disablespecific anfield entityor forvariable thosename. entitiesValue likeis plans,specified stages,by jobs,the andvalue2 tasksparameter. [--excludeEnabled]field3 <field3>] Construct specific field or variable name. Value Filteris outspecified entriesby thatthe arevalue3 enabledparameter. [--excludeDisabledfield4 <field4>] FilterConstruct outspecific entriesfield thator arevariable disabledname. Value is specified by the value4 parameter. [--manual]field5 <field5>] Construct specific field or variable name. IndicateValue thatis aspecified stageby bethe runvalue5 manuallyparameter. [--sharedfield6 <field6>] Construct Forspecific field anor artifactvariable definition,name. makesValue theis artifactspecified availableby forthe othervalue6 buildsparameter. [--cleanAfterfield7 <field7>] Clean working directory after each job completes. Use on setJobOptionsConstruct specific field or variable name. Value is specified by the value7 parameter. [--helpfield8 <field8>] PrintsConstruct thisspecific help messagefield or variable name. Value is Validspecified actionsby (case insensitive): run - Run actions from a file or standard input. 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. 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. Required parameters: project 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 getProjectList - Get a list of projects. Projects are selected based on regex filtering on project key or name. Optional parameters: regex, file, append, encoding, columns getPlanList - Get a list of plans for a project with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. Required parameters: project Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding Output formats: 1 - plan, 999 - last build results getArtifactDefinitionList - Experimental - only those available to be artifact dependencies in the last job! Get a list of shared artifact definitions for a plan with regex filtering on artifact name. Required parameters: plan Optional parameters: limit, regex, columns, file, append, encoding getRepositoryList - Get a list of global or plan repositories with regex filtering on repository name. Optional parameters: plan, regex, file, append, encoding getNotificationList - EAP (subject to change). Get a list of plan notifications. Optional 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 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, value8the value8 parameter. [--value1 <value1>] Value corresponding to the field1 parameter name. [--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 name. [--value5 <value5>] Value corresponding to the field5 parameter name. [--value6 <value6>] Value corresponding to the field6 parameter name. [--value7 <value7>] Value corresponding to the field7 parameter name. [--value8 <value8>] Value corresponding to the field8 parameter name. [--after <after>] Used in orderRepository to name the repository after which the repository will be positioned. Similarly for moveTask where it represent the id of the task. [--before <before>] Before task id. [--final] Make a final task. [--regex <regex>] Regular expression for list filtering and similar. Also for pattern match labelling. [--request <request>] URL fragment for a request. [--requestParameters <requestParameters>] URL request parameters or post data. [--requestType <requestType>] Type of a render request like GET or POST (default: GET) [--acceptType <acceptType>] Content type to accept for renderRequest if different than type. [--id <id>] Stage or task id. [--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: 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. 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 variables are entry, entry2. Required parameters: list Optional parameters: list2, 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 - testJVM, information11 getArtifactList - Get aaction list, of12 build- resultparameter artifacts.list When getServerInfo - Get information about the buildBamboo doesserver. not includeOptional aparameters: joboutputFormat, portiondateFormat, onlyfile, sharedappend, artifactsencoding are provided.Output Useformats: @all1 for- thebasic, job2 parameter- todetail, get3 both- shartedstate andvalidateLicense non-shared artifactsValidates forthe allCLI planConnector jobs.is enabled Requiredand parameters:licensed planon orthe buildserver. renderRequest Optional- parameters:Render job,url number, limit, regex, file, append, encoding getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build.based request. The response data modified by findReplace processing is returned. Required parameters: request Optional parameters: project requestParameters, requestType, type, acceptType, build, file, appendencoding, encodingfindReplace, columnsfindReplaceRegex getLabelListrunFromProjectList - Get a list of labels for a build. Required parameters: build Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName. Optional parameters: number regex, common, continue, simulate, clearFileBeforeAppend, file, appendencoding, encodingfindReplace, columnsfindReplaceRegex getCommentListrunFromPlanList - GetRun a list of comments actions for aeach build.plan with Requiredregex parameters:filtering buildon plan Optionalkey parameters: number, file, append, encoding, columns getStageList - Getor name. Use @all for project to get a list of stages for a plan with regex filtering on stage name plans across all projects. Available replacement variables are project, projectName, plan, and planName. Required parameters: planproject Optional parameters: regexfavorite, fileexcludeDisabled, attributeexcludeEnabled, columnsregex, getJobListcommon, -continue, Getsimulate, aclearFileBeforeAppend, listfile, ofencoding, jobsfindReplace, forfindReplaceRegex arunFromStageList plan- withRun regex actions for each stage with regex filtering on job key or name. Subset by stage if desired 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, attributeencoding, findReplace, columnsfindReplaceRegex getAgentListrunFromJobList - GetRun aactions listfor ofeach agentsjob based onwith regex filtering on job ofkey agentor namesname.. Restrict Optionalto parameters:a regex,specific file,stage append,or encoding,leave columnsstage blank Outputto formats:get 1jobs -across basic,all 2stages. -Available detailreplacement queueBuildvariables -are Queueproject, aprojectName, buildplan, 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: planplanName, 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: revisionregex, waitcommon, continue, timeoutsimulate, dateFormatclearFileBeforeAppend, fieldsfile, field1encoding, value1findReplace, field2,findReplaceRegex value2,runFromDeploymentProjectList 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: project or list- Experimental. Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables are deploymentProject and deploymentProjectId. Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex runFromEnvironmentList - Experimental. Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId. Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex getProjectList - Get a list of projects. Projects are selected based on regex filtering on project key or name. Optional parameters: regex, limitfile, continueappend, timeoutencoding, dateFormat,columns fields,getPlanList field1,- value1,Get field2,a value2,list field3,of value3,plans field4,for value4,a field5,project value5,with field6,regex value6,filtering field7,on value7, field8, value8 stopBuild - Request to stop a queued or running buildplan key or name. Use continue@all tofor ignoreproject errorsto findingget a buildlist toof stopplans oracross failed results. The wait parameter will cause processing to wait for completion or timeout before returningall projects. Required parameters: planproject Optional parameters: waitfavorite, timeoutexcludeDisabled, continueexcludeEnabled, restartBuildlimit, -regex, RestartoutputFormat, adateFormat, buildcolumns, thatfile, failedappend, orencoding was stopped.Output Useformats: continue1 to- ignoreplan, errors999 finding- alast build toresults restartgetBranchList or- failedGet results.a list Requiredof parameters:branches planfor a Optionalplan parameters:with wait,regex timeout,filtering continueon addCommentbranch -name Addor a comment to a buildshort name. Required parameters: build,plan comment Optional parameters: numberlimit, findReplaceregex, findReplaceRegexcolumns, file, append, encoding addLabelsgetArtifactDefinitionList - AddGet a comma separated list of labelsartifact definitions tofor a build.plan with Requiredregex parameters: build, labelsfiltering on artifact name. OptionalRequired parameters: numberplan removeLabels -Optional Removeparameters: labelslimit, fromregex, a build. Labels can be a comma separatedcolumns, file, append, encoding getRepositoryList - Get a list or regex. Either buildof global or searchplan termsrepositories (searchLabels, issues) must be provided Required parameters: labelswith regex filtering on repository name. Optional parameters: buildplan, numberregex, searchLabelsfile, issuesappend, favoriteencoding deleteProjectgetNotificationList - DeleteGet projecta andlist allof projectplan plansnotifications. RequiredOptional parameters: projectplan, file, Optionalappend, parameters:encoding filegetVariableList enableProject- -Get Enablea alllist projectof plans.global or Requiredplan parameters:variables projectbased disableProjecton -regex Disablefiltering allof projectvariable plansnames. RequiredOptional parameters: plan, projectregex, cloneProjectfile, -append, Cloneencoding eachgetBuildList plan- inGet a projectlist toof anotherbuild projectreults. IfBuild toProjectresults iscan notbe provided,filtered theby plansusing willfields beand clonedvalues. toSupported thefields sameare project. If the toProject does not exist, it will be created with name provided by projectName. Required parameters: project, 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. 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 onlystate, 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: 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: namejob, projectNamenumber, descriptionlimit, disableregex, updatePlanfile, -append, Updateencoding agetBuildQueueList plans- nameGet ora description.list Provideof abuilds 2-part plan key wherewaiting in the firstbuild partqueue. isSubset theby project or keybuild. RequiredOptional parameters: planproject, build, Optional parameters: name, description getPlanfile, append, encoding, columns getLabelList - Get plana information.list of Required parameters: plan clonePlan - Clone a planlabels for a build. Required parameters: plan, toPlan, namebuild Optional parameters: descriptionnumber, file, append, projectNameencoding, disablecolumns deletePlangetCommentList - Delete Get a list of comments for a planbuild. Required parameters: build plan enablePlan - Enable a plan to run. Required parameters: plan disablePlan - Disable a plan from running Optional parameters: number, file, append, encoding, columns getStageList - Get a list of stages for a plan with regex filtering on stage name. Required parameters: plan addStage - Add a stage to a 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, stage Optional parameters: descriptionstage, manualregex, disablefile, removeStageattribute, -columns RemovegetTaskList a- stage fromGet a plan.list Useof idtasks =for -1a tojob removewith allregex stages.filtering Useon continue to ignore not found errorstask name. Required parameters: plan, stage orjob id Optional parameters: continue addJoblimit, regex, file, columns getAgentList - AddGet a job to a stage list of agents based on regex filtering of agent names. RequiredOptional parameters: planregex, file, append, stageencoding, jobcolumns OptionalOutput parametersformats: name, description1 - basic, disable enableJob2 - Enabledetail agetDeploymentProjectList job- toExperimental. run.Get a Requiredlist parameters:of plan,deployment jobprojects disableJobbased -on Disableregex afiltering jobof fromproject runningnames. RequiredOptional parameters: planregex, jobfile, setJobOptionsappend, -encoding, Setcolumns miscellaneousgetEnvironmentList option for- Experimental. Get a job.list Theof followingenvironments optionsfor area specificallydeployment supported:project cleanbased workingon directoryregex afterfiltering jobof completesenvironment (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 requestednames. Required parameters: deploymentProject Optional parameters: regex, file, append, encoding, columns getTaskTypeList - Get a list of task types available with regex filtering on type name and description. Required parameters: plan, job Optional parameters: cleanAfterlimit, regex, labels getArtifactfile, columns pauseServer - DownloadPause athe copyserver ofto aprevent buildbuilds artifactfrom intostarting. aresumeServer file.- Resume Requiredserver parameters:to allow Usesbuilds sameto parametersbe andstarted. logicqueueBuild as- getArtifactListQueue for identifyinga build result artifacts to searchrun. If Forwait artifactsis thatspecified, representthe aaction directorywill (not a file), usecomplete until the artifactqueued namebuild plus the path tocompletes or the filetimeout inperiod theelapses. artifact.The action Optionalwill parameters:fail planif orthe build, artifact,fails fileunless continue Outputparameter formats:is job,used number,to replace,ignore encodinga getBuild - Get build failed result. A Requiredspecific parameters:revision buildcan be Optionalbuilt parameters:if number,the expand,revision fileparameter verifyBuildis -specified. VerifyPlan buildvariables wascan successful.be set Requiredusing parameters:the buildfield and Optionalvalue parameters:. numberConditional getLatestBuildNumberqueueing -is Getsupported the- number ofsee the last completeddocumentation build for this plandetails. Required parameters: plan addArtifact -Optional Addparameters: anbranch, artifactrevision, 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 taskwait, continue, timeout, dateFormat, fields, field1, value1, field2, value2, 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: project or list Optional parameters: regex, 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 finding a build to stop or failed results. The wait parameter will cause processing to wait for completion or timeout before returning. Required parameters: plan Optional parameters: wait, timeout, continue restartBuild - Restart a build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results. Required parameters: plan Optional parameters: wait, timeout, continue 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: 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 plans. Required parameters: project Optional parameters: file enableProject - Enable all 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 projectName. Required parameters: project, 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. 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. Required parameters: plan Optional parameters: name, projectName, description, disable updatePlan - Update a plans name 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 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: 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: plan, job, requirement Optional parameters: type, value updateRequirement - Update a plan requirement. Required parameters: plan, job, id Optional parameters: enabletype, disable,value fields,removeRequirement field1,- value1,Remove field2,a 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, SUBVERSIONplan 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: repositoryplan, orevent, namerecipientType Optional parameters: plan, repositoryKey, replacerecipient, 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, 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 - RemoveUpdate existing global or plan repositoryvariables. Use @allDefaults to removeglobal 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. Requiredvariables 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,type recipientType 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. 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 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 |