MaxCtrl Commands for MariaDB MaxScale 24.02
This page is part of MariaDB's Documentation.
The parent of this page is: Reference for MariaDB MaxScale 24.02
Topics on this page:
Overview
MariaDB MaxScale 24.02 ships with a command-line utility and administrative console called MaxCtrl (maxctrl
) to configure and manage MariaDB database product deployments through the MaxScale REST API. MaxCtrl supports many different commands.
Reference material is available for MariaDB MaxScale 24.02.
Usage
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:
$ maxctrl
If authentication is enabled for MaxScale's REST API, the user name and password can be provided via the --user
and --password
options:
$ maxctrl --user='maxscale' \
--password='secure-password' \
show services
The default user name is admin
, and the default password is mariadb
.
MariaDB MaxScale 24.02 MaxCtrl Commands
The following MaxCtrl Commands are supported by MariaDB MaxScale 24.02:
Command | Description |
---|---|
Modifies global logging configuration | |
Modifies global MaxScale configuration | |
Modifies parameters for a monitor | |
Modifes parameters for a server module | |
Modifies configuration for a service | |
Modifies configuration for a filter service | |
Changes password for a network user | |
Retrieves raw JSON from MaxScale API | |
Executes a command on the given module | |
Classifies the given statement | |
Clears the server module state | |
Creates a new filter service | |
Creates a new listener service | |
Creates a new monitor | |
Generates a report describing the state of all MaxScale objects | |
Creates a new server module | |
Creates a new service | |
Creates a new network user | |
Removes a filter service | |
Removes a listener service | |
Removes a monitor | |
Removes a server module | |
Removes a service | |
Removes a network user | |
Disables logging messages of the given priority level | |
Enables logging messages of the given priority level | |
Links server modules to the given monitor | |
Links server modules to the given service | |
Lists commands for configured modules | |
Lists configured filter services | |
Lists listeners for the given service | |
Lists modules currently loaded | |
Lists monitors | |
Lists configured server modules | |
Lists configured services | |
Lists current sessions | |
Lists threads in use | |
Lists network users | |
Rotates logs (closes and reopens log files) | |
Configures the state of the given server module | |
Displays commands available to the given module | |
Displays the configuration of the given filter service | |
Displays the configuration of all filter services | |
Displays the logging configuration | |
Displays the global MariaDB MaxScale configuration | |
Displays the configuration of the given module | |
Displays the configuration of all modules | |
Displays the configuration of the given monitor | |
Displays the configuration of all monitors | |
Displays the configuration of the given server module | |
Displays the configuration of all server modules | |
Displays the configuration of the given service | |
Displays the configuration of all services | |
Displays information on the given session | |
Displays information on all sessions | |
Displays information on the given thread | |
Displays information on all threads | |
Starts the given monitor | |
Starts the given service | |
Starts all services | |
Stops the given monitor | |
Stops the given service | |
Stops all services | |
Removes link from server modules to the given monitor | |
Removes link from server modules to the given service |
To see MaxCtrl Commands supported in other versions, see "MaxCtrl Commands by MariaDB MaxScale Version".
Configuration File
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 -c
or --config
option:
$ maxctrl --config=/maxscale/maxctrl.cnf \
show services