Related information for 8.1.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	Category	Type
1	addAgent	Add a local agent.	agent	description, continue	Agents	Create
2	addAgentAssignment	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. Use --options autoAgent to automatically create a local agent if it does not already exist.	agent, assignment	type, options, continue	Agent Assignments	Create
3	addApplicationLink	Add an application link to another application. By default, both incoming and outgoing links are enabled and configured without impersonation (users are not shared). Use the options parameter to customize the behavior. Use '--options impersonate' to enable shared users. Other examples are '--options disableIncoming' and '--options disableOutgoing'. If another link of the same type already exists as primary, use '--options primary' to force the new link to be primary instead.	url	name, options, continue	Links	Create
4	addArtifact	Add an artifact definition to a job.	plan, job, artifact, copyPattern	location, shared	Artifacts	Create
5	addArtifactDependency	Add an artifact dependency to a job. Artifact must be a shared artifact from another job.	plan, job, artifact, location		Artifacts	Create
6	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.	plan, branch	name, description, enable, continue	Branches	Create
7	addCapability	Add a shared or agent specific server capability.	type	agent, name, value, field, fields, field1, value1, field2, value2		Create
8	addComment	Add a comment to a build.	build, comment	number, findReplace, findReplaceRegex, input, file, encoding	Comments	Create
9	addCredentials	Add SSH, AWS, or user based credentials. For SSH, provide a file with the SSH private key. For AWS, provide an access key and secret.	credentials, userId or file or accessKeyId and accessKey	userPassword, sshParaphrase, accessKey, replace		Create
10	addEnvironment	Add an environment to deployment project. Available replacement variables: environment, environmentId.	deploymentProject, name	description	Deployment	Create
11	addEnvironmentNotification	Add a notification to a deployment environment. 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.	deploymentProject, environment, event, recipientType	recipient, field, fields, field1, value1, field2, value2	Deployment	Create
12	addEnvironmentRequirement	Add a requirement to a deployment environment.	deploymentProject, environment, requirement	type, value	Deployment	Create
13	addEnvironmentTask	Add a task to a deployment environment.	deploymentProject, environment, taskKey	description, field, fields, field1, value1, field2, value2	Deployment	Create
14	addEnvironmentTrigger	Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage, afterSuccessfulPlan, afterSuccessfulDeployment. 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.	deploymentProject, name, type	repository, branch, schedule, ipRestriction, triggeringEnvironment, disable, field, fields, field1, value1, field2, value2	Deployment	Create
15	addEnvironmentVariables	Add deployment environment variables. Use the field parameters for the variable name and the corresponding value parameters for the variable values.	deploymentProject, environment	replace, field, fields, field1, value1, field2, value2	Deployment	Create
16	addGroup	Add a new group.	group	continue	Groups	Create
17	addJob	Add a job to a stage. Available replacement variables: job, jobName.	plan, stage, job	name, description, disable	Jobs	Create
18	addLabels	Add a comma separated list of labels to a build or plan.	build or plan, labels	number	Labels	Create
19	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.	plan, event, recipientType	recipient, field, fields, field1, value1, field2, value2	Notifications	Create
20	addRepository	Add a global or plan repository. If both a name and repository are provided, the name will be used for the Bamboo name and repository will be used for the Bitbucket reposiotry. 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. If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories.	repository or name	plan, repositoryKey, credentials, type, branch, continue, replace, field, fields, field1, value1, field2, value2	Repositories	Create
21	addRequirement	Add requirement to a plan job. Type defaults to EXISTS.	plan, job, requirement	type, value	Requirements	Create
22	addStage	Add a stage to a plan. Available replacement variables: stage.	plan, stage	description, manual	Stages	Create
23	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, MAVEN_POM_EXTRACTOR, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE Available replacement variables: taskId.	plan, job, taskKey	disable, final, field, fields, field1, value1, field2, value2	Tasks	Create
24	addTrigger	Add a trigger to a plan. Pre-defined types are: polling, remote, remoteBitbucketServer, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories or custom types. 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. Available replacement variables: triggerId.	plan, type	description, repository, schedule, passingPlans, ipRestriction, disable, field, fields, field1, value1, field2, value2	Triggers	Create
25	addUser	Add a new user. User can be added to a group (or groups) using the group parameter.	userId, userEmail, group	userFullName, userPassword, continue	Users	Create
26	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.		plan, replace, findReplace, findReplaceRegex, field, fields, field1, value1, field2, value2	Variables	Create
27	cloneEnvironment	Clone an environment within a deployment project. Available replacement variables: environment, environmentId.	deploymentProject, environment, name	description	Deployment	Create
28	clonePlan	Clone a plan. The disable parameter is deprecated and no longer works on Bamboo 6.4 or higher. Available replacement variables: project,plan.	plan, toPlan, name	description, projectName	Plans	Create
29	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.	project, toProject, projectName, disable		Projects	Create
30	createDeploymentProject	Create a deployment project for a plan. Available replacement variables: deploymentProject, deploymentProjectId.	plan, name	description, branch	Deployment	Create
31	createOrUpdatePlan	Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. Available replacement variables: project, plan.	plan	name, projectName, description, disable	Plans	Create
32	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. Available replacement variables: project, plan.	plan	name, projectName, description, disable, replace, continue	Plans	Create
33	createProject	Bamboo 6.2 and higher. Create a new project.	project	name, description	Projects	Create
34	deleteDeploymentProject	Delete a deployment project by name or id.	deploymentProject	continue	Deployment	Delete
35	deletePlan	Delete a plan.	plan		Plans	Delete
36	deleteProject	Delete project and all project plans.	project	file	Projects	Delete
37	deployEnvironment	Deploy environment. To promote (re-deploy) an existing version, use --replace.	deploymentProject, environment, version	build, number, replace, wait, timeout	Deployment
38	disableAgent	Disable an agent.	agent		Agents	Update
39	disableJob	Disable a job from running. Use @all for job to disable all jobs in a stage.	plan, job	stage	Jobs	Update
40	disablePlan	Disable a plan from running.	plan		Plans	Update
41	disableProject	Disable all project plans.	project		Projects	Update
42	enableAgent	Enable an agent.	agent		Agents	Update
43	enableJob	Enable a job to run. Use @all for job to enable all jobs in a stage.	plan, job	stage	Jobs	Update
44	enablePlan	Enable a plan to run.	plan		Plans	Update
45	enableProject	Enable all project plans.	project		Projects	Update
46	exportDeploymentProject	Export a deployment project to source that can be used for deployment project creation.	deploymentProject	file, encoding, dateFormat	Deployment	Export
47	exportEnvironment	Export an environment for a deployment project to source.	deploymentProject, environment	file, encoding, dateFormat	Deployment	Export
48	exportJob	Export a job to CLI source.	plan, job	file, encoding, dateFormat	Jobs	Export
49	exportPlan	Export a plan to source that can be used for plan creation. Valid export types are CLI, JAVA.	plan	type, file, encoding, dateFormat	Plans	Export
50	exportSite	Export site to the exports directory in the home directory. By default, only the configuration is exported. Set appropriate options parameters to export additional data: exportResults, exportArtifacts, exportBuildLogs. Use the name parameter to set the file name, otherwise it will be automatically generated based on the date of the export using the date format requested.		name, options		Export
51	getAgentAssignmentList	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, type, limit, regex, file, append, encoding, columns	Agent Assignments	Get
52	getAgentList	Get a list of agents based on regex filtering of agent names. Available output formats: 1 - basic, 999 - all.		excludeEnabled, excludeDisabled, limit, regex, file, append, encoding, columns	Agents	Get
53	getApplicationLink	Get information for an application link identified by name or url. Available replacement variables: applicationLinkId.	name or url		Links	Get
54	getApplicationLinkList	Get list of a application links with optional filtering on application type and regex filtering on the name or url. Use '--options excludeSystemLinks' to exclude system defined links. Example types: jira, confluence. Available output formats: 1 - basic, 2 - status, 999 - all.		type, options, limit, regex, outputFormat, file, append, columns, encoding	Links	Get
55	getArtifact	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.	plan or build, artifact, file	job, number, replace, encoding	Artifacts	Get
56	getArtifactDefinitionList	Get a list of artifact definitions for a plan with regex filtering on artifact name.	plan	limit, regex, columns, file, append, encoding	Artifacts	Get
57	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.	plan or build	job, number, limit, regex, file, append, encoding	Artifacts	Get
58	getBranch	Get information for a branch to a plan. Branch can be either the short or long name of the branch.	plan, branch	file, encoding	Branches	Get
59	getBranchList	Get a list of branches for a plan with regex filtering on branch name, short name, or full key.	plan	limit, regex, columns, file, append, encoding	Branches	Get
60	getBranchingOptions	Get branching options for a plan.	plan	file, encoding	Branches	Get
61	getBuild	Get build result.	build	number, file, encoding	Builds	Get
62	getBuildList	Get a list of build results. Build results can be filtered by using fields and values. Supported fields are state, notState, started, endedBefore. 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. Available output formats: 1 - basic, 999 - test information and other details.	plan	labels, issues, limit, columns, file, append, encoding, field, fields, field1, value1, field2, value2	Builds	Get
63	getBuildQueueList	Get a list of builds waiting in the build queue. Subset by project or build.		project, build, file, append, encoding, columns	Builds	Get
64	getCapabilityList	Get a list of shared or agent specific capabilities with regex filtering on capability key or name (label). Use @all for agent to get shared and agent specific capabilities. Specify --options includeUnreferenced to include unreferenced server capabilities keys known to the system.		agent, options, regex, options, limit, file, append, encoding	Lists	Get
65	getClientInfo	Get information about this client tool. Available output formats: 1 - basic, 2 - JVM, 11 - action list, 12 - parameter list.		outputFormat, outputType, file, append, encoding	Info	Get
66	getCommentList	Get a list of comments for a build.	build	number, file, append, encoding, columns	Comments	Get
67	getCredentialsList	Get a list of credentials based on regex filtering of credentials name.		regex, limit, file, append, encoding	Lists	Get
68	getDeploymentProject	Get information for a deployment project by name or id.	deploymentProject		Deployment	Get
69	getDeploymentProjectList	Get a list of deployment projects based on regex filtering of project names.		regex, file, append, encoding, columns	Deployment	Get
70	getEnvironment	Get information for an environment from a deployment project by name or id.	deploymentProject, environment	file, encoding	Deployment	Get
71	getEnvironmentList	Get a list of environments for a deployment project based on regex filtering of environment names.	deploymentProject	regex, file, append, encoding, columns	Deployment	Get
72	getEnvironmentNotificationList	Get a list of environment notifications.	deploymentProject, environment	file, append, encoding	Deployment	Get
73	getEnvironmentRequirementList	Get a list of deployment environment requirements based on regex filtering of requirement names.	deploymentProject, environment	regex, limit, file, append, encoding	Deployment	Get
74	getEnvironmentTaskList	Get a list of tasks for a deployment environments with regex filtering of task name or description.	deploymentProject, environment	regex, file, append, encoding, columns	Deployment	Get
75	getEnvironmentTrigger	Get information for a deployment environment trigger.	deploymentProject, environment, id or name	file, encoding	Deployment	Get
76	getEnvironmentTriggerList	Get a list of environment triggers for a deployment environment based on regex filtering of trigger names or descriptions.	deploymentProject, environment	regex, file, append, encoding, columns	Deployment	Get
77	getEnvironmentVariableList	Get a list of deployment environment variables based on regex filtering of variable names.	deploymentProject, environment	regex, limit, file, append, encoding	Deployment	Get
78	getJob	Get job information.	plan, job		Jobs	Get
79	getJobList	Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.	plan	stage, limit, regex, file, columns	Jobs	Get
80	getLabelList	Get a list of labels for a build or plan.	build or plan	number, file, append, encoding, columns	Labels	Get
81	getLatestBuildNumber	Get the number of the last completed build for this plan.	plan		Builds	Get
82	getNotificationList	Get a list of plan notifications.	plan	file, regex, append, encoding	Notifications	Get
83	getPlan	Get plan information.	plan		Plans	Get
84	getPlanList	Get a list of plans for a project with regex filtering on plan key or name. Additionally, use labels parameter to filter by labels. Use @all for project to get a list of plans across all projects. To also include branch plans in the list, use --options "includeBranchPlans". Advanced filtering based on state and date of the latest build for the plan is also available. See getBuildList for more information. Advanced filtering based on using a repository is also possible using --options "usingRepository=xxx". Available output formats: 1 - plan, 999 - last build results.	project	favorite, excludeDisabled, excludeEnabled, labels, options, limit, regex, outputFormat, dateFormat, columns, file, append, encoding, field, fields, field1, value1, field2, value2	Plans	Get
85	getProjectList	Get a list of projects. Projects are selected based on regex filtering on project key or name.		regex, file, append, encoding, columns	Projects	Get
86	getRepository	Get details of a global or plan repository. Available replacement variables: repository, repositoryId. Available output formats: 1 - basic, 999 - all.	repository	plan	Repositories	Get
87	getRepositoryList	Get a list of global or plan repositories with regex filtering on repository name.		plan, regex, file, append, encoding	Repositories	Get
88	getRequirementList	Get a list of requirements for a job with regex filtering on requirement name.	plan, job, id	limit, regex, file, append, encoding, columns	Requirements	Get
89	getServerInfo	Get information about the Bamboo server. Available output formats: 1 - basic, 2 - detail, 3 - state, 999 - all.		outputFormat, dateFormat, file, append, encoding	Info	Get
90	getStage	Get plan stage information.	plan, stage		Stages	Get
91	getStageList	Get a list of stages for a plan with regex filtering on stage name.	plan	regex, file, columns	Stages	Get
92	getTask	Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job.	plan, job, task or id		Tasks	Get
93	getTaskList	Get a list of tasks for a job with regex filtering on task name.	plan, job	limit, regex, file, columns	Tasks	Get
94	getTaskTypeList	Get a list of task types available with regex filtering on type name and description.	plan, job	limit, regex, file, columns	Tasks	Get
95	getTrigger	Get information for a plan trigger.	plan, id or name	file, encoding	Triggers	Get
96	getTriggerList	Get a list of triggers for a job based on regex filtering of trigger names or descriptions.	plan, job	regex, file, append, encoding, columns	Triggers	Get
97	getUserList	Get list of a users with regex filtering on the userId or name.		limit, regex, file, append, columns, encoding	Users	Get
98	getVariableList	Get a list of global or plan variables based on regex filtering of variable names. The optional reference parameter can be used to set a CLI replacement variable for each variable with name prefixed by the reference parameter. Use 'bamboo.' to make references look similar to how bamboo variables are used.		plan, regex, reference, file, append, encoding	Variables	Get
99	moveEnvironment	Move an environment after or before another environment identified by name or id. If neither before or after are specified, the environment will be moved to the top. Use --after @last to move environment to the last position. After parameter takes precedence.	deploymentProject, environment	after, before	Deployment
100	movePlans	Move one or more plans from one project to another project (existing or new) with filtering similar to getPlanList. 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.	project or plan, toProject	toPlan, name, excludeEnabled, excludeDisabled, labels, options, limit, regex	Plans
101	moveStage	Change the position of a stage in a plan to be after another stage or, by default, to the top.	plan, stage	after	Stages
102	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.	plan, job, task or id	after, before, final	Tasks
103	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.	plan, repository	after	Repositories
104	pauseServer	Pause the server to prevent builds from starting.			Server	Stop
105	queueBuild	Queue a build to run. If a build number is provided (number parameter or 3 part build key), an existing failed or incomplete build can be restarted. 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.	plan or build	branch, revision, number, wait, continue, timeout, dateFormat, field, fields, field1, value1, field2, value2	Builds
106	queueBuildFromList	Queue multiple builds to run and wait for results. Plans can be filtered by using the labels parameter. Project can be @all. 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.	project or list	labels, regex, limit, continue, simulate, timeout, dateFormat, field, fields, field1, value1, field2, value2	Builds
107	removeAgent	Remove an agent.	agent	continue	Agents	Delete
108	removeAgentAssignment	Remove an assignment from a specific agent. Use continue to ignore not found error.	agent, assignment	type, continue	Agent Assignments	Delete
109	removeApplicationLink	Remove an application link identified by name or url.	name or url	continue	Links	Delete
110	removeArtifact	Remove an artifact definition from a job.	plan, job, artifact		Artifacts	Delete
111	removeBranch	Removes a branch from a plan. Use --branch @all to remove all branches from a plan.	plan, branch		Branches	Delete
112	removeBuildHistory	Remove history for specific build.	build	number, continue	Builds	Delete
113	removeCapability	Remove a shared or agent specific server capability identified by key (label) or unique name.	capability	agent		Delete
114	removeCredentials	Remove credentials by name or id.	credentials	continue		Delete
115	removeEnvironment	Remove an environment from a deployment project by name or id.	deploymentProject, environment	continue	Deployment	Delete
116	removeEnvironmentNotification	Remove deployment environment notification. Use id of -1 to remove all notifications for an environment. If an id is not provided, all notifications found matching the event and recipientType will be removed.	deploymentProject, environment, id or event and recipientType	continue	Deployment	Delete
117	removeEnvironmentRequirement	Remove a deployment environment requirement. Specify -1 for id to remove all requirements from a plan that are eligible to be removed.	deploymentProject, environment, id		Deployment	Delete
118	removeEnvironmentTask	Remove a task from a deployment environment.	deploymentProject, environment, task or id		Deployment	Delete
119	removeEnvironmentTrigger	Remove a trigger from a deployment environment. Use --id -1 or --name @all to remove all triggers. Administrator permission required to use a name and only the first trigger with the given name will be removed.	deploymentProject, environment, id or name	continue	Deployment	Delete
120	removeEnvironmentVariables	Remove deployment environment variables. Specify the variable names using the field parameters.	deploymentProject, environment	field, fields, field1, value1, field2, value2	Deployment	Delete
121	removeGroup	Remove a group.	group	continue	Groups	Delete
122	removeJob	Remove a job from a plan.	plan, job	continue	Jobs	Delete
123	removeLabels	Remove labels from a build or plan. Labels can be a comma separated list or regex.	build or plan, labels	number, continue	Labels	Delete
124	removeNotification	Remove a plan notification. Use id of -1 to remove all notifications for a plan. If an id is not provided, all notifications found matching the event and recipientType will be removed.	plan, id or event and recipientType	continue	Notifications	Delete
125	removeRepository	Remove global or plan repository. Use @all to remove all repositories. When removing a single plan repository, you can replace references with another repository defined for the plan by using --options "replaceRepository=XXX".	repository or id	plan, options, continue	Repositories	Delete
126	removeRequirement	Remove a plan requirement. Specify -1 for id to remove all requirements from a plan that are eligible to be removed.	plan, job, id		Requirements	Delete
127	removeStage	Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors.	plan, stage or id	continue	Stages	Delete
128	removeTask	Remove a task from a plan job. Use --task @all to remove all tasks.	plan, job, task or id		Tasks	Delete
129	removeTrigger	Remove a trigger from a plan. Use --id -1 or --name @all to remove all triggers. Administrator permission required to use a name and only the first trigger with the given name will be removed.	plan, id or name	continue	Triggers	Delete
130	removeUser	Remove a user.	userId	continue	Users	Delete
131	removeVariables	Remove global or plan variables. Specify the variable names using the field parameters.		plan, field, fields, field1, value1, field2, value2	Variables	Delete
132	renderRequest	Render url based request. The response data modified by findReplace processing is returned.	request	requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex	Render	Get
133	restartBuild	Restart a build that failed or was stopped. Use continue to ignore errors finding a build to restart or failed results.	plan	wait, timeout, continue	Builds
134	restoreAgentAssignments	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.	plan		Agent Assignments	Import
135	resumeServer	Resume server to allow builds to be started.			Server	Start
136	run	Run actions from a file or standard input.	file or input or standard input	common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex	Run	Run
137	runFromAgentAssignmentList	Run actions for each agent assignment with filtering like getAgentAssignment. Available replacement variables: agent, agentId, assignment, assignmentId, assignmentKey.		agent, type, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Agent Assignments	Run
138	runFromAgentList	Run actions for each agent with regex filtering on agent name. Available replacement variables: agent, agentId.		excludeEnabled, excludeDisabled, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Agents	Run
139	runFromBuildList	Run actions for each build with filtering like getBuildList. Available replacement variables: build.	plan	labels, issues, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Builds	Run
140	runFromCapabilityList	Run actions for each capability with regex filtering like getCapabilityList. Available replacement variables: capability, capabilityKey, capabilityGroup.		agent, limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Run	Run
141	runFromCsv	Run actions generated from a CSV file.	file	common, input, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex	CSV	Run
142	runFromDeploymentProjectList	Run actions for each deployment project with regex filtering on deployment project name. Available replacement variables: deploymentProject, deploymentProjectId.		regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Deployment	Run
143	runFromEnvironmentList	Run actions for each environment defined for a deployment project with regex filtering on environment name. Available replacement variables: environment, environmentId.	plan	regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Deployment	Run
144	runFromEnvironmentRequirementList	Run actions for each environment requirement defined for a deployment environment with regex filtering on requirement name. Available replacement variables: requirement, requirementId.	deploymentProject, environment	regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Deployment	Run
145	runFromEnvironmentTriggerList	Run actions for each environment trigger defined for a deployment environment with regex filtering on trigger name or description. Available replacement variables: triggerId.	deploymentProject, environment	regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Deployment	Run
146	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: project, projectName, plan, planName, stageId, stageName, job, jobName.	plan	stage, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Jobs	Run
147	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: entry, entry2.	list	list2, input, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex	Run	Run
148	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. See getPlanList for all filtering capabilities. Available replacement variables: project, projectName, plan, planName.	project	favorite, excludeDisabled, excludeEnabled, labels, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Plans	Run
149	runFromProjectList	Run actions for each project with regex filtering on project key or name. Available replacement variables: project, projectName.		regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Projects	Run
150	runFromRepositoryList	Run actions for each repository with regex filtering on repository name. Available replacement variables: repository, repositoryId.		plan, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Repositories	Run
151	runFromRequirementList	Run actions for each requirement defined for a job with regex filtering on requirement name. Available replacement variables: requirement, requirementId.	plan, job	limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Requirements	Run
152	runFromSql	Run actions generated by SQL provided by the sql parameter, a file, or standard input	sql or file	common, driver, database, host, port, url, dbUser, dbPassword, input, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex	SQL	Run
153	runFromStageList	Run actions for each stage with regex filtering on stage name. Available replacement variables: project, projectName, plan, planName, stageId, stageName.	plan	stage, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Stages	Run
154	runFromTaskList	Run actions for each task in a job with regex filtering like getTaskList. Available replacement variables: plan, job, taskId.	plan, job	limit, regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Tasks	Run
155	runFromTriggerList	Run actions for each plan trigger with regex filtering on trigger name or description. Available replacement variables: triggerId.	plan	regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Triggers	Run
156	runFromUserList	Run actions for each user with regex filtering the same as getUserList. Available replacement variables: userId.		regex, common, continue, simulate, clearFileBeforeAppend, input, file, encoding, findReplace, findReplaceRegex	Users	Run
157	runIf	Run actions only if a regex based condition is met. Other parameters and behavior are the same as the run action. By default the regex is used as a find operation in the value. Options parameter can be set to one or more of the following to modify the default behavior: literal - to treat the regex string as a literal string, exact - to require an exact match of the value, negative - to reverse the condition so a match means do NOT run action.	value, regex, file or input or standard input	common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex	Run	Run
158	setDependencyOptions	Set child dependencies and other related options.	plan	children, field, fields, field1, value1, field2, value2	Options	Update
159	setFavoritePlan	Set the plan as a favorite.	plan		Plans	Update
160	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.	plan, job	cleanAfter, regex, labels	Jobs	Update
161	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.	plan	wait, timeout, continue	Builds
162	testRepository	Experimental. Test a global or plan repository configuration to see if a successful connection can be made. Bamboo 5.15 or higher for Bitbucket, GIT, and Mercurial repositories using shared credentials only.	repository	plan	Repositories
163	unsetFavoritePlan	Remove the plan from the favorite list.	plan		Plans
164	updateBranchingOptions	Update branching options for a plan. Use the field or other field setting parameters to set options. Use getBranchingOptions to view the available fields that can be set.	plan	field, fields, field1, value1, field2, value2, file, encoding	Branches	Update
165	updateCapability	Update a capabilities value.	capability	agent, value		Update
166	updateCredentials	Update existing credentials. Credentials can be renamed by providing a name.	credentials	name, userId, file, input, accessKeyId, userPassword, sshParaphrase, accessKey		Update
167	updateEnvironmentRequirement	Update a deployment environment requirement.	deploymentProject, environment, id	type, value	Deployment	Update
168	updateEnvironmentTask	Update a task for a deployment environment.	deploymentProject, environment, task or id	description, taskKey, field, fields, field1, value1, field2, value2	Deployment	Update
169	updateEnvironmentVariables	Update existing deployment environment variables. 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.	deploymentProject, environment	append, field, fields, field1, value1, field2, value2	Deployment	Update
170	updatePlan	Update a plan's name or description. Provide a 2-part plan key where the first part is the project key. Variable @planName@ can be used in the name or description parameter to substitution the current plan name.	plan	name, description	Plans	Update
171	updateRepository	Update a global or plan repository. Be careful to provide all the parameters needed for the repository definition just like on addRepository. If the credentials parameter is provided the appropriate fields will be added automatically for GIT, Mercurial, and Bitbucket Cloud repositories.	repository or id	plan, name, credentials, field, fields, field1, value1, field2, value2	Repositories	Update
172	updateRequirement	Update a plan requirement.	plan, job, id	type, value	Requirements	Update
173	updateStage	Update stage details.	plan, stage	name, description, manual, automatic	Stages	Update
174	updateTask	Update a task in a plan job. You must provide the same parameters as if you were creating the task.	plan, job, task or id	enable, disable, taskKey, field, fields, field1, value1, field2, value2	Tasks	Update
175	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. Use append to add text to an existing variable.		plan, append, findReplace, findReplaceRegex, field, fields, field1, value1, field2, value2	Variables	Update
176	validateLicense	Validates the CLI Connector is enabled and licensed on the server.			Misc	Check
177	verifyBuild	Verify build was successful. Throws exception if not successful.	build	number	Builds

