Knowledgebase
Articles
The Mailbox Format Conversion Scripts
Overview: The following scripts allow you convert mailbox formats:...
Overview: The following scripts allow you convert mailbox formats:...
The auto-adjust-mysql-limits Script
Overview: The /usr/local/cpanel/scripts/auto-adjust-mysql-limits script updates MySQL®...
Overview: The /usr/local/cpanel/scripts/auto-adjust-mysql-limits script updates MySQL®...
The autossl_check Script
Overview: The /usr/local/cpanel/bin/autossl_check script allows you to manually check the SSL...
Overview: The /usr/local/cpanel/bin/autossl_check script allows you to manually check the SSL...
The backup Script
Overview: Use the /usr/local/cpanel/bin/backup script to run a manual backup in WHM via the...
Overview: Use the /usr/local/cpanel/bin/backup script to run a manual backup in WHM via the...
The backup_restore_manager Script
Overview: The /usr/local/cpanel/bin/backup_restore_manager script manages the backup restoration...
Overview: The /usr/local/cpanel/bin/backup_restore_manager script manages the backup restoration...
The backups_clean_metadata_for_missing_backups Script
Overview: The backups_clean_metadata_for_missing_backups script removes the metadata for backup...
Overview: The backups_clean_metadata_for_missing_backups script removes the metadata for backup...
The backups_create_metadata Script
Overview: The /usr/local/cpanel/scripts/backups_create_metadata script allows a user to create...
Overview: The /usr/local/cpanel/scripts/backups_create_metadata script allows a user to create...
The backups_list_user_files Script
Overview: The /usr/local/cpanel/scripts/backups_list_user_files script locates a user’s backup...
Overview: The /usr/local/cpanel/scripts/backups_list_user_files script locates a user’s backup...
The balance_linked_node_quotas Script
Overview: The /usr/local/cpanel/scripts/backups_list_user_files script locates a user’s backup...
Overview: The /usr/local/cpanel/scripts/backups_list_user_files script locates a user’s backup...
The ccs-check Script
Overview: The /usr/local/cpanel/scripts/ccs-check script manages maintenance for the The...
Overview: The /usr/local/cpanel/scripts/ccs-check script manages maintenance for the The...
The checkallsslcerts Script
Overview: The system runs the /usr/local/cpanel/bin/checkallsslcerts script during the nightly...
Overview: The system runs the /usr/local/cpanel/bin/checkallsslcerts script during the nightly...
The clean_user_php_sessions Script
Overview: Use the /usr/local/cpanel/scripts/clean_user_php_sessions script to purge expired PHP...
Overview: Use the /usr/local/cpanel/scripts/clean_user_php_sessions script to purge expired PHP...
The convert_accesshash_to_token Script
Overview: The /usr/local/cpanel/scripts/convert_accesshash_to_token script converts a WHM user’s...
Overview: The /usr/local/cpanel/scripts/convert_accesshash_to_token script converts a WHM user’s...
The cpanel_dovecot_solr_rebuild_index Script
Overview: The /usr/local/cpanel/3rdparty/scripts/cpanel_dovecot_solr_rebuild_index script...
Overview: The /usr/local/cpanel/3rdparty/scripts/cpanel_dovecot_solr_rebuild_index script...
The cpconftool Script
Overview: Use the /usr/local/cpanel/bin/cpconftool script to back up and restore configuration...
Overview: Use the /usr/local/cpanel/bin/cpconftool script to back up and restore configuration...
The cpuser_port_authority Script
Overview: The cpuser_port_authority script assigns one or more 5-digit port numbers for a user’s...
Overview: The cpuser_port_authority script assigns one or more 5-digit port numbers for a user’s...
The dbmaptool Script
Overview: You can use the /usr/local/cpanel/bin/dbmaptool script to grant ownership of databases...
Overview: You can use the /usr/local/cpanel/bin/dbmaptool script to grant ownership of databases...
The dbstoregrants Script
Overview: Sometimes, you must make changes directly to a MySQL® user’s grants in the YAML and...
Overview: Sometimes, you must make changes directly to a MySQL® user’s grants in the YAML and...
The dnssec-cluster-keys Script
Overview: The /usr/local/cpanel/scripts/dnssec-cluster-keys script syncs and revokes currently...
Overview: The /usr/local/cpanel/scripts/dnssec-cluster-keys script syncs and revokes currently...
The enable_spf_dkim_globally Script
Overview: This script enables SPF and DKIM system-wide. It also creates the appropriate DNS...
Overview: This script enables SPF and DKIM system-wide. It also creates the appropriate DNS...
The find_and_fix_rpm_issues Script
Overview: The /usr/local/cpanel/scripts/find_and_fix_rpm_issues script detects issues with your...
Overview: The /usr/local/cpanel/scripts/find_and_fix_rpm_issues script detects issues with your...
The find_outdated_services Script
Overview: After a system update, cPanel & WHM runs the...
Overview: After a system update, cPanel & WHM runs the...
The fix-web-vhost-configuration Script
Overview: You can use the /usr/local/cpanel/scripts/fix-web-vhost-configuration script to...
Overview: You can use the /usr/local/cpanel/scripts/fix-web-vhost-configuration script to...
The gather-update-logs Script
Overview: Important: For more information about the cPanel Analytics data that we gather...
Overview: Important: For more information about the cPanel Analytics data that we gather...
The hook Script
Overview: The /usr/local/cpanel/scripts/hook script executes standardized hooks. Normally, only...
Overview: The /usr/local/cpanel/scripts/hook script executes standardized hooks. Normally, only...
The install_dovecot_fts Script
Overview: The /usr/local/cpanel/scripts/install_dovecot_fts script enables Internet Message...
Overview: The /usr/local/cpanel/scripts/install_dovecot_fts script enables Internet Message...
The is_script_stuck Script
Overview: In some rare cases, a long process may hang indefinitely and be difficult for system...
Overview: In some rare cases, a long process may hang indefinitely and be difficult for system...
The manage_greylisting Script
Overview: The /usr/local/cpanel/scripts/manage_greylisting manages the cPanel Greylisting...
Overview: The /usr/local/cpanel/scripts/manage_greylisting manages the cPanel Greylisting...
The manage_mysql_profiles Script
Overview: The /usr/local/cpanel/scripts/manage_mysql_profiles allows you to import and export...
Overview: The /usr/local/cpanel/scripts/manage_mysql_profiles allows you to import and export...
The modify_accounts Script
Overview: You can use the /usr/local/cpanel/usr/local/cpanel/scripts/modify_accounts script to...
Overview: You can use the /usr/local/cpanel/usr/local/cpanel/scripts/modify_accounts script to...
The modify_packages Script
Overview: You can use the /usr/local/cpanel/scripts/modify_packages script to set existing...
Overview: You can use the /usr/local/cpanel/scripts/modify_packages script to set existing...
The onboot_handler Script
Overview: When the system boots, it runs the /usr/local/cpanel/bin/onboot_handler script. This...
Overview: When the system boots, it runs the /usr/local/cpanel/bin/onboot_handler script. This...
The php_fpm_config Script
Overview: The /usr/local/cpanel/scripts/php_fpm_config script installs configuration files when...
Overview: The /usr/local/cpanel/scripts/php_fpm_config script installs configuration files when...
The pkgacct Script
Overview: You can use the /usr/local/cpanel/scripts/pkgacct script to create a cpmove archive...
Overview: You can use the /usr/local/cpanel/scripts/pkgacct script to create a cpmove archive...
The process_site_templates Script
Overview: Important: You cannot run this script as the root user. The...
Overview: Important: You cannot run this script as the root user. The...
The rebuild_dbmap Script
Overview: If the database map is corrupt for a cPanel user, you can use the...
Overview: If the database map is corrupt for a cPanel user, you can use the...
The rebuild_phpconf Script
Overview: The /usr/local/cpanel/bin/rebuild_phpconf script manages your server’s default PHP...
Overview: The /usr/local/cpanel/bin/rebuild_phpconf script manages your server’s default PHP...
The rebuildhttpdconf Script
Overview: You can use the /usr/local/cpanel/scripts/rebuildhttpdconf script to rebuild Apache’s...
Overview: You can use the /usr/local/cpanel/scripts/rebuildhttpdconf script to rebuild Apache’s...
The remove_dovecot_index_files Script
Overview: You can use the /usr/local/cpanel/scripts/remove_dovecot_index_files script to remove...
Overview: You can use the /usr/local/cpanel/scripts/remove_dovecot_index_files script to remove...
The removeacct Script
Overview: The /usr/local/cpanel/scripts/removeacct script terminates cPanel accounts from the...
Overview: The /usr/local/cpanel/scripts/removeacct script terminates cPanel accounts from the...
The rescan_user_dovecot_fts Script
Overview: You can use the /usr/local/cpanel/scripts/rescan_user_dovecot_fts script to perform a...
Overview: You can use the /usr/local/cpanel/scripts/rescan_user_dovecot_fts script to perform a...
The restartsrv Scripts
Overview: The /usr/local/cpanel/scripts/restartsrv_* scripts restart services. If a service...
Overview: The /usr/local/cpanel/scripts/restartsrv_* scripts restart services. If a service...
The restorepkg Script
Overview: You can use the /usr/local/cpanel/scripts/restorepkg script to restore a cPanel...
Overview: You can use the /usr/local/cpanel/scripts/restorepkg script to restore a cPanel...
The secureit Script
Overview: The /usr/local/cpanel/scripts/secureit script secures permissions on your server. Run...
Overview: The /usr/local/cpanel/scripts/secureit script secures permissions on your server. Run...
The securemysql Script
Overview: The /usr/local/cpanel/scripts/securemysql script secures a cPanel account’s MySQL®...
Overview: The /usr/local/cpanel/scripts/securemysql script secures a cPanel account’s MySQL®...
The servers_queue Script
Overview: This script allows you to manage the task queue system. The task queue system allows...
Overview: This script allows you to manage the task queue system. The task queue system allows...
The servicedomains Script
Overview: The /usr/local/cpanel/scripts/servicedomains script allows you to create Domain Name...
Overview: The /usr/local/cpanel/scripts/servicedomains script allows you to create Domain Name...
The set-tls-settings Script
Overview: The /usr/local/cpanel/bin/set-tls-settings script configures a server’s Secure Socket...
Overview: The /usr/local/cpanel/bin/set-tls-settings script configures a server’s Secure Socket...
The set_hostname Utility
Overview: The /usr/local/cpanel/bin/set_hostname utility updates the server’s hostname and...
Overview: The /usr/local/cpanel/bin/set_hostname utility updates the server’s hostname and...
The setup_greylist_db Script
Overview: The /usr/local/cpanel/scripts/setup_greylist_db script sets up the SQLite database for...
Overview: The /usr/local/cpanel/scripts/setup_greylist_db script sets up the SQLite database for...
The setupftpserver script
Overview: The /usr/local/cpanel/scripts/setupftpserver script allows you to select your server’s...
Overview: The /usr/local/cpanel/scripts/setupftpserver script allows you to select your server’s...
The spf_installer Script
Overview: The /usr/local/cpanel/bin/spf_installer script allows you to add an SPF record to all...
Overview: The /usr/local/cpanel/bin/spf_installer script allows you to add an SPF record to all...
The suspendacct Script
Overview: The /usr/local/cpanel/scripts/suspendacct script allows you to suspend an account from...
Overview: The /usr/local/cpanel/scripts/suspendacct script allows you to suspend an account from...
The swapip Script
Overview: Use this script to update a domain’s IP address in the zone file. It will update the...
Overview: Use this script to update a domain’s IP address in the zone file. It will update the...
The try-later Script
Overview: The /usr/local/cpanel/scripts/try-later script runs a check command at a specified...
Overview: The /usr/local/cpanel/scripts/try-later script runs a check command at a specified...
The unsuspendacct Script
Overview: The /usr/local/cpanel/scripts/unsuspendacct script allows you to unsuspend an account...
Overview: The /usr/local/cpanel/scripts/unsuspendacct script allows you to unsuspend an account...
The upcp Script
Overview: The /usr/local/cpanel/scripts/upcp script lets you update cPanel & WHM on the...
Overview: The /usr/local/cpanel/scripts/upcp script lets you update cPanel & WHM on the...
The upcp-running Script
Overview: The /usr/local/cpanel/scripts/upcp-running script determines whether the upcp script...
Overview: The /usr/local/cpanel/scripts/upcp-running script determines whether the upcp script...
The view_transfer Script
Overview: You can use the /usr/local/cpanel/bin/view_transfer script to monitor transfer...
Overview: You can use the /usr/local/cpanel/bin/view_transfer script to monitor transfer...
The wwwacct Script
Overview: This script creates a cPanel account. This script also sets up the new account’s...
Overview: This script creates a cPanel account. This script also sets up the new account’s...
WHM Scripts
Overview: The cPanel & WHM installation process adds important scripts to your server’s...
Overview: The cPanel & WHM installation process adds important scripts to your server’s...
