Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 6.6.0

...

Related information for

...

6.6.0

Help Text

No Format
 

Usage:
  bamboo (-a|--action) <action> [(-f|--file) <file>] [--encoding <encoding>] [--debug] [-v|--verbose] [--quiet] [--outputFormat
  <outputFormat>] [--columns <columns>] [--connectionTimeout <connectionTimeout>] [--sql <sql>] [--driver <driver>] [--url <url>]
  [--host <host>] [--port <port>] [--database <database>] [--dbUser <dbUser>] [--dbPassword <dbPassword>] [--dbJar <dbJar>]
  [--afterSql <afterSql>] [--dbTable <dbTable>] [--dbTableKeys <dbTableKeys>] [--dbCreateTable] [--comment <comment>] [--replace]
  [--propertyFile   <propertyFile>] [--common <common>] [--special <special>] [--dateFormat <dateFormat>] [--dateFormat2 <dateFormat2>]
  [--findReplacereference <reference>] [--findReplace <findReplace>] [--findReplaceRegex <findReplaceRegex>] [--list <list>] [--list2 <list2>]
  [--options <options>] [--continue] [--simulate] [--append]
  [--clearFileBeforeAppend] (-s|--server) <server> (-u|--user) <user>
  (-p|--password) <password> [--serviceapi <service><api>] [--apiservice <api><service>]   [--cookies <cookies>] [--project <project>] [--toProject <toProject>]
  [--projectName <projectName>] [--deploymentProject <deploymentProject>] [--environment <environment>] [--version <version>] [--build
  <build>] [--plan   <plan>] [--toPlan <toPlan>] [--stage <stage>] [--job <job>] [--task <task>] [--branch <branch>] [--name <name>]
  [--description <description>] [--agent <agent>]
  [--assignment <assignment>] [--artifact <artifact>] [--requirement <requirement>]
  [--type <type>] [--value <value>] [--labels
  <labels>] [--searchLabels <searchLabels>] [--issues <issues>] [--expand <expand>]
  [--attribute <attribute>] [--commentrevision <comment><revision>]   [--revision <revision>] [--location <location>] [--copyPattern <copyPattern>] [--repository <repository>] [--after <after>]
  [--schedule <schedule>] [--taskKey <taskKey>] [--repositoryKey <repositoryKey>] [--event <event>] [--recipientType <recipientType>]
  [--recipient <recipient>] [--childPlans <childPlans>] [--ipRestriction <ipRestriction>] [--fields <fields>] [--field1 <field1>]
  [--field2 <field2>] [--field3
  <field3>] [--field4 <field4>] [--field5 <field5>] [--field6 <field6>] [--field7 <field7>] [--field8
  <field8>] [--value1 <value1>]   [--value2 <value2>] [--value3 <value3>] [--value4 <value4>] [--value5 <value5>] [--value6 <value6>]
  [--value7 <value7>] [--value8 <value8>] [--after <after>] [--before  <value8><before>] [--final] [--regex <regex>] [--request <request>]
  [--requestParameters <requestParameters>] [--requestType <requestType>]   [--acceptType <acceptType>] [--id <id>] [--number <number>]
  [--timeout <timeout>] [--limit <limit>] [--wait] [--favourite]
  [--favorite] [--enable] [--disable] [--excludeEnabled]
  [--excludeDisabled] [--manual] [--automatic] [--shared] [--cleanAfter] [--help]


	Provides capability to make requests to a remote server.
	Required parameters: action, server, password.
	Optional parameters: user (likely required for your installation).
	Other required and optional parameters depending on action requested.


  (-a|--action) <action>
        Requested operation to perform. Valid actions are listed at the end.

  [(-f|--file) <file>]
        Path to file based content or result output. Use - for standard input.

  [--encoding <encoding>]
        Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

  [--debug]
        Requests detail debug output. Optional for all actions.

  [-v|--verbose]
        Requests verbose output to help with problem determination. Optional for all actions.

  [--quiet]
        Limit some output messages. Optional for all actions.

  [--outputFormat <outputFormat>]
        Specify output format for an action. (default: 1)

  [--columns <columns>]
        Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column
        names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns
        will be ignored.

  [--connectionTimeout <connectionTimeout>]
        Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

  [--sql <sql>]
        SQL select statement used to generate a run script.

  [--driver <driver>]
        JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

  [--url <url>]
        Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

  [--host <host>]
        Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

  [--port <port>]
        Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

  [--database <database>]
        Database name is required for SQL actions.

  [--dbUser <dbUser>]
        Database user name. Defaults to user.

  [--dbPassword <dbPassword>]
        Database user password. Defaults to password.

  [--dbJar <dbJar>]
        By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url
        reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or
        https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar

  [--afterSql <afterSql>]
        Experimental. SQL to run after a successful action. Limited to specific actions at this time.

  [--dbTable <dbTable>]

       Experimental. Database table name when creating or updating a database from list output.

  [--dbTableKeys <dbTableKeys>]

       Experimental. Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for
     key set for the table.

  [--dbCreateTable]
        Experimental. Database table needs to be created before adding rows.

  [--comment <comment>]
        Comment text.

  [--replace]
        Replace existing entity on add, create, or similar actions.

  [--propertyFile <propertyFile>]
        Property file with database parameters, field mappings, or client specific information.

  [--common <common>]
        Common parameter string added to all run actions.

  [--special <special>]
        Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters
        used for specialized processing of some specific parameters.

  [--dateFormat <dateFormat>]
        Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is
        lenient starting with client date format and then some other standard formats based on JSON date format.

  [--dateFormat2 <dateFormat2>]
        Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only
        fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

  [--findReplacereference <findReplace><reference>]
        Find Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be
        referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement
        key.

  [--findReplace <findReplace>]
        Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded
        quotes must be escaped.

  [--findReplaceRegex <findReplaceRegex>]
        Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values
        containing a delimiter. Embedded quotes must be escapeddoubled.

  [--list <list>]
        Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a
        delimiter. Embedded quotes must be doubled.

  [--continuelist2 <list2>]
        ContinueComma processingseparated evenlist afterof errorsentries areto encounteredpopulate forthe runentry2 actions.replacement Alsovariable usedon forrunFromList. someSingle actionquote tovalues ignorecontaining certaina
