Scripts

For WHM version 11.30

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.

• 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 the Mail Delimiter.
• 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 — Spam-deferral 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.
• checkperlmodules — Contains a list of standard CPAN modules to install on cPanel servers. This script is used in conjunction with realperlinstaller, below. This script can be used with the following arguments:
  • --force will reinstall everymodule regardless of whether or not it is working.
  • --full will ensure that all modules are present as opposed to only checking for essential modules.
• 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)