Build Management API reference

This section describes build management-related requests.

All database examples provided in this guide are specific to MySQL. If you use a different database, use syntax that is appropriate for your respective database.

createBuildClass

Creates a build class.

Required Arguments

buildClassName

Description: Name for the build class.

Optional Arguments

tagDefinition

Description: Format string that defines the resultant build name. The default is default_%GC%_%DATE%. This string generally consists of a generic build name appended with build-specific data that you construct from the following variables:

GC —Globally unique number (Global Counter)

LC —Number unique to the build class (Local Counter; the build serial number within the class)

BUILD_CLASS —User-defined build class name

BUILD_CLASS_ID —System-generated number that the Cluster Manager uses to identify each class

USER_NAME —Name of the user who invoked eMake

MACHINE_NAME —Name of the machine where eMake was invoked

USER_BUILD_LABEL —Label specified at the eMake command line. For example, --emake-build-label=my_build

BUILD_OS_ID —Operating system ID under which the build was invoked (0 = undefined, 1 = Windows, 2 = Solaris, and 3 = Linux)

DATE —Build start date and time using variables Y, y, m, d, H, M, and S (for example, 2005-01-18 10:14:32 is 20050118101432 )

Y —Year at build start time ( YYYY )

y —Year at build start time ( YY )

m —Sequential month number at build start time ( 1-12 )

d —Sequential day of month at build start time ( 1-31 )

H —Hour of the day at build start time ( 0-23 )

M —Minutes at build start time ( 0-59 )

S —Seconds at build start time ( 0-60 )

a —Abbreviated day of week at build start time ( WED )

A —Full name day of week at build start time ( Wednesday )

b —Abbreviated month name at build start time ( AUG )

B —Full month name at build start time ( August )

c —Build start date and time using the variables A, B, d, H, M, S, and Y (for example, 2005-01-18 10:14:32 means 18/01/05 10:14:32 )

For information about constructing tag definitions, Tag Definitions.

.

annotationLevels

Description: Comma-separated list of values that indicates which levels of information to include in the annotation file. The possible values are basic, env, history, file, lookup, waiting, or registry (Windows only). An annotation file is not created until you specify at least one annotation level.

Basic annotation includes annotation for the JobCache feature.

