MaxCtrl Commands for MariaDB MaxScale
MariaDB MaxScale ships with a command-line utility and administrative console called MaxCtrl (
maxctrl) to configure and manage MariaDB Enterprise deployments through the MaxScale REST API. MaxCtrl supports many different commands.
Reference material is available for MariaDB MaxScale.
MaxCtrl commands can be run as command-line arguments:
$ maxctrl show services
Alternatively, if you need to execute several commands, you can open the administrative console by running MaxCtrl without arguments:
If authentication is enabled for MaxScale's REST API, the user name and password can be provided via the
$ maxctrl --user='maxscale' \ --password='secure-password' \ show services
The default user name is
admin, and the default password is
MaxCtrl Commands by MariaDB MaxScale Version
Choose a version of MariaDB MaxScale to see the MaxCtrl Commands supported by that version:
Support Matrix by Version
A summary of MaxCtrl Commands across MariaDB MaxScale versions:
MaxCtrl reads command-line options from the
~/.maxctrl.cnf configuration file.
The configuration file can be used to store common options, such as the user name and password:
[maxctrl] user = maxscale password = secure-password
MaxCtrl will refuse to use the
~/.maxctrl.cnf configuration file if it can be accessed by anyone other than the owner. Ensure that only the owner can access the file using the following command:
$ chown 0600 ~/.maxctrl.cnf
MaxCtrl can use a different configuration file by specifying the
$ maxctrl --config=/maxscale/maxctrl.cnf \ show services