Back to Index

Usage: clm command[::par1][::par2]...

Command List
? - Displays this command reference page
?::add - Help information on how to add a new task or modify a task
?::addx - Help information on how to add a new schedule or modify a schedule
?::pars - Help information on task parameters 1-50 for each task type
?::type - Help information on TaskTypes used
?::user - Help information on various user settings
init::program_name - program_name = Automize, AbleFtp, or JaSFtp etc (Case sensitive). This command is only required if you are using the clm for the first time, and also have not used the user interface yet
start - Starts scheduler engine
stop - Stops scheduler engine
status - Checks if scheduler engine is running
list - Displays Task List
list::n - Displays task data for task 'n' in a format suitable for editing
listx - Displays Schedule List
list::n - Displays schedule data for task 'n' in a format suitable for editing
run::n - runs task number 'n' from task list
add::taskType|*|taskTitle|*|Par1|*|Par2|*|....|*|…. - adds a new task to task list
addx::taskType|*|taskTitle|*|NextRun|*|....|*|… - adds a new schedule to schedule list
mod::n::taskType|*|taskTitle|*|Par1|*|Par2|*|....|*|….… - modifies task data for task 'n'
modx::n::taskType|*|taskTitle|*|NextRun|*|....|*|… - modifies schedule data for schedule 'n'
del::n - deletes task number 'n' from task list
delx::n - deletes schedule number 'n' from schedule list
sch::n - schedules task 'n' in schedule list
sus::n - suspends task 'n' in schedule list
out - Displays output log
act - Displays activity log
err - Displays debug log
task::taskTitle - Displays the Tasklog for taskTitle
listUser - Displays a list of user settings
getUser::name - returns the value of user 'setting'
setUser::name::value - sets the user setting value
listVar - Displays a list of user variables
getVar::variable_name - returns the value of user variable
setVar::value_to_set::variable_name - sets the user variable value
syncList - Displays a list of synchronization profiles
syncDis::profile - Displays the settings for the synchronization 'profile'
syncAdd::profile::taskList::option::waitTime::afterWait - Adds a new profile or modifies synchronization profile data if profile exists.
syncDel::profile - Deletes the synchronization profile
emailList - Displays a list of email server profiles
emailDis::profile - Displays the smtp server settings for the email 'profile'
emailAdd::profile::host::port::emailAddress::senderName::authenticationType::popServer::user::pwd - Adds a new profile or modifies email profile data if profile exists.
emailDel::profile - Deletes the email profile
emailNotifyList - Displays a list of email notification profiles
emailNotifyDis::profile - Displays the email notification settings for this profile
emailNotifyAdd::profile::true/false::notificationEmail::"crit"::exitCodeValue  -  Adds a new email notification profile or modifies profile data if profile exists. Example: to send notification email if task exits with exit code 0, use: clm emailNotifyAdd::true::me@test.com::"="::0
emailNotifyDel::profile - Deletes this email notification profile
backupDir - Displays the last backup directory
backup::dir_path - backup data to dir_path
backup::default - backup data to last backup directory
restore::dir_path - restores data from dir_path
restore::default - restores data from last backup directory
registerSched::program::code - Registers & unlocks the scheduler engine for specific 'program' using the registration 'code'. program = Automize or AbleFtp or JaSFtp etc..
registerCLM::code - Registers & unlocks this CommandLine Module using 'code'

NOTE: n is 0 based (i.e. first task in task or schedule list has index = 0)
More CLM help information is available in the user interface help file.