(For more information see Job Caching.

maxAgents

Description: Maximum number of agents that can be assigned to this build. The default is 64.

minAgents

Description: Minimum number of agents required for this build to run. The default is 2.

platform

Description: OS being used or supported. The possible values are Windows, Linux, or Solaris. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. The default is that no platforms are specified.

priority

Description: Priority for builds in this class. You can use one of three levels of priority: high, normal, and low. The default is 120 (middle of the normal priority range). The priority can be adjusted up or down by 1-10 to “boost” the priority to give certain classes preference over other builds of the same priority level. Higher boost values mean greater preference.

The value must be a number in one of the following three ranges:

  • 230 to 210 (high priority range). 220 is high priority with no boost

  • 130 to 110 (normal priority range). 120 is normal priority with no boost

  • 30 to 10 (low priority range). 20 is low priority with no boost

Description:

annoUpload

Description: Specifies whether to upload the annotation file to the Cluster Manager. The possible values are Y, 1, or true (upload) or N, 0, or false (do not upload). The default is N.

jobcacheAllowed

Description: Specifies whether the JobCache feature is allowed for this build class. The possible values are Y, 1, or true (allow) or N, 0, or false (do not allow). The default is N, except for the default build class and for build classes that exist when you upgrade to Accelerator 8.0 .

(For more information about JobCache, see Job Caching.)

resourceRequest

Description: Name of an existing resource. This requests a particular type of agent from the cloud provider.

Syntax

cmtool createBuildClass <buildClassName> [optionals...]

Example

cmtool createBuildClass batch --minAgents 5 --maxAgents 12 --priority 30 --resourceRequest blades

Creates a build class named batch that requires a minimum of 5 agents and a maximum of 12 agents. The priority is relatively low, and the requested resource is named blades.

createBuildClassComment

Creates a new build class comment.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. Use getBuildClasses to retrieve a list of build class IDs.

text

Description: The comment text.

Optional Arguments

None

Syntax

cmtool createBuildClassComment <buildClassId> <text>

Example

cmtool createBuildClassComment 7 "This build class is for QA builds."

Creates a comment for build class 7.

createBuildComment

Creates a new build comment.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

text

Description: The comment text.

Optional Arguments

None

Syntax

cmtool createBuildComment <buildId> <text>

Example

cmtool createBuildComment 1044 "This is our gold build for release 7.0"

Creates a comment for build 1044.

deleteBuild

Deletes a build, including all dependent records.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

Optional Arguments

None

Syntax

cmtool deleteBuild <buildId>

Example

cmtool deleteBuild 1037

Deletes build 1037.

deleteBuildClass

Deletes a build class, including all dependent records.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. Use the getBuildClasses command to retrieve a list of build class IDs.

Optional Arguments

None

Syntax

cmtool deleteBuildClass <buildClassId>

Example

cmtool deleteBuildClass 7

Deletes build class 7.

deleteBuildClasses

Deletes a set of build classes, including all dependent records.

Required Arguments

None

Optional Arguments

If no filter is provided, all build classes (except the default) will be deleted.

filter

Description: A SQL query used to limit the result set. See the possible values below. For a list of possible SQL values, see the getBuildClasses command.

Syntax

cmtool deleteBuildClasses [optionals...]

Example

cmtool deleteBuildClasses --filter "max_agents >20"

Deletes all build classes with more than 20 maximum agents.

deleteBuildClassComment

Deletes a build class comment.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class.

commentId

Description: The unique key that identifies a comment.

Optional Arguments

None

Syntax

cmtool deleteBuildClassComment <buildClassId> <commentId>

Example

cmtool deleteBuildClassComment 6 1018

Deletes comment 1018 for build class 6.

deleteBuildComment

Deletes a build comment.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build.

commentId

Description: The unique key that identifies a comment. Use the getBuildComments command to retrieve a list of comment IDs.

Optional Arguments

None

Syntax

cmtool deleteBuildComment <buildId> <commentId>

Example

cmtool deleteBuildComment 1037 1019

Deletes build comment 1019 for build 1037.

deleteBuilds

Deletes a set of builds, including all dependent records.

It is important to remove build logs periodically so they do not fill up the Cluster Manager’s available disk space. Uploaded annotation is also considered part of build logs, so remember to clean up build logs regularly if annotation is frequently uploaded to the Cluster Manager.

You can also manage build logs using the Cluster Manager web interface. Select the Builds tab, and then create and run a “Builds by Date” filter to display the set of builds that you want to remove. Click Delete Filtered Builds to remove the build logs from disk and from the database.

Required Arguments

If no argument is provided, all builds will be deleted.

Optional Arguments

filter

Description: SQL query used to limit the result set. For a list of possible SQL values, see the getBuilds command.

Syntax

cmtool deleteBuilds [optionals...]

Example

cmtool deleteBuilds --filter "start_time <date_sub(curdate( ), interval 20 day)"

Deletes all builds more than 20 days old.

This example is valid for MySQL only. If you use a different database, use syntax that is appropriate for your respective database.

getBuild

Finds a build with full detail by the build’s ID number.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

Optional Arguments

None

Result Tags

See the getBuilds command for descriptions.

allocatedAgents buildClassId buildClassName buildId buildLogDir buildName commandLine conflicts cwd duration effectiveAgentAlloc emakeVersion historyExists historyFile hostName

ipAddress jobCount lastRequestTime maxAgents minAgents osUserName platform priority resourceRequest result requestedAgents startTime userLabel userName waitTime

Syntax

cmtool getBuild <buildId>

Example

cmtool getBuild 1000

Retrieves build 1000.

getBuilds

Retrieves a list of builds.

Required Arguments

None

Optional Arguments

filter

Description: A SQL query used to limit the result set. See the possible values below.

There is a syntax difference between MySQL and Oracle/MS SQL for enclosing criteria when using this argument for specific strings—for MySQL, use double quotes; for Oracle/MS SQL, use single quotes.

maxResults

Description: The maximum number of elements to run from a query.

firstResult

Description: The starting index for the query result set.

This argument takes values beginning with 0. A negative value indicates a record starting from the end of the set, counting backwards, so -1 is the last record, -2 is the next to last, and so on.

order

Description: A SQL order by clause. Used to specify ordering for the query result set.

profile

Description: Can be details or info. This is the level of detail to return from a query; details gets all information and info gets a reduced information set.

You must set this argument to details in order to print fields that are part of the details category.

Result Tags and SQL Query Names

allocatedAgents

Description: The number of currently assigned agents for this build. SQL query name for --filter and --order: N/A

availableResults

Description: This is a count of ’max’ or ’first’ results if --maxResults or --firstResult is specified. SQL query name for --filter and --order: N/A

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. SQL query name for --filter and --order: build_class_id

buildClassName

Description: A name assigned by the user for the build class. SQL query name for --filter and --order: build_class_name

buildId

Description: A unique number assigned by the Cluster Manager for each build. SQL query name for --filter and --order: id

buildLogDir

Description: The directory containing uploaded build logs. SQL query name for --filter and --order: N/A

buildName

Description: The build name that is the expanded build class tag. SQL query name for --filter and --order: build_name

commandLine

Description: The original command-line invocation of eMake. SQL query name for --filter and --order: command_line

conflicts

Description: The number of conflicts in the build. SQL query name for --filter and --order: conflicts

cwd

Description: The current working directory where eMake was invoked. SQL query name for --filter and --order: cwd

duration

Description: The number of milli-seconds the build has been running.

duration for running builds is always 0. SQL query name for --filter and --order: duration

effectiveAgentAlloc

Description: The effective agent allocation percentage. 100% means eMake had all the hosts it needed all the time, while a lesser percentage means eMake had the hosts it needed for that percent of time.

The effectiveAgentAlloc for running builds is always 0. SQL query name for --filter and --order: effective_agent_alloc

emakeVersion

Description: The eMake version used for this build. SQL query name for --filter and --order: emake_version

historyExists

Description: True means the history file existed and was used by the build. SQL query name for --filter and --order: history_exists

historyFile

Description: The name of the eMake history file. SQL query name for --filter and --order: history_file

hostName

Description: The name of the machine where eMake was invoked. SQL query name for --filter and --order: host_name

ipAddress

Description: The IP address of the machine where eMake was invoked. SQL query name for --filter and --order: ip_address

jobCount

Description: The total number of jobs that ran for the build.

job_count for running builds is always 0. SQL query name for --filter and --order: job_count

lastRequestTime

Description: The last time eMake requested agents for this build. SQL query name for --filter and --order: N/A

maxAgents

Description: The maximum number of agents to request for this build. SQL query name for --filter and --order: max_agents

minAgents

Description: The minimum number of agents required for this build to run. SQL query name for --filter and --order: min_agents

osUserName

Description: The OS-level name for the user who started eMake. SQL query name for --filter and --order: os_user_name

platform

Description: The operating system being used/supported. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. SQL query name for --filter and --order: platform

priority

Description: The build priority level. When assigning resources, an optional priority boost value can be selected to give a build class preference over other builds of the same priority level. Higher boost values correspond to greater preference. SQL query name for --filter and --order: priority

resourceRequest

Description: A request to the cloud provider for a particular type of agent. SQL query name for --filter and --order: resource_request

result

Description: The build result code. -1 means the build is still running, 0-254 are actual exit codes, 256 means the build timed out, and 257 means the build was stopped. SQL query name for --filter and --order: result

requestedAgents

Description: The number of agents eMake requested. SQL query name for --filter and --order: N/A

startTime

Description: The time the build was started. SQL query name for --filter and --order: start_time

userLabel

Description: The user-supplied label (via the eMake command-line), attached to the build. SQL query name for --filter and --order: user_label

userName

Description: The unique name of the user. SQL query name for --filter and --order: user_name

waitTime

Description: The number of seconds eMake was stalled because it had to wait for agents.

wait_time for running builds is always 0. SQL query name for --filter and --order: wait_time

Syntax

cmtool getBuilds [optionals...]

Example

cmtool --output simple --fields "startTime,buildName,userName,duration" getBuilds --filter "duration >10000"

Returns the start time, build name, userName, and duration of all builds that ran more than 10 seconds.

getBuildComments

Retrieves a list of related build comments.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

Optional Arguments

commentId

Description: The unique key that identifies a comment.

Result Tags

commentId

Description: The unique key that identifies a comment.

createTime

Description: The time when the item was created.

lastModifiedBy

Description: The user who last modified the item.

modifyTime

Description: The time when the item was last modified.

text

Description: The text of the item.

Syntax

cmtool getBuildComments <buildId> [optionals...]

Example

cmtool getBuildComments 1000 --commentId 1039

Retrieves comment 1039 for build 1000.

getBuildClass

Finds a build class with full detail by its ID.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. Use the getBuildClasses command to retrieve a list of build class IDs.

Optional Arguments

None

Result Tags

See the getBuildClasses command for descriptions.

annotationLevelsannoUploadbuildClassIdbuildClassName
defaultClassmaxAgentsminAgentsnotifyOnBuildEnd
platform
priorityresourceRequesttagDefinition

Syntax

cmtool getBuildClass <buildClassId>

Example

cmtool getBuildClass 1

Retrieves build class 1.

getBuildClasses

Retrieves a list of build classes with limited detail.

Required Arguments

None

Optional Arguments

filter

Description: A SQL query used to limit the result set. See the possible values below.

There is a syntax difference between MySQL and Oracle/MS SQL for enclosing criteria when using this argument for specific strings—for MySQL, use double quotes; for Oracle/MS SQL, use single quotes.

maxResults

Description: The maximum number of elements to run from a query.

firstResult

Description: The starting index for the query result set.

This argument takes values beginning with 0. A negative value indicates a record starting from the end of the set, counting backwards, so -1 is the last record, -2 is the next to last, and so on.

order

Description: SQL order by clause. Used to specify ordering for the query result set.

profile

Description: Can be details or info. This is the level of detail to return from a query; details gets all information and info gets a reduced information set.

Result Tags and SQL Query Names

annotationLevels

Description: Annotation choices to include in the annotation file. Possible values are basic, history, file, lookup, and waiting. SQL query name for --filter and --order: annotation_levels

annoUpload

Description: If set to true, the annotation file is uploaded to Cluster Manager. SQL query name for --filter and --order: anno_upload

availableResults

Description: This is a count of ’max’ or ’first’ results if --maxResults or --firstResult is specified. SQL query name for --filter and --order: N/A

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. SQL query name for --filter and --order: id

buildClassName

Description: A name assigned by the user for the build class. SQL query name for --filter and --order: build_class_name

defaultClass

Description: If set, this is the default build class and cannot be deleted. SQL query name for --filter and --order: default_class

maxAgents

Description: The maximum number of agents to request for this build. SQL query name for --filter and --order: max_agents

minAgents

Description: The minimum number of agents required for this build to run. SQL query name for --filter and --order: min_agents

notifyOnBuildEnd

Description: If set to true, the currently logged-in user will receive an email when the build is finished. SQL query name for --filter and --order: notify_on_build_end

platform

Description: The operating system being used/supported. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. SQL query name for --filter and --order: platform

priority

Description: The build priority level. When assigning resources, an optional priority boost value can be selected to give a build class preference over other builds of the same priority level. Higher boost values correspond to greater preference. SQL query name for --filter and --order: priority

resourceRequest

Description: A request to the cloud provider for a particular type of agent. resource_request

tagDefinition

Description: A format string that defines the resulting build name. SQL query name for --filter and --order: tag_definition

Syntax

cmtool getBuildClasses [optionals...]

Example

cmtool getBuildClasses --filter "min_agents <5"

Retrieves a list of build classes that require less than 5 agents.

getBuildClassComments

Retrieves a list of related build class comments.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager for each build class. You can use the getBuildClasses command to retrieve a list of build class IDs.

Optional Arguments

commentId

Description: The unique key that identifies a comment.

Result Tags

commentId

Description: The unique key that identifies a comment.

createTime

Description: The time when the item was created.

lastModifiedBy

Description: The user who last modified the item.

modifyTime

Description: The time when the item was last modified.

text

Description: The text of the item.

Syntax

cmtool getBuildClassComments <buildClassId> [optionals...]

Example

cmtool getBuildClassComments 1000 --commentId 1039

Retrieves comment 1039 for build 1000.

Example

cmtool getBuildClassComments 12

Retrieves all build class comments for build class 12.

getBuildUserStats

Retrieves a list of user build statistics, grouped by user name, IP address, or host name.

Required Arguments

groupBy

Description: Can be hostName, ipAddress, or userName.

Optional Arguments

filter

Description: A SQL query used to limit the result set. See the possible values below.

There is a syntax difference between MySQL and Oracle/MS SQL for enclosing criteria when using this argument for specific strings—for MySQL, use double quotes; for Oracle/MS SQL, use single quotes.

order

Description: A SQL order by clause. Used to specify ordering for the query result set.

Result Tags and SQL Query Names

duration

Description: The total number of milli-seconds of all builds, filtered by the value specified in the ` groupBy ` argument. SQL query name for --filter and --order: N/A duration

entryName

Description: The value specified in the groupBy ` argument. If `groupBy ` is "userName", the entry name is the user name. SQL query name for `--filter and --order: N/A

numOfBuilds

Description: The number of builds. SQL query name for --filter and --order: N/A

waitTime

Description: The number of seconds eMake was stalled because it had to wait for agents. SQL query name for --filter and --order: wait_time

workload

Description: The total number of seconds used by the agents for all of the filtered builds. SQL query name for --filter and --order: workload

Syntax

cmtool getBuildUserStats <groupBy> [optionals...]

Example

cmtool getBuildUserStats hostName --filter "duration >30000" --order "waitTime desc, entryName asc"

Retrieves build user statistics for builds longer than 30 seconds, grouped by host name and ordered by wait time in a descending order and by entry name (in this case host name) in an ascending order.

getMetrics

Returns metrics data for a particular metric. The response is in XML format.

Required Arguments

<metricType>

Description: Key name of a metric. For example, ConcurrentBuilds. For a list of the available metrics, use the getMetricTypes command and look for the values of the <key> elements in the output.

Optional Arguments

None

Syntax

cmtool getMetrics <metricType>

Example

cmtool --secure getMetrics ConcurrentBuilds

Returns the metrics for the specified metric type.

getMetricTypes

Returns the available metric types. The response is in XML format.

Required Arguments

None

Optional Arguments

None

Syntax

cmtool getMetricTypes

Example

cmtool --output=simple getMetricTypes

Returns the available metric types.

modifyBuild

Modifies a build.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build.

priority

Description: Can be Low or Normal, but not High.

Optional Arguments

None

Syntax

cmtool modifyBuild <buildId> <priority>

Example

cmtool modifyBuild 1137 20

Changes build 1137 to priority 20.

modifyBuildClass

Modifies a build class.

Required Arguments

buildClassId

Description: Unique number assigned by the Cluster Manager for the build class. You can use the getBuildClasses command to retrieve a list of build class IDs.

Optional Arguments

buildClassName

Description: User-defined name of the build class.

tagDefinition

Description: Format string that defines the resultant build name. The default is default_%GC%_%DATE%. This string generally consists of a generic build name appended with build-specific data that you construct from the following variables:

GC —Globally unique number (Global Counter)

LC —Number unique to the build class (Local Counter; the build serial number within the class)

BUILD_CLASS —User-defined build class name

BUILD_CLASS_ID —System-generated number that the Cluster Manager uses to identify each class

USER_NAME —Name of the user who invoked eMake

MACHINE_NAME —Name of the machine where eMake was invoked

USER_BUILD_LABEL —Label specified at the eMake command line. For example, --emake-build-label=my_build

BUILD_OS_ID —Operating system ID under which the build was invoked (0 = undefined, 1 = Windows, 2 = Solaris, and 3 = Linux)

DATE —Build start date and time using variables Y, y, m, d, H, M, and S (for example, 2005-01-18 10:14:32 is 20050118101432 )

Y —Year at build start time ( YYYY )

y —Year at build start time ( YY )

m —Sequential month number at build start time ( 1-12 )

d —Sequential day of month at build start time ( 1-31 )

H —Hour of the day at build start time ( 0-23 )

M —Minutes at build start time ( 0-59 )

S —Seconds at build start time ( 0-60 )

a —Abbreviated day of week at build start time ( WED )

A —Full name day of week at build start time ( Wednesday )

b —Abbreviated month name at build start time ( AUG )

B —Full month name at build start time ( August )

c —Build start date and time using the variables A, B, d, H, M, S, and Y (for example, 2005-01-18 10:14:32 means 18/01/05 10:14:32 )

For information about constructing tag definitions, see Tag Definitions.

annotationLevels

Description: Comma-separated list of values that indicates which levels of information to include in the annotation file. The possible values are basic, env, history, file, lookup, waiting, or registry (Windows only). An annotation file is not created until you specify at least one annotation level.

Basic annotation includes annotation for the JobCache feature .

(For more information about JobCache, see Job Caching.)

maxAgents

Description: Maximum number of agents that can be assigned to this build. The default is 64.

minAgents

Description: Minimum number of agents required for this build to run. The default is 2.

platform

Description: OS being used or supported. The possible values are Windows, Linux, or Solaris. If an OS is specified for a build class, builds from other operating systems cannot affiliate themselves with this class. The default is that no platforms are specified.

priority

Description: Priority for builds in this class. You can use one of three levels of priority: high, normal, and low. The default is 120 (middle of the normal priority range). The priority can be adjusted up or down by 1-10 to “boost” the priority to give certain classes preference over other builds of the same priority level. Higher boost values mean greater preference.

The value must be a number in one of the following three ranges:

  • 230 to 210 (high priority range). 220 is high priority with no boost

  • 130 to 110 (normal priority range). 120 is normal priority with no boost

  • 30 to 10 (low priority range). 20 is low priority with no boost

annoUpload

Description: Specifies whether to upload the annotation file to the Cluster Manager. The possible values are Y, 1, or true (upload) or N, 0, or false (do not upload). The default is N.

jobcacheAllowed

Description: Specifies whether the JobCache feature is allowed for this build class. The possible values are Y, 1, or true (allow) or N, 0, or false (do not allow). The default is N, except for the default build class and for build classes that exist when you upgrade to Accelerator 8.0 .

(For more information about JobCache, see Job Caching.)

resourceRequest

Description: Name of an existing resource. This requests a particular type of agent from the cloud provider.

Syntax

cmtool modifyBuildClass <buildClassId> [optionals...]

Example

cmtool modifyBuildClass 1 --annoUpload true

Changes build class 1 to upload annotation files.

modifyBuildClassComment

Modifies a build class comment.

Required Arguments

buildClassId

Description: A unique number assigned by the Cluster Manager that identifies each build class.

commentId

Description: A unique key that identifies a comment.

text

Description: The comment text.

Optional Arguments

None

Syntax

cmtool modifyBuildClassComment <buildClassId> <commentId> <text>

Example

cmtool modifyBuildClassComment 1037 1129 "This is a low-priority class"

modifyBuildComment

Modifies a build comment.

Required Arguments

buildId

Description: A unique number assigned by the Cluster Manager for each build.

commentId

Description: The unique key that identifies a comment. Use the getBuildComments command to retrieve a list of comment IDs.

text

Description: The text of the item.

Optional Arguments

None

Syntax

cmtool modifyBuildComment <buildId> <commentId> <text>

Example

cmtool modifyBuildComment 16975 1137 "This is not a usable build"

setDatabaseConfiguration

Modifies database configuration settings.

Required Arguments

databaseName

Description: The database instance name.

databaseType

Description: The database type. Can be mariadb, mysql, oracle, or sqlserver.

hostName

Description: Machine name where the database is installed.

port

Description: Database port number.

userName

Description: Unique name of the user that is used to access the database.

password

Description: Secret value used to identify an account for a particular user.

Optional Arguments

None

Syntax

cmtool setDatabaseConfiguration <databaseName> <databaseType> <hostName> <port> <userName> <password>

stopBuild

Stops a running build. (This command has no effect on completed builds.)

Required Arguments

Use getBuilds --filter "result <0" to retrieve a list of running builds.

buildId

Description: A unique number assigned by the Cluster Manager for each build. Use the getBuilds command to retrieve a list of build IDs.

Optional Arguments

None

Syntax

cmtool stopBuild <buildId>

Example

cmtool stopBuild 16937