errors        delimiter. likeEmbedded notquotes foundmust errors on remove actionsbe doubled.

  [--simulateoptions <options>]
        Comma separated list Simulateof running actions. Log the action that would be takensupport, experimental, or other client or action specific options.

  [--appendcontinue]
        For some actions Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors
        like not found errors on remove actions.

  [--simulate]
        Simulate running actions. Log the action that would be taken.

  [--append]
        For some actions using the file parameter, append will append output to the existing file.

  [--clearFileBeforeAppend]
        For run actions, this option will automatically clear an existing file on the first append requested.

  (-s|--server) <server>
        Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

  (-u|--user) <user>
        User name for remote access. (default: automation)

  (-p|--password) <password>
        User password for remote access.

  [--serviceapi <service><api>]
        ServiceAPI address extensionversion. (default: /rest/api)

  [--api <api>]
    Some requests produce different results based on the api version used. (default: latest)

  API version. Some requests produce different results based on the api version used[--service <service>]
        Service address extension. (default: latest/rest/api)

  [--cookies <cookies>]
        Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session
        affinity for actions using REST APIs.

  [--project <project>]
        Project key. Example: XXX

  [--toProject <toProject>]
        Project key to clone to.

  [--projectName <projectName>]
        Project name.

  [--builddeploymentProject <build><deploymentProject>]
        BuildDeployment key.project Normallyname usedor toid.
