1. Create a basic or admin user, depending on what kind of user you need:

Replace maxscale\_rest\_admin and maxscale\_rest\_admin\_password with the desired user and password.

1. If you want to use MaxCtrl remotely, configure the REST API for remote connections. Several global parameters must be configured in maxscale.cnf.

For example:

1. Enable TLS for MaxScale's REST API Several global parameters must be configured in maxscale.cnf.

For example:

1. Ensure that the client also has a TLS certificate, a private key, and the CA certificate.

2. Use MaxCtrl to connect with TLS:

Replace maxscale_rest_admin and maxscale_rest_admin_password with the actual user and password.

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

Setting a Server to Maintenance Mode

1. Configure the REST API if the default configuration is not sufficient.

2. Use MaxCtrl to execute the set server command with the maintenance option:

Replace server1 with the name of the specific server.

1. If the specified server is a primary server, then MaxScale will allow open transactions to complete before closing any connections.

Forcing a Server to Maintenance Mode

1. Use MaxCtrl to execute the set server command with the maintenance --force option:

1. Replace server1 with the specific server name. When --force is used, MaxScale immediately closes all connections, even if the server is a primary server with open transactions.

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

The --force option will automatically remove the server from monitors and services before destroying it.

Bypassing the manual unlinking steps may abruptly terminate active database sessions. Only use this if traffic has already been safely drained from the node at the orchestration layer.

• Confirm that the server object was properly unlinked from the service

• Confirm that the server object was properly unlinked from the monitor

• Confirm that the server object was properly removed

There are two types of users:

Creating a Basic User

1. Configure the REST API if the default configuration is not sufficient.

2. Use MaxCtrl to execute the create user command:

Replace maxscale_rest and maxscale_rest_password with the desired user and password.

Creating an Admin User

1. Configure the REST API if the default configuration is not sufficient.

2. Use MaxCtrl to execute the create user command with the --type=admin option:

Replace maxscale_rest_admin and maxscale_rest_admin_password with the desired user and password.

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