You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Overview

In cPanel & WHM version 11.52, 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. 

Warnings:

  • 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

 

Lock NameLock TypecPanel & WHM Version

HordeUpdate

User cPanel & WHM uses this lock to prevent user access to Horde webmail interface and the CalDAV/CardDAV protocols during the Horde update process. 11.52+

UpdateHostname

Global — cPanel & WHM uses this lock to block hostname change requests while the system processes a hostname update.

11.52+
User — cPanel & WHM uses this lock to prevent user access to Horde webmail interface and the CalDAV/CardDAV protocols during a hostname change.

Scripts

ScriptDescriptionOptions
/usr/local/cpanel/bin/is_interface_locked

Use this script to check whether an interface lock exists.

  • --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.

 

  • --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.

 

  • --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.

 

Additional documentation

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels

There is no content with the specified labels