MaxScale Configuration Settings
Browse the comprehensive list of MariaDB MaxScale configuration parameters. This reference details valid values, default settings, and dynamic capabilities for servers, services, and monitors.
Description: The module parameter specifies the name of the filter module that is included in the routing chain.
Global Settings
Default: /var/log/maxscale/admin_audit.csv
Description: Defines additional TLS cipher configuration for the REST API.
allow_duplicate_servers
Description: Allows multiple server definitions to use the same IP address and port combination.
Values: all or list of auto tunable parameters, separated by ,
Description: Specifies whether a core dump file is generated in the event that MaxScale crashes.
cors_allow_origin
Description: Enables CORS and sets the Access-Control-Allow-Origin header to the specified value.
Default: /var/lib/maxscale
disable_fcrdns
Description: Disables Forward-Confirmed Reverse DNS (fcRDNS) lookups for client connections.
disable_module_unloading
Description: Disables the unloading of modules at exit. This provides more accurate Valgrind leak reports when memory is allocated within shared libraries.
disable_statement_logging
Description: Disables the logging of SQL statements sent by MaxScale to backend servers.
dump_network_traffic
Description: Dumps all raw network traffic to the log as info level messages.
enable_cors
Description: Enables Cross-Origin Resource Sharing (CORS) support for the MaxScale REST API.
enable_module_unloading
Description: Re-enables module unloading at exit (overrides disable-module-unloading)
enable_statement_logging
Description: Enables logging of all SQL statements sent by MaxScale monitors and authenticators to the backend servers.
exception_frequency
Description: Defines the frequency of generated API exceptions.
gdb_stacktrace
Description: When enabled, MaxScale attempts to use GDB to generate detailed stack traces during a crash. Can be disabled with gdb-stacktrace=false.
Description: Sets the number of entries in the reverse DNS lookup cache for client hostnames.
Values: none, file, kmip, vault
Default: 10, 1000ms, 10000ms
Default: /var/log/maxscale
Default: /etc/maxscale.modules.d/
Description: Save runtime configuration changes to disk.
Default: /var/lib/maxscale/maxscale.cnf.d/
Default: System Dependent
redirect_output_to_file
Description: Redirects stdout and stderr to the specified file path.
Description: Requires SSL for all listeners, servers, and the REST API.
Default: /usr/share/maxscale
sql_batch_size
Description: Sets the maximum batch size for REST API SQL statement processing.
Default: http://localhost:4318/v1/metrics
Description: Hard limit for the number of worker threads.
Description: Directory for low-overhead trace log files.
Description: Amount of log data to keep in trace files.
Default: 0 in MaxScale, 15 in MaxScale Trial.
Description: Specifies the password the service uses to retrieve user accounts from backends.
Description: Defines the router module that a service uses to direct client connections to backend servers.
Description: Username for retrieving user account information from backends.
Settings for File-based Key Manager
Description: Path to file containing encryption keys.
Settings for HashiCorp Vault Key Manager
Description: Sets the timeout for requests and connections to the Vault server.
Description: Manages whether encrypted (HTTPS) or unencrypted (HTTP) connections are used when communicating with the Vault server.
Description: Provides the authentication token to access the Vault server.
Settings for KMIP Key Manager
Description: Client certificate for KMIP authentication.
Description: Specifies the client private key used for connecting to the KMIP server.
Description: Defines the port on which the KMIP server listens.
Settings for TLS/SSL Encryption
Default: character_set_client=auto,character_set_connection=auto,character_set_results=auto,max_allowed_packet=auto,system_time_zone=auto,time_zone=auto,tx_isolation=auto,maxscale=auto
Mandatory: Yes, if socket is not provided.
Description: Identifies the service that the listener is connected to.
Mandatory: Yes, if port is not provided.
Mandatory: Yes, if socket is not provided.
Default: 0 in MaxScale, 15 in MaxScale Trial.
Description: Defines custom options added to replication commands for server.
Mandatory: Yes, if address is not provided.
reference/maxscale-authenticators
Settings
Default: Kerberos Default
Default: mariadb/localhost.localdomain
Settings
Settings
reference/maxscale-filters
Settings
Settings
Default: storage_inmemory
storage_memcached
Type: The Memcached server address specified as host[:port]
storage_redis
Type: The Redis server address specified as host[:port]
Type: Path to existing readable file.
Type: Path to existing readable file.
Type: Path to existing readable file.
Settings
Description: Specifies the comment injected before statements.
Settings
Settings
Default: s3.amazonaws.com
Description: Defines the S3 access key used for authentication.
Description: Describes the S3 secret key that is used for verification.
Settings
Description: Determines the path to the file containing masking rules.
Settings
Settings
Settings
Description: Specifies the base filename for session log files with unique session identifiers appended to create individual output files.
Description: Defines a regex pattern for excluding requests from specified client IP addresses or hosts from logging.
Description: Defines a regex pattern to include only queries from specific client IP addresses or hosts from logging.
Description: Defines a regex pattern that prevent requests from specific users from being logged.
Description: Specifies a regex pattern to include queries only from specific users for logging.
Settings
Description: Defines the regex pattern in SQL statements that filter should identify and replace.
Description: Specifies the string that will replace SQL query parts that match
Settings
Default: No default value
Settings per template in the template file
Default: From maxscale.cnf
Description: Overrides the global template configuration to specify whether pattern matching is case-sensitive.
Description: Identifies whether to use subsequent templates on a query once the previous template has been matched and replaced.
Description: Specifies whether whitespace differences between the template and SQL inout should be ignored during matching.
Values: Native, ECMAScript, Posix, EPosix, Awk, Grep, EGrep
Description: Simulates replacements without affecting queries and logs any possible changes to the NOTICE level.
Settings
Settings
Description: Sets the maximum number of requests per second allowed for a session during the specific sample period.
Description: Specifies how long a session can be throttled before being disconnected by MaxScale.
Settings
Description: Specifies the base name for session log files, followed by the session ID to generate unique output files.
Settings
Default: /var/lib/maxscale/wcar/
Maximum: Unlimited in MaxScale, 5min in MaxScale Lite.
Maximum: Unlimited in MaxScale, 10MB in MaxScale Lite.
reference/maxscale-monitors
Settings
Description: Specifies which monitor module will be used, such as mariadbmon
Description: Defines the password for the user defined in the user parameter; overrides older passwd
Description: Provides a comma-separated list of servers that the monitor will track and manage.
Description: Specifies the monitor's username for connecting to backend servers; if defined, this overrides the server's monitoruser
Settings
Description: Allows Galera nodes to continue performing normal operations while acting as donors during non-blocking SST methods, preventing them from losing synchronized or read/write state.
Description: Prevents MaxScale from restoring the original node to primary status after a failover; the new primary retains the role while running.
Description: Disables automatic primary and replica role assignment in a Galera cluster; when enabled, only the Synced status is assigned.
Description: Ensures that only the Galera node with wsrep_local_index = 0
Description: Controls whether the wsrep_sst_donor
Description: Allows the monitor to automatically select the writing node and manage controlled node replacements in a Galera cluster while keeping server priorities into account.
Settings
Settings for Backup operations
Settings for Cluster manipulation operations
[switchover_on_low_disk_space\*\*](../reference/maxscale-monitors/mariadb-monitor.md#switchover_on_low_disk_space**)
Settings for Primary server write test
Description: Sets the interval after which a write test is performed on the primary if no changes are detected.
Default: mxs.maxscale_write_test
reference/maxscale-protocols
Settings
Settings
Mandatory: Yes, if authentication_shared is true.
Description: Specifies the user used to access and manage shared NoSQL account information.
Values: none, in, out, back
Description: Specifies the internal cache to use, currently supporting only the cache
Values: return_error, return_empty
reference/maxscale-rest-api
Resource Operations
[Create a filter](../reference/maxscale-rest-api/maxscale-filter-resource.md#Create a filter)
Type of the object, must be filters
Resource Operations
[Create a new listener](../reference/maxscale-rest-api/maxscale-listener-resource.md#Create a new listener)
Type of the object, must be listeners
data.attributes.parameters.port OR data.attributes.parameters.socket
The TCP port or UNIX Domain Socket the listener listens on. Only one of the fields can be defined.
Resource Operations
[Create a monitor](../reference/maxscale-rest-api/maxscale-monitor-resource.md#Create a monitor)
Type of the object, must be monitors
The monitor module to use
Resource Operations
[Create a server](../reference/maxscale-rest-api/maxscale-server-resource.md#Create a server)
Type of the object, must be servers
data.attributes.parameters.address OR data.attributes.parameters.socket
The or to use. Only one of the fields can be defined.
Resource Operations
[Create a service](../reference/maxscale-rest-api/maxscale-service-resource.md#Create a service)
Type of the object, must be services
reference/maxscale-routers
Settings
Default: /var/lib/maxscale/binlogs
Settings
Type: non-negative integer
Description: Specifes the primary server from which query results are returned to the client.
Type: non-negative integer
Type: non-negative integer
Type: non-negative integer
Description: Defines the service that Diff will operate on.
Settings
Description: Specifies the Exasol ODBC connection string used to connect to the database.
Default: "UTIL.maria_preprocessor"
Settings
Description: Specifies the list of Kafka brokers in host:port
Description: Specifies the Kafka topic where replicated events are published.
Settings
Description: Specifies the comma-separated list of Kafka broker addresses used to establish connections.
Description: Specifies the comma-separated list of topics to subscribe to.
Settings
Default: No default value
Default: No default value
Default: No default value
Description: Defines the primary target server whose results are returned to the client and whose availability is required for the session.
Settings
Settings
Default: true (>= MaxScale 24.02), false(<= MaxScale 23.08)
Values: least_current_operations
Default: true (>= MaxScale 24.02), false (<= MaxScale 23.08)
Default: 30s (>= MaxScale 24.02), 0s (<= MaxScale 23.08)
Settings
Settings
Description: Identifies the primary target cluster to which all write operations are directed.
This page is licensed: CC BY-SA / Gnu FDL