Global Parameters in 2.4¶

MariaDB MaxScale configuration handles configuration set for the MaxScale Instance itself, the REST API, and globals settings for all other configuration units through a series of special parameters called global parameters. You can define global parameters using the configuration file (e.g., maxscale.cnf) in the [maxscale] configuration unit.

Global Parameter

Description

admin_auth

Enables HTTP Basic Access authentication for REST API.

admin_enabled

Enables the administrative interface for REST API.

admin_host

Network interface the REST API listens on.

admin_log_auth_failures

Enables logging authentication failures to the administrative interface.

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_ssl_ca_cert

Path to PEM file containing TLS Certificate Authority (CA) to use in HTTPS for REST API.

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.

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.

cachedir

Path to the directory containing cached data.

connector_plugindir

Path to MariaDB Connector C plugin directory.

datadir

Path to the data directory.

dump_last_statements

Sets condition on which MariaDB MaxScale dumps the last statement sent by the client.

execdir

Path to directory containing executable files.

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_messages

Deprecated, use the log_notice parameter instead.

log_notice

Enables logging messages at the notice syslog priority.

log_throttling

Comma-separated list of the maximum number of times logging message can occur within a period, the length of the period, and the amount of time to suppress logging messages that exceed this limit.

log_trace

Deprecated, use the log_info parameter instead.

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.

maxlog

Logs messages to the log file.

module_configdir

Path to directory containing module configurations.

ms_timestamp

Enables millisecond precision in log timestamps.

non_blocking_polls

Ignored. Parameter deprecrated in MariaDB MaxScale 2.3.

passive

Puts the MaxScale Instance on stand-by, Passive Instances monitor Servers and accept client connections, but take no action.

persistdir

Path to directory containing persistent configurations.

piddir

Path to the directory containing the PID file.

poll_sleep

Ignored. Parameter deprecarated in MariaDB MaxScale 2.3.

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.

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.

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.

thread_stack_size

Ignored. Parameter deprecated in MariaDB MaxScale 2.3.

threads

Number of worker threads available.

users_refresh_time

Maximum amount of time in seconds before refreshing user authentication.

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.