refer
to a specific build (3 or 4 part name). However, it was also an older terminology for a
        [--environment <environment>]
        Deployment environment name or id.

  [--version <version>]
        Version name for deployment.

  [--build <build>]
        Build key. Normally used to refer to a specific build (3 or 4 part name). However, it was also an older terminology for a
        plan and some action continue to accept the older terminology. Example: XXX-DEF or XXX-DEF-1

  [--plan <plan>]
        Plan key containing the project key. Preferred way to reference a plan instead of the older build terminology. Example:
        XXX-DEF

  [--toPlan <toPlan>]
        Plan key to be created. Example: XXX-DEF

  [--stage <stage>]
        Stage name.

  [--job <job>]
        Job key. Example: JOB1

  [--nametask <name><task>]
        NameTask ofid, entityname, likeor plan namedescription. Task ids  [--description are unique, but names and descriptions are not. Name and description lookup is done
        by finding the first match in the ordered task list.

  [--branch <branch>]
        Branch name.

  [--name <name>]
        Name of entity, like plan name.

  [--description <description>]
        Description for entity.

  [--agent <agent>]
        Agent name.

  [--assignment <assignment>]
        Key used to identify a project, plan, or job to be assigned to a specific agent. This makes the agent dedicated to only
        perform builds for all assignments.  Example: XXX, XXX-DEF, XXX-DEF-JOB1

  [--artifact <artifact>]
        Build artifact name. May be extended by a path name for locating files within an artifact representing a dirctory.

  [--requirement <requirement>]
        Plan requirement key, either a custom key or a system capability key like: system.builder.ant.Ant.

  [--type <type>]
        Requirement match type. Values: exist (default), equal, match. Also, content type for renderRequest and trigger type for
        addTrigger. (default: )

  [--value <value>]
        Requirement match value.

  [--labels <labels>]
        Comma or blank separated list of labels.

  [--searchLabels <searchLabels>]
        Comma or blank separated list of labels used for search.

  [--issues <issues>]
        Comma separated list of JIRA issue keys.

  [--expand <expand>]
        Expanded request information to obtain more detailed data on request.

  [--attribute <attribute>]
        Attribute to list.

  [--comment <comment>]
        Comment for an build.

  [--revision revision <revision>]
        Revision id or tag.

  [--location <location>]
        Working directory relative path to a source location for an artifact definition or a destination location for an artifact
        dependency.

  [--copyPattern <copyPattern>]
        Copy pattern for an artifact definition.

  [--repository <repository>]
        Name of a repository. In some cases, a comma separated list of repository names.

  [--after <after>]
        Used in orderRepository to name the repository after which the repository will be positioned.

  [--schedule <schedule>]
        Cron, daily time, or periodic schedule. A cron schedule must be valid cron expresssions and defaults to 0 0 0 ? * *. A daily
        time is a 24 hour format (HH:mm) value. A periodic schedule is a numeric value in seconds and defaults to 180.

  [--taskKey <taskKey>]
        Task key. Example: com.atlassian.bamboo.plugins.scripttask:task.builder.script.An alias can also be used to make it easier
        and less error prone. See addTask for the list.

  [--repositoryKey <repositoryKey>]
        Repository key that uniquely identifies the repository type. Example:
        com.atlassian.bamboo.plugins.atlassian-bamboo-plugin-mercurial:hg

  [--event <event>]
        Event alias or key. Add-ons provide events identified by key. Example key:
        com.atlassian.bamboo.plugin.system.notifications:chainCompleted.failedChains

  [--recipientType <recipientType>]
        Recipient type alias or key. Add-ons provide recipient types identified by key. Example key:
        com.atlassian.bamboo.plugins.bamboo-hipchat:recipient.hipchat

  [--childPlansrecipient <childPlans><recipient>]
        Recipient value Commafor separatedadd listnotifications. ofMany planrecipient keystypes thatneed representa childprimary planrecipient dependenciesvalue. This parameter can [--ipRestriction <ipRestriction>]be used
        Comma separated list of instead of setting a recipient type specific field and value.

  [--childPlans <childPlans>]
        Comma separated list of plan keys that represent child plan dependencies.

  [--ipRestriction <ipRestriction>]
        Comma separated list of IP addresses to restrict ability to remotely trigger builds.

  [--fields <fields>]
        Use to specify task or repository specific fields or variables and their values. A comma separated list of key:value pairs.
        Single quote the key:value pair if it contains a comma (,) or line breaks.

  [--field1 <field1>]
        Construct specific field or variable name. Value is specified by the value1 parameter.

  [--field2 <field2>]
        Construct specific field or variable name. Value is specified by the value2 parameter.

  [--field3 <field3>]
        Construct specific field or variable name. Value is specified by the value3 parameter.

  [--field4 <field4>]
        Construct specific field or variable name. Value is specified by the value4 parameter.

  [--field5 <field5>]
        Construct specific field or variable name. Value is specified by the value5 parameter.

  [--field6 <field6>]
        Construct specific field or variable name. Value is specified by the value6 parameter.

  [--field7 <field7>]
        Construct specific field or variable name. Value is specified by the value7 parameter.

  [--field8 <field8>]
        Construct specific field or variable name. Value is specified by the value8 parameter.

  [--value1 <value1>]
        Value corresponding to the field1 parameter name.

  [--value2 <value2>]
        Value corresponding to the field2 parameter name.

  [--value3 <value3>]
        Value corresponding to the field3 parameter name.

  [--value4 <value4>]
        Value corresponding to the field4 parameter name.

  [--value5 <value5>]
        Value corresponding to the field5 parameter name.

  [--value6 <value6>]
        Value corresponding to the field6 parameter name.

  [--value7 <value7>]
        Value corresponding to the field7 parameter name.

  [--value8 <value8>]
        Value corresponding to the field8 parameter name.

  [--regexafter <regex><after>]
        Used in RegularorderRepository expressionto forname listthe filteringrepository andafter similar.which Alsothe forrepository patternwill matchbe labellingpositioned. Similarly for  [--request <request>]moveTask where
        it represent URLthe fragmentid forof athe requesttask.

  [--requestParametersbefore <requestParameters><before>]
        URLBefore request parameters or post datatask id.

  [--requestType <requestType>final]
        Type ofMake a render request like GET or POST (default: GET)

  final task.

  [--acceptTyperegex <acceptType><regex>]
        Regular Contentexpression for typelist tofiltering acceptand forsimilar. renderRequestAlso iffor differentpattern thanmatch typelabelling.

  [--idrequest <id><request>]
        URL Stagefragment orfor taska idrequest.

  [--numberrequestParameters <number><requestParameters>]
        BuildURL number.request Defaultsparameters toor latest. (default: 0)post data.

  [--timeoutrequestType <timeout><requestType>]
        WaitType timeoutof ina seconds.render Userequest -1like toGET waitor forever.POST (default: -1GET)

  [--limitacceptType <limit><acceptType>]
        Content Maximumtype to numberaccept offor entriesrenderRequest toif return. (default: 2147483647)different than type.

  [--waitid <id>]
        WaitStage foror actiontask to completeid.

  [--favouritenumber <number>]
        SubsetBuild number. Defaults to favouriteslatest. Same as favorite.
(default: 0)

  [--favoritetimeout <timeout>]
        Wait Subsettimeout toin favoritesseconds. SameUse as favourite.-1 to wait forever. (default: -1)

  [--enablelimit <limit>]
        Maximum Enablenumber anof entityentries whento updatingreturn. (default: 2147483647)

  [--disablewait]
        Disable anWait entity for thoseaction entities like plans, stages, jobs, and tasksto complete.

  [--excludeEnabledfavourite]
        FilterSubset outto entriesfavourites. thatSame areas enabledfavorite.

  [--excludeDisabledfavorite]
        FilterSubset outto entriesfavorites. thatSame areas disabledfavourite.

  [--manualenable]
        IndicateEnable thatan aentity stage be run manuallywhen updating.

  [--shareddisable]
        ForDisable an artifactentity definition,for makesthose the artifact available for other buildsentities like plans, stages, jobs, and tasks.

  [--cleanAfterexcludeEnabled]
        CleanFilter workingout directoryentries afterthat eachare job completes. Use on setJobOptions.enabled.

   [--helpexcludeDisabled]
        Filter out Printsentries thisthat helpare messagedisabled.

 Valid actions (case insensitive):

run - Run actions from a file or standard input.
	 Required parameters: file or standard input
	 Optional parameters: common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromSql - Run actions generated by SQL provided by the sql parameter, a file, or standard input
	 Required parameters: sql or file or standard input
	 Optional parameters: common, driver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
	 Required parameters: file
	  [--manual]
        Indicate that a stage be run manually.

  [--automatic]
        Indicate that a stage be run automatically.

  [--shared]
        For an artifact definition, makes the artifact available for other builds.

  [--cleanAfter]
        Clean working directory after each job completes. Use on setJobOptions.

  [--help]
        Prints this help message.


Valid actions (case insensitive):

run - Run actions from a file or standard input.
	 Required parameters: file or standard input
	 Optional parameters: common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromListrunFromSql - Run actions forgenerated by eachSQL entryprovided inby athe list.sql 	parameter, Whena file, isor provided,standard eachinput
action	 inRequired theparameters: filesql augmentedor byfile theor commonstandard parameterinput
will	 beOptional runparameters: forcommon, each entry.
	 Otherwise, just the action specified by the common parameter will be run.
	 Available replacement variable is entrydriver, database, host, port, url, dbUser, dbPassword,
	 propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
runFromCsv - Run actions generated from a CSV file.
	 Required parameters: listfile
	 Optional parameters: filecommon, commonpropertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInforunFromList - Run Getactions informationfor abouteach theentry thisin clienta toollist.
	 OptionalWhen parameters:file outputFormat,is fileprovided, append,each encodingaction 	in Outputthe formats:file 1augmented -by basic,the 2common -parameter JVMwill getServerInfo be run for each entry.
	 Otherwise, just the action specified by the common parameter will be run.
	 Available replacement variables are entry, entry2.
	 Required parameters: list
	 Optional parameters: list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex
getClientInfo - Get information about the Bamboothis client servertool.
	 Optional parameters: outputFormat, dateFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - detailJVM, 311 - action statelist, validateLicense12 - Validates the parameter list
getServerInfo - Get information about the Bamboo server.
	 Optional parameters: outputFormat, dateFormat, file, append, encoding
	 Output formats: 1 - basic, 2 - detail, 3 - state
validateLicense - Validates the CLI Connector is enabled and licensed on the server.
renderRequest - Render url based request. The response data modified by findReplace processing is returned.
	 Required parameters: request
	 Optional parameters: requestParameters, requestType, type, acceptType, build, file, encoding, findReplace, findReplaceRegex
runFromProjectList - Run actions for each project with regex filtering on project key or name. Available replacement variables are project and projectName.
	 Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromPlanList - Run actions for each plan with regex filtering on plan key or name. Use @all for project to get a list of plans across all projects. Available replacement variables are project, projectName, plan, and planName.
	 Required parameters: project
	 Optional parameters: favorite, excludeDisabled, excludeEnabled, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromStageList - Run actions for each stage with regex filtering on stage name. Available replacement variables are project, projectName, plan, planName, stageId, and stageName.
	 Required parameters: plan
	 Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromJobList - Run actions for each job with regex filtering on job key or name. Restrict to a specific stage or leave stage blank to get jobs across all stages. Available replacement variables are project, projectName, plan, planName, stageId, stageName, job, and jobName.
	 Required parameters: plan
	 Optional parameters: stage, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromRepositoryList - Run actions for each repository with regex filtering on repository name. Available replacement variables are repository and repositoryId.
	 Optional parameters: plan, regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
runFromAgentList - Run actions for each agent with regex filtering on agent name. Available replacement variables are agent and agentId.
	 Optional parameters: regex, common, continue, simulate, clearFileBeforeAppend, file, encoding, findReplace, findReplaceRegex
getProjectListrunFromDeploymentProjectList - GetExperimental. aRun listactions offor projects.each Projectsdeployment are selected based onproject with regex filtering on deployment project key or name name. Available replacement variables are deploymentProject and deploymentProjectId.
	 Optional parameters: regex, filecommon, appendcontinue, simulate, clearFileBeforeAppend, file, encoding, findReplace, columnsfindReplaceRegex
getPlanListrunFromEnvironmentList - Get a list of plansExperimental. Run actions for each environment defined for a deployment project with regex filtering on plan key orenvironment name. UseAvailable @allreplacement forvariables projectare toenvironment get a list of plans across all projectsand environmentId.
	 Required parameters: project
	 Optional parameters: favoriteregex, excludeDisabledcommon, excludeEnabledcontinue, limitsimulate, regexclearFileBeforeAppend, outputFormatfile, dateFormatencoding, columnsfindReplace, file,findReplaceRegex
append,getProjectList encoding- 	Get Outputa formats:list 1of -projects. plan,Projects 999are -selected lastbased buildon resultsregex filtering getArtifactDefinitionListon -project Experimentalkey -or onlyname.
those	 availableOptional toparameters: beregex, artifactfile, dependenciesappend, inencoding, thecolumns
lastgetPlanList job!- Get a list of shared artifact definitionsplans for a planproject with regex filtering on plan key artifactor name. Use @all for project to get a list of plans across all projects.
	 Required parameters: planproject
	 Optional parameters: favorite, excludeDisabled, excludeEnabled, limit, regex, outputFormat, dateFormat, columns, file, append, encoding
getRepositoryList	 -Output Getformats: a1 list- ofplan, global999 or- planlast repositories build results
getBranchList - Get a list of branches for a plan with regex filtering on repository branch name or short name.
	 Required parameters: plan
	 Optional parameters: planlimit, regex, columns, file, append, encoding
getNotificationListgetArtifactDefinitionList - Get a EAPlist (subjectof toartifact change).definitions Getfor a list of plan notifications plan with regex filtering on artifact name.
	 Required parameters: plan
	 Optional parameters: plan limit, regex, columns, file, append, encoding
getVariableListgetRepositoryList - Get a list of global or plan variablesrepositories basedwith on regex filtering ofon variablerepository namesname.
	 Optional parameters: plan, regex, file, append, encoding
getBuildListgetNotificationList - Get a list of buildplan reultsnotifications.
Build	 resultsOptional can parameters: plan, file, append, encoding
getVariableList - Get a list of global or plan variables based on regex filtering of variable names.
	 Optional parameters: plan, regex, file, append, encoding
getBuildList - Get a list of build reults. Build results can be filtered by using fields and values. Supported fields are state, notState, and started. For example, include only successful results by using: --field1 state --value SUCCESSFUL, or include only builds started after a specific date use: --field2 started --value2 2016-04-30 --dateFormat yyyy-MM-dd. Default limit is 25.
	 Required parameters: plan
	 Optional parameters: limit, favorite, labels, issues, columns, file, append, encoding, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
	 Output formats: 1 - basic, 2 - test information
getArtifactList - Get a list of build result artifacts. When the build does not include a job portion, only shared artifacts are provided. Use @all for the job parameter to get both sharted and non-shared artifacts for all plan jobs.
	 Required parameters: plan or build
	 Optional parameters: job, number, limit, regex, file, append, encoding
getBuildQueueList - Get a list of builds waiting in the build queue. Subset by project or build.
	 Optional parameters: project, build, file, append, encoding, columns
getLabelList - Get a list of labels for a build.
	 Required parameters: build
	 Optional parameters: number, file, append, encoding, columns
getCommentList - Get a list of comments for a build.
	 Required parameters: build
	 Optional parameters: number, file, append, encoding, columns
getStageList - Get a list of stages for a plan with regex filtering on stage name.
	 Required parameters: plan
	 Optional parameters: regex, file, attribute, columns
getJobList - Get a list of jobs for a plan with regex filtering on job key or name. Subset by stage if desired.
	 Required parameters: plan
	 Optional parameters: stage, regex, file, attribute, columns
getAgentListgetTaskList - Get a list of tasks for agentsa basedjob onwith regex filtering ofon agenttask names.name.
	 OptionalRequired parameters: regexplan, file, append, job
	 Optional parameters: limit, regex, file, columns
getAgentList - Get a list of agents based on regex filtering of agent names.
	 Optional parameters: regex, file, append, encoding, columns
	 Output formats: 1 - basic, 2 - detail
queueBuildgetDeploymentProjectList - Experimental. QueueGet a buildlist toof run.deployment Ifprojects waitbased ison specified,regex thefiltering actionof willproject notnames.
complete	 untilOptional theparameters: queuedregex, buildfile, completesappend, orencoding, thecolumns
timeoutgetEnvironmentList period- elapsesExperimental. TheGet actiona willlist failof ifenvironments thefor builda failsdeployment unlessproject continuebased parameteron isregex usedfiltering toof ignore a failed resultenvironment names.
A	 specificRequired revisionparameters: candeploymentProject
be	 builtOptional ifparameters: theregex, revisionfile, parameterappend, isencoding, specified.columns
PlangetTaskTypeList variables- canGet bea setlist usingof thetask fieldtypes andavailable valuewith parameters.regex Conditionalfiltering queueingon istype supportedname - see the documentation for detailsand description.
	 Required parameters: plan, job
	 Optional parameters: revisionlimit, waitregex, continuefile, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
queueBuildFromListcolumns
pauseServer - Pause the server to prevent builds from starting.
resumeServer - Resume server to allow builds to be started.
queueBuild - Queue multiplea buildsbuild to run. andIf wait foris results.specified, Thethe action will not complete until allthe queued buildsbuild completecompletes or the timestimeout period outelapses. IfThe continueaction iswill specified,fail buildsif willthe continuebuild tofails beunless queuedcontinue evenparameter afteris an attemptused to queueignore a buildfailed failsresult. A specific Therevision actioncan willbe failbuilt if any build fails or times outthe revision parameter is specified. Plan variables can be set using the field and value parameters. Conditional queueing is supported - see the documentation for details.
	 Required parameters: project or listplan
	 Optional parameters: regexbranch, revision, limitwait, continue, timeout, dateFormat, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
stopBuildqueueBuildFromList - Queue multiple Requestbuilds to stoprun aand queuedwait orfor running buildresults. UseThe continueaction towill ignorenot errorscomplete findinguntil aall buildqueued tobuilds stopcomplete or failedtimes resultsout. If continue Theis waitspecified, parameterbuilds will causecontinue processing to waitbe forqueued completioneven orafter timeoutan beforeattempt returning.to 	queue Requireda parameters:build planfails. 	The Optionalaction parameters:will wait,fail timeout, continue
restartBuild - Restart aif any build that failedfails or wastimes stoppedout. UseConditional continuequeueing tois ignoresupported errors- findingsee athe builddocumentation to restart or failed resultsfor details.
	 Required parameters: project planor list
	 Optional parameters: waitregex, timeoutlimit, continue, addCommenttimeout, -dateFormat, Addfields, afield1, commentvalue1, tofield2, a build.
	 Required parameters: build, comment
	 Optional parameters: number, findReplace, findReplaceRegex, file, encoding
addLabels - Add a comma separated list of labels to a buildvalue2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
stopBuild - Request to stop a queued or running build. Use continue to ignore errors finding a build to stop or failed results. The wait parameter will cause processing to wait for completion or timeout before returning.
	 Required parameters: build,plan
labels
	 Optional parameters: numberwait, removeLabelstimeout, -continue
RemoverestartBuild labels- fromRestart a build. Labelsthat canfailed beor awas commastopped. separatedUse listcontinue orto regex.ignore Eithererrors buildfinding ora searchbuild termsto (searchLabels, issues) must be providedrestart or failed results.
	 Required parameters: labelsplan
	 Optional parameters: buildwait, numbertimeout, searchLabels, issues, favorite
deleteProjectcontinue
addComment - DeleteAdd projecta andcomment allto projecta plansbuild.
	 Required parameters: build, projectcomment
	 Optional parameters: filenumber, enableProjectfindReplace, -findReplaceRegex, Enablefile, allencoding
projectaddLabels plans.- 	Add Requireda parameters:comma projectseparated disableProjectlist -of Disablelabels allto projecta plansbuild.
	 Required parameters: projectbuild, cloneProjectlabels
-	 Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName.
	 Required parameters: project, toProject, projectName, disable
createPlan - Create a new plan. Provide a 2-part plan key where the first part is the project key. If the project key does not exist, it will be created with the provided project name. Server instances only. Use continue to ignore the request if the plan already exists.
	 Required parameters: plan
	 Optional parameters: name, projectName, description, disable, continue
createOrUpdatePlan - Same as createPlan when plan does not exist. However, it will update an existing plan's name and description. Server instances onlyOptional parameters: number
removeLabels - Remove labels from a build. Labels can be a comma separated list or regex. Either build or search terms (searchLabels, issues) must be provided
	 Required parameters: labels
	 Optional parameters: build, number, searchLabels, issues, favorite
deleteProject - Delete project and all project plans.
	 Required parameters: project
	 Optional parameters: file
enableProject - Enable all project plans.
	 Required parameters: project
disableProject - Disable all project plans.
	 Required parameters: project
cloneProject - Clone each plan in a project to another project. If toProject is not provided, the plans will be cloned to the same project. If the toProject does not exist, it will be created with name provided by projectName.
	 Required parameters: plan
	 Optional parameters: nameproject, toProject, projectName, description, disable
updatePlancreatePlan - UpdateCreate a plans name or descriptionnew plan. Provide a 2-part plan key where the first part is the project key. 	If Requiredthe parameters:project plankey 	does Optional parameters: namenot exist, descriptionit getPlanwill -be Getcreated planwith information.the 	provided Requiredproject parameters:name. planUse clonePlancontinue -to Cloneignore a planthe request if the plan already exists.
	 Required parameters: plan, toPlan, name
	 Optional parameters: descriptionname, projectName, description, disable, continue
deletePlancreateOrUpdatePlan - Same Deleteas createPlan awhen plan. does 	not Required parameters: plan
enablePlan - Enable a plan to runexist. However, it will update an existing plan's name and description.
	 Required parameters: plan
disablePlan
	 Optional parameters: name, projectName, description, disable
updatePlan - DisableUpdate a plans planname fromor runningdescription. 	Provide Required parameters:a 2-part plan addStagekey where -the Addfirst apart stageis tothe aproject plankey.
	 Required parameters: plan,
stage
	 Optional parameters: descriptionname, manualdescription
removeStagegetPlan - Get Removeplan ainformation.
stage	 fromRequired aparameters: plan.
Use idclonePlan = -1 toClone remove all stages. Use continue to ignore not found errorsa plan.
	 Required parameters: plan, stagetoPlan, orname
id
	 Optional parameters: continuedescription, addJobprojectName, -disable
AdddeletePlan a- job toDelete a stageplan.
	 Required parameters: plan, stage, job
	 Optional parameters: name, description, disable
enableJob 
enablePlan - Enable a jobplan to run.
	 Required parameters: plan,
job
disableJobdisablePlan - Disable a jobplan from running.
	 Required parameters: plan,
jobsetFavoritePlan setJobOptions - Set miscellaneousthe optionplan foras a jobfavorite.
The	 followingRequired optionsparameters: areplan
specificallyunsetFavoritePlan supported:- cleanRemove workingthe directoryplan afterfrom jobthe completesfavorite (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 requestedlist.
	 Required parameters: plan
exportPlan - Experimental. Export a plan to source that can be used for plan creation.  Valid export types are CLI, JAVA (Bamboo 6.0 and higher).
	 Required parameters: plan, job
	 Optional parameters: cleanAftertype, regexfile, labels
getArtifactencoding, dateFormat
movePlans - DownloadMove aone copyor ofmore aplans buildfrom artifactone intoproject ato file.another 	project Required(existing parameters:or new). UsesSpecifying samea parametersplan andwill logicmove asthat getArtifactListplan. forIf identifyingplan buildis resultnot artifactsspecified, toplans search.from Forthe artifactssource thatproject, representwith afiltering directorylike (not a file)for getPlanList, usewill thebe artifactmoved. namePlan pluskey theand pathname tocan thebe filechanged inon the artifact.move 	by Optionalspecifying parameters: plan or build, artifact, file
	 Output formats: job, number, replace, encoding
getBuild - Get build result.
	 Required parameters: build
	 Optional parameters: number, expand, file
verifyBuild - Verify build was successful.
	 Required parameters: build
	 Optional parameters: number
getLatestBuildNumber - Get the number of the last completed build for this plantoPlan and name respectively. When toPlan or name are provided for multiple plan moves, they must contain <at:var at:name="plan" /> or <at:var at:name="planName" /> replacement variables. Before the move takes place, the server state will be checked and paused if necessary and, if paused, resumed after the end of the operation.
	 Required parameters: planproject addArtifactor -plan, Add an artifact definition to a job. Server instances only.
	 RequiredtoProject
	 Optional parameters: plantoPlan, jobname, artifactexcludeEnabled, copyPattern
	 Optional parameters: locationexcludeDisabled, limit, sharedregex
removeArtifactaddBranch - RemoveAdd ana artifactbranch definition fromto a jobplan. ServerThe instancesplan only.branch 	will Requiredbe parameters:disabled plan, job, artifact
addArtifactDependency - Add an artifact dependency to a job. Artifact must be a shared artifact from another jobby default. For add, the branch parameter refers to the repository branch. An optional name for the plan branch can be specified, otherwise the repository branch name will be used.
	 Required parameters: plan, job branch
	 Optional parameters: name, artifactdescription, locationenable
setDependencyOptionsremoveBranch - Experimental. Set child dependencies and other related options Removes a branch from a plan. Use --branch @all to remove all branches from a plan.
	 Required parameters: plan, 	branch
OptionalgetBranch parameters:- children,Get fields,information field1,for value1,a field2,branch value2,to field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addTaska plan. Branch can be either the short or long name of the branch.
	 Required parameters: plan, branch
	 Optional parameters: file, encoding
addStage - Add a taskstage to a plan job. A valid task key or alias is required. Valid aliases are: ANT, ARTIFACT_DOWNLOAD, CHECKOUT, CLI_BAMBOO, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_STASH, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE
	 Required parameters: plan, job, taskKey
	 Optional parameters: disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateTask - Update a task in a plan job. You must provide the same parameters as if you were creating the task.
	 Required parameters: plan, stage
	 Optional parameters: description, manual
getStage - Get plan stage information.
	 Required parameters: plan, stage
updateStage - Update stage details.
	 Required parameters: plan, stage
	 Optional parameters: name, description, manual, automatic
removeStage - Remove a stage from a plan. Use --stage @all to remove all stages. Use continue to ignore not found errors.
	 Required parameters: plan, stage or id
	 Optional parameters: continue
addJob - Add a job to a stage.
	 Required parameters: plan, stage, job
	 Optional parameters: name, description, disable
enableJob - Enable a job to run.
	 Required parameters: plan, job
disableJob - Disable a job from running.
	 Required parameters: plan, job
setJobOptions - Set miscellaneous option for a job. The following options are specifically supported: clean working directory after job completes (cleanAfter switch) and pattern matching labeling (regex and labels parameters). Use the field and value parameters for additional settings with values determined from the screen. Some previous settings may be lost if not specifically requested.
	 Required parameters: plan, job
	 Optional parameters: cleanAfter, regex, labels
getArtifact - Download a copy of a build artifact into a file.
	 Required parameters:  Uses same parameters and logic as getArtifactList for identifying build result artifacts to search. For artifacts that represent a directory (not a file), use the artifact name plus the path to the file in the artifact.
	 Optional parameters: plan or build, artifact, file
	 Output formats: job, number, replace, encoding
getBuild - Get build result.
	 Required parameters: build
	 Optional parameters: number, expand, file, encoding
verifyBuild - Verify build was successful.
	 Required parameters: build
	 Optional parameters: number
getLatestBuildNumber - Get the number of the last completed build for this plan.
	 Required parameters: plan
addArtifact - Add an artifact definition to a job.
	 Required parameters: plan, job, artifact, copyPattern
	 Optional parameters: location, shared
removeArtifact - Remove an artifact definition from a job.
	 Required parameters: plan, job, artifact
addArtifactDependency - Add an artifact dependency to a job. Artifact must be a shared artifact from another job.
	 Required parameters: plan, job, artifact, location
setDependencyOptions - Set child dependencies and other related options.
	 Required parameters: plan
	 Optional parameters: children, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addTask - Add a task to a plan job. A valid task key or alias is required. Valid aliases are: ANT, ARTIFACT_DOWNLOAD, CHECKOUT, CLI_BAMBOO, CLI_BITBUCKET, CLI_CONFLUENCE, CLI_CRUCIBLE, CLI_FISHEYE, CLI_HIPCHAT, CLI_JIRA, CLI_SERVICE_DESK, CLI_UPM, GANT, GINT, GRADLE, GRADLEW, GROOVY, MAVEN2, MAVEN3, SCP, SQL, SCRIPT, SSH, VARIABLE_REPLACE
	 Required parameters: plan, job, taskKey
	 Optional parameters: disable, final, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateTask - Update a task in a plan job. You must provide the same parameters as if you were creating the task.
	 Required parameters: plan, job, task or id
	 Optional parameters: enable, disable, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeTask - Remove a task from a plan job. Use --task @all to remove all tasks.
	 Required parameters: plan, job, task or id
moveTask - Move a task to before or after another task. Use final to make a task final. Final tasks must follow all non final tasks. If neither before or after are specified, the task will be moved to the last position respecting the final parameter.
	 Required parameters: plan, job, task or id
	 Optional parameters: after or before, final
getTask - Get detail information on a task from a plan job. Use --task @all to give detail information on all tasks for a job.
	 Required parameters: plan, job, task or id
addRepository - Add a global or plan repository. For a plan repository, you can reference a linked (global) repository. Otherwise a valid repository key or alias is required. Valid aliases are: BITBUCKET, BITBUCKET_CLOUD, BITBUCKET_SERVER, STASH, BCVS, GIT, GITHUB, MERCURIAL, PERFORCE, SUBVERSION
	 Required parameters: repository or name
	 Optional parameters: plan, repositoryKey, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateRepository - Update a global or plan repository.
	 Required parameters: repository or id
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeRepository - Remove global or plan repository. Use @all to remove all repositories.
	 Required parameters: repository or id
	 Optional parameters: plan, continue
getRepository - Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.
	 Required parameters: repository
	 Optional parameters: plan
orderRepository - Order repository in the list of repositories for a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository name.
	 Required parameters: plan, repository
	 Optional parameters: after
addRequirement - Add requirement to a plan job.
	 Required parameters: plan, job, requirement
	 Optional parameters: type, value
updateRequirement - Update a plan requirement.
	 Required parameters: plan, job, id
	 Optional parameters: enabletype, disable,value
fields,removeRequirement field1,- value1,Remove field2,a value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeTask - Remove a task fromplan requirement.
	 Required parameters: plan, job, id
addNotification - Add a plan jobnotification. There Useare id2 =parts -1to toa removenotification all- tasks.an 	event Requiredthat parameters:triggers plan,the job,notification idand addRepositorya -recipient Addtype athat globaldetermines orthe plannotification repositoryprotocol. 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, SUBVERSIONThere are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are available.
	 Required parameters: repositoryplan, orevent, namerecipientType
	 Optional parameters: plan, repositoryKeyrecipient, replace, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateRepository - Update a global or plan repository.
	 Required parameters: repository or id, field7, value7, field8, value8
removeNotification - Remove a plan notification. Use id of -1 to remove all notifications for a plan.
	 Required parameters: plan, id
addVariables - Add global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values,
	 Optional parameters: plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeRepositoryupdateVariables - Update Removeexisting global or plan repositoryvariables. Use @allDefaults to remove all repositories.
	 Required parameters: repository or id
	 Optional parameters: plan, continue
getRepository - Get details of a global or plan repository. Sets the repository and repositoryId replacement variables.
	 Required parameters: repository
	 Optional parameters: plan
orderRepository - Order repository in the list of repositories for a plan. Defaults to move the repository to the top to make it the default repository. Otherwise specify the after respository name.
	 Required parameters: plan, repository
	 Optional parameters: after
addRequirement - Add requirement to a plan job.
	 Requiredglobal variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values,
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeVariables - Remove global or plan variables. Specify the variable names using the field parameters.
	 Optional parameters: plan, jobfields, requirementfield1, 	value1, Optional parameters: type, value
updateRequirement - Update a plan requirement.
	 Required parameters: plan, job, id
	 Optional parameters: type, value
removeRequirement - Remove a plan requirement.
	 Required parameters: plan, job, id
addNotification - Add a plan notification. There are 2 parts to a notification - an event that triggers the notification and a recipient type that determines the notification protocol. There are built-in notifications and others provided by add-ons. A recipient type may have additional parameters. Generally, these can be specified by the field and values parameters. In some cases, pre-defined parameters are availablefield2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addTrigger - Add a trigger to a plan. Pre-defined types are: polling, remote, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories. Polling triggers default to all plan repositories or use repository @all. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Use of the name parameter is deprecated - description should be used instead.
	 Required parameters: plan, event, recipientTypetype
	 Optional parameters: description, repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeNotificationremoveTrigger - Remove a plan notificationtrigger from a plan. Use id of= -1 to remove all notifications for a plantriggers.
	 Required parameters: plan, id
addVariablesaddAgent - Add global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values,
	 Optional parameters: plan, replace fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
updateVariables - Update existing global or plan variables. Defaults to global variables unless a plan is specified. Use the field parameters for the variable name and the corresponding value parameters for the variable values, a local agent.
	 Required parameters: agent
	 Optional parameters: description
removeAgent - Remove an agent.
	 Required parameters: agent
enableAgent - Enable an agent.
	 Required parameters: agent
disableAgent - Disable an agent.
	 Required parameters: agent
addAgentAssignment - Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error.
	 Required parameters: agent, assignment
	 Optional parameters: continue
removeAgentAssignment - Remove an assignment from a specific agent. Use continue to ignore not found error.
	 Required parameters: agent, assignment
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeVariables - Remove global or plan variables. Specify the variable names using the field parameters.
	 Optional parameters: plan, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addTrigger - Add a trigger to a plan. Pre-defined types are: polling, remote, scheduled. One or more repositories can be specified for pre-defined type triggers based on repositories. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters. Alias types are: stashTrigger continue
createDeploymentProject - Experimental. Create a deployment project for a plan.
	 Required parameters: plan, name
	 Optional parameters: description, branch
getDeploymentProject - Experimental. Get information for a deployment project by name or id.
	 Required parameters: deploymentProject
deleteDeploymentProject - Experimental. Delete a deployment project by name or id.
	 Required parameters: deploymentProject
	 Optional parameters: continue
addEnvironment - Experimental. Add an environment to deployment project.
	 Required parameters: deploymentProject, name
	 Optional parameters: description
getEnvironment - Experimental. Get information for an environment from a deployment project by name or id.
	 Required parameters: deploymentProject, environment
	 Optional parameters: file, encoding
removeEnvironment - Experimental. Remove an environment from a deployment project by name or id.
	 Required parameters: plandeploymentProject, name, typeenvironment
	 Optional parameters: repository, schedule, ipRestriction, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
removeTrigger - Remove a trigger from a plan. Use id = -1 to remove all triggers. Server instances only.
	 Required parameters: plan, id
addAgent - Add a local agent.
	 Required parameters: agent
	 Optional parameters: description
removeAgent - Remove an agent.
	 Required parameters: agent
enableAgent - Enable an agent.
	 Required parameters: agent
disableAgent - Disable an agent.
	 Required parameters: agent
addAgentAssignment - Assign a project, plan, or job to a specific agent. This makes the agent is dedicated to only perform builds for all assignments. Use continue to ignore already exists error continue
deployEnvironment - Experimental. Deploy environment. To promote (re-deploy) an existing version, use --replace.
	 Required parameters: deploymentProject, environment, version
	 Optional parameters: build, number, replace
addEnvironmentTask - Experimental. Add a task to a deployment environment.
	 Required parameters: deploymentProject, environment, taskKey
	 Optional parameters: description, fields, field1, value1, field2, value2, field3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8
addEnvironmentTrigger - Experimental. Add a trigger to a deployment project. Pre-defined types are: scheduled, afterSuccessfulStage. One or more repositories can be specified for pre-defined type triggers based on repositories. Custom types can be specified with the appropriate trigger key (or alias) and all required parameters using the various field parameters.
	 Required parameters: deploymentProject, agentname, assignmenttype
	 Optional parameters: continuerepository, removeAgentAssignmentschedule, -ipRestriction, Removefields, anfield1, assignmentvalue1, fromfield2, avalue2, specific agent. Use continue to ignore not found error.
	 Required parameters: agent, assignment
	 Optional parameters: continuefield3, value3, field4, value4, field5, value5, field6, value6, field7, value7, field8, value8