N1 Grid Service Provisioning System 5.0 Command-Line Interface Reference Manual

Chapter 9 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 9–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 9–2 Arguments and Result for the pdb.p.ci


Argument/Result		Syntax	Description
path	[R]	InputStreamWrapper	The plan in XML format
major	[O]	Boolean	Whether to checkin as a new major version; default false
hidePrev	[O]	Boolean	Whether to hide the previous plan, default true
result		ExecutionPlan	The new execution plan

pdb.p.co

This command outputs a plan in XML format to stdout.

Table 9–3 Argument for the pdp.p.co Command


Argument		Syntax	Description
plan	[R]	ExecutionPlan	The execution plan

pdb.p.genplan

This command generates and outputs a plan as XML.

Table 9–4 Arguments for the pdb.p.genplan Command


Argument		Syntax	Description
ID	[R]	ComponentID	The ID of the component to generate the plan for.
pt	[R]	NamedBlockType[]	List of procedure types named install, uninstall, and call
pn	[R]	StringArray	List of procedure names to use in this plan.

pdb.p.la

This command lists the latest versions of all plans.

Table 9–5 Arguments and Result for the pdb.p.la Command


Argument/Result		Syntax	Description
sh	[O]	Boolean	Whether hidden plans are shown. Default is false
cat	[O]	CategoryID	Category filter to apply. Default is “all”.
folderID	[O]	FolderID	Parent folder ID; default is the root folder (NM:/)
flatView	[O]	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 9–6 Argument and Result for the pdb.p.lo Command


Argument/Result		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the plan to view
result		ExecutionPlan	The execution plan

pdb.p.del

This command deletes an execution plan.

Table 9–7 Argument and Result for the pdb.p.del Command


Argument/Result		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the plan to delete
all	[O]	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 9–8 Argument and Result of the pdb.p.lv Command


Argument/Result		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the execution plan
result		ExecutionPlanArray	The execution plans

pdb.p.mv

This command moves or renames a plan.

Table 9–9 Arguments for the pdb.p.mv Command


Argument		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the plan to move or rename
fullname	[R]	String	The new full name (path + name) of the plan

pdb.p.sh

This command hides or shows (un-hides) a plan.

Table 9–10 Arguments for the pdb.p.sh Command


Argument		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the plan to hide or un-hide
hide	[R]	Boolean	Whether the plan is set to hidden
all	[O]	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 9–11 Arguments for the pdb.p.sc Command


Argument		Syntax	Description
ID	[R]	ExecutionPlanID	The ID of the plan to which the categories should be applied.
catIDs	[R]	CategoryIDSet	The IDs of the categories to associate with this plan
all	[O]	Boolean	Whether to update the categories for all versions of the plan, default false