N1 Service Provisioning System 4.1 Reference Guide

Overview of the `cmp` Commands

The cmp commands control comparisons.

Table 8–1 Summary of cmp Commands


Command Name	Description
cmp.dj.add	Adds (starts) a new comparison.
cmp.dj.del	Deletes (stops) a new comparison.
cmp.dj.la	Lists running and completed comparisons.
cmp.dj.lo	Retrieves a running comparison to display its status.
cmp.ds.add	Adds comparison settings to the specified comparison.
cmp.ds.la	Lists all comparison settings.
cmp.ds.lo	Retrieves the specified comparison settings.
cmp.ds.sc	Associates a comparison settings with a set of categories.
cmp.ds.mod	Modifies the specified comparison settings.

cmp.dj.add

This command adds (starts) a new comparison.

Table 8–2 Argument and Result for the cmp.dj.add Command


Argument/Result		Class	Description
ID	[R]	DifferenceSettings	The comparison settings
result		DifferenceJobID	The ID of the new comparison

cmp.dj.del

This command deletes (stops) a running comparison.

Table 8–3 Argument and Result for the cmp.dj.del Command


Argument/Result		Class	Description
ID	[R]	DifferenceJobID	The ID of the running comparison
result		Boolean	True if the comparison was successfully stopped

cmp.dj.la

This command lists running and completed comparisons.

Table 8–4 Argument and Result for the cmp.dj.la Command


Argument/Result		Class	Description
max	[O]	Integer	The maximum number of jobs to list; ignored if there are more running comparisons than the given number
result		RunningDiffBeanArray	All the running comparisons and some completed ones

cmp.dj.lo

This command retrieves a running comparison to display its progress.

Table 8–5 Arguments for the cmp.dj.lo


Argument/Result		Class	Description
ID	[R]	DifferenceJobID	The ID of the comparison
old	[O]	Boolean	Whether to show old messages; default is false
new	[O]	Boolean	Whether to poll for new messages; default is true

cmp.ds.add

This command adds new comparison settings; some optional arguments may be required for some style/level/scope combinations

Table 8–6 Arguments and Result for cmp.ds.add


Argument/Result		Class	Description
name	[R]	String	The name of the comparison settings
desc	[O]	String	The settings" description
style	[R]	Style	The settings" style
level	[R/O]	Level	The settings" level
scope	[R/O]	Scope	The settings" scope
srchID	[R/O]	HostID	The settings" source host ID
dsthID	[R/O]	HostID	The settings" destination host ID
dsthsID	[R/O]	HostSetID	The settings" destination host set ID
srcdir	[R/O]	String	The settings" source directory
dstdir	[R/O]	String	The settings" destination directory
ignp	[R/O]	StringArray	The settings" ignore paths
cRef	[R/O]	InstalledComponentRef	The settings" component reference
tout	[R]	TimeInterval	The settings" timeout
fsl	[O]	Boolean	Whether to follow symbolic links or not; default is true
incd	[O]	Boolean	The settings" include subdirectories flag; default is false
srcP	[R/O]	ReaderWrapper	The settings' source prepare mini-plan
dstP	[R/O]	ReaderWrapper	The settings' destination prepare mini-plan
srcC	[R/O]	ReaderWrapper	The settings' source cleanup mini-plan
dstC	[R/O]	ReaderWrapper	The settings' destination cleanup mini-plan
usePlans	[R/O]	Boolean	The settings' flag indicating if mini-plans should be executed; default is true
dstUseSrcP	[R/O]	Boolean	The settings's flag indicating if source prepare mini-plan is used on destination; default is true
dstUseSrcC	[R/O]	Boolean	The settings's flag indicating if source cleanup mini-plan is used on destination; default is true
result		DifferenceSettings	The new comparison settings

cmp.ds.la

This command lists all comparison settings.

Table 8–7 Argument and Result for the cmp.ds.la Command


Argument/Result		Class	Description
cat	[O]	CategoryID	Category filter to apply, default “all”
result		DifferenceSettingsArray	All the comparison settings

cmp.ds.lo

This command retrieves the specified comparison settings.

Table 8–8 Argument and Result for the cmp.ds.lo


Argument/Result		Class	Description
ID	[R]	DifferenceSettingsID	The ID of the comparison settings
result		DifferenceSettings	The comparison settings

cmp.ds.del

This command deleted a comparison settings object.

Table 8–9 Argument and Result for the cmp.ds.del


Argument/Result		Class	Description
ID	[R]	DifferenceSettingsID	The ID of the comparison settings

cmp.ds.mod

This command adds new comparison settings by using existing settings as a template. Omitted arguments preserve current values when possible.

Table 8–10 Argument and Result for the cmp.ds.mod


Argument/Result		Class	Description
ID	[R]	DifferenceSettingsID	The ID of the template comparison settings
desc	[O]	String	The settings' description
style	[O]	Style	The settings' style
level	[R/O]	Level	The settings' level
scope	[R/O]	Scope	The settings' scope
srchID	[R/O]	HostID	The settings' source host ID
dsthID	[R/O]	HostID	The settings' destination host ID
dsthsID	[R/O]	HostSetID	The settings' destination host set ID
srcdir	[R/O]	String	The settings' source directory
dstdir	[R/O]	String	The settings' destination directory
ignp	[R/O]	StringArray	The settings' ignore paths
cRef	[R/O]	InstalledComponentRef	The settings' component reference
tout	[O]	TimeInterval	The settings' timeout
fsl	[O]	Boolean	Whether to follow symbolic links or not; default is true
incd	[O]	Boolean	The settings' include subdirectories flag
srcP	[R/O]	ReaderWrapper	The settings' source prepare mini-plan
dstP	[R/O]	ReaderWrapper	The settings' destination prepare mini-plan
srcC	[R/O]	ReaderWrapper	The settings' source cleanup mini-plan
dstC	[R/O]	ReaderWrapper	The settings' destination cleanup mini-plan
usePlans	[R/O]	Boolean	The settings' flag indicating if mini-plans should be executed; default is true
dstUseSrcP	[R/O]	Boolean	The settings's flag indicating if source prepare mini-plan is used on destination; default is true
dstUseSrcC	[R/O]	Boolean	The settings's flag indicating if source cleanup mini-plan is used on destination; default is true
result		DifferenceSettings	The new comparison settings

cmp.ds.sc

This command associates a comparison setting with a set of categories.

Table 8–11 Argument and Result for the cmp.ds.sc Command


Argument/Result		Syntax	Description
ID	[R]	DifferenceSettingsID	The ID of the comparison setting to affect
catIDs	[R]	CategoryIDSet	The IDs of the categories to associate with this comparison setting

Overview of the cmp Commands