Module Parameters for MariaDB MaxScale

This page is part of MariaDB's SkySQL Documentation.

The parent of this page is: Reference for MariaDB MaxScale

Topics on this page:

Overview
Module Parameters by MariaDB MaxScale Version
- Support Matrix by Version

Overview

MariaDB MaxScale supports many module parameters.

Reference material is available for MariaDB MaxScale.

Module Parameters by MariaDB MaxScale Version

Choose a version of MariaDB MaxScale to see the Module Parameters supported by that version:

Module Parameters for MariaDB MaxScale 6

Support Matrix by Version

A summary of Module Parameters across MariaDB MaxScale versions:

Parameter	Module	In 6?
address	Protocol.MariaDBProtocol	6
address	servers.servers	6
admin_auth	maxscale.maxscale	6
admin_enabled	maxscale.maxscale	6
admin_gui	maxscale.maxscale	6
admin_host	maxscale.maxscale	6
admin_log_auth_failures	maxscale.maxscale	6
admin_pam_readonly_service	maxscale.maxscale	6
admin_pam_readwrite_service	maxscale.maxscale	6
admin_port	maxscale.maxscale	6
admin_secure_gui	maxscale.maxscale	6
admin_ssl_ca_cert	maxscale.maxscale	6
admin_ssl_cert	maxscale.maxscale	6
admin_ssl_key	maxscale.maxscale	6
admin_ssl_version	maxscale.maxscale	6
assume_unique_hostnames	Monitor.mariadbmon	6
auth_all_servers	Router.readconnroute	6
auth_all_servers	Router.readwritesplit	6
auth_connect_timeout	maxscale.maxscale	6
auth_read_timeout	maxscale.maxscale	6
auth_write_timeout	maxscale.maxscale	6
authenticator	Protocol.MariaDBProtocol	6
authenticator	servers.servers	6
authenticator_options	Protocol.MariaDBProtocol	6
auto_failover	Monitor.mariadbmon	6
auto_rejoin	Monitor.mariadbmon	6
backend_connect_attempts	Monitor.mariadbmon	6
backend_connect_timeout	Monitor.mariadbmon	6
backend_read_timeout	Monitor.mariadbmon	6
backend_write_timeout	Monitor.mariadbmon	6
causal_reads	Router.readwritesplit	6
causal_reads_timeout	Router.readwritesplit	6
cluster	Router.readconnroute	6
cluster	Router.readwritesplit	6
config_sync_cluster	maxscale.maxscale	6
config_sync_interval	maxscale.maxscale	6
config_sync_password	maxscale.maxscale	6
config_sync_timeout	maxscale.maxscale	6
config_sync_user	maxscale.maxscale	6
connection_init_sql_file	Protocol.MariaDBProtocol	6
connection_keepalive	Router.readconnroute	6
connection_keepalive	Router.readwritesplit	6
connection_timeout	Router.readconnroute	6
connection_timeout	Router.readwritesplit	6
cooperative_monitoring_locks	Monitor.mariadbmon	6
debug	maxscale.maxscale	6
delayed_retry	Router.readwritesplit	6
delayed_retry_timeout	Router.readwritesplit	6
demotion_sql_file	Monitor.mariadbmon	6
detect_stale_master	Monitor.mariadbmon	6
detect_stale_slave	Monitor.mariadbmon	6
detect_standalone_master	Monitor.mariadbmon	6
disable_sescmd_history	Router.readconnroute	6
disable_sescmd_history	Router.readwritesplit	6
disk_space_check_interval	Monitor.mariadbmon	6
disk_space_threshold	Monitor.mariadbmon	6
disk_space_threshold	servers.servers	6
dump_last_statements	maxscale.maxscale	6
enable_root_user	Router.readconnroute	6
enable_root_user	Router.readwritesplit	6
enforce_read_only_slaves	Monitor.mariadbmon	6
enforce_simple_topology	Monitor.mariadbmon	6
enforce_writable_master	Monitor.mariadbmon	6
events	Monitor.mariadbmon	6
extra_port	servers.servers	6
failcount	Monitor.mariadbmon	6
failover_timeout	Monitor.mariadbmon	6
filters	Router.readconnroute	6
filters	Router.readwritesplit	6
handle_events	Monitor.mariadbmon	6
idle_session_pool_time	Router.readconnroute	6
idle_session_pool_time	Router.readwritesplit	6
ignore_external_masters	Monitor.mariadbmon	6
journal_max_age	Monitor.mariadbmon	6
lazy_connect	Router.readwritesplit	6
load_persisted_configs	maxscale.maxscale	6
local_address	maxscale.maxscale	6
localhost_match_wildcard_host	Router.readconnroute	6
localhost_match_wildcard_host	Router.readwritesplit	6
log_auth_warnings	Router.readconnroute	6
log_auth_warnings	Router.readwritesplit	6
log_debug	maxscale.maxscale	6
log_info	maxscale.maxscale	6
log_notice	maxscale.maxscale	6
log_throttling	maxscale.maxscale	6
log_warn_super_user	maxscale.maxscale	6
log_warning	maxscale.maxscale	6
maintenance_on_low_disk_space	Monitor.mariadbmon	6
master_accept_reads	Router.readconnroute	6
master_accept_reads	Router.readwritesplit	6
master_conditions	Monitor.mariadbmon	6
master_failure_mode	Router.readwritesplit	6
master_failure_timeout	Monitor.mariadbmon	6
master_reconnection	Router.readwritesplit	6
max_auth_errors_until_block	maxscale.maxscale	6
max_connections	Router.readconnroute	6
max_connections	Router.readwritesplit	6
max_replication_lag	Router.readconnroute	6
max_sescmd_history	Router.readconnroute	6
max_sescmd_history	Router.readwritesplit	6
max_slave_connections	Router.readwritesplit	6
max_slave_replication_lag	Router.readwritesplit	6
maxlog	maxscale.maxscale	6
monitor_interval	Monitor.mariadbmon	6
monitorpw	servers.servers	6
monitoruser	servers.servers	6
ms_timestamp	maxscale.maxscale	6
net_write_timeout	Router.readconnroute	6
net_write_timeout	Router.readwritesplit	6
optimistic_trx	Router.readwritesplit	6
passive	maxscale.maxscale	6
password	Monitor.mariadbmon	6
password	Router.readconnroute	6
password	Router.readwritesplit	6
persistmaxtime	servers.servers	6
persistpoolmax	servers.servers	6
port	Protocol.MariaDBProtocol	6
port	servers.servers	6
priority	servers.servers	6
promotion_sql_file	Monitor.mariadbmon	6
protocol	Protocol.MariaDBProtocol	6
protocol	servers.servers	6
proxy_protocol	servers.servers	6
prune_sescmd_history	Router.readconnroute	6
prune_sescmd_history	Router.readwritesplit	6
query_classifier	maxscale.maxscale	6
query_classifier_args	maxscale.maxscale	6
query_classifier_cache_size	maxscale.maxscale	6
query_retries	maxscale.maxscale	6
query_retry_timeout	maxscale.maxscale	6
rank	Router.readconnroute	6
rank	Router.readwritesplit	6
rank	servers.servers	6
rebalance_period	maxscale.maxscale	6
rebalance_threshold	maxscale.maxscale	6
rebalance_window	maxscale.maxscale	6
replication_master_ssl	Monitor.mariadbmon	6
replication_password	Monitor.mariadbmon	6
replication_user	Monitor.mariadbmon	6
retain_last_statements	Router.readconnroute	6
retain_last_statements	Router.readwritesplit	6
retain_last_statements	maxscale.maxscale	6
retry_failed_reads	Router.readwritesplit	6
reuse_prepared_statements	Router.readwritesplit	6
router	Router.readconnroute	6
router	Router.readwritesplit	6
router_options	Router.readconnroute	6
script	Monitor.mariadbmon	6
script_max_replication_lag	Monitor.mariadbmon	6
script_timeout	Monitor.mariadbmon	6
servers	Router.readconnroute	6
servers	Router.readwritesplit	6
servers_no_promotion	Monitor.mariadbmon	6
service	Protocol.MariaDBProtocol	6
session_trace	Router.readconnroute	6
session_trace	Router.readwritesplit	6
session_trace	maxscale.maxscale	6
session_track_trx_state	Router.readconnroute	6
session_track_trx_state	Router.readwritesplit	6
skip_permission_checks	maxscale.maxscale	6
slave_conditions	Monitor.mariadbmon	6
slave_connections	Router.readwritesplit	6
slave_selection_criteria	Router.readwritesplit	6
socket	Protocol.MariaDBProtocol	6
socket	servers.servers	6
sql_mode	Protocol.MariaDBProtocol	6
sql_mode	maxscale.maxscale	6
ssl	Protocol.MariaDBProtocol	6
ssl	servers.servers	6
ssl_ca_cert	Protocol.MariaDBProtocol	6
ssl_ca_cert	servers.servers	6
ssl_cert	Protocol.MariaDBProtocol	6
ssl_cert	servers.servers	6
ssl_cert_verify_depth	Protocol.MariaDBProtocol	6
ssl_cert_verify_depth	servers.servers	6
ssl_cipher	Protocol.MariaDBProtocol	6
ssl_cipher	servers.servers	6
ssl_crl	Protocol.MariaDBProtocol	6
ssl_key	Protocol.MariaDBProtocol	6
ssl_key	servers.servers	6
ssl_verify_peer_certificate	Protocol.MariaDBProtocol	6
ssl_verify_peer_certificate	servers.servers	6
ssl_verify_peer_host	Protocol.MariaDBProtocol	6
ssl_verify_peer_host	servers.servers	6
ssl_version	Protocol.MariaDBProtocol	6
ssl_version	servers.servers	6
strict_multi_stmt	Router.readwritesplit	6
strict_sp_calls	Router.readwritesplit	6
strip_db_esc	Router.readconnroute	6
strip_db_esc	Router.readwritesplit	6
switchover_on_low_disk_space	Monitor.mariadbmon	6
switchover_timeout	Monitor.mariadbmon	6
syslog	maxscale.maxscale	6
targets	Router.readconnroute	6
targets	Router.readwritesplit	6
threads	maxscale.maxscale	6
transaction_replay	Router.readwritesplit	6
transaction_replay_attempts	Router.readwritesplit	6
transaction_replay_max_size	Router.readwritesplit	6
transaction_replay_retry_on_deadlock	Router.readwritesplit	6
type	Protocol.MariaDBProtocol	6
type	Router.readconnroute	6
type	Router.readwritesplit	6
type	servers.servers	6
use_sql_variables_in	Router.readwritesplit	6
user	Monitor.mariadbmon	6
user	Router.readconnroute	6
user	Router.readwritesplit	6
user_accounts_file	Router.readconnroute	6
user_accounts_file	Router.readwritesplit	6
user_accounts_file_usage	Router.readconnroute	6
user_accounts_file_usage	Router.readwritesplit	6
user_mapping_file	Protocol.MariaDBProtocol	6
users_refresh_interval	maxscale.maxscale	6
users_refresh_time	maxscale.maxscale	6
verify_master_failure	Monitor.mariadbmon	6
version_string	Router.readconnroute	6
version_string	Router.readwritesplit	6
writeq_high_water	maxscale.maxscale	6
writeq_low_water	maxscale.maxscale	6