Chapter 5 cmp:
CLI Commands for Running Comparisons
This chapter describes commands that you need to use to run comparisons.
Overview of the cmp Commands
The cmp commands control comparisons.
Table 5–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.del
|
Deletes comparison settings from the specified comparison.
|
|
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 5–2 Argument and Result for the cmp.dj.add Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
DifferenceSettings
|
The comparison settings
|
|
result
|
DifferenceJobID
|
The ID of the new comparison
|
cmp.dj.del
This command deletes (stops) a running comparison.
Table 5–3 Argument and Result for the cmp.dj.del Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
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 5–4 Argument and Result for the cmp.dj.la Command
|
Argument/Result
|
Syntax
|
Description
|
|
max
|
Optional
|
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 5–5 Arguments for the cmp.dj.lo
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
DifferenceJobID
|
The ID of the comparison
|
|
old
|
Optional
|
Boolean
|
Whether to show old messages; default is false
|
|
new
|
Optional
|
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 5–6 Arguments and Result for cmp.ds.add
|
Argument/Result
|
Syntax
|
Description
|
|
name
|
Required
|
String
|
The name of the comparison settings
|
|
desc
|
Optional
|
String
|
The description of the settings
|
|
style
|
Required
|
Style
|
The style of the settings
|
|
level
|
[R/O]
|
Level
|
The level of the settings
|
|
scope
|
[R/O]
|
Scope
|
The scope of the settings
|
|
srchID
|
[R/O]
|
HostID
|
The source host ID of the settings
|
|
dsthID
|
[R/O]
|
HostID
|
The destination host ID of the settings
|
|
dsthsID
|
[R/O]
|
HostSetID
|
The destination host set ID of the settings
|
|
srcdir
|
[R/O]
|
String
|
The source directory of the settings
|
|
dstdir
|
[R/O]
|
String
|
The destination directory of the settings
|
|
ignp
|
[R/O]
|
StringArray
|
The ignore paths of the settings
|
|
cRef
|
[R/O]
|
InstalledComponent- Ref
|
The component reference of the settings
|
|
tout
|
Required
|
TimeInterval
|
The timeout of the settings
|
|
fsl
|
Optional
|
Boolean
|
Whether to follow symbolic links or not; default is true.
|
|
incd
|
Optional
|
Boolean
|
The include subdirectories flag of the settings; default is false
|
|
srcP
|
[R/O]
|
ReaderWrapper
|
The source prepare mini-plan of the settings
|
|
dstP
|
[R/O]
|
ReaderWrapper
|
The destination prepare mini-plan of the settings
|
|
srcC
|
[R/O]
|
ReaderWrapper
|
The source cleanup mini-plan of the settings
|
|
dstC
|
[R/O]
|
ReaderWrapper
|
The destination cleanup mini-plan of the settings
|
|
usePlans
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether mini-plans should be
executed; default is true
|
|
dstUseSrcP
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether source prepare mini-plan
is used on destination; default is true
|
|
dstUseSrcC
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether 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 5–7 Argument and Result for the cmp.ds.la Command
|
Argument/Result
|
Syntax
|
Description
|
|
cat
|
Optional
|
CategoryID
|
Category filter to apply, default “all”
|
|
result
|
DifferenceSettings- Array
|
All the comparison settings
|
cmp.ds.lo
This command retrieves the specified comparison settings.
Table 5–8 Argument and Result for the cmp.ds.lo
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
DifferenceSettingsID
|
The ID of the comparison settings
|
|
result
|
DifferenceSettings
|
The comparison settings
|
cmp.ds.del
This command deleted a comparison settings object.
Table 5–9 Argument and Result for the cmp.ds.del
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
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 are overwritten.
Table 5–10 Argument and Result for the cmp.ds.mod
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
DifferenceSettingsID
|
The ID of the template comparison settings
|
|
desc
|
Optional
|
String
|
The description of the settings
|
|
style
|
Optional
|
Style
|
The style of the settings
|
|
level
|
[R/O]
|
Level
|
The level of the settings
|
|
scope
|
[R/O]
|
Scope
|
The scope of the settings
|
|
srchID
|
[R/O]
|
HostID
|
The source host ID of the settings
|
|
dsthID
|
[R/O]
|
HostID
|
The destination host ID of the settings
|
|
dsthsID
|
[R/O]
|
HostSetID
|
The destination host set ID of the settings
|
|
srcdir
|
[R/O]
|
String
|
The source directory of the settings
|
|
dstdir
|
[R/O]
|
String
|
The destination directory of the settings
|
|
ignp
|
[R/O]
|
StringArray
|
The ignore path of the settings
|
|
cRef
|
[R/O]
|
InstalledComponent- Ref
|
The component reference of the settings
|
|
tout
|
Optional
|
TimeInterval
|
The timeout of the settings
|
|
fsl
|
Optional
|
Boolean
|
Whether to follow symbolic links or not; default is true. If this argument
is omitted, the value is overwritten.
|
|
incd
|
Optional
|
Boolean
|
The include subdirectories flag of the settings
|
|
srcP
|
[R/O]
|
ReaderWrapper
|
The source prepare mini-plan of the settings
|
|
dstP
|
[R/O]
|
ReaderWrapper
|
The destination prepare mini-plan of the settings
|
|
srcC
|
[R/O]
|
ReaderWrapper
|
The source cleanup mini-plan of the settings
|
|
dstC
|
[R/O]
|
ReaderWrapper
|
The destination cleanup mini-plan of the settings
|
|
usePlans
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether mini-plans should be
executed; default is true. If this argument is omitted,the value is overwritten .
|
|
dstUseSrcP
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether source prepare mini-plan
is used on destination; default is true. If this argument is omitted, the value is overwritten.
|
|
dstUseSrcC
|
[R/O]
|
Boolean
|
The flag of the settings that indicates whether source cleanup mini-plan
is used on destination; default is true. If this argument is omitted, the value is overwritten.
|
|
result
|
DifferenceSettings
|
The new comparison settings
|
cmp.ds.sc
This command associates a comparison setting with a set of categories.
Table 5–11 Argument and Result for the cmp.ds.sc Command
|
Argument/Result
|
Syntax
|
Description
|
|
ID
|
Required
|
DifferenceSettingsID
|
The ID of the comparison setting to affect
|
|
catIDs
|
Required
|
CategoryIDSet
|
The IDs of the categories to associate with this comparison setting
|
Download this book in PDF (730 KB)