1. Server Management
1.1. Command Line
The command line utility allows administrators to manage the clearPath from the console application. The clearpath command line utility can only be run as root.
./clearpath
1.1.1. Header
clearPath System Manager
Version : YY.MM.DD
Copyright : Copyright 2026 sigmaIQ
Support : support@cphs.cloud
Note
where YY.MM.DD is the year, month, and day of the clearPath build
1.1.2. Command Line Switches
clearPath System Manager
Version : YY.MM.DD
Copyright : Copyright 2026 sigmaIQ
Support : support@cphs.cloud
--cmd configure configures cron jobs - only needs to run on reboot
--cmd update checks memory usage, disk space, system plots, removes stuck locks
--cmd lastauditcheck sends a notification in the event of 7 days or more with no audits
--cmd optimize checks the database to improve performance and clean up
--cmd housekeeping Updates system counters and flags and temporary files, trends
--cmd password Generates a Password Expires Report
--cmd archive Updates the Report Archive
--cmd indicators Fixes the auditor mistakes for multiple indicators
--cmd ulearn Updates the ULearn resources
--cmd xml Updates the XML file for export
--cmd backup Initiates a database backup
--cmd notify Sends out Notifications
--cmd removelocks Deletes all command locks
--cmd schema Checks the current database schema to ensure its uptodate
--cmd scripts Rebuilds the backup scripts
--cmd accounts Notify Admin on accounts that are expiring
--cmd certcheck Checks the TLS certificate expiry and alerts support via email
--domain site.cphs.cloud Optional - include this parameter to check any tls certificate
--cmd telemetry Sends Metric back to clearPath
--type hourly sends back server load, disk space, memory usage, events by severity
--type daily sends back the number of sync'd audits, overall compliance
--type weekly sends back the number of sync'd audits, overall compliance
--type monthly sends back more detailed usage and compliance
--type onstartup sends back basic data to notify that the server has been restarted
--type full sends everthing back. Should not normally be needed. Not included in the cron tasks
--action pull gets messages from topics defined in db.
Not normally needed for client sites.
Not normally a scheduled in cron. If it is scheduled it should @daily
--action listener persistent MQTT listener that subscribes to topics defined in db.
Runs continuously until the process is stopped.
Cron: @reboot clearpath --cmd telemetry --action listener
--cmd clean Removes old events and event details, backups and audit logs
--interval xxx xxx is the number of days of data to preserve. If not specified the default is 180 days
--cmd reminders Send System Reminders
--cmd audits Imports sync'd audits into database
--cmd mail Gets incoming email followed by sending pending outgoing email
--action pop Checks incoming email
--action smtp Sends outgoing email
--action clear deletes the outgoing email queue and attachments
--action test sends a test email to support@cphs.cloud
--copyto email@mydomain.com sends a test email to the specified email address
--cmd info Returns information from system
--copyto email@mydomain.com sends email to the specified email address
--attach [
sysinfo includes system information as an attachment
logs includes system logs as an attachment
schema includes portable mysql schema as an attachment
config includes configuration file as an attachment
console includes email configuration as an attachment
events includes system events from the last day as an attachment
]
--cmd distribute Checks to see if any report distribution list need to be sent
--action forceall sends all the active distribution lists right away
--cmd reports Runs defined reports
--scope marked runs reports that are marked for update
--scope all forces all reports to update
--action smart scans hhctsession/hhctdata and marks affected reports for update
--create com|pro|ent|ultimate generates a PDF report set for every account based on edition, then marks them for update
--cmd cron Manage cron jobs
--action install installs any missing jobs
--action clean removes all cron jobs and then adds in the new/updated
--action remove removes all cron jobs
--cmd httpd Configure httpd with Proxy settings
--action install installs new httpd configuration file. Any existing config settings will be lost
--action remove removes the proxy settings
--domain client.domain.com domain name
--cmd maintenance Shows current maintenance mode state
--action enable Enables maintenance mode
--action disable Disables maintenance mode
--cmd import Imports Ministry and iScrub Legacy Data
--type [1=iScrub,2=Ministry] Specifies the data format type
--file filename.csv name of the filename.csv
--account accountid specify the account ID
--cmd sms Send SMS Test Message
--send 1-xxx-xxx-xxxx Send to Number
--msg "Hello World" Text Message (use double quotes)
Note
The --attach sysinfo, --attach logs, and --attach schema
options under --cmd info are only available on Linux production
builds.
1.1.2.1. Examples
To force all reports to update run the following:
/usr/local/clearpath/clearpath --cmd reports --scope all
Warning
Including the –scope all, will force all reports regardless of their update status to refresh. This could take a long time depending on the number of reports on the system.
To update reports that are marked for update:
/usr/local/clearpath/clearpath --cmd reports
Note
Using the –cmd reports with no scope specified is faster and more efficient as it only updates the report are marked for update.
To send out a MQTT telemetry message
/usr/local/clearpath/clearpath --cmd telemetry --type full
1.2. Crontab
This is the standard crontab configuration. There may be slight differences in your cron configuration on your instance of clearPath.
To modify the cron run the following from the command line:
crontab -e
Note
root access is required to modify the cron jobs.
Note
--cmd cron --action install (which calls AddCronJobs in
clearpath.system.manager.pas) is the authoritative installer for
these jobs. The listing below mirrors that procedure as of the current
build and is illustrative; if it ever drifts from a freshly-installed
crontab, the source code wins.
# System Manager - maintenance
@reboot /usr/local/clearpath/clearpath --cmd configure -f 2>&1 >> /dev/null
@hourly /usr/local/clearpath/clearpath --cmd update -f 2>&1 >> /dev/null
0 18 * * 6 /usr/local/clearpath/clearpath --cmd optimize -f 2>&1 >> /dev/null
@weekly /usr/local/clearpath/clearpath --cmd lastauditcheck -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/clearpath --cmd housekeeping -f 2>&1 >> /dev/null
@weekly /usr/local/clearpath/clearpath --cmd password -f 2>&1 >> /dev/null
*/5 * * * * /usr/local/clearpath/clearpath --cmd indicators -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/clearpath --cmd ulearn -f 2>&1 >> /dev/null
@monthly /usr/local/clearpath/clearpath --cmd archive -f 2>&1 >> /dev/null
# MQTT Telemetry
@hourly /usr/local/clearpath/clearpath --cmd telemetry --type hourly -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/clearpath --cmd telemetry --type daily -f 2>&1 >> /dev/null
@weekly /usr/local/clearpath/clearpath --cmd telemetry --type weekly -f 2>&1 >> /dev/null
@monthly /usr/local/clearpath/clearpath --cmd telemetry --type monthly -f 2>&1 >> /dev/null
@reboot /usr/local/clearpath/clearpath --cmd telemetry --type onstartup -f 2>&1 >> /dev/null
*/5 * * * * /usr/local/clearpath/clearpath --cmd telemetry --type spot -f 2>&1 >> /dev/null
# TLS certificate expiry alerts
@daily /usr/local/clearpath/clearpath --cmd certcheck -f 2>&1 >> /dev/null
# Updates, Reminders and Notifications
@daily /usr/local/clearpath/clearpath --cmd xml -f 2>&1 >> /dev/null
@hourly /usr/local/clearpath/clearpath --cmd notify -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/clearpath --cmd reminders -f 2>&1 >> /dev/null
@monthly /usr/local/clearpath/clearpath --cmd clean -f 2>&1 >> /dev/null
*/2 * * * * /usr/local/clearpath/clearpath --cmd audits -f 2>&1 >> /dev/null
*/5 * * * * /usr/local/clearpath/clearpath --cmd mail -f 2>&1 >> /dev/null
30 6 * * * /usr/local/clearpath/clearpath --cmd distribute -f 2>&1 >> /dev/null
# Reports
*/1 * * * * /usr/local/clearpath/clearpath --cmd reports --scope marked -f 2>&1 >> /dev/null
0 3 * * * /usr/local/clearpath/clearpath --cmd reports --scope all -f 2>&1 >> /dev/null
# Backups
@hourly /usr/local/clearpath/scripts/clearpathhourlybackupscript.sh -f 2>&1 >> /dev/null
@weekly /usr/local/clearpath/scripts/clearpathweeklybackupscript.sh -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/scripts/clearpathdailybackupscript.sh -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/scripts/clearpathoffsitebackup.sh -f 2>&1 >> /dev/null
@daily /usr/local/clearpath/scripts/clearpathdailyauditsbackupscript.sh -f 2>&1 >> /dev/null
# LetsEncrypt Auto Renewals
@daily /bin/certbot renew -f 2>&1 >> /dev/null