Page tree
Skip to end of metadata
Go to start of metadata

This document is for a previous release of cPanel & WHM. To view our latest documentation, visit our Home page.

For cPanel & WHM 11.44

Overview

When cPanel & WHM is installed, a number of predefined scripts become available in your server’s /usr/local/cpanel/scripts directory. You can use any of the scripts simply by typing its location in a terminal session. For example, if you wanted to run the update script, you would type:

/usr/local/cpanel/scripts/upcp 

Warning:

Do not use a script within the /usr/local/cpanel/scripts directory if it is not listed here. Executing such a script may damage your server. 

Scripts

  • build_maxemails_config — Sets limits on the amount of email that users can send from domains on your server. For more information about configuring limits with this script, see our documentation on Mail Limiting Features.
  • easyapache — Upgrades and reinstalls Apache.
  • phpextensionmgr — Manages PHP extensions.
  • *up — Updates a service. We currently provide the following update scripts for the services noted:
    • bandminup — Bandmin application.
    • courierup — Courier mail server.
    • cpaddonsup — cPanel’s addon scripts.
    • dovecotup — Dovecot mail server.
    • eximup — Exim mail exchanger.
    • ftpup — FTP servers (ProFTP and Pure-FTP).
    • imapup — IMAP mail server.
    • mysqlup —MySQL service.
    • nsdup — BIND nameserver.
    • phpup — Current version of PHP.
    • suphpup — SuPHP tool for handling PHP requests.
  • restartsrv_* — Restarts a service. We currently provide restart scripts for the following; simply replace the asterisk (*) in restartsrv_* with the term in bold:
    • apache — Apache web server.
    • bind — BIND nameserver software.
    • chkservd — cPanel’s TailWatch log processing service.
    • clamd — ClamAV anti-virus software.
    • courier — Courier mail server.
    • cpdavd — cPanel’s WebDAV server.
    • cppop — cPanel’s POP server.
    • dovecot — Dovecot mail server.
    • entropychat — Entropy chat client.
    • exim — Exim mail exchanger.
    • eximstats — Exim mail statistics tracker.
    • ftpserver — FTP server.
    • httpd — Apache web server.
    • imap — IMAP server.
    • inetd — Super-server daemon for managing Internet services.
    • interchange — Interchange e-commerce software.
    • ipaliases — IP aliasing software.
    • melange — Melange chat client.
    • mysql — MySQL database server.
    • named — BIND nameserver software.
    • nsd — Open-source NSD nameserver daemon.
    • postgres — PostgresSQL database service.
    • postgresql — PostgreSQL database service.
    • proftpd — ProFTP server daemon.
    • pureftpd — Pure-FTP server daemon.
    • rsyslogd — Open-source log forwarder daemon.
    • spamd — Apache SpamAssassin™ daemon.
    • sshd — Secure shell daemon.
    • syslogd — Log forwarder daemon.
    • tailwatchd — cPanel’s TailWatch log processing service.
    • tomcat — Apache Tomcat service.
    • xinetd — Open-source super-server daemon.
  • addpop — Adds a POP account.
  • delpop — Removes a POP account.
  • wwwacct — Adds a cPanel account.
  • killpkg — Removes a package.
  • restorepkg — Restores a package.
  • cpbackup — Backs up all accounts.
  • pkgacct — Handles cPanel packages.
  • upcp — Updates cPanel and WHM.
  • setupmailserver — Allows you to switch between mailservers.
  • setupftpserver — Allows you to switch between FTP servers.
  • setupnameserver — Allows switching between DNS servers.
  • realperlinstaller — A wrapper script that automates the installation of Perl CPAN modules.
  • suspendacct — Suspends an account.
  • unsuspendacct — Unsuspends an account.
  • runweblogs — Updates statistics for a user.
  • runstatsonce — Updates statistics for all users.
  • makecppphp — Re-installs cPanel’s internal PHP.
  • portsup — Updates ports (FreeBSD® systems only).
  • check_users_my_cnf — Check user accounts for ~/.my.cnf files that do not work and disable them. This script only returns output when it detects a bad .my.cnf.
    • For more information, run the following command /usr/local/cpanel/scripts/check_users_my_cnf --help.
  • comparecdb — Compare the contents of 2 CDB files. You will need to specify the 2 CDB files you wish to compare after the script.
    • For example: /usr/local/cpanel/scripts/comparecdb $file1 $file2 (where the $file1 and $file2 represent the 2 files you wish to compare)
  • dumpcdb — Displays the contents of a CDB file. You will need to specify the CDB file you wish to view.
    • For example: /usr/local/cpanel/scripts/dumpcdb $file (where $file represents the file you wish to view)
  • try-later — Executes a user-defined check command at a specified interval. If the check command returns an error, it will be retried later, as often as allowed by the max-retries parameter. When the check succeeds, a user-defined action command runs. This script can be used with the following options:
    • --check is a command that determines whether the action command will run.
    • --help will display a brief help message.
    • --delay will allow you to specify a delay (in minutes) after which to run the check and action commands. This value defaults to 5. If set, then this option overrides the --at command.
    • --at will allow you to specify a delay (in an interval other than minutes) after which to run the check and action commands. If set, then the try-later command will pass directly to the at command. To learn more about the at command, visit its man page.
    • --action will run when the check command succeeds.
    • --act-finally will run the action command when retries are exhausted.
    • --skip-first will skip the initial check command.
    • --max-retries will allow you to specify the maximum retry attempts before running the action command. This value defaults to infinite.
  • upcp-running — Specifies whether a upcp command is running. This information displays in text output and the script's exit value. By default, a zero exit value signals that the target upcp command is running.
    • --invert-exit will exit with a non-zero error value (1) if the target upcp command is running.
    • --help will display a brief help message.
  • chkmydns — Performs a simple configuration check of MyDNS.
  • exportmydnsdb — Exports zones from MyDNS for use with BIND and NSD.
  • fixmailinglistperms — Repairs permissions for all mailing list files and directories.
  • gather-update-logs — Sends update logs to cPanel for analysis.
  • hook — Executes any hooks that would be called normally in the specified context.
  • importmydnsdb — Imports zone information from BIND and NSD into MyDNS.
  • mydnsup — Installs and updates MyDNS packages.
  • restartsrv_mydns — Restarts script from MyDNS.
  • slurp_exim_mainlog — Imports exim mainlog data into the eximstats database.
  • update_php_timezonedb — Updates the timezone database used by PHP.
  • xfer_horde_sid_resolver.pl — Resolves key collision errors before importing Horde data during an account transfer.
  • installruby — Installs Ruby.
  • installpostgres — Installs PostgreSQL.
  • convert_roundcube_mysql2sqlite — Converts the Roundcube database from MySQL to SQLite.

    Warning:

    Individual accounts may still need to be converted, even after the database conversion. To convert individual cPanel accounts which use Roundcube to SQLite, add the username as the parameter:/usr/local/cpanel/scripts/convert_roundcube_mysql2sqlite user 

  • dovecot_auto_expunge_trash — This script runs nightly and deletes messages from trash folders that are older than the Trash Expire Time value in Home >> Service Configuration >> Mailserver Configuration. To activate this script, select the Auto Expunge Trash checkbox.