Overview

MaxGUI is a graphical utility that can perform administrative tasks using MaxScale's REST API. It is available starting in MaxScale 2.5. It supports many different operations.

MaxGUI is not available out-of-the box. MaxScale requires some configuration before MaxGUI can be used.

Enabling MaxGUI

1. If you want to use MaxGUI remotely, for remote connections.

Several global parameters must be configured in maxscale.cnf.

For example:

1. MaxGUI requires TLS, so you must Several global parameters must be configured in maxscale.cnf.

For example:

1. Ensure that the admin_gui global parameter is enable. It is enabled by default, so it will only be disabled if it was previously disabled manually.

2. Restart the MaxScale instance.

1. user with MaxCtrl:

Replace maxscale_rest_admin and maxscale_rest_admin_password with the desired user and password.

1. named admin with MaxCtrl:

1. Visit MaxGUI in your web browser.

For example:

• If you were accessing it from local host with the default port, then you would visit this address:

• If you were accessing it with the above example configuration, then you would visit this address:

1. Enter your user and password to login.

_{This page is: Copyright © 2025 MariaDB. All rights reserved.}

Overview

When using MaxScale, it is often necessary to temporarily remove a server from the load balancing pool without actually shutting down the server. This is usually needed to perform maintenance on the server, such as when upgrading the server's software or when performing schema upgrades.

MaxScale allows users to set servers to "maintenance mode", which prevents MaxScale from routing traffic to the server and prevents it from being elected as the new primary server during failover or switchover.

MaxGUI is a graphical utility that can perform administrative tasks using MaxScale's MaxScale's REST API. It can be used to set a server to maintenance mode.

Setting a Server to Maintenance Mode

1. .

2. Visit MaxGUI in your web browser. For example, if you are accessing it from local host with the default port, then visit this address:

3. Enter your username and password to log in.

4. On the dashboard, the "Servers" tab is shown by default.

Forcing a Server to Maintenance Mode

2. Visit MaxGUI in your web browser. For example, if you are accessing it from local host with the default port, then visit this address:

3. Enter your user and password to login.

4. On the dashboard, the "Servers" tab is shown by default.

_{This page is: Copyright © 2025 MariaDB. All rights reserved.}