This chapter describes commands that you need to use to manage components and check-in jobs.
The CLI includes the following sets of commands for managing components.
Table 3–1 Sets of Commands for Managing Components
CLI Prefix |
Description of Command Set |
---|---|
cdb.c |
Commands for managing components |
cdb.ic |
Commands for retrieving information about installed components. |
cdb.vs |
Commands for managing variable settings objects. |
cdb.ssr |
Commands for managing system service ref objects. |
cdb.ctr |
Commands for managing component type ref objects. |
cdb.rsrc |
Commands for managing browsable components. |
cdb.cj |
Commands for controlling and monitoring component check-in jobs. |
This chapter describes all the commands in each of these sets.
The cdb.c commands provide general-purpose controls for managing components.
Table 3–2 CLI Commands for Managing Components
Command |
Description |
---|---|
cdb.c.ci |
Checks in non-browsable components and component models. |
cdb.c.co |
Checks out a component. |
cdb.c.la |
Lists all versions of all components. |
cdb.c.lo |
Lists detailed information about a component. |
cdb.c.lv |
Lists all versions of a component. |
cdb.c.mod |
Modifies a component. |
cdb.c.mv |
Moves or renames a component. |
cdb.c.sc |
Applies one or more categories to a component. |
cdb.c.sh |
Shows or hides a component. |
cdb.c.del |
Deletes a component |
Use the cdb.c.ci command to check in certain components. You will need to use this command in the following scenarios.
You need to check in a non-browsable component (for example: an untyped or container component).
If you need to check in a browsable component, use the cdb.rsrc.ci command. For a description of the command and its arguments, see cdb.rsrc.ci.
You need to check in a component model (the XML representation of a component), but not the referenced components or source objects. You might use this functionality when updating control blocks and variable values.
If you want to create new versions of the component and all of its referenced components, use the cdb.rsrc.ci command. For a description of the command and its arguments, see cdb.rsrc.ci.
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
path |
[R] |
InputStreamWrapper |
The location of the XML component definition |
major |
[O] |
Boolean |
Whether to checkin as a new major version; default false. |
import |
[O] |
Boolean |
Whether to import variable settings, default true |
hidePrev |
[O] |
Boolean |
Whether to hide the previous component, default true. |
parents |
[O] |
Boolean |
Whether nonexistent parent folders are created during component check-in. Default is false. |
result |
Component |
The new component |
This command checks out a component. It outputs the specified component in XML format.
Table 3–4 Argument and Result for the cdb.c.co Command
Arguments/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The ID of the component XML to view. |
result |
Component |
The component in XML format |
The command lists all versions of all components.
Table 3–5 Arguments and Result for the cdb.c.la Command
Arguments/Result |
Syntax |
Description |
|
---|---|---|---|
sh |
[O] |
Boolean |
Whether hidden components are shown, default false |
cat |
[O] |
CategoryID |
Category filter to apply, default “all” |
folderID |
[O] |
FolderID |
Parent folder ID; default is the root folder (NM:/) |
flatView |
[O] |
Boolean |
Whether results should be displayed in flat view; default is true |
result |
SummaryComponent- Array |
The components |
This command lists the details of a specified component.
Table 3–6 Arguments and Result for the cdb.c.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to view |
result |
Component |
The component |
This command lists all the versions of the specified component.
Table 3–7 Argument and Result for the cdb.c.lv Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component |
result |
SummaryComponent- Array |
All the versions of the component |
This command modifies a component, which results in a new version of the component.
Table 3–8 Arguments and Result for the cdb.c.mod Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component |
label |
[O] |
String |
The component label |
desc |
[O] |
String |
The component description |
rva |
[O] |
StringArray |
The component versions; use version number, “#” for recommended, “+” for default, and “-“ for latest; or omit this argument to use latest for all components. This argument is only applicable for composite components. |
hidePrev |
[O] |
Boolean |
Whether to hide the previous version. Default is true. |
result |
Component |
The component |
This command moves or renames a component.
Table 3–9 Arguments for the cdb.c.mv Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to move or rename |
fullname |
[R] |
String |
The new full name (path + name) of the component |
This command associates a component with a set of categories.
Table 3–10 Arguments and Result for the cdb.c.sc Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to affect |
catIDs |
[R] |
CategoryIDSet |
The IDs of the Categories to associate with this component |
all |
[O] |
Boolean |
Whether to change all versions of the component, default false |
This command associates a component with a set of categories.
Table 3–11 Arguments and Result for the cdb.c.sc Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to affect |
catIDs |
[R] |
CategoryIDSet |
The IDs of the Categories to associate with this component |
all |
[O] |
Boolean |
Whether to change all versions of the component, default false |
This command deletes a component.
Table 3–12 Arguments for the cdb.c.del Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to delete |
all |
[O] |
Boolean |
Whether to delete all versions of the component, default false |
The cdb.ic commands retrieve information about components that are already installed on hosts.
Table 3–13 CLI Commands for Managing Installed Components
Command |
Description |
---|---|
cdb.ic.lbc |
Lists all the hosts on which a component is installed. |
cdb.ic.lbh |
Lists all the components installed on a specific host. |
cdb.ic.vs.lo |
Lists details of the specified generated variable settings object. |
This command lists all the hosts on which a particular component is installed.
Table 3–14 Argument and result for the cdb.ic Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component ID |
result |
InstalledComponent- BeanArray |
The installed components |
This command lists all the components installed on a particular host.
Table 3–15 Argument and Result for the cdb.ic.lbh Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
host |
[R] |
HostID |
The host ID |
cat |
[O] |
CategoryID |
Category filter to apply; default all |
result |
InstalledComponent- BeanArray |
The installed components |
This command lists details of a particular generated variable settings object..
Table 3–16 Argument and Result for the cdb.ic.vs.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
InstalledComponentID |
The ID of the installed component whose generated variable settings will be viewed. |
result |
GeneratedVariable- Settings |
The generated variable settings |
The cdb.vs commands manage variable settings for components.
Table 3–17 CLI Commands for Managing Variable Settings
Command |
Description |
---|---|
cdb.vs.add |
Adds a new variable settings object. |
cdb.vs.del |
Deletes a variable settings object. |
cdb.vs.imp |
Imports a variable settings object from one component into another. |
cdb.vs.la |
Lists all the variable settings objects associated with a specific component. |
cdb.vs.lo |
Lists the details of a specific variable settings object. |
cdb.vs.mod |
Modifies a variable settings object. |
This command adds a new variable settings object
Table 3–18 Arguments and Result for the cdb.vs.add Command
Argument/Result |
Syntax |
Result |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component |
name |
[R] |
String |
The new name |
vars |
[R] |
Hashtable |
The new override values |
result |
ComponentVariable- Settings |
The new component variable settings |
This command deletes an existing variable settings object.
Table 3–19 Argument for the cdb.vs.del Command
Argument |
Syntax |
Description |
|
---|---|---|---|
vs |
[R] |
ComponentVariable- SettingsID |
The ID of the component variable settings to delete |
This command imports variable settings from one component into another.
Table 3–20 Arguments for the cdb.vs.imp Command
Argument |
Syntax |
Description |
|
---|---|---|---|
src |
[R] |
ComponentID |
The component to import variable settings from. |
dst |
[R] |
ComponentID |
The component to import variable settings to |
This command lists all variable settings objects associated with a particular component.
Table 3–21 Argument and Result for the cdb.vs.la Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
comp |
[R] |
ComponentID |
The component. |
result |
ComponentVariable- SettingsArray |
The component variable settings. |
This command lists details of a particular variable settings object.
Table 3–22 Argument and Result for the cdb.vs.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
vs |
[R] |
ComponentVariable- Settings |
The component variable settings to view |
result |
ComponentVariable- Settings |
The component variable settings |
This command modifies an existing variable settings object
Table 3–23 Arguments and Result for the cdb.vs.mod Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
vs |
[R] |
ComponentVariable- Settings |
The component variable settings |
name |
[O] |
String |
The new name |
vars |
[O] |
Hashtable |
The new override values |
result |
ComponentVariable- Settings |
The modified component variable settings |
Command |
Description |
---|---|
cdb.ssr.add |
Adds a system service ref |
cdb.ssr.mod |
Modifies an existing system service ref; omitted arguments preserve current values |
cdb.ssr.del |
Deletes a system service ref |
cdb.ssr.lo |
Retrieves a system service ref |
cdb.ssr.la |
Lists all system service refs |
This command adds a new system service ref.
Table 3–25 Argument and Result for the cdb.ssr.add Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
name |
[R] |
String |
The system service ref name |
desc |
[O] |
String |
The system service ref description |
icn |
[R] |
String |
The name of the referenced installed component |
icv |
[R] |
String |
The version of the referenced installed component |
icp |
[O] |
String |
The install path of the referenced installed component |
result |
SystemServiceRef |
The new system service ref |
This command modifies an existing system service ref; omitted arguments preserve current values.
Table 3–26 Argument and Result for the cdb.ssr.mod Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ssr |
[R] |
SystemServiceRef |
The target system service ref |
name |
[O] |
String |
The system service ref name |
desc |
[O] |
String |
The system service ref description |
icn |
[O] |
String |
The name of the referenced installed component |
icv |
[O] |
String |
The version of the referenced installed component |
icp |
[O] |
String |
The install path of the referenced installed component |
result |
SystemServiceRef |
The modified system service ref |
This command deletes a system service ref..
Table 3–27 Argument and Result for the cdb.ssr.del Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
SystemServiceRefID |
The system service ref ID |
This command retrieves a system service ref.
Table 3–28 Argument and Result for the cdb.ssr.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
SystemServiceRef |
The target system service ref |
result |
SystemServiceRef |
The system service ref |
This command lists all system service refs.
Table 3–29 Argument and Result for the cdb.ssr.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
result |
SystemServiceRefArray |
The system service refs |
Command |
Description |
---|---|
cdb.ctr.add |
Adds a new component type ref |
cdb.ctr.mod |
Modifies an existing component type ref; omitted arguments preserve current values |
cdb.ctr.del |
Deletes a component type ref |
cdb.ctr.lo |
Retrieves a component type ref |
cdb.ctr.la |
Lists all component type refs |
This command adds a new component type ref..
Table 3–31 Argument and Result for the cdb.ctr.add Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
name |
[R] |
String |
The component type ref name |
desc |
[O] |
String |
The component type ref description |
order |
[R] |
String |
The component type ref order |
group |
[R] |
String |
The component type ref group |
indentLevel |
[R] |
String |
The component type indent level |
compref |
[R] |
String |
The name of the component ref within the component type ref |
compver |
[R] |
String |
The version of the component ref within the component type ref |
result |
ComponentTypeRef |
The new component type ref |
Modifies an existing component type ref; omitted arguments preserve current values.
Table 3–32 Argument and Result for the cdb.ctr.mod Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ctr |
[R] |
ComponentTypeRef |
The target component type ref |
name |
[O] |
String |
The component type ref name |
desc |
[O] |
String |
The component type ref description |
order |
[O] |
String |
The component type ref order |
group |
[O] |
String |
The component type ref group |
indentLevel |
[O] |
String |
The component type indent level |
compver |
[O] |
String |
The version of the component ref within the component type ref |
result |
ComponentTypeRef |
The modified component type ref |
This command deletes a component type ref.
Table 3–33 Argument and Result for the cdb.ctr.del Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentTypeRefID |
The component type ref ID |
This command retrieves a component type ref.
Table 3–34 Argument and Result for the cdb.ctr.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentTypeRef |
The target component type ref |
result |
ComponentTypeRef |
The component type ref |
This command lists all component type refs.
Table 3–35 Argument and Result for the cdb.ctr.la Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
result |
ComponentTypeRef- Array |
The component type refs |
The cdb.rsrc commands provide general-purpose controls for managing components.
Table 3–36 CLI Commands for Managing Components
Command |
Description |
---|---|
cdb.rsrc.ci |
Checks in certain components and their resources to the repository. |
cdb.rsrc.cib |
Checks in all the components listed in a batch file. |
cdb.rsrc.co |
Checks out the specified component. |
cdb.rsrc.gd |
Generates a resource descriptor. |
cdb.rsrc.rci |
Rechecks in a component. |
cdb.rsrc.showopts |
Shows the check-in options that are supported by a particular type. |
Use the cdb.rsrc.ci command to check in certain components and their source objects. You will need to use this command in the following scenarios.
You need to check in a browsable component (for example: file or Weblogic EJB)
If you want to check in a non-browsable component, use the cdb.c.ci command. For a description of the command and its arguments, see cdb.c.ci.
You need to check in source objects for a simple component.
You need to check in the referenced components of a browsable, composite component.
Each invocation of the cdb.rsrc.ci command is considered a “check-in job,” and can be managed with the CLI commands for managing check-in jobs. For example, to determine which cdb.rsrc.ci commands are running, you can run the cdb.cj.la command, which lists all the current check-in jobs. You can also pass compCheckInID value returned by cdb.rsrc.ci as an argument to cdb.cj.lo to get status information about a specific check-in job.
Table 3–37 Arguments and Result for the cdb.rsrc.ci Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
src |
[R] |
String |
The local file/directory being checked in |
dst |
[R] |
String |
Which component name to check in as |
type |
[R] |
String |
The type of the component |
platform |
[O] |
HostSetID |
The platform of the component |
desc |
[O] |
String |
A description of the component |
major |
[O] |
Boolean |
Whether the version increment should be major or minor, default false |
config |
[O] |
Boolean |
Whether the component is a config file; the default is false |
hidePrev |
[O] |
Boolean |
Whether to hide the latest component; the default is true |
includeOwners |
[O] |
Boolean |
Whether to include owner information; the default is true |
includeGroups |
[O] |
Boolean |
Whether to include group information; the default is true |
addTo |
[O] |
Boolean |
Whether the files being checked in should be added to the existing files to create a new version of the component, instead of completely replacing the existing files to create a new component |
hostID |
[O] |
HostID |
The ID of the local host |
redun |
[O] |
Boolean |
Whether redundancy checking should apply; the default is true |
pickerName |
[O] |
String |
The name of the component picker to use (defaults to null for the default picker). |
extraOpts |
[O] |
Hashtable |
Names and values for any additional options for the type. config, includeOwners, includeGroups, addTo, and redun cannot be specified using the extraOpts argument. Instead, use the command-line equivalent options described in this table to specify these values. One example of an extraOpts parameter is descriptorPath. This parameter enables you to specify the path to the resource descriptor file that you plan to reference when checking in files. For more information, see Chapter 5, Resource Descriptor Schema, in Sun N1 Service Provisioning System 5.1 XML Schema Reference Guide. |
result |
CompCheckInID |
The ID for this component check in job. |
The command is the “check-in batch” command. It checks in all the components listed in a batch file.
Table 3–38 Arguments and Result of the cdb.rsrc.cib
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
batchfile |
[R] |
String |
The name of the batch file listing the components to be checked in |
haltonerror |
[O] |
Boolean |
When true, first error will halt batch execution, default true |
pwdrelative |
[O] |
Boolean |
When true, relative paths are relative to the user directory; otherwise they are relative to the batchfile location, defaults to false |
result |
String |
Message indicating the operation is complete |
The rsrc.cib operates on a batch file that includes a line for each component that will be checked in. Batch files enable you to check-in large numbers of component with a single command.
Each line in the batch file corresponds to a single component on the local machine that will be checked in as a single component. Each line consists of a series of fields that are separated by the pipe character (|). Some fields are optional and may be omitted. If an optional field is omitted but is followed by other fields, the omitted field should be followed by a | character, so that rsrc.cib can accurately identify each field.
You can include comments in a batch file. Any line that begins with the pound character (#) is interpreted as a comment.
The following table describes the syntax of a line of a batch file.
Table 3–39 Syntax of a Line in a Batch File
Content |
Optional/Required |
---|---|
The location of the component on the local machine |
Required |
The name to be assigned to the component when checked in |
Required |
The component type |
Required |
The platform the component is intended for expressed as a HostSetID in the form NM:<platform_name>, where <platform_name> is one of the platform names listed in Table 3–40. |
Optional |
A description of the component |
Optional |
A boolean designation of whether the file is a configuration file |
Optional (Default is false) |
A boolean designation of whether check-in should be assigned a major version number (e.g., 2.0) |
Optional (Default is false) |
A boolean designation of whether to hide the previous most recent version of the component |
Optional (Default is true) |
A boolean designation of whether to include owner information when storing permissions information |
Optional (Default is true) |
A boolean designation of whether to include group information when storing permissions information |
Optional (Default is true) |
A boolean designation of whether the files being checked in should be added to the existing files to create a new version, instead of creating a new version by completely replacing the existing files |
Optional (Default is true) |
If this component is being checked in a from a host, the host ID of the host from which the component is being checked in |
Optional |
A boolean designation of whether redundancy checking should apply |
Optional (Default is true) |
The name of the picker to use (optional, defaults to null for the default picker) | |
A Hashtable in string form containing extra options supported by the type's exporter. Note that the boolean values for the following cannot be specified using the extraOpts argument:
Instead, use the batch file format equivalent options to specify these values. |
The following table lists the names that you can use in the fourth field of a batch file line to specify a platform for the component.
Table 3–40 Names for Platforms
Platform Name |
Description |
---|---|
any |
Any platform supported by the Sun N1 Service Provisioning System software |
AIX - any version |
Either IBM AIX 5.1 or IBM AIX 5.2 |
AIX 5.1 |
IBM AIX 5.1 |
AIX 5.2 |
IBM AIX 5.2 |
Solaris - any version |
SolarisTM 6, Solaris 7, or Solaris 8 releases |
Solaris 7 |
Solaris 7 release |
Solaris 8 |
Solaris 8 release |
Solaris 9 |
Solaris 9 release |
Solaris 10 |
Solaris 10 release |
Windows 2000 Server |
Microsoft Windows 2000 Server |
Red Hat Linux |
Red Hat Advanced Server 2.1 |
To check in a local file named home/etc/myfile as the component mypath/mycomponentname as the component type file for the platform Solaris 7 with the description “this is my file” and no designation as a configuration file, you would enter the following line in a batch file:
/home/myfile|mypath/mycomponentname|file|NM:Solaris 7|this is my file |
If the file being checked in was a configuration file, you would add a boolean field to the end of the line and the field to true. For example:
/home/myfile|mypath/mycomponentname|file|NM:Solaris 7|this is my file|true |
If you wanted to omit a description for the mycomponent, you do change this line to the following (note the adjacent pipe separators):
/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true
To check in the component as a major version (e.g., 2.0 as opposed to 1.7), you would add true in the boolean field for major version check-ins:
/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true |true
If the check in was desired to not hide the previous component, the line above would become (note the additional false in the final field):
/home/myfile|mypath/mycomponentname|file|NM:Solaris 7||true |true|false
Similar format considerations apply to the optional boolean specifying whether to include owner and group information when storing permissions information.
The Sun N1 Service Provisioning System software applies these rules when parsing batch files.
In fields that are known to be path names, slashes (whether forward or backward) are always translated to accommodate the convention used on the native file system.
Blank lines are allowed as visual separators of clusters of files.
Leading or trailing whitespace is not stripped from fields.
Both absolute and relative paths are allowed in a batchfile. By default, relative paths are interpreted as being relative to the batchfile location; this can be overridden with the -pwdrelative flag, in which case relative paths will be interpreted as being relative to the current working directory.
Batch check in via text file is invoked via a cdb.src.cib command (“cib” = check in batch) of the form
cdb.rsrc.cib -batchfile [batchfile location] [-haltonerror true|false] [-pwdrelative true|false] |
Before checking in any components, the cdb.rsrc.cib command performs a syntax check of the file. Next it verifies the existence of all the local files that are to be checked in. If cdb.rsrc.cib detects errors in either of these processes, it reports the errors and halts execution (regardless of the setting of the --haltonerror boolean argument).
The command line includes an optional -haltonerror argument (false by default) that designates whether or not an error from the check-in of a single file should halt the check-in of subsequent files. This boolean argument applies only to errors encountered after cdb.rsrc.cib has performed its preliminary error-checking (described in the section above).
The command line includes an optional -pwdrelative provision (false by default) that designates whether relative paths in the batch file should be interpreted as being relative to the current working directory (pwdrelative = true) or relative to the location of the batchfile (pwdrelative = false).
Batchfile processing is non-transactional. This means that if batch file processing fails and/or halts before completion, any components that have been successfully checked in remain checked in, and are not “un”-checked in.
Concurrent batch check ins are not arbitrated. If two different batch check-ins targeting the same set of components begin to run at the same time, there is no mechanism throttling the processing of one batch file while another completes. Both batch files will be processed in the interleaved manner that results from their proximate timing.
This command checks out the specified component. It transfers a copy from the repository to the local machine.
Table 3–41 Arguments and Result for the cdb.rsrc.co
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
src |
[R] |
String |
The name of the component to transfer |
v |
[R] |
String |
The version of the component |
dst |
[R] |
String |
The location where the component is to be placed |
result |
String |
Message indicating the operation is complete |
This command generates a resource descriptor for the specified component. For more information about resource descriptors, see Resource Descriptor File Concepts in Sun N1 Service Provisioning System 5.1 Plan and Component Developer’s Guide.
Table 3–42 Argument and Result for the cdb.rsrc.gd Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component for which to generate the descriptor. |
example: cr_cli -cmd cdb.rsrc.gd -ID NM:component-name[:version] -u <username> -p <password> |
This command re-checks in a component. If a check-in job has been interrupted, you can use this command to repeat the check-in without artificially incrementing the version number of the checked-in component.
Table 3–43 Argument and Result for the cdb.rsrc.rci Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
ComponentID |
The ID of the component to re-check in. |
result |
CompCheckInID |
The ID of the resulting check in job. |
The command shows the checkin options supported by a particular component type.
Table 3–44 Arguments and Result of the cdb.rsrc.showopts
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
type |
[R] |
String |
The type of the component |
result |
BrowserInfo[] |
The component picker names and options supported by the exporter |
Checking in a component creates a check-in job. A check-in job is a process that lasts until the component has been fully entered in the repository and assigned a version number. The cdb.cj commands enable you to control and monitor check-in jobs.
Table 3–45 CLI Commands for Controlling and Monitoring Check-in Jobs
Command |
Description |
---|---|
cdb.cj.la |
Lists all check-in jobs. |
cdb.cj.lo |
Lists the status and details of a check-in job. |
cdb.cj.stop |
Stops the check-in job. |
This command lists check-in jobs (components being checked in through the HTML user interface or through a CLI check-in command such as rsrc.ci). It lists all the jobs that are currently active, as well as the last 20 jobs that completed.
Table 3–46 Result of the cdb.cj.la Command
Result |
Syntax |
Description |
---|---|---|
result |
CompCheckInId[] |
The list of check in job IDs |
This command displays the status and details of the specified check-in job. You specify a job by its compCheckInID. This value is returned by cdb.rsrc.ci when you check in a component.
Table 3–47 Argument and Result of the cdb.cj.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
compCheckInID |
The ID of the check in job |
result |
compStatus |
The check in job that was specified |
Because this command requires the ID of the check-in job, it does not support ID NM: notation for its argument. See Appendix A, Input Types for a detailed description of compCheckInId syntax.
This command stops the specified check-in job.
Table 3–48 Argument and Result of the rsrc.cj.stop
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
CompCheckInID |
The ID of the check in job |
result |
CompStatus |
The check in job that was specified |
Because this command requires the ID of the check-in job, it does not support ID NM: notation for its argument. See Appendix A, Input Types for a detailed description of CheckInJobID syntax.