Chapter 6 cdb: CLI Commands for Managing Components
This chapter describes commands that you need to use to manage components.
Overview of the cdb Commands
The CLI includes the following sets of commands for managing components.
Table 6–1 Sets of Commands for Managing Components|
CLI Prefix |
Description of Command Set |
|---|---|
|
cdb.c |
Commands for managing components (XML models) |
|
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. |
This chapter describes all the commands in each of these sets.
cdb.c: Managing Components
The cdb.c commands provide general-purpose controls for managing components.
Table 6–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.sc |
Applies one or more categories to a component. |
|
cdb.c.sh |
Shows or hides a component. |
|
cdb.c.del |
Deletes a component |
cdb.c.ci
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 component in XML format |
|
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. |
|
result |
Component |
The new component |
|
cdb.c.co
This command checks out a component. It outputs the specified component in XML format.
Table 6–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 |
|
cdb.c.la
The command lists all versions of all components.
Table 6–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” (meaning all but system category) |
|
result |
SummaryComponentArray |
The components |
|
cdb.c.lo
This command lists the details of a specified component.
Table 6–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 |
|
cdb.c.lv
This command lists all the versions of the specified component.
Table 6–7 Argument and Result for the cdb.c.lv Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
comp |
[R] |
Component |
The component |
|
result |
SummaryComponentArray |
All the versions of the component |
|
cdb.c.mod
This command saves a component with new resource versions.
Table 6–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 resource versions; use version number, “#” for recommended, “+” for default, and “-“ for latest; or omit this argument to use latest for all resources. This argument is only applicable for composite components. |
|
hidePrev |
[O] |
boolean |
Whether to hide the previous build. Default is true. |
|
result |
Component |
The component |
|
cdb.c.sc
This command associates a component with a set of categories.
Table 6–9 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 |
cdb.c.sc
This command associates a component with a set of categories.
Table 6–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 |
cdb.c.del
This command deletes a component.
Table 6–11 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 |
cdb.ic: Managing Installed Components
The cdb.ic commands retrieve information about components that are already installed on hosts.
Table 6–12 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. |
cdb.ic.lbc
This command lists all the hosts on which a particular component is installed.
Table 6–13 Argument and result for the cdb.ic Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
comp |
[R] |
ComponentID |
The component ID |
|
result |
InstalledComponentBeanArray |
The installed components |
|
cdb.ic.lbh
This command lists all the components installed on a particular host.
Table 6–14 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 |
InstalledComponentBeanArray |
The installed components |
|
cdb.ic.vs.lo
This command lists details of a particular generated variable settings object..
Table 6–15 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 |
GeneratedVariableSettings |
The generated variable settings |
|
cdb.vs: Managing Variable Settings
The cdb.vs commands manage variable settings for components.
Table 6–16 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. |
cdb.vs.add
This command adds a new variable settings object
Table 6–17 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 |
ComponentVariableSettings |
The new component variable settings |
|
cdb.vs.del
This command deletes an existing variable settings object.
Table 6–18 Argument for the cdb.vs.del Command|
Argument |
Syntax |
Description |
|
|---|---|---|---|
|
vs |
[R] |
ComponentVariableSettingsID |
The ID of the component variable settings to delete |
cdb.vs.imp
This command imports variable settings from one component into another.
Table 6–19 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 |
cdb.vs.la
This command lists all variable settings objects associated with a particular component.
Table 6–20 Argument and Result for the cdb.vs.la Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
comp |
[R] |
ComponentID |
The component. |
|
result |
ComponentVariableSettingsArray |
The component variable settings. |
|
cdb.vs.lo
This command lists details of a particular variable settings object.
Table 6–21 Argument and Result for the cdb.vs.lo Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
vs |
[R] |
ComponentVariableSettings |
The component variable settings to view |
|
result |
ComponentVariableSettings |
The component variable settings |
|
cdb.vs.mod
This command modifies an existing variable settings object
Table 6–22 Arguments and Result for the cdb.vs.mod Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
vs |
[R] |
ComponentVariableSettings |
The component variable settings |
|
name |
[O] |
String |
The new name |
|
vars |
[O] |
Hashtable |
The new override values |
|
result |
ComponentVariableSettings |
The modified component variable settings |
|
cdb.ssr: System Service Ref Commands
Table 6–23 CLI Commands for System Service Ref|
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 |
cdb.ssr.add
This command adds a new system service ref.
Table 6–24 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 |
|
cdb.ssr.mod
This command modifies an existing system service ref; omitted arguments preserve current values.
Table 6–25 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 |
|
cdb.ssr.del
This command deletes a system service ref..
Table 6–26 Argument and Result for the cdb.ssr.del Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
ID |
[R] |
SystemServiceRefID |
The system service ref ID |
cdb.ssr.lo
This command retrieves a system service ref.
Table 6–27 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 |
|
cdb.ssr.la
This command lists all system service refs.
Table 6–28 Argument and Result for the cdb.ssr.lo Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
result |
SystemServiceRefArray |
The system service refs |
|
cdb.ctr: Component Type Commands
Table 6–29 CLI Commands for System Service Ref|
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 |
cdb.ctr.add
This command adds a new component type ref..
Table 6–30 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 |
[O] |
String |
The version of the component ref within the component type ref |
|
result |
ComponentTypeRef |
The new component type ref |
|
cdb.ctr.mod
Modifies an existing system service ref; omitted arguments preserve current values.
Table 6–31 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 |
|
compref |
[O] |
String |
The name of the component ref within the component type ref |
|
compver |
[O] |
String |
The version of the component ref within the component type ref |
|
result |
ComponentTypeRef |
The modified component type ref |
|
cdb.ctr.del
This command deletes a component type ref.
Table 6–32 Argument and Result for the cdb.ctr.del Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
ID |
[R] |
ComponentTypeRefID |
The component type ref ID |
cdb.ctr.lo
This command retrieves a component type ref.
Table 6–33 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 |
|
cdb.ctr.la
This command lists all component type refs.
Table 6–34 Argument and Result for the cdb.ctr.la Command|
Argument/Result |
Syntax |
Description |
|
|---|---|---|---|
|
result |
ComponentTypeRefArray |
The component type refs |
|
- © 2010, Oracle Corporation and/or its affiliates