Reference - 6.8.0
On this page
Related information for 6.8.0
Quick Tips
- To get all help from a command line use: --help
- To get help for any action, add --help to the action
- Example: --action getClientInfo --help
- More tips
Actions
|
Action |
Description |
Required Parameters |
Optional Parameters |
Output Formats |
Category |
Type |
---|---|---|---|---|---|---|---|
1 |
Add a local agent. |
|
Agents |
Create |
|||
2 |
Assign a project, plan, job, deployment project, or environment to a specific agent. This makes the agent dedicated to only perform builds for all assignments. If deployment or environment names are used instead of keys, type must be provided to indicate assignment represents a DEPLOYMENT_PROJECT or ENVIRONMENT. Use continue to ignore already exists error. |
|
Agent Assignments |
Create |
|||
3 |
Add an artifact definition to a job. |
|
Artifacts |
Create |
|||
4 |
Add an artifact dependency to a job. Artifact must be a shared artifact from another job. |
|
|
Artifacts |
Create |
||
5 |
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. |
|
Branches |
Create |
|||
6 |
Add a comment to a build. |
|
Comments |
Create |
|||
7 |
Experimental. Add an environment to deployment project. |
|
Deployment |
Create |
|||
8 |
Experimental. Add a task to a deployment environment. |
description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Deployment |
Create |
||
9 |
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. |
repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Deployment |
Create |
||
10 |
Add a job to a stage. |
|
Jobs |
Create |
|||
11 |
Add a comma separated list of labels to a build. |
|
Labels |
Create |
|||
12 |
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. |
recipient, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Notifications |
Create |
||
13 |
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 |
repository or name |
plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Repositories |
Create |
|
14 |
Add requirement to a plan job. |
|
Requirements |
Create |
|||
15 |
Add a stage to a plan. |
|
Stages |
Create |
|||
16 |
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 |
disable, final, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Tasks |
Create |
||
17 |
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. |
description, repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Triggers |
Create |
||
18 |
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. |
|
plan, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Variables |
Create |
|
19 |
Clone a plan. |
|
Plans |
Create |
|||
20 |
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. |
|
|
Projects |
Create |
||
21 |
Experimental. Create a deployment project for a plan. |
|
Deployment |
Create |
|||
22 |
Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. |
|
Plans |
Create |
|||
23 |
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. |
|
Plans |
Create |
|||
24 |
Experimental. Delete a deployment project by name or id. |
|
Deployment |
Delete |
|||
25 |
Delete a plan. |
|
|
Plans |
Delete |
||
26 |
Delete project and all project plans. |
|
Projects |
Delete |
|||
27 |
Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace. |
|
Deployment |
|
|||
28 |
Disable an agent. |
|
|
Agents |
Update |
||
29 |
Disable a job from running. |
|
|
Jobs |
Update |
||
30 |
Disable a plan from running. |
|
|
Plans |
Update |
||
31 |
Disable all project plans. |
|
|
Projects |
Update |
||
32 |
Enable an agent. |
|
|
Agents |
Update |
||
33 |
Enable a job to run. |
|
|
Jobs |
Update |
||
34 |
Enable a plan to run. |
|
|
Plans |
Update |
||
35 |
Enable all project plans. |
|
|
Projects |
Update |
||
36 |
Experimental. Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA (Bamboo 6.0 and higher). |
|
Plans |
Export |
|||
37 |
Get a list of assignments for agents with regex filtering on entity key or name. Specify an agent to filter by agent. Specify an assignment type to filter on type. Valid types are PROJECT, PLAN, JOB, DEPLOYMENT_PROJECT, ENVIRONMENT. |
|
|
Agent Assignments |
Get |
||
38 |
Get a list of agents based on regex filtering of agent names. |
|
1 - basic, 2 - detail |
Agents |
Get |
||
39 |
Download a copy of a build artifact into a file. |
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. |
job, number, replace, encoding |
Artifacts |
Get |
||
40 |
Get a list of artifact definitions for a plan with regex filtering on artifact name. |
|
Artifacts |
Get |
|||
41 |
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. |
|
Artifacts |
Get |
|||
42 |
Get information for a branch to a plan. Branch can be either the short or long name of the branch. |
|
Branches |
Get |
|||
43 |
Get a list of branches for a plan with regex filtering on branch name or short name. |
|
Branches |
Get |
|||
44 |
Get build result. |
|
Builds |
Get |
|||
45 |
Get a list of build results. 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. |
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 |
1 - basic, 2 - test information |
Builds |
Get |
||
46 |
Get a list of builds waiting in the build queue. Subset by project or build. |
|
|
Builds |
Get |
||
47 |
Get information about this client tool. |
|
1 - basic, 2 - JVM, 11 - action list, 12 - parameter list |
Info |
Get |
||
48 |
Get a list of comments for a build. |
|
Comments |
Get |
|||
49 |
Experimental. Get information for a deployment project by name or id. |
|
|
Deployment |
Get |
||
50 |
Experimental. Get a list of deployment projects based on regex filtering of project names. |
|
|
Deployment |
Get |
||
51 |
Experimental. Get information for an environment from a deployment project by name or id. |
|
Deployment |
Get |
|||
52 |
Experimental. Get a list of environments for a deployment project based on regex filtering of environment names. |
|
Deployment |
Get |
|||
53 |
Get job information. |
|
|
Jobs |
Get |
||
54 |
Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired. |
|
Jobs |
Get |
|||
55 |
Get a list of labels for a build. |
|
Labels |
Get |
|||
56 |
Get the number of the last completed build for this plan. |
|
|
Builds |
Get |
||
57 |
Get a list of plan notifications. |
|
|
Notifications |
Get |
||
58 |
Get plan information. |
|
|
Plans |
Get |
||
59 |
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. Advanced filtering based on state and date of the latest build for the plan is also available. See getBuildList for more information. |
favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
1 - plan, 999 - last build results |
Plans |
Get |
||
60 |
Get a list of projects. Projects are selected based on regex filtering on project key or name. |
|
|
Projects |
Get |
||
61 |
Get details of a global or plan repository. Sets the repository and repositoryId replacement variables. |
|
Repositories |
Get |
|||
62 |
Get a list of global or plan repositories with regex filtering on repository name. |
|
|
Repositories |
Get |
||
63 |
Get information about the Bamboo server. |
|
1 - basic, 2 - detail, 3 - state |
Info |
Get |
||
64 |
Get plan stage information. |
|
|
Stages |
Get |
||
65 |
Get a list of stages for a plan with regex filtering on stage name. |
|
Stages |
Get |
|||
66 |
Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job. |
|
|
Tasks |
Get |
||
67 |
Get a list of tasks for a job with regex filtering on task name. |
|
Tasks |
Get |
|||
68 |
Get a list of task types available with regex filtering on type name and description. |
|
Tasks |
Get |
|||
69 |
Get a list of global or plan variables based on regex filtering of variable names. |
|
|
Variables |
Get |
||
70 |
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 (plan) or (planName) replacement variables. Consider pausing the server to prevent activity during a move using the pauseServer action or specifying --options pause to have the action automatically pause the server and resume after the end of the operation. |
|
Plans |
|
|||
71 |
Change the position of a stage in a plan. |
|
|
Stages |
|
||
72 |
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. |
|
Tasks |
|
|||
73 |
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. |
|
Repositories |
|
|||
74 |
Pause the server to prevent builds from starting. |
|
|
|
Server |
Stop |
|
75 |
Queue a build to run. If wait is specified, the action will not complete until the queued build completes or the timeout period elapses. The action will fail if the build fails unless continue parameter is used to ignore a failed result. A specific revision can be built if the revision parameter is specified. Plan variables can be set using the field and value parameters. Conditional queueing is supported - see the documentation for details. |
branch, revision, wait, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Builds |
|
||
76 |
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. |
regex, limit, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Builds |
|
||
77 |
Remove an agent. |
|
|
Agents |
Delete |
||
78 |
Remove an assignment from a specific agent. Use continue to ignore not found error. |
|
Agent Assignments |
Delete |
|||
79 |
Remove an artifact definition from a job. |
|
|
Artifacts |
Delete |
||
80 |
Removes a branch from a plan. Use --branch @all to remove all branches from a plan. |
|
|
Branches |
Delete |
||
81 |
Experimental. Remove an environment from a deployment project by name or id. |
|
Deployment |
Delete |
|||
82 |
Remove a job from a plan. |
|
Jobs |
Delete |
|||
83 |
Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided |
|
Labels |
Delete |
|||
84 |
Remove a plan notification. Use id of -1 to remove all notifications for a plan. |
|
|
Notifications |
Delete |
||
85 |
Remove global or plan repository. Use @all to remove all repositories. |
repository or id |
|
Repositories |
Delete |
||
86 |
Remove a plan requirement. |
|
|
Requirements |
Delete |
||
87 |
Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors. |
|
Stages |
Delete |
|||
88 |
Remove a task from a plan job. Use --task @all to remove all tasks. |
|
|
Tasks |
Delete |
||
89 |
Remove a trigger from a plan. Use id = -1 to remove all triggers. |
|
|
Triggers |
Delete |
||
90 |
Remove global or plan variables. Specify the variable names using the field parameters. |
|
plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Variables |
Delete |
|
91 |
Render url based request. The response data modified by findReplace processing is returned. |
requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex |
|
Render |
Get |
||
92 |
Restart a build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results. |
|
Builds |
|
|||
93 |
Only useful in the context of a run script replacing an existing plan with createPlan. This will attempt to add agent assignments saved during createPlan and that are still valid. |
|
|
Agent Assignments |
Import |
||
94 |
Resume server to allow builds to be started. |
|
|
|
Server |
Start |
|
95 |
Run actions from a file or standard input. |
common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
Run |
Run |
||
96 |
Run actions for each agent assignment with filtering like getAgentAssignment. Available replacement variables are agent, agentId, assignment, assignmentId, and assignmentKey. |
|
agent, type, limit, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Agent Assignments |
Run |
|
97 |
Run actions for each agent with regex filtering on agent name. Available replacement variables are agent and agentId. |
|
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Agents |
Run |
|
98 |
Run actions generated from a CSV file. |
common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
CSV |
Run |
||
99 |
Experimental. Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables are deploymentProject and deploymentProjectId. |
|
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Deployment |
Run |
|
100 |
Experimental. Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables are environment and environmentId. |
|
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Deployment |
Run |
|
101 |
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. |
stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Jobs |
Run |
||
102 |
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. |
list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
Run |
Run |
||
103 |
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. See getPlanList for all filtering capabilities. Available replacement variables are project, projectName, plan, and planName. |
favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Plans |
Run |
||
104 |
Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName. |
|
regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Projects |
Run |
|
105 |
Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId. |
|
plan, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Repositories |
Run |
|
106 |
Run actions generated by SQL provided by the sql parameter, a file, or standard input |
common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex |
|
SQL |
Run |
||
107 |
Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName. |
stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex |
|
Stages |
Run |
||
108 |
Set child dependencies and other related options. |
children, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Options |
Update |
||
109 |
Set the plan as a favorite. |
|
|
Plans |
Update |
||
110 |
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. |
|
Jobs |
Update |
|||
111 |
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. |
|
Builds |
|
|||
112 |
Remove the plan from the favorite list. |
|
|
Plans |
|
||
113 |
Update a plans name or description. Provide a 2-part plan key where the first part is the project key. |
|
Plans |
Update |
|||
114 |
Update a global or plan repository. |
repository or id |
plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Repositories |
Update |
|
115 |
Update a plan requirement. |
|
Requirements |
Update |
|||
116 |
Update stage details. |
|
Stages |
Update |
|||
117 |
Update a task in a plan job. You must provide the same parameters as if you were creating the task. |
enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Tasks |
Update |
||
118 |
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. Use append to add text to an existing variable. |
|
plan, append, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8 |
|
Variables |
Update |
|
119 |
Validates the CLI Connector is enabled and licensed on the server. |
|
|
|
Misc |
Check |
|
120 |
Verify build was successful. |
|
Builds |
|
Parameters
|
Parameter |
Short |
Value |
Description |
---|---|---|---|---|
1 |
|
|
Content type to accept for renderRequest if different than type. |
|
2 |
a |
|
Requested operation to perform. Valid actions are listed at the end. |
|
3 |
|
|
Used in orderRepository to name the repository after which the repository will be positioned. Similarly for moveTask where it represent the name or id of the task. Similarly for moveStage where it represent the name of the stage. |
|
4 |
|
|
SQL to run after a successful action. Limited to specific actions at this time. |
|
5 |
|
|
Agent name. |
|
6 |
|
|
API version. Some requests produce different results based on the api version used. |
|
7 |
|
|
Append to existing varaibles on updateVariables. For some actions using the file parameter, append will append output to the existing file. |
|
8 |
|
|
Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory. |
|
9 |
|
|
Key used to identify a project, plan, job, deployment proejct, or environment to be assigned to a specific agent. This makes the agent dedicated to only perform builds for all assignments. Examples: XXX, XXX-DEF, XXX-DEF-JOB1, Deployment for XXX-DEF, Deployment for XXX-DEF:QA, 77857004-77955436 |
|
10 |
|
|
Attribute to list. |
|
11 |
|
|
Indicate that a stage be run automatically. |
|
12 |
|
|
Before task name or id. |
|
13 |
|
|
Branch name. |
|
14 |
|
|
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 |
|
15 |
|
|
Comma separated list of plan keys that represent child plan dependencies. |
|
16 |
|
|
Clean working directory after each job completes. Use on setJobOptions. |
|
17 |
|
|
For run actions, this option will automatically clear an existing file on the first append requested. |
|
18 |
|
|
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. |
|
19 |
|
|
Comment text. |
|
20 |
|
|
Common parameter string added to all run actions. |
|
21 |
|
|
Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite. |
|
22 |
|
|
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. |
|
23 |
|
|
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. |
|
24 |
|
|
Copy pattern for an artifact definition. |
|
25 |
|
|
Database name is required for SQL actions. |
|
26 |
|
|
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. |
|
27 |
|
|
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. |
|
28 |
|
|
Database table needs to be created before adding rows. |
|
29 |
|
|
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
|
|
30 |
|
|
Database user password. Defaults to password. |
|
31 |
|
|
Database table name when creating or updating a database from list output. |
|
32 |
|
|
Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table. |
|
33 |
|
|
Database user name. Defaults to user. |
|
34 |
|
|
Requests detail debug output. Optional for all actions. |
|
35 |
|
|
Deployment project name or id. |
|
36 |
|
|
Description for entity. |
|
37 |
|
|
Disable an entity for those entities like plans, stages, jobs, and tasks. |
|
38 |
|
|
JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions. |
|
39 |
|
|
Enable an entity when updating. |
|
40 |
|
|
Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform. |
|
41 |
|
|
Deployment environment name or id. |
|
42 |
|
|
Event alias or key. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains |
|
43 |
|
|
Filter out entries that are disabled. |
|
44 |
|
|
Filter out entries that are enabled. |
|
45 |
|
|
Expanded request information to obtain more detailed data on request. |
|
46 |
|
|
Subset to favorites. Same as favourite. |
|
47 |
|
|
Subset to favourites. Same as favorite. |
|
48 |
|
|
Use to set construct specific fields or variables using field=value syntax. The first equal sign (=) delineates the field name from it's value. Multiple field parameters can be provided. This provides a more convenient and expandable way to set fields as an alternative to the fields and numbered field parameters. Values are trimmed unless single quoted and single quoted strings will have single quotes removed. |
|
49 |
|
|
Construct specific field or variable name. Value is specified by the value1 parameter. |
|
50 |
|
|
Construct specific field or variable name. Value is specified by the value2 parameter. |
|
51 |
|
|
Construct specific field or variable name. Value is specified by the value3 parameter. |
|
52 |
|
|
Construct specific field or variable name. Value is specified by the value4 parameter. |
|
53 |
|
|
Construct specific field or variable name. Value is specified by the value5 parameter. |
|
54 |
|
|
Construct specific field or variable name. Value is specified by the value6 parameter. |
|
55 |
|
|
Construct specific field or variable name. Value is specified by the value7 parameter. |
|
56 |
|
|
Construct specific field or variable name. Value is specified by the value8 parameter. |
|
57 |
|
|
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. |
|
58 |
f |
|
Path to file based content or result output. Use - for standard input. |
|
59 |
|
|
Make a final task. |
|
60 |
|
|
Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped. |
|
61 |
|
|
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. |
|
62 |
|
|
Prints this help message. |
|
63 |
|
|
Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided. |
|
64 |
|
|
Stage or task id. |
|
65 |
|
|
Comma separated list of IP addresses to restrict ability to remotely trigger builds. |
|
66 |
|
|
Comma separated list of JIRA issue keys. |
|
67 |
|
|
Job key. Example: JOB1 |
|
68 |
|
|
Comma or blank separated list of labels. |
|
69 |
|
|
Maximum number of entries to return. |
|
70 |
|
|
Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. |
|
71 |
|
|
Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled. |
|
72 |
|
|
Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency. |
|
73 |
|
|
Indicate that a stage be run manually. |
|
74 |
|
|
Name of entity, like plan name. |
|
75 |
|
|
Build number. Defaults to latest. |
|
76 |
|
|
Comma separated list of support, experimental, or other client or action specific options. |
|
77 |
|
|
Specify output format for an action. |
|
78 |
p |
|
User password for remote access. |
|
79 |
|
|
Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF |
|
80 |
|
|
Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided. |
|
81 |
|
|
Project key. Example: XXX |
|
82 |
|
|
Project name. |
|
83 |
|
|
Property file with database parameters, field mappings, or client specific information. |
|
84 |
|
|
Limit some output messages. Optional for all actions. |
|
85 |
|
|
Recipient value for add notifications. Many recipient types need a primary recipient value. This parameter can be used instead of setting a recipient type specific field and value. |
|
86 |
|
|
Recipient type alias or key. Add-ons provide recipient types identified by key. Example key: com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat |
|
87 |
|
|
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. |
|
88 |
|
|
Regular expression for list filtering and similar. Also for pattern match labelling. |
|
89 |
|
|
Replace existing entity on add, create, or similar actions. |
|
90 |
|
|
Name of a repository. In some cases, a comma separated list of repository names. |
|
91 |
|
|
Repository key that uniquely identifies the repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg |
|
92 |
|
|
URL fragment for a request. |
|
93 |
|
|
URL request parameters or post data. |
|
94 |
|
|
Type of a render request like GET or POST |
|
95 |
|
|
Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant. |
|
96 |
|
|
Revision id or tag. |
|
97 |
|
|
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. |
|
98 |
|
|
Comma or blank separated list of labels used for search. |
|
99 |
s |
|
Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser. |
|
100 |
|
|
Service address extension. |
|
101 |
|
|
For an artifact definition, makes the artifact available for other builds. |
|
102 |
|
|
Simulate running actions. Log the action that would be taken. |
|
103 |
|
|
Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters. |
|
104 |
|
|
SQL select statement used to generate a run script. |
|
105 |
|
|
Stage name. |
|
106 |
|
|
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. |
|
107 |
|
|
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. |
|
108 |
|
|
Wait timeout in seconds. Use -1 to wait forever. |
|
109 |
|
|
Plan key to be created. Example: XXX-DEF |
|
110 |
|
|
Project key to clone to. |
|
111 |
|
|
Requirement match type. Values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger. |
|
112 |
|
|
Action specific setting. Example: Database access url for SQL actions. Optional when host is provided. |
|
113 |
u |
|
User name for remote access. |
|
114 |
|
|
Requirement match value. |
|
115 |
|
|
Value corresponding to the field1 parameter name. |
|
116 |
|
|
Value corresponding to the field2 parameter name. |
|
117 |
|
|
Value corresponding to the field3 parameter name. |
|
118 |
|
|
Value corresponding to the field4 parameter name. |
|
119 |
|
|
Value corresponding to the field5 parameter name. |
|
120 |
|
|
Value corresponding to the field6 parameter name. |
|
121 |
|
|
Value corresponding to the field7 parameter name. |
|
122 |
|
|
Value corresponding to the field8 parameter name. |
|
123 |
|
|
Requests verbose output to help with problem determination. Optional for all actions. |
|
124 |
|
|
Version name for deployment. |
|
125 |
|
|
Wait for action to complete. |
Parameter Tips
Common parameters
A few common parameters are available that are not specifically listed as optional parameters for each action: help, verbose, debug, quiet, special, dateFormat, dateFormat2, and outputType. Similarly for database related parameters that are optional for all get list actions: url, dbUser, dbPassword, database, driver, dbJar, host, port, dbCreateTable, dbTable, dbTableKeys, afterSql, and propertyFile.
Tips
- To get help for a specific action, type the action followed by --help - example: --action getProjectList --help
- Use double dash for multi-letter parameters - example: --help
- Use single dash for single letter parameters indicated in the Short column in parameter help - example: -v
- When parameters are specified, most need a value as indicated by a check in the Value column in parameter help - example: --action addPage
- Some parameters are flags (boolean) and must not be followed by a value - example: --verbose
- Parameter names are case sensitive, but, action values are not - example: --userid is invalid but --action addpage is equivalent to --action addPage
- An incorrect case parameter will result in an unknown parameter error and show action help with correctly cased parameter (9.8 or higher)
- Some parameters become required once a specific action is chosen. This is indicated in the action help text as required.
- Some parameters have both short (one letter) and long (more than one letter) parameter names - example: -a or --action are the same and cannot both be specified
- Some parameters have default values, if so, they are indicated in the help text
- Values that contain blanks or some special characters (platform specific) must be enclosed by double quotes - example: --title "this is my title"
- Quoting rules in commands can vary by terminal environment:
- Windows command terminals or run action scripts for all platforms: embedded double quotes within a double quoted string must be escaped by doubling the double quote - example: –common "-a addComment --comment ""This is an example of a double quoted string inside a double quote"" "
- Linux and Mac/OSX command terminals require standard Linux style escaping: embedded double quotes within a double quoted string can be escaped with a \ - example: –common " -a addComment --comment \"This is an example of a double quoted string inside a double quote\" "
- Run CLI Actions usage: embedded double quotes within a double quoted string can be escaped by doubling the double quote (first example above)
- A single quote sometimes can used in place of a double quotes on some command terminal environments - example: –common '-a addComment --comment "This is an example of a double quoted string inside a double quote" '
- Some parameters allow entry of a comma separated list of values, values containing a comma must be enclosed in single quotes - example: --custom "'first:a,b,c', second:x". Embedded single quotes within a quoted string must be doubled
- Some text fields support the automatic conversion of " \n " (blanks are significant) to be replaced with a new line character - example: --description "A multi-line text field: \n # line 1 \n # line 2"
Special parameter
Some special characters are difficult to deal with or make action text very complicated. This is because they have special meaning in either the OS command terminal handling, the tool's command line parsing, or the tool's use of separators (like comma or colon separated lists). As a convenience to avoid some of these nasty situations, a special parameter was implemented to allow alternate characters to be used instead of (or in addition to) the problematic characters within parameter values. The choice of what special characters to use depends on the content so that you do not have conflicts with intended content. The special parameter works by the user providing a order specific alternate character. The alternative character is replaced with the real character after all other parsing occurs. It is implemented for many action parameters that are problematic in this area. Not all situations are covered, but, that will improve as other use cases are identified.
Position | Character | Character name | Suggested alternate | Usage |
---|---|---|---|---|
1 | , | comma | Some parameters use comma separated lists. | |
2 | : | colon | # | Some parameters use colon separated values. |
3 | @ | at sign | Replacement variables syntax: @...@. | |
4 | ' | single quote | Used in separated lists to cover cases where content contains separator. | |
5 | " | double quote | ~ | Parameters containing blanks. |
6 | ^ | caret | Substitution double quote indicator: ^^...^^. See ACLI-673 for details. |
A blank in any position is ignored (no alternate provided).
Example: –special " # ~" provides alternates for colon and double quote.
--common "--findReplace ~something to find containing a : (colon)#replacement~"
Character Set
User and password values should be in the ISO-8859-1 character set. Also avoid characters that require escaping on your OS command terminal. Non standard characters will result in an authorization error similar to: User is not authorized to perform the request.
Log a request with our support team.
Confluence®, Jira®, Atlassian Bamboo®, Bitbucket®, Fisheye®, and Atlassian Crucible® are registered trademarks of Atlassian®
Copyright © 2005 - 2024 Appfire | All rights reserved. Appfire™, the 'Apps for makers™' slogan and Bob Swift Atlassian Apps™ are all trademarks of Appfire Technologies, LLC.