Global Parameters for MariaDB MaxScale 23.02

This page is part of MariaDB's Documentation.

The parent of this page is: Reference for MariaDB MaxScale 23.02

Topics on this page:

Overview
MariaDB MaxScale 23.02 Global Parameters

Overview

MariaDB MaxScale 23.02 supports many global parameters.

Reference material is available for MariaDB MaxScale 23.02.

MariaDB MaxScale 23.02 Global Parameters

The following Global Parameters are supported by MariaDB MaxScale 23.02:

Global Parameter	Description
admin_audit	Enable REST audit logging
admin_audit_exclude_methods	List of HTTP methods to exclude from audit logging, e.g., "GET"
admin_audit_file	Full path to admin audit file
admin_auth	Enables HTTP Basic Access authentication for REST API
admin_enabled	Enables the administrative interface for REST API
admin_gui	Enable admin GUI
admin_host	Network interface the REST API listens on
admin_jwt_algorithm	JWT signature algorithm
admin_jwt_key	Encryption key ID for symmetric signature algorithms. If left empty, MaxScale will generate a random key that is used to sign the JWT.
admin_jwt_max_age	Maximum age of the JWTs generated by MaxScale
admin_log_auth_failures	Enables logging authentication failures to the administrative interface
admin_oidc_url	Extra public certificates used to validate externally signed JWTs
admin_pam_readonly_service	Enables PAM-based authentication served for REST API for read-only users
admin_pam_readwrite_service	Enables PAM-based authentication service for REST API for users who can perform any REST API operation
admin_port	Port on network interface the REST API listenes on
admin_secure_gui	Only serve GUI over HTTPS
admin_ssl_ca	Path to PEM file containing TLS Certificate Authority (CA) to use in HTTPS for REST API. Formerly admin_ssl_ca_cert.
admin_ssl_ca_cert	Alias for 'admin_ssl_ca'
admin_ssl_cert	Path to PEM file containing TLS certificate to use in HTTPS for REST API
admin_ssl_key	Path to PEM file containing TLS key to use in HTTPS for REST API
admin_ssl_version	Minimum required TLS protocol version for the REST API
admin_verify_url	URL for third-party verification of client tokens
auth_connect_timeout	Amount of time to wait in seconds for authentication to the Server
auth_read_timeout	Amount of time to wait in seconds when retrieving user authentication data from the Server
auth_write_timeout	Amount of time to wait in seconds when retrieving user authentication data from the Server. MaxScale does not write authentication data to the Server.
auto_tune	Specifies whether a MaxScale parameter whose value depends on a specific global server variable, should automatically be updated to match the variable's current value
cachedir	Path to the directory containing cached data
config_sync_cluster	Cluster used for configuration synchronization. If left empty (i.e., value is ""), synchronization is not done.
config_sync_db	Database where the 'maxscale_config' table is created
config_sync_interval	How often to synchronize the configuration
config_sync_password	Password for the user used for configuration synchronization
config_sync_timeout	Timeout for the configuration synchronization operations
config_sync_user	User account used for configuration synchronization
connector_plugindir	Path to MariaDB Connector C plugin directory
datadir	Path to the data directory
debug	Debug options
dump_last_statements	Sets condition on which MariaDB MaxScale dumps the last statement sent by the client
execdir	Path to directory containing executable files
key_manager	Key manager type
language	Path to directory containing the `errmsg.sys` file
libdir	Path to the directory searched for modules
load_persisted_configs	Enables loading persistent runtime configuration changes on startup. Persistent runtime changes are saved to the `/var/lib/maxscale/maxscale.cnf.d/` directory.
local_address	Sets local address or network interface to use when connecting to Servers
log_augmentation	Appends logging messages with the name of the function where the message was logged (used primarily for development purposes)
log_debug	Enables logging messages at the `debug` syslog priority
log_info	Enables logging messages at the `info` syslog priority
log_notice	Enables logging messages at the `notice` syslog priority
log_throttling	Limit the amount of identical log messages than can be logged during a certain time period
log_warn_super_user	Log a warning when a user with super privilege logs in
log_warning	Enables logging messages at the `warning` syslog priority
logdir	Path to directory used to store log files
max_auth_errors_until_block	Maximum number of authentication failures allowed before temporarily blocking a host
max_read_amount	Maximum amount of data read before return to epoll_wait
maxlog	Logs messages to the log file
module_configdir	Path to directory containing module configurations
ms_timestamp	Enables millisecond precision in log timestamps
passive	Puts the MaxScale Instance on stand-by, Passive Instances monitor Servers and accept client connections, but take no action
persist_runtime_changes	Persist configurations changes done at runtime
persistdir	Path to directory containing persistent configurations
piddir	Path to the directory containing the PID file
query_classifier	Sets the Query Classifier module
query_classifier_args	Specifies arguments passed to the Query Classifier
query_classifier_cache_size	Maximum size for Query Classifier Cache
query_retries	Number of times to retry an internal query interruped by network errors
query_retry_timeout	Amount of time in seconds to wait on retried queries
rebalance_period	How often should the load of the worker threads be checked and rebalancing be made
rebalance_threshold	If the difference in load between the thread with the maximum load and the thread with the minimum load is larger than the value of this parameter, then work will be moved from the former to the latter
rebalance_window	The load of how many seconds should be taken into account when rebalancing
retain_last_statements	Number of statements stored for each session. Used in debugging.
session_trace	Number of log entries stored in the session trace log. Used in debugging.
session_trace_match	Regular expression that is matched against the contents of the session trace log and if it matches the contents are logged when the session stops
sharedir
skip_name_resolve	Do not resolve client IP addresses to hostnames during authentication
skip_permission_checks	Disables user permission checks for services and monitors during startup
sql_mode	Specifies SQL Mode for Query Classifier
substitute_variables	Sets environmental variables for cofniguration files
syslog	Logs messages to the syslog
threads	This parameter specifies how many threads will be used for handling the routing
threads_max	This parameter specifies a hard maximum for the number of routing threads
users_refresh_interval	How often the users will be refreshed
users_refresh_time	How often the users can be refreshed
writeq_high_water	Maximum size of client-side write queue to a given Server before MaxScale blocks traffic going to the Server to allow it to catch up
writeq_low_water	Size the client-side write queue must drop to before MaxScale unblocks a throttled Server

To see Global Parameters supported in other versions, see "Global Parameters by MariaDB MaxScale Version".