Interface Lock Scripts

This element (ia-generated) isn't supported, or may require an update to be displayed. You can try to refresh the app.

Overview

We added scripts to manage the Interface Lock System. We created the Interface Lock System to block user changes to various features during cPanel & WHM upgrades. The Interface Lock System can manage global or user-specific blocks. This document contains the scripts that you can use to mange the Interface Lock System.
Warning:
You should only use the scripts provided in this article for maintenance purposes.
Do not use these scripts unless cPanel support instructs you to do so.

Interface lock names

  • UpdateHostname
  • Global — cPanel & WHM uses this lock to block hostname change requests while the system processes a hostname update.
  • User — cPanel & WHM uses this lock to prevent user access to the Horde webmail interface and the CalDAV/CardDAV protocols during a hostname change.

Scripts

/usr/local/cpanel/bin/is_interface_locked — Use this script to check whether an interface lock exists.
Options:
  • --help — Displays the help information.
  • --version — Displays the script version.
  • --name — The WHM or cPanel interface lock name.
  • --user — The cPanel user.
/usr/local/cpanel/bin/lock_interface — Use this script to lock an interface.
Options:
  • --help — Displays the help information.
  • --version — Displays the script version.
  • --name — The WHM or cPanel Interface lock name.
  • --user — The cPanel user.
  • --all — All cPanel users.
Note:The --all option does not indicate a global lock.
/usr/local/cpanel/bin/unlock_interface — Use this script to unlock an interface.
Options:
  • --help — Displays the help information.
  • --version — Displays the script version.
  • --name — The WHM or cPanel interface lock name.
  • --user — The cPanel user.
  • --all — All cPanel users.
Note:The --all option does not indicate a global lock