Parameters

	Parameter	Short	Description
1	acceptType		Content type to accept for renderRequest if different than type.
2	accessKey		Secret access key for AWS credentials.
3	accessKeyId		Access key id for AWS credentials.
4	action	a	Requested operation to perform. Valid actions are listed at the end.
5	after		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.
6	afterSql		SQL to run after a successful action. Limited to specific actions at this time.
7	agent		Agent name.
8	append		Append to existing varaibles on updateVariables. For some actions using the file parameter, append will append output to the existing file.
9	artifact		Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.
10	assignment		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
11	automatic		Indicate that a stage be run automatically.
12	before		Before task name or id.
13	branch		Plan branch name normally. In the context of a repository it can reference a repository branch.
14	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
15	capability		Capability name (label) or key.
16	childPlans		Comma separated list of plan keys that represent child plan dependencies.
17	cleanAfter		Clean working directory after each job completes. Use on setJobOptions.
18	clearFileBeforeAppend		For run actions, this option will automatically clear an existing file on the first append requested.
19	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.
20	comment		Comment text.
21	common		Common parameter string added to all run actions.
22	connectionTimeout		Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.
23	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.
24	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.
25	copyPattern		Copy pattern for an artifact definition.
26	credentials		Credentials name or id.
27	database		Database name is required for SQL actions.
28	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.
29	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.
30	dbCreateTable		Database table needs to be created before adding rows.
31	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-42.1.4.jar or https://jdbc.postgresql.org/download/postgresql-42.1.4.jar
32	dbPassword		Database user password. Defaults to password.
33	dbTable		Database table name when creating or updating a database from list output.
34	dbTableKeys		Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.
35	dbUser		Database user name. Defaults to user.
36	debug		Requests detail debug output. Optional for all actions.
37	deploymentProject		Deployment project name or id.
38	description		Description for entity.
39	disable		Disable an entity for those entities like plans, stages, jobs, and tasks.
40	driver		JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.
41	enable		Enable an entity when updating.
42	encoding		Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.
43	environment		Deployment environment name or id.
44	event		Event alias or key. Alias values are: After X Build Failures, All Builds Completed, All Jobs Completed, Change of Build Status, Change of Job Status, Change of Responsibilities, Comment Added, Failed Builds And First Successful, Failed Jobs And First Successful, First Failed Job For Plan, Job Error, Job Hung, Job Queue Timeout, Job Queued Without Capable Agents, Notify After X Consecutive Failures, Notify on All Build Errors. Add-ons provide events identified by key. Example key: com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains.
45	excludeDisabled		Filter out entries that are disabled.
46	excludeEnabled		Filter out entries that are enabled.
47	expand		Deprecated. Not used.
48	favorite		Subset to favorites. Same as favourite.
49	favourite		Subset to favourites. Same as favorite.
50	field		Use to set construct specific fields or variables using field=value syntax. The first equal sign (=) delineates the field name from it's value. 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.
51	field1		Construct specific field or variable name. Value is specified by the value1 parameter.
52	field2		Construct specific field or variable name. Value is specified by the value2 parameter.
53	field3		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
54	field4		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
55	field5		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
56	field6		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
57	field7		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
58	field8		Deprecated - use multiple field parameters instead. Similar to field1 and value1 usage.
59	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.
60	file	f	Path to file based content or result output. Use - for standard input. Use + for getting lines from 'input' parameters.
61	final		Make a final task.
62	findReplace		Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.
63	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.
64	group		Group name. In the case of addUser, a comma separated list of group names.
65	help		Prints this help message.
66	host		Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.
67	id		Stage or task id.
68	input	i	Line of input used in place of file data. One or more input parameters are used as lines the file parameter has a special value of +.
69	ipRestriction		Comma separated list of IP addresses to restrict ability to remotely trigger builds.
70	issues		Comma separated list of Jira issue keys.
71	job		Job key. Example: JOB1
72	labels		Comma or blank separated list of labels. When used for filtering, any label will satify the filter condition.
73	limit		Maximum number of entries to return.
74	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.
75	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.
76	location		Working directory relative path to a source location for an artifact definition or a destination location for an artifact dependency.
77	manual		Indicate that a stage be run manually.
78	name		Name of entity, like plan name.
79	number		Build number. Defaults to latest.
80	options		Comma separated list of support, experimental, or other client or action specific options.
81	outputFormat		Specify output format for a list actions. Output format determines what columns are retrieved for the list. More columns usually take longer to retrieve.
82	outputType		CSV output can be converted to plain text or HTML based on the value of this parameter. Valid values are: text, table, html.
83	password	p	User password for remote access. This is a required parameter for most actions.
84	plan		Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example: XXX-DEF
85	port		Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.
86	project		Project key. Example: XXX
87	projectName		Project name.
88	propertyFile		Property file with database parameters, field mappings, or client specific information.
89	quiet		Limit some output messages. Optional for all actions.
90	recipient		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.
91	recipientType		Recipient type alias or key. Alias values are: CLI, Committers - Users who have committed to the build, Email Address, Group, Hipchat room, IM Address, Responsible Users, User, users who are responsible for the current failure, users who have committed to the build, users who have marked this build as their favourite, Watchers - Users who have marked this plan as their favourite. Add-ons provide recipient types are identified by key. Example key: com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat.
92	reference		Reference to a replacement key value used to remember an action specific value like issue key, entity id, or similar so it can be referenced later. Each action that allows this parameter will specify that the reference parameter is valid for the action.
93	regex		Regular expression for condition matching or list filtering.
94	replace		Replace existing entity on add, create, or similar actions.
95	repository		Name of a repository. In some cases, a comma separated list of repository names.
96	repositoryKey		Repository key that uniquely identifies the repository type. Example: com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg
97	request		URL fragment for a request.
98	requestParameters		URL request parameters or post data.
99	requestType		Type of a render request like GET or POST
100	requirement		Plan requirement key, either a custom key or a system capability key or name like system.builder.ant.Ant or Ant.
101	revision		Revision id or tag.
102	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.
103	server	s	Server URL. Normally the same URL used when using a browser to access the server. This is a required parameter for most actions.
104	shared		For an artifact definition, makes the artifact available for other builds.
105	simulate		Simulate running actions. Log the action that would be taken.
106	special		Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.
107	sql		SQL select statement used to generate a run script.
108	sshParaphrase		Paraphrase for SSH credentials.
109	stage		Stage name.
110	successfulPlans		Comma separated list of keys that represent plans that must be successful before a build is triggered.
111	targetPassword		Target server user password. Defaults to password parameter.
112	targetServer		Target server URL. Meaning is action specific. For addRepository, used to access Bitbucket Server information.
113	targetUser		Target server user. Defaults to user parameter.
114	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.
115	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.
116	timeout		Wait timeout in seconds. Use -1 to wait forever.
117	toPlan		Plan key to be created. Example: XXX-DEF
118	toProject		Project key to clone to.
119	triggeringEnvironment		Deployment environment name or id.
120	type		Capability type like Executable, Custom, or JDK.Also requirement match type with values: exist (default), equal, match. Also, content type for renderRequest and trigger type for addTrigger.
121	url		Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.
122	user	u	User name for remote access.
123	userEmail		User email for user management actions.
124	userFullName		User name for user management actions.
125	userId		User id for user credentials and user management.
126	userPassword		User password for user credentials and user manaagement.
127	value		Field value or condition value for matching.
128	value1		Value corresponding to the field1 parameter name.
129	value2		Value corresponding to the field2 parameter name.
130	value3		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
131	value4		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
132	value5		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
133	value6		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
134	value7		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
135	value8		Deprecated - use multiple field parameters instead. Similar to value1 and field1 usage.
136	verbose		Requests verbose output to help with problem determination. Optional for all actions.
137	version		Version name for deployment.
138	wait		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.

Reference - 8.1.0

On this page

Related information for 8.1.0

Quick Tips

Actions

Parameters

Parameter Tips