Show TOC

CBS Command Line ToolLocate this document in the navigation structure

Use

Here you can find information about the Component Build Service (CBS) command line tool. The CBS command line tool allows you to retrieve CBS status information and perform administrative tasks in a shell-oriented environment.

The CBS command line tool provides some commands which are related to software logistics:

  • downloaddcarc

  • downloadsca

  • uploaddcarc

  • uploadsca

We recommend that you do not to use these commands to bypass Change Management Service (CMS). You should execute all tasks related to software logistics in the CMS.

Starting the Tool

For more information, see Starting Command Line Tools .

Help

You can use the help command to obtain an overview of the existing commands. To display information about a specific command, enter help <command name> . This will show the command syntax and a short description of the command.

You can get a printout with the full list of the commands and their parameters, arguments, and examples of their usage using the command help -x <location to export the commands>\CBS.doc .

Spooling Log Messages

By default, the command line tool writes user messages directly to the console. In some cases you may need to redirect the location where the information for the error messages is logged. You can redirect these user messages to a file using the spool command.

For example, to start spooling to the file c:\temp\spool.txt , use the command as follows:

spool c:\ temp \spool.txt

Note that if such a file already exists it will be overwritten.

Commands

Some of the commands require that a valid CBS connection is established. For more information about doing this, see Establishing a CBS Connection .

List of Commands

Command Name

Description

activate/act

Activates the specified activities.

analyze

Analyzes request logs, build logs or component data that were downloaded.

bsstate

Shows information about the specified build space.

buildall

Builds all DCs of the specified compartment and build space.

builddc

Builds the specified development component.

cancelrequest/cr

Cancels the specified request.

connect

Connects to a CBS.

createbs

Creates a build space.

createimportrequest/cir

Creates an import request.

deletedc

Deletes the specified DC (archives) from the build space.

deletedcs

Deletes specified DCs (archives) from the build space.

downloadbuildlogs/logs

Downloads all DC build logs for the specified DC.

downloadcomp

Downloads archives of the specified compartment(s).

downloadrequestlogs/reqlogs

Downloads the request logs for the specified request id.

downloadconfig

Downloads the development configuration of a build space.

downloaddcarc

Downloads the archive of a specified development component.

exec

Executes the specified OS command in a separate process.

exit

Exits the application.

getbuildnumber/getbn

Shows the build number for the specified build space.

help

Provides help for commands.

initcompartment

Initializes the specified compartment.

latestbn

Shows the build number of the latest successful DC build.

listbuildspaces/lbs

Shows all build spaces on the CBS.

listbuildvariants/lbv

Shows build variants of the specified compartment.

listcompartments/lcomp

Shows compartments of the specified build space.

listdcs/ldcs

Shows development components of the specified compartment.

listopenrequests/lor

Shows open requests of the build space.

listpendingactivities/lpa

Shows pending activities for activation.

removebs

Removes the specified build space.

requeststate/rstate

Shows the state of the specified request.

rootcauseanalysis/rca

Checks for the root causes of broken DCs.

script

Runs a set of commands from a (script) file.

setbuildnumber/setbn

Sets the build number for the specified build space.

setinputmode

Sets the input mode for the specified build space.

spool

Writes the trace to specified trace file.

startup

Provides common options/arguments for the application startup.

submitrequest/sr

Submits the specified request.

switchoff

Turns off the specified build space switch.

switchon

Turns on the specified build space switch.

timing

Activates/deactivates command execution time reporting.

tracefile

Specifies the trace file for technical messages such as stack traces.

traceperf

Starts/stops performance tracing of this application/the specified profile.

transferbuildnumber/tbn

Transfers the build number.

updatebs

Updates the development configuration of the specified build space.

uploaddcarc

Uploads the archive of the specified development component.

uploadsca

Uploads a software component archive to the CBS.

vars

List currently defined variables, clears variables or sets variable value.

waitforemptyqueue/weq

Waits until all requests have been processed.