Related information for 6.
...
3.0
...
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> [--service <service>] [--api <api>] [--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>] [--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>] [--revision <revision>] [--location <location>] [--copyPattern <copyPattern>] [--repository <repository>] [--schedule <schedule>] [--taskKey <taskKey>] [--repositoryKey <repositoryKey>] [--event <event>] [--recipientType <recipientType>] [--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>] [--requestParameters <requestParameters>] [--requestType <requestType>] [--acceptType <acceptType>] [--id <id>] [--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 [--afterSql <afterSql>] SQL to run after a successful action. Limited to specific actions at this time. [--dbTable <dbTable>] Database table name when creating or 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 the table. [--dbCreateTable] 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 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. [--reference <reference>] Reference to a replacement key value used to remember an action 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. [--findReplace <findReplace>] Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. [--findReplaceRegex <findReplaceRegex>] Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled. [--list <list>] Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. [--list2 <list2>] Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. [--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 found errors on remove actions. [--simulate] Simulate running actions. Log the action that would be taken. [--append] For some actions using the file parameter, append will append output to the existing file. [--clearFileBeforeAppend] For run actions, this option will automatically clear an existing file on the first append requested. (-s|--server) <server> Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser. (-u|--user) <user> User name for remote access. (default: automation) (-p|--password) <password> User password for remote access. [--service <service>] Service address extension. (default: /rest/api) [--api <api>] API version. Some requests produce different results based on the api version used. (default: latest) [--cookies <cookies>] Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs. [--project <project>] Project key. Example: XXX [--toProject <toProject>] Project key to clone to. [--projectName <projectName>] Project name. [--builddeploymentProject <build><deploymentProject>] BuildDeployment key.project Normallyname usedor toid. refer to a specific build (3 or 4 part name). However, it was also an [--environment <environment>] Deployment environment name or id. [--version <version>] Version name for deployment. [--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 [--toPlan <toPlan>] Plan key to be created. Example: XXX-DEF [--stage <stage>] Stage name. [--job <job>] Job 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 finding the first match in the ordered task list. [--branch <branch>] Branch name. [--name <name>] Name of entity, like plan name. [--description <description>] Description for entity. [--agent <agent>] Agent name. [--assignment <assignment>] Key used to identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to only perform builds for all assignments. Example: XXX, XXX-DEF, XXX-DEF-JOB1 [--artifact <artifact>] Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory. [--requirement <requirement>] Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant. [--type <type>] Requirement match type. Values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger. (default: ) [--value <value>] Requirement match value. [--labels <labels>] Comma or blank separated list of labels. [--searchLabels <searchLabels>] Comma or blank separated list of labels used for search. [--issues <issues>] Comma separated list of JIRA issue keys. [--expand <expand>] Expanded request information to obtain more detailed data on request. [--attribute <attribute>] Attribute to list. [--revision <revision>] Revision id or tag. [--location <location>] Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency. [--copyPattern <copyPattern>] Copy pattern for an artifact definition. [--repository <repository>] Name of a repository. In some cases, a comma separated list of repository names. [--schedule <schedule>] Cron, daily time, or periodic schedule. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily time is a 24 hour format (HH:mm) value. A periodic schedule is a numeric value in seconds and defaults to 180. [--taskKey <taskKey>] Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier and less error prone. See addTask for the list. [--repositoryKey <repositoryKey>] Repository key that uniquely identifies the repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg [--event <event>] Event alias or key. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains [--recipientType <recipientType>] Recipient type alias or key. Add-ons provide recipient types identified by key. Example key: com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat [--childPlans <childPlans>] Comma separated list of plan keys that represent child plan dependencies. [--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 breaks. [--field1 <field1>] Construct specific field or variable name. Value is specified by the value1 parameter. [--field2 <field2>] Construct specific field or variable name. Value is specified by the value2 parameter. [--field3 <field3>] Construct specific field or variable name. Value is specified by the value3 parameter. [--field4 <field4>] Construct specific field or variable name. Value is specified by the value4 parameter. [--field5 <field5>] Construct specific field or variable name. Value is specified by the value5 parameter. [--field6 <field6>] Construct specific field or variable name. Value is specified by the value6 parameter. [--field7 <field7>] Construct specific field or variable name. Value is specified by the value7 parameter. [--field8 <field8>] Construct specific field or variable name. Value is specified by the 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. [--sharedautomatic] ForIndicate anthat artifacta definition,stage makesbe therun artifactautomatically. available for other [--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 - 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 getProjectListrunFromDeploymentProjectList - GetExperimental. aRun listactions offor projects.each Projectsdeployment areproject selectedwith based on regex filtering on deployment project key or namename. Available replacement variables are deploymentProject and deploymentProjectId. Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, appendencoding, encodingfindReplace, columnsfindReplaceRegex getPlanListrunFromEnvironmentList - Get a list of plansExperimental. Run actions for each environment defined for a deployment project with regex filtering on plan keyenvironment or name. UseAvailable @allreplacement forvariables projectare toenvironment get a list of plans across all projectsand environmentId. Required parameters: project Optional parameters: favoriteregex, excludeDisabledcommon, excludeEnabledcontinue, limitsimulate, regex, outputFormat, dateFormat, columnsclearFileBeforeAppend, file, appendencoding, encoding Output formats: 1 - planfindReplace, 999 - last build results getBranchListfindReplaceRegex getProjectList - Get a list of branches for a plan withprojects. Projects are selected based on regex filtering on branchproject namekey or short name. Required parameters: plan Optional parameters: limit, regex, columns, file, append, encoding, getArtifactDefinitionListcolumns getPlanList - ExperimentalGet a -list onlyof thoseplans availablefor toa beproject artifactwith dependenciesregex infiltering theon lastplan job!key Getor aname. listUse of@all sharedfor artifactproject definitionsto forget a planlist withof regexplans filteringacross onall artifact nameprojects. Required parameters: planproject Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding getRepositoryList Output formats: 1 - plan, 999 - last build results getBranchList - Get a list of globalbranches for ora plan repositories with regex filtering on repository branch name or short name. OptionalRequired parameters: plan Optional parameters: limit, regex, columns, file, append, encoding getArtifactDefinitionList - getNotificationListExperimental - only EAPthose (subjectavailable to change). be artifact dependencies in the last job! Get a list of shared artifact definitions for a plan notifications with regex filtering on artifact name. Required parameters: plan Optional parameters: plan limit, regex, columns, file, append, encoding getVariableListgetRepositoryList - Get a list of global or plan variablesrepositories basedwith on regex filtering ofon variablerepository namesname. Optional parameters: plan, regex, file, append, encoding getBuildListgetNotificationList - EAP (subject to change). Get a list of buildplan reultsnotifications. Build resultsOptional can be 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: 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 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: build 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 Optional parameters: regex, file, attribute, columns getJobList - Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired. Required parameters: plan Optional parameters: stage, regex, file, attribute, columns getTaskList - Get a list of tasks for a job with regex filtering on task name. Required parameters: plan, job Optional parameters: limit, regex, file, columns getAgentList - Get a list of agents based on regex filtering of agent names.. Optional parameters: regex, file, append, encoding, columns Output formats: 1 - basic, 2 - detail queueBuildgetDeploymentProjectList - Experimental. QueueGet a buildlist toof run.deployment Ifprojects waitbased ison specified,regex thefiltering actionof willproject notnames. complete untilOptional theparameters: queuedregex, buildfile, completesappend, orencoding, thecolumns timeoutgetEnvironmentList period- elapsesExperimental. TheGet actiona willlist failof ifenvironments thefor builda failsdeployment unlessproject continuebased parameteron isregex usedfiltering toof ignoreenvironment anames. failed result.Required Aparameters: specificdeploymentProject revision canOptional beparameters: builtregex, iffile, theappend, revisionencoding, parametercolumns isqueueBuild specified.- PlanQueue variablesa canbuild beto setrun. usingIf thewait fieldis andspecified, value parameters. 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: branch, revision, wait, 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. 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 only. 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 addStageaddBranch - Add a stagebranch to a plan. The Required parameters: plan, stage Optional parameters: description, manual removeStage - Remove a stage from a plan. Use id = -1 to remove all stages. Use continue to ignore not found errorsplan 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, stage or idbranch Optional parameters: continue addJobname, description, enable removeBranch - AddRemoves a jobbranch tofrom a stageplan. Required parameters: plan, stage,branch jobgetBranch - OptionalGet parameters:information name,for description,a disable enableJob - Enable a job to runbranch to a plan. Branch can be either the short or long name of the branch. Required parameters: plan, job disableJobbranch Optional parameters: file, encoding addStage - DisableAdd a stage jobto froma runningplan. Required parameters: plan, jobstage setJobOptions -Optional Setparameters: miscellaneousdescription, optionmanual forgetStage a- job.Get Theplan followingstage optionsinformation. are specificallyRequired supportedparameters: cleanplan, workingstage directoryupdateStage after- jobUpdate completesstage (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 requesteddetails. Required parameters: plan, stage Optional parameters: name, description, manual, automatic removeStage - Remove a stage from a plan. Use id = -1 to remove all stages. Use continue to ignore not found errors. Required parameters: plan, jobstage or id Optional parameters: cleanAfter, regex, labels getArtifactcontinue addJob - DownloadAdd a copyjob ofto a build artifact into a filestage. Required parameters: plan, stage, job Uses sameOptional parameters: andname, logicdescription, asdisable getArtifactListenableJob for- identifyingEnable builda result artifactsjob to searchrun. ForRequired artifactsparameters: thatplan, representjob adisableJob directory- (notDisable 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 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 verifyBuild - Verify build was successful. Required parameters: build Optional parameters: number getLatestBuildNumber - Get the number of the last completed build for this plan. Required parameters: plan addArtifact - Add an artifact definition to a job. Server instances only. Required parameters: plan, job, artifact, copyPattern Optional parameters: location, shared removeArtifact - Remove an artifact definition from a job. Server instances only. Required parameters: plan, job, artifact addArtifactDependency - Add an artifact dependency to a job. Artifact must be a shared artifact from another job. Required parameters: plan, job, artifact, location 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: numberdisable, expandfinal, filefields, verifyBuildfield1, -value1, Verifyfield2, buildvalue2, was successful. Required parameters: build Optional parameters: number getLatestBuildNumber - Get the number of the last completed build for this plan. Required parameters: plan addArtifact - Add an artifact definition to a job. Server instances onlyfield3, 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, artifact, copyPatternid Optional parameters: location, shared removeArtifact enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeTask - Remove ana artifact definitiontask from a plan job. Server instances only Use id = -1 to remove all tasks. Required parameters: plan, job, artifactid addArtifactDependencymoveTask - 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 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, id Optional parameters: children,after fields,or field1before, value1,final field2,addRepository value2,- field3,Add value3,a field4,global value4,or field5, value5, field6, value6, field7, value7, field8, value8 addTask - Add a task to a plan job. A valid taskplan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: ANTBITBUCKET, ARTIFACTBITBUCKET_DOWNLOADCLOUD, CHECKOUT, CLI_BAMBOO, CLI_BITBUCKET, CLI_CONFLUENCESERVER, CLI_CRUCIBLESTASH, CLI_FISHEYEBCVS, CLI_HIPCHATGIT, CLI_JIRAGITHUB, CLI_SERVICE_DESKMERCURIAL, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACEPERFORCE, SUBVERSION Required parameters: plan,repository job,or taskKeyname Optional parameters: disableplan, repositoryKey, finalreplace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 updateTaskupdateRepository - Update a taskglobal in aor plan jobrepository. You must provide the same parameters as if you were creating the task. Required parameters: plan,repository job,or id Optional parameters: enable, disableplan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeTaskremoveRepository - Remove aglobal task fromor a plan jobrepository. Use id = -1@all to remove all tasks. Required parameters: plan, job, 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 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, id repository Optional parameters: plan orderRepository after- orOrder before,repository finalin addRepositorythe -list Addof arepositories globalfor ora plan. repository.Defaults Forto amove planthe repository, you can reference a linked (global) to the top to make it the default repository. Otherwise specify the aafter validrespository repositoryname. key orRequired aliasparameters: isplan, required.repository Valid aliasesOptional areparameters: BITBUCKET, BITBUCKET_CLOUD, BITBUCKET_SERVER, STASH, BCVS, GIT, GITHUB, MERCURIAL, PERFORCE, SUBVERSION after addRequirement - Add requirement to a plan job. Required parameters: repositoryplan, orjob, namerequirement Optional parameters: plantype, repositoryKey,value replace,updateRequirement fields,- field1,Update value1,a field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 updateRepository - Update a global or plan repositoryplan requirement. Required parameters: plan, job, id Optional parameters: type, value removeRequirement - Remove a plan requirement. Required parameters: repositoryplan, orjob, id addNotification - OptionalAdd parameters:a 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 variablesnotification. 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, event, recipientType Optional parameters: fields, planfield1, orderRepositoryvalue1, -field2, Ordervalue2, repositoryfield3, invalue3, thefield4, listvalue4, offield5, repositoriesvalue5, forfield6, a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository namevalue6, field7, value7, field8, value8 removeNotification - Remove a plan notification. Use id of -1 to remove all notifications for a plan. Required parameters: plan, repositoryid addVariables Optional- parameters:Add afterglobal addRequirementor -plan Addvariables. requirementDefaults to global variables unless a plan jobis specified. Use the Requiredfield parameters: plan,for job,the requirementvariable name Optionaland parameters:the type,corresponding value updateRequirementparameters -for Updatethe a plan requirement.variable values, RequiredOptional 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 available. Required parameters: plan, event, recipientType Optional parameters: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, 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 removeNotificationaddTrigger - 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,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. Required parameters: plan, name, type Optional parameters: planrepository, schedule, replaceipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 updateVariablesremoveTrigger - UpdateRemove existinga global or plan variables. Defaults to global variables unless trigger from a plan is specified. Use theid field= parameters-1 forto theremove variableall nametriggers. andServer theinstances corresponding value parameters for the variable values, Optionalonly. Required parameters: plan, fields,id field1,addAgent value1,- field2,Add value2,a field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 removeVariableslocal agent. Required parameters: agent Optional parameters: description removeAgent - Remove globalan oragent. plan variables.Required Specifyparameters: theagent variableenableAgent names- usingEnable thean field parametersagent. OptionalRequired parameters: plan,agent fields,disableAgent field1,- value1,Disable 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: stashTriggeran 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: planagent, name, typeassignment 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 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: plan, id addAgent - Add a local agent deploymentProject Optional parameters: continue addEnvironment - Experimental. Add an environment to deployment project. Required parameters: agent: deploymentProject, name Optional parameters: description removeAgentgetEnvironment - Remove Experimental. Get information for an agent.environment from Requireda parameters:deployment agentproject enableAgentby -name Enableor an agentid. Required parameters: agent disableAgent - Disable an agent.deploymentProject, environment RequiredOptional parameters: agent addAgentAssignmentfile, encoding removeEnvironment - 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 errorExperimental. Remove an environment from a deployment project by name or id. Required parameters: deploymentProject, environment Optional parameters: continue deployEnvironment - Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace. Required parameters: deploymentProject, agentenvironment, assignmentversion Optional parameters: continuebuild, removeAgentAssignmentnumber, -replace RemoveaddEnvironmentTask an- assignmentExperimental. fromAdd a specific agent. Use continuetask to ignorea notdeployment found errorenvironment. Required parameters: agentdeploymentProject, environment, assignmenttaskKey Optional parameters: continue description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |