Chapter 10 pdb: CLI Commands for Managing Plans
This chapter describes the commands that you need to use to manage plans.
Overview of the pdb Commands
You can use the pdb commands to manage plans. A plan
is an XML document that specifies the operations to be performed on components
and hosts.
Table 10–1 Summary of the pdb Commands
|
Command
|
Description
|
|
pdb.p.ci
|
Checks in a new version of a plan.
|
|
pdb.p.co
|
Checks out a plan (outputs a plan in XML).
|
|
pdb.p.genplan
|
Generates and outputs a plan in XML.
|
|
pdb.p.la
|
Lists the latest versions of all plans.
|
|
pdb.p.lo
|
Views a plan.
|
|
pdb.p.del
|
Deletes an execution plan.
|
|
pdb.p.lv
|
Lists all the versions of the specified plan.
|
|
pdb.p.mv
|
Moves and/or renames a plan.
|
|
pdb.p.sh
|
Shows or hides a plan.
|
|
pdb.p.sc
|
Associates a plan with a set of categories.
|
pdb.p.ci
Checks in a new version of a plan from XML
Table 10–2 Arguments and Result for the pdb.p.ci
|
Argument/Result
|
Syntax
|
Description
|
|
path
|
Required
|
InputStreamWrapper
|
The plan in XML format
|
|
major
|
Optional
|
Boolean
|
Whether to checkin as a new major version; default false
|
|
hidePrev
|
Optional
|
Boolean
|
Whether to hide the previous plan, default true
|
|
parents
|
Optional
|
Boolean
|
Whether nonexistent parents are created during plan check-in. The default
value is false.
|
|
result
|
ExecutionPlan
|
The new execution plan
|
pdb.p.co
This command outputs a plan in XML format to stdout.
Table 10–3 Argument for the pdp.p.co Command
|
Argument
|
Syntax
|
Description
|
|
plan
|
Required
|
ExecutionPlan
|
The execution plan
|
pdb.p.genplan
This command generates and outputs a plan as XML.
Table 10–4 Arguments for the pdb.p.genplan Command
|
Argument
|
Syntax
|
Description
|
|
componentID
|
Required
|
ComponentID
|
The ID of the component to generate the plan for.
|
|
pn
|
Required
|
StringArray
|
List of procedure names to use in this plan.
|
|
pt
|
Required
|
NamedBlockType[]
|
List of procedure types named install, uninstall, and call
|
pdb.p.la
This command lists the latest versions of all plans.
Table 10–5 Arguments and Result for the pdb.p.la Command
|
Argument/Result
|
Syntax
|
Description
|
|
sh
|
Optional
|
Boolean
|
Whether hidden plans are shown. Default is false
|
|
cat
|
Optional
|
CategoryID
|
Category filter to apply. Default is “all”.
|
|
folderID
|
Optional
|
FolderID
|
Parent folder ID; default is the root folder (NM:/)
|
|
flatView
|
Optional
|
Boolean
|
Whether to display results in flat view; defaults to true
|
|
result
|
ExecutionPlanArray
|
The execution plans
|
pdb.p.lo
This command views an execution plan.
Table 10–6 Argument and Result for the pdb.p.lo Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the plan to view
|
|
result
|
ExecutionPlan
|
The execution plan
|
pdb.p.del
This command deletes an execution plan.
Table 10–7 Argument and Result for the pdb.p.del Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the plan to delete
|
|
all
|
Optional
|
Boolean
|
Whether to delete all versions of the plan, default false
|
pdb.p.lv
This command lists all the versions of the specified plan.
Table 10–8 Argument and Result of the pdb.p.lv Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the execution plan
|
|
result
|
ExecutionPlanArray
|
The execution plans
|
pdb.p.mv
This command moves or renames a plan.
Table 10–9 Arguments for the pdb.p.mv Command
|
Argument
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the plan to move or rename
|
|
fullname
|
Required
|
String
|
The new full name (path + name) of the plan
|
pdb.p.sh
This command hides or shows (un-hides) a plan.
Table 10–10 Arguments for the pdb.p.sh Command
|
Argument
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the plan to hide or un-hide
|
|
hide
|
Required
|
Boolean
|
Whether the plan is set to hidden
|
|
all
|
Optional
|
Boolean
|
Whether to change all versions of the plan, default false
|
pdb.p.sc
This command associates a plan with a set of categories.
Table 10–11 Arguments for the pdb.p.sc Command
|
Argument
|
Syntax
|
Description
|
|
ID
|
Required
|
ExecutionPlanID
|
The ID of the plan to which the categories should be applied.
|
|
catIDs
|
Required
|
CategoryIDSet
|
The IDs of the categories to associate with this plan
|
|
all
|
Optional
|
Boolean
|
Whether to update the categories for all versions of the plan, default
false
|
Download this book in PDF (730 KB)