Command Summary

A summary of DOE-C Command Line Utility commands. For more detailed information about a command, refer to the reference topic for the command.

Administrative commands

Operation

Command

Start Command Line Utility console to enter commands interactively

%DOE-C_CLU_HOME%/bin/clu.bat

(from a command prompt)

Run Command Line Utility to take commands from an XML file

%DOE-C_CLU_HOME%/bin/execute-commandXMLFile xmlFileName

(from a command prompt)

Log in

login 
[-u|--DOEServerUser UnwiredServerAdminUser] 
[-pw|--password UnwiredServerAdminPassword] 
[-h|--help] [-sl|--silent]

Exit

exit [-h|--help]

Get help

help [-h|--help] | [-a|--all] | commandName]
Package management commands

Operation

Command

Deploy a package

deploy 
[-dir|--deployFilesDirectory deploymentDirectory] 
[sc|--securityConfiguration securityConfigName] 
[-u|--technicalUser SAPUserAccount] 
[-pw|--password SAPUserPassword] 
[-h|--help] [-sl|--silent]

Get a list of deployed packages

getPackages 
[-d|--domain domainName]
[-i|in inputXmlFile] 
[-o|--out outputXmlFile] 
[-h|--help] [-sl|--silent]

Get details for specific deployed packages

getPackages 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-o|--out outputXmlFile] 
[ps|--packageNames nameAndVersionList] 
[-h|--help] [-sl|--silent]

Set endpoint properties for a deployed package

setEndpointProperties 
[-i|--in inputXmlFile] 
[[-a|--all] | [-p|--packageName name]] 
[-ds|--doePacketDropSize byteSize] 
[-ew|--doeExtractWindow maxNumMsgs] 
[-u|--technicalUser SAPUserAccount] 
[-pw|--password SAPUserPassword] 
[-tca|--technicalUserCertAlias aliasName] 
[-sp|--securityProfile profileName]
[-t|--httpTimeout seconds] 
[-h|--help] [-sl|--silent]
Get endpoint properties for a deployed package
getEndpointProperties 
[-i|--in inputXmlFile] 
[[-a|--all] | [-ps|--packageNames name]] 
[-h|--help] [-sl|--silent]

Test endpoint properties for a deployed package

testEndpoint 
[-i|--in inputXmlFile] 
[-p|--packageName name] 
[-h|--help] [-sl|--silent]
Set the security configuration for deployed packages
setPackageSecurityConfiguration 
[-d|--domain domainName]
[-sc|--securityConfiguration securityConfigName]
[-i|--in inputXmlFile] 
[[-a|--all] | [-ps|--packageNames nameAndVersionList]  
[-u|--technicalUser SAPUserAccount] 
[-pw|--password SAPUserPassword] 
[-h|--help] [-sl|--silent]

Set the log level for deployed packages

setPackageLogLevel 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-l|logLevel level] 
[-ps|--packageNames name] 
[-h|--help] [-sl|--silent]

Get the log level for deployed packages

getPackageLogLevel 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-o|--out outputXmlFile] 
[-ps|--packageNames name] 
[-h|--help] [-sl|--silent]

Remove deployed packages

removePackages 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-ps|--packageNames name] 
[-h|--help] [-sl|--silent]
Subscription management commands

Operation

Command

Get information on subscriptions to deployed packages

getSubscriptions  
[-d|--domain domainName]
[-i|--in[-i|--in inputXmlFile] 
[-o|--out outputXmlFile] 
[-f|--filter filterExpression] 
[-ps|--packageNames name] 
[-h|--help] [-sl|--silent]

Get information on subscriptions to a deployed package, with sorting and pagination options

getSubscriptions2 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-o|--out outputXmlFile] 
[-f|--filter filterExpression] 
[-p|--packageName name] 
[-pn|--pageNumber number] 
[-ps|--pageSize size] 
[-s|--sort column[:Ascending|Descending]] 
[-h|--help] [-sl|--silent]

Set the log level for subscriptions to a deployed package

setSubscriptionsLogLevel 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-l|--logLevel level] 
[[-a|--all] | [-p|--packageName name]] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]

Get the log level for subscriptions to a deployed package

getSubscriptionsLogLevel 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[-p|--packageName name] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]

Suspend subscriptions

suspendSubscriptions 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[[-a|--all] | [-p|--packageName name]] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]

Resume subscriptions

resumeSubscriptions 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[[-a|--all] | [-p|--packageName name]] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]

Resynchronize subscriptions to a deployed package

resyncSubscriptions 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[[-a|--all] | [-p|--packageName name]] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]

End subscriptions to a deployed package

endSubscriptions 
[-d|--domain domainName]
[-i|--in inputXmlFile] 
[[-a|--all] | [-p|--packageName name]] 
[-s|--subscriptionID ID] 
[-h|--help] [-sl|--silent]